Skip to content

Commit f0759bf

Browse files
committed
Update comment
1 parent 8e4b271 commit f0759bf

File tree

6 files changed

+24
-24
lines changed

6 files changed

+24
-24
lines changed

automation_file/local/dir/dir_process.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
def copy_dir(dir_path: str, target_dir_path: str) -> bool:
99
"""
1010
Copy dir to target path (path need as dir path)
11-
:param dir_path: which dir we want to copy (str path)
11+
:param dir_path: which dir do we want to copy (str path)
1212
:param target_dir_path: copy dir to this path
1313
:return: True if success else False
1414
"""
@@ -28,7 +28,7 @@ def copy_dir(dir_path: str, target_dir_path: str) -> bool:
2828

2929
def remove_dir_tree(dir_path: str) -> bool:
3030
"""
31-
:param dir_path: which dir we want to remove (str path)
31+
:param dir_path: which dir do we want to remove (str path)
3232
:return: True if success else False
3333
"""
3434
dir_path = Path(dir_path)
@@ -44,7 +44,7 @@ def remove_dir_tree(dir_path: str) -> bool:
4444

4545
def rename_dir(origin_dir_path, target_dir: str) -> bool:
4646
"""
47-
:param origin_dir_path: which dir we want to rename (str path)
47+
:param origin_dir_path: which dir do we want to rename (str path)
4848
:param target_dir: target name as str full path
4949
:return: True if success else False
5050
"""

automation_file/local/file/file_process.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
def copy_file(file_path: str, target_path: str) -> bool:
1010
"""
11-
:param file_path: which file we want to copy (str path)
11+
:param file_path: which file do we want to copy (str path)
1212
:param target_path: put copy file on target path
1313
:return: True if success else False
1414
"""
@@ -27,8 +27,8 @@ def copy_file(file_path: str, target_path: str) -> bool:
2727

2828
def copy_specify_extension_file(file_dir_path: str, target_extension: str, target_path: str) -> bool:
2929
"""
30-
:param file_dir_path: which dir we want to search
31-
:param target_extension: Which extension do we search
30+
:param file_dir_path: which dir do we want to search
31+
:param target_extension: what extension we will search
3232
:param target_path: copy file to target path
3333
:return: True if success else False
3434
"""
@@ -78,7 +78,7 @@ def copy_all_file_to_dir(dir_path: str, target_dir_path: str) -> bool:
7878

7979
def rename_file(origin_file_path, target_name: str, file_extension=None) -> bool:
8080
"""
81-
:param origin_file_path: which dir we want to search file
81+
:param origin_file_path: which dir do we want to search file
8282
:param target_name: rename file to target name
8383
:param file_extension: Which extension do we search
8484
:return: True if success else False
@@ -113,7 +113,7 @@ def rename_file(origin_file_path, target_name: str, file_extension=None) -> bool
113113

114114
def remove_file(file_path: str) -> None:
115115
"""
116-
:param file_path: which file we want to remove
116+
:param file_path: which file do we want to remove
117117
:return: None
118118
"""
119119
file_path = Path(file_path)

automation_file/local/zip/zip_process.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ def zip_file(zip_file_path: str, file: [str, List[str]]) -> None:
4747

4848
def read_zip_file(zip_file_path: str, file_name: str, password: [str, None] = None) -> bytes:
4949
"""
50-
:param zip_file_path: which zip we want to read
51-
:param file_name: which file on zip we want to read
50+
:param zip_file_path: which zip do we want to read
51+
:param file_name: which file on zip do we want to read
5252
:param password: if zip have password use this password to unzip zip file
5353
:return:
5454
"""
@@ -86,8 +86,8 @@ def unzip_all(
8686
zip_file_path: str, extract_member: [str, None] = None,
8787
extract_path: [str, None] = None, password: [str, None] = None) -> None:
8888
"""
89-
:param zip_file_path: which zip we want to unzip
90-
:param extract_member: which member we want to unzip
89+
:param zip_file_path: which zip do we want to unzip
90+
:param extract_member: which member do we want to unzip
9191
:param extract_path: extract to path
9292
:param password: if zip have password use this password to unzip zip file
9393
:return: None
@@ -133,7 +133,7 @@ def zip_file_info(zip_file_path: str) -> List[str]:
133133

134134
def set_zip_password(zip_file_path: str, password: bytes) -> None:
135135
"""
136-
:param zip_file_path: which zip we want to set password
136+
:param zip_file_path: which zip do we want to set password
137137
:param password: password will be set
138138
:return: None
139139
"""

automation_file/remote/google_drive/download/download_file.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def drive_download_file(file_id: str, file_name: str) -> BytesIO:
4141

4242
def drive_download_file_from_folder(folder_name: str) -> Union[dict, None]:
4343
"""
44-
:param folder_name: which folder we want to download file
44+
:param folder_name: which folder do we want to download file
4545
:return: dict or None
4646
"""
4747
try:

automation_file/remote/google_drive/search/search_drive.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def drive_search_all_file() -> Union[dict, None]:
3030

3131
def drive_search_file_mimetype(mime_type: str) -> Union[dict, None]:
3232
"""
33-
:param mime_type: search all file with mime_type on Google Drive
33+
:param mime_type: search all file with mime_type on Google Drive
3434
:return: dict or None
3535
"""
3636
try:
@@ -61,7 +61,7 @@ def drive_search_file_mimetype(mime_type: str) -> Union[dict, None]:
6161

6262
def drive_search_field(field_pattern: str) -> Union[dict, None]:
6363
"""
64-
:param field_pattern: which pattern will search
64+
:param field_pattern: what pattern will we use to search
6565
:return: dict or None
6666
"""
6767
try:

automation_file/remote/google_drive/share/share_file.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
def drive_share_file_to_user(
1010
file_id: str, user: str, user_role: str = "writer") -> Union[dict, None]:
1111
"""
12-
:param file_id: which file we want to share
13-
:param user: what user we want to share
14-
:param user_role: what role we want to share
12+
:param file_id: which file do we want to share
13+
:param user: what user do we want to share
14+
:param user_role: what role do we want to share
1515
:return: dict or None
1616
"""
1717
try:
@@ -40,8 +40,8 @@ def drive_share_file_to_user(
4040

4141
def drive_share_file_to_anyone(file_id: str, share_role: str = "reader") -> Union[dict, None]:
4242
"""
43-
:param file_id: which file we want to share
44-
:param share_role: what role we want to share
43+
:param file_id: which file do we want to share
44+
:param share_role: what role do we want to share
4545
:return: dict or None
4646
"""
4747
try:
@@ -69,9 +69,9 @@ def drive_share_file_to_anyone(file_id: str, share_role: str = "reader") -> Unio
6969
def drive_share_file_to_domain(
7070
file_id: str, domain: str, domain_role: str = "reader") -> Union[dict, None]:
7171
"""
72-
:param file_id: which file we want to share
73-
:param domain: what domain we want to share
74-
:param domain_role: what role we want to share
72+
:param file_id: which file do we want to share
73+
:param domain: what domain do we want to share
74+
:param domain_role: what role do we want to share
7575
:return: dict or None
7676
"""
7777
try:

0 commit comments

Comments
 (0)