update document comments.

Author: huiguangjun

alibabacloud_oss_v2/_client.py

@@ -32,7 +32,7 @@
 
 
 class AddressStyle():
-    """_summary_
+    """address style information
     """
     Virtual = 1
     Path = 2
@@ -62,15 +62,12 @@ def __init__(
             self._seekable = False
 
     def is_seekable(self) -> bool:
-        """'_summary_
-
-        Returns:
-            bool: _description_
+        """'is seekable
         """
         return self._seekable
 
     def mark(self) -> None:
-        """_summary_
+        """Set the current marked position in the stream.
         """
         if self.is_seekable() is False:
             return
@@ -79,7 +76,7 @@ def mark(self) -> None:
             self._io_curr = self._body.tell()
 
     def reset(self) -> None:
-        """_summary_
+        """Resets the buffer to the marked position.
         """
         if self.is_seekable() is False:
             return
@@ -208,14 +205,14 @@ def verify_operation(self, op_input: OperationInput, options: _Options) -> None:
             raise exceptions.ObjectNameInvalidError()
 
     def apply_operation(self, options: _Options, op_input: OperationInput) -> None:
-        """_summary_"""
+        """apply operation"""
         self._apply_operation_options(options) # pylint: disable=no-member
         _apply_operation_metadata(op_input, options)
 
 
     def build_request_context(self, op_input: OperationInput, options: _Options, inner: _InnerOptions
                               ) -> SigningContext:
