chore: port changes to CFFI implementation

Author: Rogdham

src/python/backports/zstd/_cffi/__init__.py

@@ -53,14 +53,12 @@
 
 
 def get_param_bounds(parameter, is_compress):
-    """
-    Get CompressionParameter/DecompressionParameter bounds.
-
-    parameter
-      The parameter to get bounds.
-    is_compress
-      True for CompressionParameter, False for DecompressionParameter.
-    """
+    """Get CompressionParameter/DecompressionParameter bounds.
+
+  parameter
+    The parameter to get bounds.
+  is_compress
+    True for CompressionParameter, False for DecompressionParameter."""
     if is_compress:
         bound = _lib.ZSTD_cParam_getBounds(parameter)
         if _lib.ZSTD_isError(bound.error):
@@ -73,12 +71,10 @@ def get_param_bounds(parameter, is_compress):
 
 
 def get_frame_info(frame_buffer):
-    """
-    Get Zstandard frame infomation from a frame header.
+    """Get Zstandard frame infomation from a frame header.
 
-    frame_buffer
-      A bytes-like object, containing the header of a Zstandard frame.
-    """
+  frame_buffer
+    A bytes-like object, containing the header of a Zstandard frame."""
     decompressed_size = _lib.ZSTD_getFrameContentSize(
         _ffi.from_buffer(frame_buffer), len(frame_buffer)
     )
@@ -98,13 +94,11 @@ def get_frame_info(frame_buffer):
 
 
 def get_frame_size(frame_buffer):
-    """
-    Get the size of a Zstandard frame, including the header and optional checksum.
+    """Get the size of a Zstandard frame, including the header and optional checksum.
 
-    frame_buffer
-      A bytes-like object, it should start from the beginning of a frame,
-      and contains at least one complete frame.
-    """
+  frame_buffer
+    A bytes-like object, it should start from the beginning of a frame,
+    and contains at least one complete frame."""
     frame_size = _lib.ZSTD_findFrameCompressedSize(
         _ffi.from_buffer(frame_buffer), len(frame_buffer)
     )
@@ -144,16 +138,14 @@ def _clinic_train_dict(*args):
 
 
 def train_dict(samples_bytes, samples_sizes, dict_size):
-    """
-    Train a Zstandard dictionary on sample data.
-
-    samples_bytes
-      Concatenation of samples.
-    samples_sizes
-      Tuple of samples' sizes.
-    dict_size
-      The size of the dictionary.
-    """
+    """Train a Zstandard dictionary on sample data.
+
+  samples_bytes
+    Concatenation of samples.
+  samples_sizes
+    Tuple of samples' sizes.
+  dict_size
+    The size of the dictionary."""
     _clinic_train_dict(samples_bytes, samples_sizes, dict_size)
 
     # Check arguments
@@ -193,20 +185,18 @@ def _clinic_finalize_dict(*args):
 def finalize_dict(
     custom_dict_bytes, samples_bytes, samples_sizes, dict_size, compression_level
 ):
-    """
-    Finalize a Zstandard dictionary.
-
-    custom_dict_bytes
-      Custom dictionary content.
-    samples_bytes
-      Concatenation of samples.
-    samples_sizes
-      Tuple of samples' sizes.
-    dict_size
-      The size of the dictionary.
-    compression_level
-      Optimize for a specific Zstandard compression level, 0 means default.
-    """
+    """Finalize a Zstandard dictionary.
+
+  custom_dict_bytes
+    Custom dictionary content.
+  samples_bytes
+    Concatenation of samples.
+  samples_sizes
+    Tuple of samples' sizes.
+  dict_size
+    The size of the dictionary.
+  compression_level
+    Optimize for a specific Zstandard compression level, 0 means default."""
     _clinic_finalize_dict(
         custom_dict_bytes, samples_bytes, samples_sizes, dict_size, compression_level
     )

src/python/backports/zstd/_cffi/_common.py

@@ -121,14 +121,12 @@ def _set_parameter_error(is_compress, key, value):
 
 
 def set_parameter_types(c_parameter_type, d_parameter_type):
-    """
-    Set CompressionParameter and DecompressionParameter types for validity check.
-
-    c_parameter_type
-      CompressionParameter IntEnum type object
-    d_parameter_type
-      DecompressionParameter IntEnum type object
-    """
+    """Set CompressionParameter and DecompressionParameter types for validity check.
+
+  c_parameter_type
+    CompressionParameter IntEnum type object
+  d_parameter_type
+    DecompressionParameter IntEnum type object"""
     _PARAMETER_TYPES["compression"] = c_parameter_type
     _PARAMETER_TYPES["decompression"] = d_parameter_type
 

src/python/backports/zstd/_cffi/compressor.py

@@ -31,26 +31,24 @@ def _zstd_contentsize_converter(size):
     if size < 0 or size >= _lib.ZSTD_CONTENTSIZE_ERROR:
         raise ValueError(
             "size argument should be a positive int less "
-            "than %ull" % _lib.ZSTD_CONTENTSIZE_ERROR
+            "than %u" % _lib.ZSTD_CONTENTSIZE_ERROR
         )
 
     return size
 
 
 class ZstdCompressor:
