Add comment

Add comment

Author: JE-Chen45

.readthedocs.yaml

@@ -1,9 +1,27 @@
-version: 2
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
-sphinx:
-  configuration: docs/source/conf.py
+# Required
+version: 2
 
+# Set the OS, Python version and other tools you might need
 build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+#formats:
+#  - pdf
+#  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+python:
+  install:
+  - requirements: docs/requirements.txt

automation_file/local/dir/dir_process.py

@@ -1,41 +1,60 @@
 import shutil
-import sys
 from pathlib import Path
 
 from automation_file.utils.exception.exceptions import DirNotExistsException
 from automation_file.utils.logging.loggin_instance import file_automation_logger
 
 
-def copy_dir(dir_path: str, target_dir_path: str) -> None:
+def copy_dir(dir_path: str, target_dir_path: str) -> bool:
+    """
+    Copy dir to target path (path need as dir path)
+    :param dir_path: which dir we want to copy (str path)
+    :param target_dir_path: copy dir to this path
+    :return: True if success else False
+    """
     dir_path = Path(dir_path)
     target_dir_path = Path(target_dir_path)
     if dir_path.is_dir():
         try:
             shutil.copytree(dir_path, target_dir_path, dirs_exist_ok=True)
             file_automation_logger.info(f"Copy dir {dir_path}")
+            return True
         except shutil.Error as error:
             file_automation_logger.error(f"Copy dir {dir_path} failed: {repr(error)}")
     else:
         file_automation_logger.error(f"Copy dir {dir_path} failed: {repr(DirNotExistsException)}")
+        return False
 
 
-def remove_dir_tree(dir_path: str) -> None:
+def remove_dir_tree(dir_path: str) -> bool:
+    """
+    :param dir_path: which dir we want to remove (str path)
+    :return: True if success else False
+    """
     dir_path = Path(dir_path)
     if dir_path.is_dir():
         try:
             shutil.rmtree(dir_path)
             file_automation_logger.info(f"Remove dir tree {dir_path}")
+            return True
         except shutil.Error as error:
             file_automation_logger.error(f"Remove dir tree {dir_path} error: {repr(error)}")
+            return False
 
 
-def rename_dir(origin_dir_path, target_dir: str) -> None:
+def rename_dir(origin_dir_path, target_dir: str) -> bool:
+    """
+    :param origin_dir_path: which dir we want to rename (str path)
+    :param target_dir: target name as str full path
+    :return: True if success else False
+    """
     origin_dir_path = Path(origin_dir_path)
     if origin_dir_path.exists() and origin_dir_path.is_dir():
         try:
             Path.rename(origin_dir_path, target_dir)
             file_automation_logger.info(
                 f"Rename dir origin dir path: {origin_dir_path}, target dir path: {target_dir}")
+            return True
         except Exception as error:
             file_automation_logger.error(
                 f"Rename dir error:  {repr(error)}, "
@@ -46,9 +65,14 @@ def rename_dir(origin_dir_path, target_dir: str) -> None:
             f"Rename dir error:  {repr(DirNotExistsException)}, "
             f"Rename dir origin dir path: {origin_dir_path}, "
             f"target dir path: {target_dir}")
+        return False
 
 
 def create_dir(dir_path: str) -> None:
+    """
+    :param dir_path: create dir on dir_path
+    :return: None
+    """
     dir_path = Path(dir_path)
     dir_path.mkdir(exist_ok=True)
     file_automation_logger.info(f"Create dir {dir_path}")

automation_file/local/file/file_process.py

@@ -6,19 +6,32 @@
 from automation_file.utils.logging.loggin_instance import file_automation_logger
 
 
-def copy_file(file_path: str, target_path: str) -> None:
+def copy_file(file_path: str, target_path: str) -> bool:
+    """
+    :param file_path: which file we want to copy (str path)
+    :param target_path: put copy file on target path
+    :return: True if success else False
+    """
     file_path = Path(file_path)
     if file_path.is_file() and file_path.exists():
         try:
             shutil.copy2(file_path, target_path)
             file_automation_logger.info(f"Copy file origin path: {file_path}, target path : {target_path}")
+            return True
         except shutil.Error as error:
             file_automation_logger.error(f"Copy file failed: {repr(error)}")
     else:
         file_automation_logger.error(f"Copy file failed: {repr(FileNotExistsException)}")
+        return False
 
 
-def copy_specify_extension_file(file_dir_path: str, target_extension: str, target_path: str) -> None:
+def copy_specify_extension_file(file_dir_path: str, target_extension: str, target_path: str) -> bool:
+    """
+    :param file_dir_path: which dir we want to search
+    :param target_extension: Which extension do we search
+    :param target_path: copy file to target path
+    :return: True if success else False
+    """
     file_dir_path = Path(file_dir_path)
     if file_dir_path.exists() and file_dir_path.is_dir():
         for file in file_dir_path.glob(f"**/*.{target_extension}"):
