bitarray 3.10.1__tar.gz → 3.11.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.10.1
+Version: 3.11.0
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -54,16 +54,17 @@ 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.
+* Free-threading support (for GIL-disabled CPython 3.14 and later)
+* Fast methods for encoding and decoding variable-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``.
+* 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
 * Type hinting
-* Extensive test suite with about 600 unittests
+* Extensive test suite with over 600 unit tests
 * Utility module ``bitarray.util``:
 
   * conversion to and from hexadecimal strings
@@ -72,7 +73,8 @@ Key features
   * conversion to and from integers
   * creating Huffman codes
   * compression of sparse bitarrays
-  * (de-) serialization
+  * run-length encoding
+  * serialization and deserialization
   * various count functions
   * other helpful functions
 
@@ -94,7 +96,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.11.0
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
@@ -111,7 +113,7 @@ Once you have installed the package, you may want to test it:
     ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 640 tests in 0.192s
+    Ran 654 tests in 0.192s
 
     OK (skipped=4)
 
@@ -283,8 +285,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 +360,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.11.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.
@@ -970,13 +972,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 +1009,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 +1071,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 +1081,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
 

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

@@ -19,16 +19,17 @@ 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.
+* Free-threading support (for GIL-disabled CPython 3.14 and later)
+* Fast methods for encoding and decoding variable-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``.
+* 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
 * Type hinting
-* Extensive test suite with about 600 unittests
+* Extensive test suite with over 600 unit tests
 * Utility module ``bitarray.util``:
 
   * conversion to and from hexadecimal strings
@@ -37,7 +38,8 @@ Key features
   * conversion to and from integers
   * creating Huffman codes
   * compression of sparse bitarrays
-  * (de-) serialization
+  * run-length encoding
+  * serialization and deserialization
   * various count functions
   * other helpful functions
 
@@ -59,7 +61,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.11.0
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
@@ -76,7 +78,7 @@ Once you have installed the package, you may want to test it:
     ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 640 tests in 0.192s
+    Ran 654 tests in 0.192s
 
     OK (skipped=4)
 
@@ -248,8 +250,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 +325,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.11.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.
@@ -935,13 +937,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 +974,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 +1036,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 +1046,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
 

{bitarray-3.10.1 → bitarray-3.11.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.11.0}/bitarray/__init__.pyi

@@ -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,

{bitarray-3.10.1 → bitarray-3.11.0}/bitarray/_bitarray.c

@@ -57,8 +57,9 @@ resize(bitarrayobject *self, Py_ssize_t nbits)
 {
     const size_t size = Py_SIZE(self);
     const size_t allocated = self->allocated;
-    const size_t newsize = BYTES((size_t) nbits);
+    const size_t newsize = BYTES(nbits);
     size_t new_allocated;
+    char *item;
 
     if (self->ob_exports > 0) {
         PyErr_SetString(PyExc_BufferError,
@@ -76,47 +77,41 @@ resize(bitarrayobject *self, Py_ssize_t nbits)
 
 #ifndef NDEBUG
     assert(self->readonly == 0);
-    assert(allocated >= size && size == BYTES((size_t) self->nbits));
+    assert(allocated >= size && size == BYTES(self->nbits));
     if (self->ob_item == NULL)
         assert(size == 0 && allocated == 0);
     assert(self->readonly == 0);
 #endif
 
     /* bypass everything when buffer size hasn't changed */
-    if (newsize == size) {
-        self->nbits = nbits;
-        return 0;
-    }
+    if (newsize == size)
+        goto done;
 
     if (newsize == 0) {
         PyMem_Free(self->ob_item);
         self->ob_item = NULL;
         Py_SET_SIZE(self, 0);
         self->allocated = 0;
-        self->nbits = 0;
-        return 0;
+        goto done;
     }
 
     new_allocated = new_allocation(size, allocated, newsize);
-
     if (new_allocated == allocated) {
         /* bypass reallocation */
         Py_SET_SIZE(self, newsize);
-        self->nbits = nbits;
-        return 0;
+        goto done;
     }
 
     assert(new_allocated >= newsize);
-    self->ob_item = PyMem_Realloc(self->ob_item, new_allocated);
-    if (self->ob_item == NULL) {
-        Py_SET_SIZE(self, 0);
-        self->allocated = 0;
-        self->nbits = 0;
+    item = PyMem_Realloc(self->ob_item, new_allocated);
+    if (item == NULL) {
         PyErr_NoMemory();
         return -1;
     }
+    self->ob_item = item;
     Py_SET_SIZE(self, newsize);
     self->allocated = new_allocated;
+ done:
     self->nbits = nbits;
     return 0;
 }
@@ -125,7 +120,7 @@ resize(bitarrayobject *self, Py_ssize_t nbits)
 static bitarrayobject *
 newbitarrayobject(PyTypeObject *type, Py_ssize_t nbits, int endian)
 {
-    const size_t nbytes = BYTES((size_t) nbits);
+    const size_t nbytes = BYTES(nbits);
     bitarrayobject *obj;
 
     assert(nbits >= 0);
@@ -5228,7 +5223,7 @@ sysinfo(PyObject *module, PyObject *args)
 {
     char *key;
 
-    if (!PyArg_ParseTuple(args, "s:_sysinfo", &key))
+    if (!PyArg_ParseTuple(args, "s:sysinfo", &key))
         return NULL;
 
 #define R(k, v)                             \
@@ -5265,20 +5260,20 @@ sysinfo(PyObject *module, PyObject *args)
 }
 
 PyDoc_STRVAR(sysinfo_doc,
-"_sysinfo(key) -> int\n\
+"sysinfo(key) -> int\n\
 \n\
 Return system- and compile-specific information given a key.");
 
 
 static PyMethodDef module_functions[] = {
-    {"bits2bytes",          (PyCFunction) bits2bytes,         METH_O,
+    {"bits2bytes",         (PyCFunction) bits2bytes,         METH_O,
      bits2bytes_doc},
     {"_bitarray_reconstructor",
-                            (PyCFunction) reconstructor,      METH_VARARGS,
+                           (PyCFunction) reconstructor,      METH_VARARGS,
      reduce_doc},
-    {"get_default_endian",  (PyCFunction) get_default_endian, METH_NOARGS,
+    {"get_default_endian", (PyCFunction) get_default_endian, METH_NOARGS,
      get_default_endian_doc},
-    {"_sysinfo",            (PyCFunction) sysinfo,            METH_VARARGS,
+    {"sysinfo",            (PyCFunction) sysinfo,            METH_VARARGS,
      sysinfo_doc},
     {NULL}  /* sentinel */
 };