bitarray 3.8.2__tar.gz → 3.9.1__tar.gz

{bitarray-3.8.2 → bitarray-3.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.8.2
+Version: 3.9.1
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -19,8 +19,9 @@ 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
 Dynamic: author
 Dynamic: author-email
@@ -29,6 +30,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
+Dynamic: requires-python
 Dynamic: summary
 
 bitarray: efficient arrays of booleans
@@ -90,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.8.2
-    sys.version: 3.13.5 (main, Jun 16 2025) [Clang 18.1.8]
+    bitarray version: 3.9.1
+    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
@@ -103,12 +107,12 @@ Once you have installed the package, you may want to test it:
     Py_DEBUG: 0
     DEBUG: 0
     .........................................................................
-    .........................................................................
-    ................................................................
+    ................................................s........................
+    ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 598 tests in 0.165s
+    Ran 632 tests in 0.191s
 
-    OK
+    OK (skipped=2)
 
 The ``test()`` function is part of the API.  It will return
 a ``unittest.runner.TextTestResult`` object, such that one can verify that
@@ -353,7 +357,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.8.2 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.1 -- `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.
@@ -422,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.
@@ -455,7 +462,7 @@ bitarray methods:
    New in version 2.9: add non-overlapping sub-bitarray count
 
 
-``decode(code, /)`` -> iterator
+``decode(code, /)`` -> decodeiterator
    Given a prefix code (a dict mapping symbols to bitarrays, or ``decodetree``
    object), decode content of bitarray and return an iterator over
    corresponding symbols.
@@ -464,6 +471,8 @@ bitarray methods:
 
    New in version 3.0: returns iterator (equivalent to past ``.iterdecode()``)
 
+   New in version 3.9: returns public ``decodeiterator`` object
+
 
 ``encode(code, iterable, /)``
    Given a prefix code (a dict mapping symbols to bitarrays),
@@ -556,6 +565,19 @@ bitarray methods:
    Reverse all bits in bitarray (in-place).
 
 
+``rotate(k=1, /)``
+   Rotate bitarray in-place by ``k`` positions.
+   Positive ``k`` rotates right, negative ``k`` rotates left.
+
+   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
+   the ``collections.deque`` object.
+
+   New in version 3.9
+
+
 ``search(sub_bitarray, start=0, stop=<end>, /, right=False)`` -> iterator
    Return iterator over indices where sub_bitarray is found, such that
    sub_bitarray is contained within ``[start:stop]``.
@@ -634,6 +656,25 @@ Data descriptors were added in version 2.6.
    bool indicating whether buffer is read-only
 
 
+decodeiterator methods:
+-----------------------
+
+``skipbits(n, /)`` -> bitarray
+   Skip over the next ``n`` bits and return them.
+   Raises ``ValueError`` if count is out of range.
+
+   New in version 3.9
+
+
+decodeiterator data descriptors:
+--------------------------------
+
+``index`` -> int
+   current bit position to be decoded by subsequent ``next``
+
+   New in version 3.9
+
+
 Other objects:
 --------------
 
@@ -911,9 +952,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.8.2 → bitarray-3.9.1}/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.8.2
-    sys.version: 3.13.5 (main, Jun 16 2025) [Clang 18.1.8]
+    bitarray version: 3.9.1
+    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
@@ -70,12 +72,12 @@ Once you have installed the package, you may want to test it:
     Py_DEBUG: 0
     DEBUG: 0
     .........................................................................
-    .........................................................................
-    ................................................................
+    ................................................s........................
+    ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 598 tests in 0.165s
+    Ran 632 tests in 0.191s
 
-    OK
+    OK (skipped=2)
 
 The ``test()`` function is part of the API.  It will return
 a ``unittest.runner.TextTestResult`` object, such that one can verify that
@@ -320,7 +322,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.8.2 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.1 -- `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.
@@ -422,7 +427,7 @@ bitarray methods:
    New in version 2.9: add non-overlapping sub-bitarray count
 
 
-``decode(code, /)`` -> iterator
+``decode(code, /)`` -> decodeiterator
    Given a prefix code (a dict mapping symbols to bitarrays, or ``decodetree``
    object), decode content of bitarray and return an iterator over
    corresponding symbols.
@@ -431,6 +436,8 @@ bitarray methods:
 
    New in version 3.0: returns iterator (equivalent to past ``.iterdecode()``)
 
+   New in version 3.9: returns public ``decodeiterator`` object
+
 
 ``encode(code, iterable, /)``
    Given a prefix code (a dict mapping symbols to bitarrays),
@@ -523,6 +530,19 @@ bitarray methods:
    Reverse all bits in bitarray (in-place).
 
 
+``rotate(k=1, /)``
+   Rotate bitarray in-place by ``k`` positions.
+   Positive ``k`` rotates right, negative ``k`` rotates left.
+
+   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
+   the ``collections.deque`` object.
+
+   New in version 3.9
+
+
 ``search(sub_bitarray, start=0, stop=<end>, /, right=False)`` -> iterator
    Return iterator over indices where sub_bitarray is found, such that
    sub_bitarray is contained within ``[start:stop]``.
@@ -601,6 +621,25 @@ Data descriptors were added in version 2.6.
    bool indicating whether buffer is read-only
 
 
+decodeiterator methods:
+-----------------------
+
+``skipbits(n, /)`` -> bitarray
+   Skip over the next ``n`` bits and return them.
+   Raises ``ValueError`` if count is out of range.
+
+   New in version 3.9
+
+
+decodeiterator data descriptors:
+--------------------------------
+
+``index`` -> int
+   current bit position to be decoded by subsequent ``next``
+
+   New in version 3.9
+
+
 Other objects:
 --------------
 
@@ -878,9 +917,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.8.2 → bitarray-3.9.1}/bitarray/__init__.py