@@ -27,12 +40,19 @@ def copy_specify_extension_file(file_dir_path: str, target_extension: str, targe
                 f"Copy specify extension file on dir"
                 f"origin dir path: {file_dir_path}, target extension: {target_extension}, "
                 f"to target path {target_path}")
+        return True
     else:
         file_automation_logger.error(
             f"Copy specify extension file failed: {repr(FileNotExistsException)}")
+        return False
 
 
-def copy_all_file_to_dir(dir_path: str, target_dir_path: str) -> None:
+def copy_all_file_to_dir(dir_path: str, target_dir_path: str) -> bool:
+    """
+    :param dir_path: copy all file on dir
+    :param target_dir_path: put file to target dir
+    :return: True if success else False
+    """
     dir_path = Path(dir_path)
     target_dir_path = Path(target_dir_path)
     if dir_path.is_dir() and target_dir_path.is_dir():
@@ -43,6 +63,7 @@ def copy_all_file_to_dir(dir_path: str, target_dir_path: str) -> None:
                 f"origin dir: {dir_path}, "
                 f"target dir: {target_dir_path}"
             )
+            return True
         except shutil.Error as error:
             file_automation_logger.error(
                 f"Copy all file to dir failed, "
@@ -52,9 +73,16 @@ def copy_all_file_to_dir(dir_path: str, target_dir_path: str) -> None:
             )
     else:
         print(repr(DirNotExistsException), file=sys.stderr)
+        return False
 
 
-def rename_file(origin_file_path, target_name: str, file_extension=None) -> None:
+def rename_file(origin_file_path, target_name: str, file_extension=None) -> bool:
+    """
+    :param origin_file_path: which dir we want to search file
+    :param target_name: rename file to target name
+    :param file_extension: Which extension do we search
+    :return: True if success else False
+    """
     origin_file_path = Path(origin_file_path)
     if origin_file_path.exists() and origin_file_path.is_dir():
         if file_extension is None:
@@ -68,6 +96,7 @@ def rename_file(origin_file_path, target_name: str, file_extension=None) -> None
                 file_index = file_index + 1
                 file_automation_logger.info(
                     f"Renamed file: origin file path:{origin_file_path}, with new name: {target_name}")
+            return True
         except Exception as error:
             file_automation_logger.error(
                 f"Rename file failed, "
@@ -79,15 +108,25 @@ def rename_file(origin_file_path, target_name: str, file_extension=None) -> None
     else:
         file_automation_logger.error(
             f"Rename file failed, error: {repr(DirNotExistsException)}")
+        return False
 
 
 def remove_file(file_path: str) -> None:
+    """
+    :param file_path: which file we want to remove
+    :return: None
+    """
     file_path = Path(file_path)
     if file_path.exists() and file_path.is_file():
         file_path.unlink(missing_ok=True)
         file_automation_logger.info(f"Remove file, file path: {file_path}")
 
 
 def create_file(file_path: str, content: str) -> None:
+    """
+    :param file_path: create file on path
+    :param content: what content will write to file
+    :return: None
+    """
     with open(file_path, "w+") as file:
         file.write(content)

automation_file/local/zip/zip_process.py

@@ -2,17 +2,28 @@
 from pathlib import Path
 from shutil import make_archive
 from typing import List
+from zipfile import ZipInfo
 
 from automation_file.utils.exception.exceptions import ZIPGetWrongFileException
 from automation_file.utils.logging.loggin_instance import file_automation_logger
 
 
 def zip_dir(dir_we_want_to_zip: str, zip_name: str) -> None:
+    """
+    :param dir_we_want_to_zip: dir str path
+    :param zip_name: zip file name
+    :return: None
+    """
     make_archive(root_dir=dir_we_want_to_zip, base_name=zip_name, format="zip")
     file_automation_logger.info(f"Dir to zip: {dir_we_want_to_zip}, zip file name: {zip_name}")
 
 
 def zip_file(zip_file_path: str, file: [str, List[str]]) -> None:
+    """
+    :param zip_file_path: add file to zip file
+    :param file: single file path or list of file path (str) to add into zip
+    :return: None
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="w")
     if isinstance(file, str):
         file_name = Path(file)
@@ -34,7 +45,13 @@ def zip_file(zip_file_path: str, file: [str, List[str]]) -> None:
     current_zip.close()
 
 
-def read_zip_file(zip_file_path: str, file_name: str, password: [str, None] = None) -> None:
+def read_zip_file(zip_file_path: str, file_name: str, password: [str, None] = None) -> bytes:
+    """
+    :param zip_file_path: which zip we want to read
+    :param file_name: which file on zip we want to read
+    :param password: if zip have password use this password to unzip zip file
+    :return:
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="r")
     with current_zip.open(name=file_name, mode="r", pwd=password, force_zip64=True) as read_file:
         data = read_file.read()
