bitarray 3.8.1__tar.gz → 3.9.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.8.1
+Version: 3.9.0
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -11,7 +11,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: C
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -22,6 +21,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Free Threading :: 1 - Unstable
 Classifier: Topic :: Utilities
+Requires-Python: >=3.7
 License-File: LICENSE
 Dynamic: author
 Dynamic: author-email
@@ -30,6 +30,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
+Dynamic: requires-python
 Dynamic: summary
 
 bitarray: efficient arrays of booleans
@@ -91,8 +92,8 @@ 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.1
-    sys.version: 3.13.5 (main, Jun 16 2025) [Clang 18.1.8]
+    bitarray version: 3.9.0
+    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
     pointer size: 64 bit
     sizeof(size_t): 8
@@ -104,12 +105,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 622 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
@@ -354,7 +355,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.8.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.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.
@@ -378,7 +379,7 @@ The bitarray object:
 
    ``endian``: Specifies the bit-endianness of the created bitarray object.
    Allowed values are ``big`` and ``little`` (the default is ``big``).
-   The bit-endianness effects the buffer representation of the bitarray.
+   The bit-endianness affects the buffer representation of the bitarray.
 
    ``buffer``: Any object which exposes a buffer.  When provided, ``initializer``
    cannot be present (or has to be ``None``).  The imported buffer may be
@@ -456,7 +457,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.
@@ -465,6 +466,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),
@@ -473,7 +476,7 @@ bitarray methods:
 
 
 ``extend(iterable, /)``
-   Append items from to the end of the bitarray.
+   Append items from iterable to the end of the bitarray.
    If ``iterable`` is a (Unicode) string, each ``0`` and ``1`` are appended as
    bits (ignoring whitespace and underscore).
 
@@ -504,7 +507,7 @@ bitarray methods:
 
 ``fromfile(f, n=-1, /)``
    Extend bitarray with up to ``n`` bytes read from file object ``f`` (or any
-   other binary stream what supports a ``.read()`` method, e.g. ``io.BytesIO``).
+   other binary stream that supports a ``.read()`` method, e.g. ``io.BytesIO``).
    Each read byte will add eight bits to the bitarray.  When ``n`` is omitted
    or negative, reads and extends all data until EOF.
    When ``n`` is non-negative but exceeds the available data, ``EOFError`` is
@@ -524,8 +527,9 @@ bitarray methods:
 
 
 ``invert(index=<all bits>, /)``
-   Invert all bits in bitarray (in-place).
-   When the optional ``index`` is given, only invert the single bit at ``index``.
+   Invert bits in-place.  When ``index`` is omitted, invert all bits.
+   When ``index`` is an integer, invert the single bit at index.
+   When ``index`` is a slice, invert the selected bits.
 
    New in version 1.5.3: optional index argument
 
@@ -556,6 +560,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 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]``.
@@ -608,7 +625,7 @@ bitarray methods:
 
 ``unpack(zero=b'\x00', one=b'\x01')`` -> bytes
    Return bytes that contain one byte for each bit in the bitarray,
-   using specified mapping.
+   using the specified mapping.
 
 
 bitarray data descriptors:
@@ -634,6 +651,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:
 --------------
 
@@ -683,7 +719,8 @@ This sub-module was added in version 1.2.
 ``ba2base(n, bitarray, /, group=0, sep=' ')`` -> str
    Return a string containing the base ``n`` ASCII representation of
    the bitarray.  Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
-   The bitarray has to be multiple of length 1, 2, 3, 4, 5 or 6 respectively.
+   The bitarray has to have a length divisible by 1, 2, 3, 4, 5 or 6
+   respectively.
    For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
    standard base 64 alphabet is used.
    When grouped, the string ``sep`` is inserted between groups

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

@@ -57,8 +57,8 @@ 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.1
-    sys.version: 3.13.5 (main, Jun 16 2025) [Clang 18.1.8]
+    bitarray version: 3.9.0
+    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
     pointer size: 64 bit
     sizeof(size_t): 8
@@ -70,12 +70,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 622 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 +320,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.8.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.9.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.
@@ -344,7 +344,7 @@ The bitarray object:
 
    ``endian``: Specifies the bit-endianness of the created bitarray object.
    Allowed values are ``big`` and ``little`` (the default is ``big``).
-   The bit-endianness effects the buffer representation of the bitarray.
+   The bit-endianness affects the buffer representation of the bitarray.
 
    ``buffer``: Any object which exposes a buffer.  When provided, ``initializer``
    cannot be present (or has to be ``None``).  The imported buffer may be
@@ -422,7 +422,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 +431,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),
@@ -439,7 +441,7 @@ bitarray methods:
 
 
 ``extend(iterable, /)``
-   Append items from to the end of the bitarray.
+   Append items from iterable to the end of the bitarray.
    If ``iterable`` is a (Unicode) string, each ``0`` and ``1`` are appended as
    bits (ignoring whitespace and underscore).
 
@@ -470,7 +472,7 @@ bitarray methods:
 
 ``fromfile(f, n=-1, /)``
    Extend bitarray with up to ``n`` bytes read from file object ``f`` (or any
-   other binary stream what supports a ``.read()`` method, e.g. ``io.BytesIO``).
+   other binary stream that supports a ``.read()`` method, e.g. ``io.BytesIO``).
    Each read byte will add eight bits to the bitarray.  When ``n`` is omitted
    or negative, reads and extends all data until EOF.
    When ``n`` is non-negative but exceeds the available data, ``EOFError`` is
@@ -490,8 +492,9 @@ bitarray methods:
 
 
 ``invert(index=<all bits>, /)``
-   Invert all bits in bitarray (in-place).
-   When the optional ``index`` is given, only invert the single bit at ``index``.
+   Invert bits in-place.  When ``index`` is omitted, invert all bits.
+   When ``index`` is an integer, invert the single bit at index.
+   When ``index`` is a slice, invert the selected bits.
 
    New in version 1.5.3: optional index argument
 
@@ -522,6 +525,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 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]``.
@@ -574,7 +590,7 @@ bitarray methods:
 
 ``unpack(zero=b'\x00', one=b'\x01')`` -> bytes
    Return bytes that contain one byte for each bit in the bitarray,
-   using specified mapping.
+   using the specified mapping.
 
 
 bitarray data descriptors:
@@ -600,6 +616,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:
 --------------
 
@@ -649,7 +684,8 @@ This sub-module was added in version 1.2.
 ``ba2base(n, bitarray, /, group=0, sep=' ')`` -> str
    Return a string containing the base ``n`` ASCII representation of
    the bitarray.  Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
-   The bitarray has to be multiple of length 1, 2, 3, 4, 5 or 6 respectively.
+   The bitarray has to have a length divisible by 1, 2, 3, 4, 5 or 6
+   respectively.
    For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
    standard base 64 alphabet is used.
    When grouped, the string ``sep`` is inserted between groups

{bitarray-3.8.1 → bitarray-3.9.0}/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.1 → bitarray-3.9.0}/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: ...