-    """
-    Create a compressor object for compressing data incrementally.
+    """Create a compressor object for compressing data incrementally.
 
-      level
-        The compression level to use. Defaults to COMPRESSION_LEVEL_DEFAULT.
-      options
-        A dict object that contains advanced compression parameters.
-      zstd_dict
-        A ZstdDict object, a pre-trained Zstandard dictionary.
+  level
+    The compression level to use. Defaults to COMPRESSION_LEVEL_DEFAULT.
+  options
+    A dict object that contains advanced compression parameters.
+  zstd_dict
+    A ZstdDict object, a pre-trained Zstandard dictionary.
 
-    Thread-safe at method level. For one-shot compression, use the compress()
-    function instead.
-    """
+Thread-safe at method level.  For one-shot compression, use the
+compress() function instead."""
 
     CONTINUE = _lib.ZSTD_e_continue
     FLUSH_BLOCK = _lib.ZSTD_e_flush
@@ -95,13 +93,11 @@ def __init__(self, level=None, options=None, zstd_dict=None):
 
     @property
     def last_mode(self):
-        """
-        The last mode used to this compressor object, its value can be .CONTINUE,
-        .FLUSH_BLOCK, .FLUSH_FRAME. Initialized to .FLUSH_FRAME.
+        """The last mode used to this compressor object, its value can be .CONTINUE,
+.FLUSH_BLOCK, .FLUSH_FRAME. Initialized to .FLUSH_FRAME.
 
-        It can be used to get the current state of a compressor, such as, data
-        flushed, or a frame ended.
-        """
+It can be used to get the current state of a compressor, such as, data
+flushed, or a frame ended."""
         return self._last_mode
 
     def _zstd_set_c_level(self, level):
@@ -203,17 +199,15 @@ def __del__(self):
             self._cctx = _ffi.NULL
 
     def compress(self, data, mode=_lib.ZSTD_e_continue):
-        """
-        Provide data to the compressor object.
+        """Provide data to the compressor object.
 
-          mode
-            Can be these 3 values ZstdCompressor.CONTINUE,
-            ZstdCompressor.FLUSH_BLOCK, ZstdCompressor.FLUSH_FRAME
+  mode
+    Can be these 3 values ZstdCompressor.CONTINUE,
+    ZstdCompressor.FLUSH_BLOCK, ZstdCompressor.FLUSH_FRAME
 
