bitarray 3.10.1__tar.gz → 3.12.0__tar.gz

{bitarray-3.10.1 → bitarray-3.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.10.1
+Version: 3.12.0
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
 Classifier: Topic :: Utilities
 Requires-Python: >=3.7
@@ -54,16 +55,20 @@ Key features
   operations ``+``, ``*``, ``+=``, ``*=``, the ``in`` operator, ``len()``
 * Bitwise operations: ``~``, ``&``, ``|``, ``^``, ``<<``, ``>>`` (as well as
   their in-place versions ``&=``, ``|=``, ``^=``, ``<<=``, ``>>=``).
-* Free-threading support (for GIL disabled CPython 3.14 and later)
-* Fast methods for encoding and decoding variable bit length prefix codes.
-* Bitarray objects support the buffer protocol (both importing and
-  exporting buffers).
-* Packing and unpacking to other binary data formats, e.g. ``numpy.ndarray``.
+* `Free-threading support <https://github.com/ilanschnell/bitarray/blob/master/doc/free_threading.rst>`__
+  (for GIL-disabled CPython 3.14 and later)
+* Fast methods for encoding and decoding variable-length prefix codes.
+* Bitarray objects support the `buffer protocol <https://github.com/ilanschnell/bitarray/blob/master/doc/buffer.rst>`__
+  (both importing and exporting buffers).
+* Efficient packing and unpacking for interoperability with byte-oriented
+  objects such as NumPy arrays.
 * Pickling and unpickling of bitarray objects.
 * Immutable ``frozenbitarray`` objects which are hashable
-* Sequential search
+* Fast searching for bits and bit patterns
+* ``bitfields`` sub-module for packing and unpacking fixed-width
+  `bit-field structures <https://github.com/ilanschnell/bitarray/blob/master/doc/bitfields.rst>`__
 * Type hinting
-* Extensive test suite with about 600 unittests
+* Extensive test suite with over 700 unit tests
 * Utility module ``bitarray.util``:
 
   * conversion to and from hexadecimal strings
@@ -71,8 +76,9 @@ Key features
   * pretty printing
   * conversion to and from integers
   * creating Huffman codes
-  * compression of sparse bitarrays
-  * (de-) serialization
+  * `compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+  * run-length encoding
+  * serialization and deserialization
   * various count functions
   * other helpful functions
 
@@ -94,7 +100,7 @@ Once you have installed the package, you may want to test it:
     $ python -c 'import bitarray; bitarray.test()'
     bitarray is installed in: /Users/ilan/bitarray/bitarray
     sys.prefix: /Users/ilan/miniforge
-    bitarray version: 3.10.1
+    bitarray version: 3.12.0
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
@@ -111,7 +117,7 @@ Once you have installed the package, you may want to test it:
     ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 640 tests in 0.192s
+    Ran 711 tests in 0.196s
 
     OK (skipped=4)
 
@@ -283,8 +289,8 @@ this topic, please read `buffer protocol <https://github.com/ilanschnell/bitarra
 to memory-map a file to a bitarray: `mmapped-file.py <https://github.com/ilanschnell/bitarray/blob/master/examples/mmapped-file.py>`__
 
 
-Variable bit length prefix codes
---------------------------------
+Variable-length prefix codes
+----------------------------
 
 The ``.encode()`` method takes a dictionary mapping symbols to bitarrays
 and an iterable, and extends the bitarray object with the encoded symbols
@@ -358,7 +364,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.10.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.12.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
 
 In the following, ``item`` and ``value`` are usually a single bit -
 an integer 0 or 1.
@@ -394,7 +400,7 @@ The bitarray object:
 
 
 bitarray methods:
------------------
+^^^^^^^^^^^^^^^^^
 
 ``all()`` -> bool
    Return ``True`` when all bits in bitarray are 1.
@@ -490,9 +496,12 @@ bitarray methods:
    New in version 3.4: allow ``bytes`` object
 
 
-``fill()`` -> int
+``fill(m=8, /)`` -> int
    Add zeros to the end of the bitarray, such that the length will be
-   a multiple of 8, and return the number of bits added [0..7].
+   a multiple of the positive integer ``m``, and return the number of bits
+   added (in ``range(m)``).
+
+   New in version 3.12: add optional alignment argument
 
 
 ``find(sub_bitarray, start=0, stop=<end>, /, right=False)`` -> int
@@ -638,10 +647,10 @@ bitarray methods:
    using the specified mapping.
 
 
-bitarray data descriptors:
---------------------------
+bitarray attributes:
+^^^^^^^^^^^^^^^^^^^^
 
-Data descriptors were added in version 2.6.
+Attributes were added in version 2.6.
 
 ``endian`` -> str
    bit-endianness as Unicode string
@@ -662,7 +671,7 @@ Data descriptors were added in version 2.6.
 
 
 decodeiterator methods:
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 
 ``skipbits(n, /)`` -> bitarray
    Skip over the next ``n`` bits and return them.
@@ -671,8 +680,8 @@ decodeiterator methods:
    New in version 3.9
 
 
-decodeiterator data descriptors:
---------------------------------
+decodeiterator attributes:
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``index`` -> int
    current bit position to be decoded by subsequent ``next``
@@ -681,7 +690,7 @@ decodeiterator data descriptors:
 
 
 decodetree methods:
--------------------
+^^^^^^^^^^^^^^^^^^^
 
 ``nodes()`` -> tuple
    Return tuple with number of:
@@ -783,7 +792,7 @@ This sub-module was added in version 1.2.
    Bitarray of base ``n`` ASCII representation.
    Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
    For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
-   standard base 64 alphabet is used.  Whitespace is ignored.
+   standard base 64 alphabet is used.  ASCII whitespace is ignored.
 
    See also: `Bitarray representations <https://github.com/ilanschnell/bitarray/blob/master/doc/represent.rst>`__
 
@@ -891,7 +900,7 @@ This sub-module was added in version 1.2.
 ``hex2ba(hexstr, /, endian=None)`` -> bitarray
    Bitarray of hexadecimal representation.  hexstr may contain any number
    (including odd numbers) of hex digits (upper or lower case).
-   Whitespace is ignored.
+   ASCII whitespace is ignored.
 
    New in version 3.3: ignore whitespace
 
@@ -970,13 +979,34 @@ This sub-module was added in version 1.2.
    New in version 3.5
 
 
+``rl_decode(stream, /, endian=None)`` -> bitarray
+   Decode a run-length encoded bitarray from a binary stream (an integer
+   iterator, or bytes-like object), and return the decoded bitarray.
+   This function consumes only one bitarray and leaves the remaining stream
+   untouched.  Use ``rl_encode()`` for encoding.
+
+   See also: `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
+
+   New in version 3.11
+
+
+``rl_encode(bitarray, /)`` -> bytes
+   Return the run-length encoded binary representation of a bitarray.
+   This representation may be useful for bitarrays with long runs of
+   identical bits.  Use ``rl_decode()`` for decoding.
+
+   See also: `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
+
+   New in version 3.11
+
+
 ``sc_decode(stream, /)`` -> bitarray
    Decompress binary stream (an integer iterator, or bytes-like object) of a
    sparse compressed (``sc``) bitarray, and return the decoded  bitarray.
    This function consumes only one bitarray and leaves the remaining stream
    untouched.  Use ``sc_encode()`` for compressing (encoding).
 
-   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.7
 
@@ -986,11 +1016,25 @@ This sub-module was added in version 1.2.
    representation.  This representation is useful for efficiently storing
    sparse bitarrays.  Use ``sc_decode()`` for decompressing (decoding).
 
-   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.7
 
 
+``sc_stat(stream)`` -> dict
+   Scan a stream produced by ``sc_encode()`` and return a dictionary containing
+   its bit-endianness (``endian``), length (``nbits``), and the number of blocks
+   of each type (``blocks``).  ``blocks`` is a list such that ``blocks[i]`` is the
+   number of blocks of type ``i``.
+
+   Like ``sc_decode()``, it consumes one encoded bitarray and leaves remaining
+   input untouched.
+
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+
+   New in version 3.11
+
+
 ``serialize(bitarray, /)`` -> bytes
    Return a serialized representation of the bitarray, which may be passed to
    ``deserialize()``.  It efficiently represents the bitarray object (including
@@ -1034,7 +1078,7 @@ This sub-module was added in version 1.2.
    return the decoded bitarray.  This function consumes only one bitarray and
    leaves the remaining stream untouched.  Use ``vl_encode()`` for encoding.
 
-   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__
+   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.2
 
@@ -1044,7 +1088,7 @@ This sub-module was added in version 1.2.
    This representation is useful for efficiently storing small bitarray
    in a binary stream.  Use ``vl_decode()`` for decoding.
 
-   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__
+   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.2
 
@@ -1062,3 +1106,75 @@ This sub-module was added in version 1.2.
    bit-endianness (``little`` or ``big``).
 
 
+The `bitarray.bitfields` module:
+--------------------------------
+
+This sub-module was added in version 3.12.
+For a detailed description, see: `Bit-field structures <https://github.com/ilanschnell/bitarray/blob/master/doc/bitfields.rst>`__
+
+``Struct(format)`` -> compiled struct object
+   Central class for packing and unpacking bit-level structures.
+
+
+``calcsize(format)`` -> int
+   Return the size (in bits) of the struct corresponding to the format string.
+
+
+``compile(format)`` -> Struct
+   Compile given format string and return a compiled format object that
+   can be used to pack and/or unpack data multiple times.
+
+
+``pack(format, v1, v2, ...)`` -> bitarray
+   Return a bitarray containing the values v1, v2, ... packed according
+   to the format string.
+
+
+``pack_into(format, bitarray, offset, v1, v2, ...)`` -> None
+   Pack the values v1, v2, ... into the writable bitarray starting at bit
+   offset ``offset``.  A negative offset counts from the end of bitarray.
+
+
+``unpack(format, bitarray)`` -> tuple
+   Return a tuple containing values unpacked according to the format string.
+
+
+``unpack_from(format, bitarray, offset=0)`` -> tuple
+   Unpack values from bitarray starting at bit offset ``offset``, and return a
+   tuple.  A negative offset counts from the end of bitarray.
+
+
+Struct methods:
+^^^^^^^^^^^^^^^
+
+``format()`` -> str
+   Return the canonical format string reconstructed from this compiled format.
+
+
+``pack(v1, v2, ...)`` -> bitarray
+   Return a bitarray containing the values v1, v2, ... packed according to this
+   compiled format.
+
+
+``pack_into(bitarray, offset, v1, v2, ...)`` -> None
+   Pack the values v1, v2, ... into the writable bitarray starting at bit
+   offset ``offset``.  A negative offset counts from the end of bitarray.
+
+
+``unpack(bitarray)`` -> tuple
+   Return a tuple containing values unpacked according to this compiled format.
+
+
+``unpack_from(bitarray, offset=0)`` -> tuple
+   Unpack values from bitarray starting at bit offset ``offset``, and return a
+   tuple.  A negative offset counts from the end of bitarray.
+
+
+Struct attributes:
+^^^^^^^^^^^^^^^^^^
+
+``width`` -> int
+   Total number of bits in the compiled structure.
+
+``values`` -> int
+   Number of values consumed by ``pack()`` and returned by ``unpack()``.

{bitarray-3.10.1 → bitarray-3.12.0}/README.rst

@@ -19,16 +19,20 @@ Key features
   operations ``+``, ``*``, ``+=``, ``*=``, the ``in`` operator, ``len()``
 * Bitwise operations: ``~``, ``&``, ``|``, ``^``, ``<<``, ``>>`` (as well as
   their in-place versions ``&=``, ``|=``, ``^=``, ``<<=``, ``>>=``).
-* Free-threading support (for GIL disabled CPython 3.14 and later)
-* Fast methods for encoding and decoding variable bit length prefix codes.
-* Bitarray objects support the buffer protocol (both importing and
-  exporting buffers).
-* Packing and unpacking to other binary data formats, e.g. ``numpy.ndarray``.
+* `Free-threading support <https://github.com/ilanschnell/bitarray/blob/master/doc/free_threading.rst>`__
+  (for GIL-disabled CPython 3.14 and later)
+* Fast methods for encoding and decoding variable-length prefix codes.
+* Bitarray objects support the `buffer protocol <https://github.com/ilanschnell/bitarray/blob/master/doc/buffer.rst>`__
+  (both importing and exporting buffers).
+* Efficient packing and unpacking for interoperability with byte-oriented
+  objects such as NumPy arrays.
 * Pickling and unpickling of bitarray objects.
 * Immutable ``frozenbitarray`` objects which are hashable
-* Sequential search
+* Fast searching for bits and bit patterns
+* ``bitfields`` sub-module for packing and unpacking fixed-width
+  `bit-field structures <https://github.com/ilanschnell/bitarray/blob/master/doc/bitfields.rst>`__
 * Type hinting
-* Extensive test suite with about 600 unittests
+* Extensive test suite with over 700 unit tests
 * Utility module ``bitarray.util``:
 
   * conversion to and from hexadecimal strings
@@ -36,8 +40,9 @@ Key features
   * pretty printing
   * conversion to and from integers
   * creating Huffman codes
-  * compression of sparse bitarrays
-  * (de-) serialization
+  * `compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+  * run-length encoding
+  * serialization and deserialization
   * various count functions
   * other helpful functions
 
@@ -59,7 +64,7 @@ Once you have installed the package, you may want to test it:
     $ python -c 'import bitarray; bitarray.test()'
     bitarray is installed in: /Users/ilan/bitarray/bitarray
     sys.prefix: /Users/ilan/miniforge
-    bitarray version: 3.10.1
+    bitarray version: 3.12.0
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
@@ -76,7 +81,7 @@ Once you have installed the package, you may want to test it:
     ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 640 tests in 0.192s
+    Ran 711 tests in 0.196s
 
     OK (skipped=4)
 
@@ -248,8 +253,8 @@ this topic, please read `buffer protocol <https://github.com/ilanschnell/bitarra
 to memory-map a file to a bitarray: `mmapped-file.py <https://github.com/ilanschnell/bitarray/blob/master/examples/mmapped-file.py>`__
 
 
-Variable bit length prefix codes
---------------------------------
+Variable-length prefix codes
+----------------------------
 
 The ``.encode()`` method takes a dictionary mapping symbols to bitarrays
 and an iterable, and extends the bitarray object with the encoded symbols
@@ -323,7 +328,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.10.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.12.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
 
 In the following, ``item`` and ``value`` are usually a single bit -
 an integer 0 or 1.
@@ -359,7 +364,7 @@ The bitarray object:
 
 
 bitarray methods:
------------------
+^^^^^^^^^^^^^^^^^
 
 ``all()`` -> bool
    Return ``True`` when all bits in bitarray are 1.
@@ -455,9 +460,12 @@ bitarray methods:
    New in version 3.4: allow ``bytes`` object
 
 
-``fill()`` -> int
+``fill(m=8, /)`` -> int
    Add zeros to the end of the bitarray, such that the length will be
-   a multiple of 8, and return the number of bits added [0..7].
+   a multiple of the positive integer ``m``, and return the number of bits
+   added (in ``range(m)``).
+
+   New in version 3.12: add optional alignment argument
 
 
 ``find(sub_bitarray, start=0, stop=<end>, /, right=False)`` -> int
@@ -603,10 +611,10 @@ bitarray methods:
    using the specified mapping.
 
 
-bitarray data descriptors:
---------------------------
+bitarray attributes:
+^^^^^^^^^^^^^^^^^^^^
 
-Data descriptors were added in version 2.6.
+Attributes were added in version 2.6.
 
 ``endian`` -> str
    bit-endianness as Unicode string
@@ -627,7 +635,7 @@ Data descriptors were added in version 2.6.
 
 
 decodeiterator methods:
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 
 ``skipbits(n, /)`` -> bitarray
    Skip over the next ``n`` bits and return them.
@@ -636,8 +644,8 @@ decodeiterator methods:
    New in version 3.9
 
 
-decodeiterator data descriptors:
---------------------------------
+decodeiterator attributes:
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``index`` -> int
    current bit position to be decoded by subsequent ``next``
@@ -646,7 +654,7 @@ decodeiterator data descriptors:
 
 
 decodetree methods:
--------------------
+^^^^^^^^^^^^^^^^^^^
 
 ``nodes()`` -> tuple
    Return tuple with number of:
@@ -748,7 +756,7 @@ This sub-module was added in version 1.2.
    Bitarray of base ``n`` ASCII representation.
    Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
    For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
-   standard base 64 alphabet is used.  Whitespace is ignored.
+   standard base 64 alphabet is used.  ASCII whitespace is ignored.
 
    See also: `Bitarray representations <https://github.com/ilanschnell/bitarray/blob/master/doc/represent.rst>`__
 
@@ -856,7 +864,7 @@ This sub-module was added in version 1.2.
 ``hex2ba(hexstr, /, endian=None)`` -> bitarray
    Bitarray of hexadecimal representation.  hexstr may contain any number
    (including odd numbers) of hex digits (upper or lower case).
-   Whitespace is ignored.
+   ASCII whitespace is ignored.
 
    New in version 3.3: ignore whitespace
 
@@ -935,13 +943,34 @@ This sub-module was added in version 1.2.
    New in version 3.5
 
 
+``rl_decode(stream, /, endian=None)`` -> bitarray
+   Decode a run-length encoded bitarray from a binary stream (an integer
+   iterator, or bytes-like object), and return the decoded bitarray.
+   This function consumes only one bitarray and leaves the remaining stream
+   untouched.  Use ``rl_encode()`` for encoding.
+
+   See also: `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
+
+   New in version 3.11
+
+
+``rl_encode(bitarray, /)`` -> bytes
+   Return the run-length encoded binary representation of a bitarray.
+   This representation may be useful for bitarrays with long runs of
+   identical bits.  Use ``rl_decode()`` for decoding.
+
+   See also: `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
+
+   New in version 3.11
+
+
 ``sc_decode(stream, /)`` -> bitarray
    Decompress binary stream (an integer iterator, or bytes-like object) of a
    sparse compressed (``sc``) bitarray, and return the decoded  bitarray.
    This function consumes only one bitarray and leaves the remaining stream
    untouched.  Use ``sc_encode()`` for compressing (encoding).
 
-   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.7
 
@@ -951,11 +980,25 @@ This sub-module was added in version 1.2.
    representation.  This representation is useful for efficiently storing
    sparse bitarrays.  Use ``sc_decode()`` for decompressing (decoding).
 
-   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.7
 
 
+``sc_stat(stream)`` -> dict
+   Scan a stream produced by ``sc_encode()`` and return a dictionary containing
+   its bit-endianness (``endian``), length (``nbits``), and the number of blocks
+   of each type (``blocks``).  ``blocks`` is a list such that ``blocks[i]`` is the
+   number of blocks of type ``i``.
+
+   Like ``sc_decode()``, it consumes one encoded bitarray and leaves remaining
+   input untouched.
+
+   See also: `Compression of sparse bitarrays <https://github.com/ilanschnell/bitarray/blob/master/doc/sparse_compression.rst>`__
+
+   New in version 3.11
+
+
 ``serialize(bitarray, /)`` -> bytes
    Return a serialized representation of the bitarray, which may be passed to
    ``deserialize()``.  It efficiently represents the bitarray object (including
@@ -999,7 +1042,7 @@ This sub-module was added in version 1.2.
    return the decoded bitarray.  This function consumes only one bitarray and
    leaves the remaining stream untouched.  Use ``vl_encode()`` for encoding.
 
-   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__
+   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.2
 
@@ -1009,7 +1052,7 @@ This sub-module was added in version 1.2.
    This representation is useful for efficiently storing small bitarray
    in a binary stream.  Use ``vl_decode()`` for decoding.
 
-   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__
+   See also: `Variable length bitarray format <https://github.com/ilanschnell/bitarray/blob/master/doc/variable_length.rst>`__, `Comparison of bitarray codecs <https://github.com/ilanschnell/bitarray/blob/master/doc/codecs.rst>`__
 
    New in version 2.2
 
@@ -1027,3 +1070,75 @@ This sub-module was added in version 1.2.
    bit-endianness (``little`` or ``big``).
 
 
+The `bitarray.bitfields` module:
+--------------------------------
+
+This sub-module was added in version 3.12.
+For a detailed description, see: `Bit-field structures <https://github.com/ilanschnell/bitarray/blob/master/doc/bitfields.rst>`__
+
+``Struct(format)`` -> compiled struct object
+   Central class for packing and unpacking bit-level structures.
+
+
+``calcsize(format)`` -> int
+   Return the size (in bits) of the struct corresponding to the format string.
+
+
+``compile(format)`` -> Struct
+   Compile given format string and return a compiled format object that
+   can be used to pack and/or unpack data multiple times.
+
+
+``pack(format, v1, v2, ...)`` -> bitarray
+   Return a bitarray containing the values v1, v2, ... packed according
+   to the format string.
+
+
+``pack_into(format, bitarray, offset, v1, v2, ...)`` -> None
+   Pack the values v1, v2, ... into the writable bitarray starting at bit
+   offset ``offset``.  A negative offset counts from the end of bitarray.
+
+
+``unpack(format, bitarray)`` -> tuple
+   Return a tuple containing values unpacked according to the format string.
+
+
+``unpack_from(format, bitarray, offset=0)`` -> tuple
+   Unpack values from bitarray starting at bit offset ``offset``, and return a
+   tuple.  A negative offset counts from the end of bitarray.
+
+
+Struct methods:
+^^^^^^^^^^^^^^^
+
+``format()`` -> str
+   Return the canonical format string reconstructed from this compiled format.
+
+
+``pack(v1, v2, ...)`` -> bitarray
+   Return a bitarray containing the values v1, v2, ... packed according to this
+   compiled format.
+
+
+``pack_into(bitarray, offset, v1, v2, ...)`` -> None
+   Pack the values v1, v2, ... into the writable bitarray starting at bit
+   offset ``offset``.  A negative offset counts from the end of bitarray.
+
+
+``unpack(bitarray)`` -> tuple
+   Return a tuple containing values unpacked according to this compiled format.
+
+
+``unpack_from(bitarray, offset=0)`` -> tuple
+   Unpack values from bitarray starting at bit offset ``offset``, and return a
+   tuple.  A negative offset counts from the end of bitarray.
+
+
+Struct attributes:
+^^^^^^^^^^^^^^^^^^
+
+``width`` -> int
+   Total number of bits in the compiled structure.
+
+``values`` -> int
+   Number of values consumed by ``pack()`` and returned by ``unpack()``.

{bitarray-3.10.1 → bitarray-3.12.0}/bitarray/__init__.py

@@ -13,8 +13,7 @@ from collections import namedtuple
 
 from bitarray._bitarray import (
     bitarray, decodetree, decodeiterator, _bitarray_reconstructor,
-    get_default_endian, bits2bytes, _sysinfo,
-    BITARRAY_VERSION as __version__
+    get_default_endian, bits2bytes, BITARRAY_VERSION as __version__
 )
 
 __all__ = ['bitarray', 'frozenbitarray', 'decodetree', 'decodeiterator',

{bitarray-3.10.1 → bitarray-3.12.0}/bitarray/__init__.pyi

@@ -64,7 +64,7 @@ class bitarray:
                code: Union[CodeDict, decodetree]) -> decodeiterator: ...
 
     def extend(self, x: Union[str, Iterable[int]]) -> None: ...
-    def fill(self) -> int: ...
+    def fill(self, m: int = ...) -> int: ...
     def find(self,
              sub_bitarray: Union[bitarray, int],
              start: int = ...,
@@ -169,7 +169,6 @@ __version__: str
 def bits2bytes(n: int) -> int: ...
 def get_default_endian() -> str: ...
 def test(verbosity: int = ...) -> TextTestResult: ...
-def _sysinfo(key: str) -> int: ...
 def _bitarray_reconstructor(cls: type,
                             buffer: bytes,
                             endian: str,