@@ -12,11 +12,13 @@ Author: Ilan Schnell
 from collections import namedtuple
 
 from bitarray._bitarray import (
-    bitarray, decodetree, bits2bytes, _bitarray_reconstructor,
-    get_default_endian, _sysinfo, BITARRAY_VERSION as __version__
+    bitarray, decodetree, decodeiterator, _bitarray_reconstructor,
+    get_default_endian, bits2bytes, _sysinfo,
+    BITARRAY_VERSION as __version__
 )
 
-__all__ = ['bitarray', 'frozenbitarray', 'decodetree', 'bits2bytes']
+__all__ = ['bitarray', 'frozenbitarray', 'decodetree', 'decodeiterator',
+           'bits2bytes']
 
 BufferInfo = namedtuple('BufferInfo',
                         ['address', 'nbytes', 'endian', 'padbits',
@@ -51,7 +53,7 @@ and may therefore be used as a dictionary key.
 
     append = bytereverse = clear = extend = encode = fill = __delitem__
     frombytes = fromfile = insert = invert = pack = pop = __delitem__
-    remove = reverse = setall = sort = __setitem__ = __delitem__
+    remove = rotate = reverse = setall = sort = __setitem__ = __delitem__
     __iadd__ = __iand__ = __imul__ = __ior__ = __ixor__ = __delitem__
     __ilshift__ = __irshift__ = __delitem__
 

{bitarray-3.8.2 → bitarray-3.9.1}/bitarray/__init__.pyi

@@ -2,6 +2,7 @@
 #
 # This stub, as well as util.pyi, are tested with Python 3.10 and mypy 1.11.2
 
+from abc import ABCMeta
 from collections.abc import Iterable, Iterator, Sequence
 from unittest.runner import TextTestResult
 
@@ -31,6 +32,12 @@ class decodetree:
     def todict(self) -> CodeDict: ...
 
 
+class decodeiterator(Iterator, metaclass=ABCMeta):
+    @property
+    def index(self) -> int: ...
+    def skipbits(self, count: int = ...) -> bitarray: ...
+
+
 class bitarray:
     def __init__(self,
                  initializer: Union[int, str, Iterable[int], None] = ...,
@@ -55,7 +62,7 @@ class bitarray:
 
     def encode(self, code: CodeDict, x: Iterable) -> None: ...
     def decode(self,
-               code: Union[CodeDict, decodetree]) -> Iterator: ...
+               code: Union[CodeDict, decodetree]) -> decodeiterator: ...
 
     def extend(self, x: Union[str, Iterable[int]]) -> None: ...
     def fill(self) -> int: ...
@@ -85,6 +92,7 @@ class bitarray:
     def pack(self, b: BytesLike) -> None: ...
     def pop(self, i: int = ...) -> int: ...
     def remove(self, value: int) -> None: ...
+    def rotate(self, k: int = ...) -> None: ...
     def reverse(self) -> None: ...
 
     def setall(self, value: int) -> None: ...