-        Return a chunk of compressed data if possible, or b'' otherwise. When you have
-        finished providing data to the compressor, call the flush() method to finish
-        the compression process.
-        """
+Return a chunk of compressed data if possible, or b'' otherwise.
+When you have finished providing data to the compressor, call the
+flush() method to finish the compression process."""
         if (
             mode != _lib.ZSTD_e_continue
             and mode != _lib.ZSTD_e_flush
@@ -327,17 +321,15 @@ def _compress_mt_continue_lock_held(self, data):
         return _OutputBuffer_Finish(buffer, out)
 
     def flush(self, mode=_lib.ZSTD_e_end):
-        """
-        Finish the compression process.
+        """Finish the compression process.
 
-          mode
-            Can be these 2 values ZstdCompressor.FLUSH_FRAME,
-            ZstdCompressor.FLUSH_BLOCK
+  mode
+    Can be these 2 values ZstdCompressor.FLUSH_FRAME,
+    ZstdCompressor.FLUSH_BLOCK
 
-        Flush any remaining data left in internal buffers. Since Zstandard data
-        consists of one or more independent frames, the compressor object can still
-        be used after this method is called.
-        """
+Flush any remaining data left in internal buffers.  Since Zstandard
+data consists of one or more independent frames, the compressor
+object can still be used after this method is called."""
         # Check mode value
         if mode != _lib.ZSTD_e_end and mode != _lib.ZSTD_e_flush:
             raise ValueError(
@@ -359,20 +351,19 @@ def flush(self, mode=_lib.ZSTD_e_end):
                 raise
 
     def set_pledged_input_size(self, size, /):
-        """
-        Set the uncompressed content size to be written into the frame header.
+        """Set the uncompressed content size to be written into the frame header.
 
-          size
-            The size of the uncompressed data to be provided to the compressor.
+  size
+    The size of the uncompressed data to be provided to the compressor.
 
-        This method can be used to ensure the header of the frame about to be written
-        includes the size of the data, unless the CompressionParameter.content_size_flag
-        is set to False. If last_mode != FLUSH_FRAME, then a RuntimeError is raised.
+This method can be used to ensure the header of the frame about to
+be written includes the size of the data, unless the
+CompressionParameter.content_size_flag is set to False.
+If last_mode != FLUSH_FRAME, then a RuntimeError is raised.
 
-        It is important to ensure that the pledged data size matches the actual data
-        size. If they do not match the compressed output data may be corrupted and the
-        final chunk written may be lost.
-        """
+It is important to ensure that the pledged data size matches the
+actual data size.  If they do not match the compressed output data
+may be corrupted and the final chunk written may be lost."""
         size = _zstd_contentsize_converter(size)
 
         # Thread-safe code

src/python/backports/zstd/_cffi/decompressor.py

@@ -24,17 +24,15 @@
 
 
 class ZstdDecompressor:
-    """
-    Create a decompressor object for decompressing data incrementally.
+    """Create a decompressor object for decompressing data incrementally.
 
-      zstd_dict
-        A ZstdDict object, a pre-trained Zstandard dictionary.
-      options
-        A dict object that contains advanced decompression parameters.
+  zstd_dict
+    A ZstdDict object, a pre-trained Zstandard dictionary.
+  options
+    A dict object that contains advanced decompression parameters.
 
-    Thread-safe at method level. For one-shot decompression, use the decompress()
-    function instead.
-    """
+Thread-safe at method level.  For one-shot decompression, use the
+decompress() function instead."""
 
     def __init__(self, zstd_dict=None, options=None):
         self._input_buffer = _ffi.NULL
@@ -101,7 +99,7 @@ def _zstd_set_d_parameters(self, options):
             # Check key type
             if isinstance(key, _PARAMETER_TYPES["compression"]):
                 raise TypeError(
-                    "compression options dictionary key must not be a "
+                    "decompression options dictionary key must not be a "
                     "CompressionParameter attribute"
                 )
 
@@ -125,12 +123,11 @@ def __del__(self):
 
     @property
     def unused_data(self):
-        """
-        A bytes object of un-consumed input data.
+        """A bytes object of un-consumed input data.
 
-        When ZstdDecompressor object stops after a frame is
-        decompressed, unused input data after the frame. Otherwise this will be b''.
-        """
+When ZstdDecompressor object stops after a frame is
+decompressed, unused input data after the frame.  Otherwise this
+will be b''."""
         with self._lock:
             if not self._eof:
                 return b""
@@ -145,46 +142,41 @@ def unused_data(self):
 
     @property
     def eof(self):
-        """
-        True means the end of the first frame has been reached. If decompress data
-        after that, an EOFError exception will be raised.
-        """
+        """True means the end of the first frame has been reached. If decompress data
+after that, an EOFError exception will be raised."""
         return self._eof
 
     @property
     def needs_input(self):
-        """
-        If the max_length output limit in .decompress() method has been reached,
-        and the decompressor has (or may has) unconsumed input data, it will be set
-        to False. In this case, passing b'' to the .decompress() method may output
-        further data.
-        """
+        """If the max_length output limit in .decompress() method has been reached,
+and the decompressor has (or may has) unconsumed input data, it will be set
+to False. In this case, passing b'' to the .decompress() method may output
+further data."""
         return self._needs_input
 
     def decompress(self, data, max_length=-1):
-        """
-        Decompress *data*, returning uncompressed bytes if possible, or b'' otherwise.
-
-          data
-            A bytes-like object, Zstandard data to be decompressed.
-          max_length
-            Maximum size of returned data. When it is negative, the size of
-            output buffer is unlimited. When it is nonnegative, returns at
-            most max_length bytes of decompressed data.
-
-        If *max_length* is nonnegative, returns at most *max_length* bytes of
-        decompressed data. If this limit is reached and further output can be
-        produced, *self.needs_input* will be set to ``False``. In this case, the next
-        call to *decompress()* may provide *data* as b'' to obtain more of the output.
-
-        If all of the input data was decompressed and returned (either because this
-        was less than *max_length* bytes, or because *max_length* was negative),
-        *self.needs_input* will be set to True.
-
-        Attempting to decompress data after the end of a frame is reached raises an
-        EOFError. Any data found after the end of the frame is ignored and saved in
-        the self.unused_data attribute.
-        """
+        """Decompress *data*, returning uncompressed bytes if possible, or b'' otherwise.
+
+  data
+    A bytes-like object, Zstandard data to be decompressed.
+  max_length
+    Maximum size of returned data. When it is negative, the size of
+    output buffer is unlimited. When it is nonnegative, returns at
+    most max_length bytes of decompressed data.
+
+If *max_length* is nonnegative, returns at most *max_length* bytes
+of decompressed data.  If this limit is reached and further output
+can be produced, *self.needs_input* will be set to ``False``.  In
+this case, the next call to *decompress()* may provide *data* as b''
+to obtain more of the output.
+
+If all of the input data was decompressed and returned (either
+because this was less than *max_length* bytes, or because
+*max_length* was negative), *self.needs_input* will be set to True.
+
+Attempting to decompress data after the end of a frame is reached
+raises an EOFError.  Any data found after the end of the frame is
+ignored and saved in the self.unused_data attribute."""
         with self._lock:
             return self._stream_decompress_lock_held(data, max_length)