fix #91

add file_filter for download_folder & upload_folder

Author: lemisky

src/aligo/apis/Create.py

@@ -1,6 +1,6 @@
 """Create class"""
 import os
-from typing import List
+from typing import List, Callable
 
 from aligo.core import *
 from aligo.request import *
@@ -63,22 +63,23 @@ def upload_files(self, file_paths: List[str], parent_file_id: str = 'root', driv
         return file_list
 
     def upload_folder(self, folder_path: str, parent_file_id: str = 'root', drive_id: str = None,
-                      check_name_mode: CheckNameMode = "auto_rename",
-                      folder_check_name_mode: CheckNameMode = 'refuse') -> List:
+                      check_name_mode: CheckNameMode = "auto_rename", folder_check_name_mode: CheckNameMode = 'refuse',
+                      file_filter: Callable[[os.DirEntry], bool] = lambda x: False) -> List:
         """
         上传文件夹
         :param folder_path: [str] 文件夹路径
         :param parent_file_id: Optional[str] 父文件夹id, 默认为 'root'
         :param drive_id: [str] 指定网盘id, 默认为 None, 如果为 None, 则使用默认网盘
         :param check_name_mode: [CheckNameMode] 检查文件名模式, 默认为 'auto_rename'
         :param folder_check_name_mode: [CheckNameMode] 检查文件夹名模式, 默认为 'refuse'
+        :param file_filter: 文件过滤函数
         :return: [List]
 
         用法示例:
         >>> from aligo import Aligo
         >>> ali = Aligo()
         >>> # noinspection PyShadowingNames
-        >>> resut = ali.upload_folder('/Users/aligo/Desktop/test')
+        >>> result = ali.upload_folder('/Users/aligo/Desktop/test')
         >>> print(result)
         """
         result = []
@@ -97,6 +98,8 @@ def upload_folder(self, folder_path: str, parent_file_id: str = 'root', drive_id
         # 3. 开始扫描目标文件夹
         file: os.DirEntry
         for file in os.scandir(folder_path):
+            if file_filter(file):
+                continue
             if file.is_file():
                 # 4. 如果是文件, 就上传, 并继续
                 x = self.upload_file(file.path, parent_file_id=folder.file_id, name=file.name, drive_id=drive_id,

src/aligo/apis/Download.py

@@ -1,6 +1,6 @@
 """..."""
 import os
-from typing import List, overload
+from typing import List, overload, Callable
 
 from aligo.core import *
 from aligo.request import *
@@ -64,12 +64,14 @@ def batch_download_url(self,
         result = self._core_batch_download_url(body)
         return list(result)
 
-    def download_folder(self, folder_file_id: str, local_folder: str = '.', drive_id: str = None) -> str:
+    def download_folder(self, folder_file_id: str, local_folder: str = '.', drive_id: str = None,
+                        file_filter: Callable[[BaseFile], bool] = lambda x: False) -> str:
         """
         下载文件夹
         :param folder_file_id: [str] 文件夹 id
         :param local_folder: [str] 本地文件夹路径, 默认为当前目录, 即下载到哪里
         :param drive_id: [str] 文件夹所在的网盘 id
+        :param file_filter: 文件过滤函数
         :return: [str] 本地文件夹路径
 
         用法示例:
@@ -81,14 +83,17 @@ def download_folder(self, folder_file_id: str, local_folder: str = '.', drive_id
         if folder_file_id != 'root':
             folder = self._core_get_file(GetFileRequest(file_id=folder_file_id, drive_id=drive_id))
             local_folder = os.path.join(local_folder, self._del_special_symbol(folder.name))
-        return self.__download_folder(folder_file_id, local_folder, drive_id)
+        return self.__download_folder(folder_file_id, local_folder, drive_id, file_filter=file_filter)
 
-    def __download_folder(self, folder_file_id: str, local_folder: str = '.', drive_id: str = None) -> str:
+    def __download_folder(self, folder_file_id: str, local_folder: str = '.', drive_id: str = None,
+                          file_filter: Callable[[BaseFile], bool] = lambda x: False) -> str:
         """下载文件夹"""
         # 创建文件夹, 即使文件夹为空
         os.makedirs(local_folder, exist_ok=True)
         files = []
         for file in self._core_get_file_list(GetFileListRequest(parent_file_id=folder_file_id, drive_id=drive_id)):
+            if file_filter(file):
+                continue
             if file.type == 'folder':
                 self.__download_folder(folder_file_id=file.file_id,
                                        local_folder=os.path.join(local_folder, self._del_special_symbol(file.name)))