bitarray 3.9.0__tar.gz → 3.9.2__tar.gz

{bitarray-3.9.0 → bitarray-3.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.9.0
+Version: 3.9.2
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -19,7 +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 :: Free Threading :: 1 - Unstable
+Classifier: Programming Language :: Python :: Free Threading :: 2 - Beta
 Classifier: Topic :: Utilities
 Requires-Python: >=3.7
 License-File: LICENSE
@@ -92,9 +92,11 @@ 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
-    bitarray version: 3.9.0
+    bitarray version: 3.9.2
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
+    sys.abiflags: ''
+    sys._is_gil_enabled(): True
     pointer size: 64 bit
     sizeof(size_t): 8
     sizeof(bitarrayobject): 80
@@ -108,7 +110,7 @@ Once you have installed the package, you may want to test it:
     ................................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 622 tests in 0.191s
+    Ran 633 tests in 0.191s
 
     OK (skipped=2)
 
@@ -355,7 +357,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.9.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.2 -- `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.
@@ -424,13 +426,16 @@ bitarray methods:
 
 ``bytereverse(start=0, stop=<end of buffer>, /)``
    For each byte in byte-range(``start``, ``stop``) reverse bits in-place.
-   The start and stop indices are given in terms of bytes (not bits).
+   The start and stop indices are given in terms of bytes (not bits) and
+   are interpreted like slice bounds and clipped to the buffer size.
    Also note that this method only changes the buffer; it does not change the
    bit-endianness of the bitarray object.  Pad bits are left unchanged such
    that two consecutive calls will always leave the bitarray unchanged.
 
    New in version 2.2.5: optional start and stop arguments
 
+   New in version 3.9.1: clip arguments instead of raising ``IndexError``
+
 
 ``clear()``
    Remove all items from bitarray.
@@ -564,7 +569,7 @@ bitarray methods:
    Rotate bitarray in-place by ``k`` positions.
    Positive ``k`` rotates right, negative ``k`` rotates left.
 
-   When bitarray is not empty, rotating one step to the right is
+   When bitarray ``a`` is not empty, rotating one step to the right is
    equivalent to ``a.insert(0, a.pop())``, and rotating one step to the left
    is equivalent to ``a.append(a.pop(0))``.
    The same convention is used by the ``.rotate()`` method of
@@ -580,6 +585,9 @@ bitarray methods:
    unless ``right=True``, which will iterate in descending order (starting with
    rightmost match).
 
+   For example, ``a.search(1)`` is the easiest (and most efficient) way
+   to create an iterator over all active indices in ``a``.
+
    See also: `Bitarray 3 transition <https://github.com/ilanschnell/bitarray/blob/master/doc/bitarray3.rst>`__
 
    New in version 2.9: optional start and stop arguments - add optional keyword argument ``right``
@@ -763,8 +771,8 @@ This sub-module was added in version 1.2.
 
 ``byteswap(a, n=<buffer size>, /)``
    Reverse every ``n`` consecutive bytes of ``a`` in-place.
-   By default, all bytes are reversed.  Note that ``n`` is not limited to 2, 4
-   or 8, but can be any positive integer.
+   By default, all bytes are reversed.  Note that ``n`` is **not** limited
+   to 2, 4 or 8, but can be any positive integer.
    Also, ``a`` may be any object that exposes a writable buffer.
    Nothing about this function is specific to bitarray objects.
 
@@ -947,9 +955,9 @@ This sub-module was added in version 1.2.
 
 
 ``sc_encode(bitarray, /)`` -> bytes
-   Compress a sparse bitarray and return its binary representation.
-   This representation is useful for efficiently storing sparse bitarrays.
-   Use ``sc_decode()`` for decompressing (decoding).
+   Compress a bitarray using sparse encoding and return its binary
+   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>`__
 

{bitarray-3.9.0 → bitarray-3.9.2}/README.rst

@@ -57,9 +57,11 @@ 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
-    bitarray version: 3.9.0
+    bitarray version: 3.9.2
     sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
+    sys.abiflags: ''
+    sys._is_gil_enabled(): True
     pointer size: 64 bit
     sizeof(size_t): 8
     sizeof(bitarrayobject): 80
@@ -73,7 +75,7 @@ Once you have installed the package, you may want to test it:
     ................................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 622 tests in 0.191s
+    Ran 633 tests in 0.191s
 
     OK (skipped=2)
 
@@ -320,7 +322,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.9.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.2 -- `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.
@@ -389,13 +391,16 @@ bitarray methods:
 
 ``bytereverse(start=0, stop=<end of buffer>, /)``
    For each byte in byte-range(``start``, ``stop``) reverse bits in-place.
-   The start and stop indices are given in terms of bytes (not bits).
+   The start and stop indices are given in terms of bytes (not bits) and
+   are interpreted like slice bounds and clipped to the buffer size.
    Also note that this method only changes the buffer; it does not change the
    bit-endianness of the bitarray object.  Pad bits are left unchanged such
    that two consecutive calls will always leave the bitarray unchanged.
 
    New in version 2.2.5: optional start and stop arguments
 
+   New in version 3.9.1: clip arguments instead of raising ``IndexError``
+
 
 ``clear()``
    Remove all items from bitarray.
@@ -529,7 +534,7 @@ bitarray methods:
    Rotate bitarray in-place by ``k`` positions.
    Positive ``k`` rotates right, negative ``k`` rotates left.
 
-   When bitarray is not empty, rotating one step to the right is
+   When bitarray ``a`` is not empty, rotating one step to the right is
    equivalent to ``a.insert(0, a.pop())``, and rotating one step to the left
    is equivalent to ``a.append(a.pop(0))``.
    The same convention is used by the ``.rotate()`` method of
@@ -545,6 +550,9 @@ bitarray methods:
    unless ``right=True``, which will iterate in descending order (starting with
    rightmost match).
 
+   For example, ``a.search(1)`` is the easiest (and most efficient) way
+   to create an iterator over all active indices in ``a``.
+
    See also: `Bitarray 3 transition <https://github.com/ilanschnell/bitarray/blob/master/doc/bitarray3.rst>`__
 
    New in version 2.9: optional start and stop arguments - add optional keyword argument ``right``
@@ -728,8 +736,8 @@ This sub-module was added in version 1.2.
 
 ``byteswap(a, n=<buffer size>, /)``
    Reverse every ``n`` consecutive bytes of ``a`` in-place.
-   By default, all bytes are reversed.  Note that ``n`` is not limited to 2, 4
-   or 8, but can be any positive integer.
+   By default, all bytes are reversed.  Note that ``n`` is **not** limited
+   to 2, 4 or 8, but can be any positive integer.
    Also, ``a`` may be any object that exposes a writable buffer.
    Nothing about this function is specific to bitarray objects.
 
@@ -912,9 +920,9 @@ This sub-module was added in version 1.2.
 
 
 ``sc_encode(bitarray, /)`` -> bytes
-   Compress a sparse bitarray and return its binary representation.
-   This representation is useful for efficiently storing sparse bitarrays.
-   Use ``sc_decode()`` for decompressing (decoding).
+   Compress a bitarray using sparse encoding and return its binary
+   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>`__