@@ -47,6 +64,13 @@ def read_zip_file(zip_file_path: str, file_name: str, password: [str, None] = No
 
 def unzip_file(
         zip_file_path: str, extract_member, extract_path: [str, None] = None, password: [str, None] = None) -> None:
+    """
+    :param zip_file_path: which zip we want to unzip
+    :param extract_member: which member we want to unzip
+    :param extract_path: extract member to path
+    :param password: if zip have password use this password to unzip zip file
+    :return: None
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="r")
     current_zip.extract(member=extract_member, path=extract_path, pwd=password)
     file_automation_logger.info(
@@ -61,6 +85,13 @@ def unzip_file(
 def unzip_all(
         zip_file_path: str, extract_member: [str, None] = None,
         extract_path: [str, None] = None, password: [str, None] = None) -> None:
+    """
+    :param zip_file_path: which zip we want to unzip
+    :param extract_member: which member we want to unzip
+    :param extract_path: extract to path
+    :param password: if zip have password use this password to unzip zip file
+    :return: None
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="r")
     current_zip.extractall(members=extract_member, path=extract_path, pwd=password)
     file_automation_logger.info(
@@ -72,7 +103,11 @@ def unzip_all(
     current_zip.close()
 
 
-def zip_info(zip_file_path: str) -> None:
+def zip_info(zip_file_path: str) -> List[ZipInfo]:
+    """
+    :param zip_file_path: read zip file info
+    :return: List[ZipInfo]
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="r")
     info_list = current_zip.infolist()
     current_zip.close()
@@ -82,7 +117,11 @@ def zip_info(zip_file_path: str) -> None:
     return info_list
 
 
-def zip_file_info(zip_file_path: str) -> None:
+def zip_file_info(zip_file_path: str) -> List[str]:
+    """
+    :param zip_file_path: read inside zip file info
+    :return: List[str]
+    """
     current_zip = zipfile.ZipFile(zip_file_path, mode="r")
     name_list = current_zip.namelist()
     current_zip.close()
@@ -93,6 +132,11 @@ def zip_file_info(zip_file_path: str) -> None:
 
 
 def set_zip_password(zip_file_path: str, password: bytes) -> None:
+    """
+    :param zip_file_path: which zip we want to set password
+    :param password: password will be set
+    :return: None
+    """
     current_zip = zipfile.ZipFile(zip_file_path)
     current_zip.setpassword(pwd=password)
     current_zip.close()

automation_file/remote/google_drive/delete/delete_manager.py

@@ -7,6 +7,10 @@
 
 
 def drive_delete_file(file_id: str) -> Union[Dict[str, str], None]:
+    """
+    :param file_id: Google Drive file id
+    :return: Dict[str, str] or None
+    """
     try:
         file = driver_instance.service.files().delete(fileId=file_id).execute()
         file_automation_logger.info(f"Delete drive file: {file_id}")

automation_file/remote/google_drive/dir/folder_manager.py

@@ -7,6 +7,10 @@
 
 
 def drive_add_folder(folder_name: str) -> Union[dict, None]:
+    """
+    :param folder_name: folder name will create on Google Drive
+    :return: dict or None
+    """
     try:
         file_metadata = {
             "name": folder_name,

automation_file/remote/google_drive/download/download_file.py

@@ -10,6 +10,11 @@
 
 
 def drive_download_file(file_id: str, file_name: str) -> BytesIO:
+    """
+    :param file_id: file have this id will download
+    :param file_name: file save on local name
+    :return: file
+    """
     try:
         request = driver_instance.service.files().get_media(fileId=file_id)
         file = io.BytesIO()
@@ -35,6 +40,10 @@ def drive_download_file(file_id: str, file_name: str) -> BytesIO:
 
 
 def drive_download_file_from_folder(folder_name: str) -> Union[dict, None]:
+    """
+    :param folder_name:  which folder we want to download file
+    :return: dict or None
+    """
     try:
         files = dict()
         response = driver_instance.service.files().list(

automation_file/remote/google_drive/driver_instance.py

@@ -18,6 +18,11 @@ def __init__(self):
         self.scopes = ["https://www.googleapis.com/auth/drive"]
 
     def later_init(self, token_path: str, credentials_path: str):
+        """
+        :param token_path: Google Drive token path
+        :param credentials_path: Google Drive credentials path
+        :return: None
+        """
         token_path = Path(token_path)
         credentials_path = Path(credentials_path)
         creds = None