-        """_summary_
+        """build request context
         """
         # host & path
         url = _build_url(op_input, options)
@@ -273,7 +270,7 @@ def build_request_context(self, op_input: OperationInput, options: _Options, inn
         return context
 
     def retry_max_attempts(self, options: _Options) -> int:
-        """_summary_"""
+        """retry max attempts"""
         if options.retry_max_attempts is not None:
             attempts = int(options.retry_max_attempts)
         elif options.retryer is not None:
@@ -284,11 +281,11 @@ def retry_max_attempts(self, options: _Options) -> int:
         return max(1, attempts)
 
     def has_feature(self, flag: int) -> bool:
-        """_summary_"""
+        """has feature"""
         return (self._options.feature_flags & flag) > 0 # pylint: disable=no-member
 
     def get_retry_attempts(self) -> bool:
-        """_summary_"""
+        """get retry attempts"""
         return self.retry_max_attempts(self._options) # pylint: disable=no-member
 
 class _SyncClientImpl(_ClientImplMixIn):
@@ -303,7 +300,7 @@ def __init__(self, config: Config, **kwargs) -> None:
         self._inner = inner
 
     def invoke_operation(self, op_input: OperationInput, **kwargs) -> OperationOutput:
-        """_summary_
+        """Common class interface invoice operation
 
         Args:
             op_input (OperationInput): _description_

alibabacloud_oss_v2/checkpoint.py

@@ -46,7 +46,7 @@
 # }
 
 class DownloadCheckpoint:
-    """_summary_
+    """Download Checkpoint
     """
     def __init__(
         self,
@@ -189,10 +189,7 @@ def _is_valid(self) -> bool:
         return False
 
     def dump(self) -> bool:
-        """_summary_
-
-        Returns:
-            _type_: _description_
+        """dump the checkpoint to local file
         """
         #Calculate MD5
         self.cp_info["Data"]["DownloadInfo"] = {
@@ -247,7 +244,7 @@ def remove(self) -> None:
 # }
 
 class UploadCheckpoint:
-    """_summary_
+    """Upload Checkpoint
     """
     def __init__(
         self,
@@ -352,10 +349,7 @@ def _is_valid(self) -> bool:
         return False
 
     def dump(self) -> bool:
-        """_summary_
-
-        Returns:
-            _type_: _description_
+        """dump the checkpoint to local file
         """
         #Calculate MD5
         self.cp_info["Data"]["UploadInfo"] = {
@@ -377,7 +371,7 @@ def dump(self) -> bool:
         return True
 
     def remove(self) -> None:
-        """_summary_
+        """remove the checkpoint file
         """
         try:
             os.remove(self.cp_filepath)

alibabacloud_oss_v2/client.py

@@ -1,5 +1,5 @@
 # pylint: disable=line-too-long
-"""_summary_"""
+"""Client used to interact with **Alibaba Cloud Object Storage Service (OSS)**."""
 import copy
 from typing import Optional
 from .config import Config
@@ -29,11 +29,11 @@
 from .filelike import AppendOnlyFile, ReadOnlyFile
 
 class Client:
-    """_summary_
+    """Client
     """
 
     def __init__(self, config: Config, **kwargs) -> None:
-        """_summary_
+        """Initialize Client
 
         Args:
             config (Config): _description_
@@ -45,7 +45,7 @@ def __repr__(self) -> str:
 
     def invoke_operation(self, op_input: OperationInput, **kwargs
                          ) -> OperationOutput:
-        """_summary_
+        """invoke operation
 
         Args:
             op_input (OperationInput): _description_
@@ -679,7 +679,7 @@ def list_multipart_uploads_paginator(self, **kwargs) -> ListMultipartUploadsPagi
 
     # transfer managers
     def downloader(self, **kwargs) -> Downloader:
-        """_summary_
+        """downloader
 
         Args:
 
@@ -689,7 +689,7 @@ def downloader(self, **kwargs) -> Downloader:
         return Downloader(self, **kwargs)
 
     def uploader(self, **kwargs) -> Uploader:
-        """_summary_
+        """uploader
 
         Returns:
             Uploader: _description_
@@ -818,29 +818,29 @@ def is_bucket_exist(self, bucket: str, request_payer: Optional[str] = None, **kw
         return result is not None
 
     def put_object_from_file(self, request: models.PutObjectRequest, filepath: str, **kwargs) -> models.PutObjectResult:
-        """_summary_
+        """put an object from file
 
         Args:
-            request (models.PutObjectRequest): _description_
-            filepath (str): _description_
+            request (PutObjectRequest): Request parameters for PutObject operation.
+            filepath (str): The path of the file to upload.
 
         Returns:
-            models.PutObjectResult: _description_
+            PutObjectResult: Response result for PutObject operation.
         """
         with open(filepath, 'rb') as f:
             req = copy.copy(request)
             req.body = f
             return self.put_object(req, **kwargs)
 
     def get_object_to_file(self, request: models.GetObjectRequest, filepath: str, **kwargs) -> models.GetObjectResult:
-        """_summary_
+        """get an object to file
 
         Args:
-            request (models.GetObjectRequest): _description_
-            filepath (str): _description_
+            request (GetObjectRequest): Request parameters for GetObject operation.
+            filepath (str): The path of the file to download.
 
         Returns:
-            models.GetObjectResult: _description_
+            GetObjectResult: Response result for GetObject operation.
         """
         prog = None
         if request.progress_fn:

alibabacloud_oss_v2/crc.py

@@ -225,14 +225,6 @@ def write(self, data: bytes):
 
     @staticmethod
     def combine(crc1, crc2, size) -> int:
-        """_summary_
-
-        Args:
-            crc1 (_type_): _description_
-            crc2 (_type_): _description_
-            size (_type_): _description_
-
-        Returns:
-            int: _description_
+        """Combines two CRC64 values into one CRC64
         """
         return _COMBINE_FUNC(crc1, crc2, size)

alibabacloud_oss_v2/crypto/aes_ctr.py

@@ -17,7 +17,7 @@ def _iv_to_big_int(iv: bytes) -> int:
     return iv_big_int
 
 class IteratorEncryptor():
-    """_summary_
+    """Iterator Encryptor
     """
 
     def __init__(
@@ -73,7 +73,7 @@ def __next__(self):
             raise err
 
 class IterableEncryptor():
-    """_summary_
+    """Iterable Encryptor
     """
 
     def __init__(
@@ -93,7 +93,7 @@ def __iter__(self):
             counter=self._counter)
 
 class FileLikeEncryptor():
-    """_summary_
+    """File Like Encryptor
     """
     def __init__(
         self,
@@ -109,7 +109,7 @@ def __init__(
         self._offset = offset
 
     def read(self, n: int = -1) -> AnyStr:
-        """_summary_
+        """read
 
         Args:
             n (int, optional): _description_. Defaults to -1.
@@ -131,7 +131,7 @@ def read(self, n: int = -1) -> AnyStr:
         return self._cipher.encrypt(self._reader.read(n))
 
     def seek(self, offset: int, whence: int = 0) -> int:
-        """_summary_
+        """seek
 
         Args:
             offset (int): _description_
@@ -149,13 +149,13 @@ def seek(self, offset: int, whence: int = 0) -> int:
         return offset
 
     def tell(self) -> int:
-        """_summary_
+        """tell
         """
         return self._reader.tell()
 
 
 class StreamBodyDecryptor(StreamBody):
-    """_summary_
+    """Stream Body Decryptor
     """
     def __init__(
         self,
@@ -219,13 +219,7 @@ def __init__(
         self.no_str = False
 
     def encrypt(self, src: Any) -> Any:
-        """_summary_
-
-        Args:
-            src (Any): _description_
-
-        Returns:
-            Any: _description_
+        """encrypt data
         """
         if not self.no_str and isinstance(src, str):
             return self._get_cipher().encrypt(src.encode())
@@ -246,7 +240,7 @@ def encrypt(self, src: Any) -> Any:
         raise TypeError(f'src is not str/bytes/file-like/Iterable type, got {type(src)}')
 
     def decrypt(self, src: Any) -> Any:
-        """_summary_
+        """decrypt data
 
         Args:
             src (Any): _description_
@@ -268,7 +262,7 @@ def _get_cipher(self):
 
     @staticmethod
     def random_key() -> bytes:
-        """_summary_
+        """random key
 
         Returns:
             bytes: _description_
@@ -277,7 +271,7 @@ def random_key() -> bytes:
 
     @staticmethod
     def random_iv() -> bytes:
-        """_summary_
+        """random iv
 
         Returns:
             bytes: _description_

alibabacloud_oss_v2/crypto/aes_ctr_cipher.py

@@ -19,18 +19,18 @@ def __init__(
         self._cipher = _AesCtr(cipher_data, offset)
 
     def encrypt_content(self, data: Any) -> Any:
-        """_summary_
+        """encrypt content
         """
         return self._cipher.encrypt(data)
 
     def decrypt_content(self, data: Any) -> Any:
-        """_summary_
+        """decrypt content
         """
         reader = self._cipher.decrypt(data)
         return reader
 
     def clone(self, **kwargs) -> ContentCipher:
-        """_summary_
+        """clone
         """
         return _AESCtrCipher(
             cipher_data=self._cipher_data,
@@ -50,7 +50,7 @@ def get_align_len(self) -> int:
 
 
 class AESCtrCipherBuilder(ContentCipherBuilder):
-    """_summary_
+    """AES Ctr Cipher Builder
 
     Args:
         ContentCipherBuilder (_type_): _description_

alibabacloud_oss_v2/crypto/cipher.py

@@ -6,7 +6,7 @@ class Encrypter(abc.ABC):
 
     @abc.abstractmethod
     def encrypt(self, reader: Any) -> Any:
-        """_summary_
+        """encrypt
         """
 
 
@@ -15,9 +15,9 @@ class Decrypter(abc.ABC):
 
     @abc.abstractmethod
     def decrypt(self, reader: Any) -> Any:
-        """_summary_
+        """decrypt
         """
 
 class Cipher(Encrypter, Decrypter):
-    """_summary_
+    """Cipher
     """