update document comments

Author: huiguangjun

alibabacloud_oss_v2/downloader.py

@@ -103,7 +103,14 @@ def __init__(
     ) -> None:
         """
             client (DownloadAPIClient): A agent that implements the HeadObject and GetObject api.
-            downloader_options (DownloaderOptions, optional): optional.
+            kwargs: Extra keyword arguments used to initialize the downloader.
+                - part_size (int): The part size. Default value: 6 MiB.
+                - parallel_num (int): The number of the download tasks in parallel. Default value: 3.
+                - block_size (int): The block size is the number of bytes it should read into memory. Default value: 16 KiB.
+                - use_temp_file (bool): Whether to use a temporary file when you download an object. A temporary file is used by default.
+                - enable_checkpoint (bool): Whether to enable checkpoint. Defaults to False.
+                - checkpoint_dir (str): The directory to store checkpoint.
+                - verify_data (bool): Whether to verify data when the download is resumed. Defaults to False.            
         """
         part_size = kwargs.get('part_size', defaults.DEFAULT_DOWNLOAD_PART_SIZE)
         parallel_num = kwargs.get('parallel_num', defaults.DEFAULT_DOWNLOAD_PARALLEL)
@@ -138,7 +145,14 @@ def download_file(
         Args:
             request (models.GetObjectRequest):  the request parameters for the download operation.
             filepath (str): The path of a local file.
-
+            kwargs: Extra keyword arguments.
+                - part_size (int): The part size.
+                - parallel_num (int): The number of the download tasks in parallel.
+                - block_size (int): The block size is the number of bytes it should read into memory.
+                - use_temp_file (bool): Whether to use a temporary file when you download an object.
+                - enable_checkpoint (bool): Whether to enable checkpoint.
+                - checkpoint_dir (str): The directory to store checkpoint.
+                - verify_data (bool): Whether to verify data when the download is resumed.
         Returns:
             DownloadResult: The result for the download operation.
         """
@@ -178,7 +192,10 @@ def download_to(
         Args:
             request (models.GetObjectRequest):  the request parameters for the download operation.
             writer (IO[bytes]): writes the data into writer
-
+            kwargs: Extra keyword arguments.
+                - part_size (int): The part size.
+                - parallel_num (int): The number of the download tasks in parallel.
+                - block_size (int): The block size is the number of bytes it should read into memory.
         Returns:
             DownloadResult: The result for the download operation.
         """

alibabacloud_oss_v2/uploader.py

@@ -151,6 +151,12 @@ def __init__(
     ) -> None:
         """
             client (UploadAPIClient): A agent that implements the PutObject and Multipart Upload api.
+            kwargs: Extra keyword arguments used to initialize the uploader.
+                - part_size (int): The part size. Default value: 6 MiB.
+                - parallel_num (int): The number of the upload tasks in parallel. Default value: 3.
+                - leave_parts_on_error (bool): Whether to retain the uploaded parts when an upload task fails. By default, the uploaded parts are not retained.
+                - enable_checkpoint (bool): Whether to enable checkpoint. Defaults to False.
+                - checkpoint_dir (str): The directory to store checkpoint.            
         """
         part_size = kwargs.get('part_size', defaults.DEFAULT_UPLOAD_PART_SIZE)
         parallel_num = kwargs.get('parallel_num', defaults.DEFAULT_UPLOAD_PARALLEL)
@@ -187,6 +193,12 @@ def upload_file(
         Args:
             request (models.PutObjectRequest):  the request parameters for the upload operation.
             filepath (str): The path of a local file.
+            kwargs: Extra keyword arguments.
+                - part_size (int): The part size.
+                - parallel_num (int): The number of the upload tasks in parallel.
+                - leave_parts_on_error (bool): Whether to retain the uploaded parts when an upload task fails.
+                - enable_checkpoint (bool): Whether to enable checkpoint.
+                - checkpoint_dir (str): The directory to store checkpoint.            
 
         Returns:
             UploadResult: The result for the upload operation.
@@ -222,7 +234,10 @@ def upload_from(
         Args:
             request (models.PutObjectRequest):  The request parameters for the upload operation.
             reader (IO[bytes]): The stream to be uploaded.
-
+            kwargs: Extra keyword arguments.
+                - part_size (int): The part size.
+                - parallel_num (int): The number of the upload tasks in parallel.
+                - leave_parts_on_error (bool): Whether to retain the uploaded parts when an upload task fails.
         Returns:
             UploadResult: The result for the upload operation.
         """