bitarray 3.9.2__tar.gz → 3.10.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitarray
-Version: 3.9.2
+Version: 3.10.1
 Summary: efficient arrays of booleans -- C extension
 Home-page: https://github.com/ilanschnell/bitarray
 Author: Ilan Schnell
@@ -54,6 +54,7 @@ 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).
@@ -92,9 +93,9 @@ 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.2
-    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
+    bitarray version: 3.10.1
+    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
     pointer size: 64 bit
@@ -106,13 +107,13 @@ Once you have installed the package, you may want to test it:
     Py_GIL_DISABLED: 0
     Py_DEBUG: 0
     DEBUG: 0
-    .........................................................................
-    ................................................s........................
+    .....................................s...................................
+    ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 633 tests in 0.191s
+    Ran 640 tests in 0.192s
 
-    OK (skipped=2)
+    OK (skipped=4)
 
 The ``test()`` function is part of the API.  It will return
 a ``unittest.runner.TextTestResult`` object, such that one can verify that
@@ -357,7 +358,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.9.2 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.10.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.
@@ -466,6 +467,7 @@ bitarray methods:
    Given a prefix code (a dict mapping symbols to bitarrays, or ``decodetree``
    object), decode content of bitarray and return an iterator over
    corresponding symbols.
+   The prefix code length cannot exceed 256 bits.
 
    See also: `Bitarray 3 transition <https://github.com/ilanschnell/bitarray/blob/master/doc/bitarray3.rst>`__
 
@@ -678,6 +680,26 @@ decodeiterator data descriptors:
    New in version 3.9
 
 
+decodetree methods:
+-------------------
+
+``nodes()`` -> tuple
+   Return tuple with number of:
+
+   0. incomplete nodes (pointing to a single child node)
+   1. complete nodes (pointing to two child nodes)
+   2. leaf nodes (pointing to a symbol)
+
+   New in version 3.10
+
+
+``todict()`` -> dict
+   Return a dict mapping the symbols to frozenbitarrays.  This dict is a
+   reconstruction of the code dict which the object was created with.
+
+   New in version 3.10
+
+
 Other objects:
 --------------
 
@@ -692,6 +714,7 @@ Other objects:
 ``decodetree(code, /)`` -> decodetree
    Given a prefix code (a dict mapping symbols to bitarrays),
    create a binary tree object to be passed to ``.decode()``.
+   The prefix code length cannot exceed 256 bits.
 
    New in version 1.6
 
@@ -798,7 +821,7 @@ This sub-module was added in version 1.2.
    Given a frequency map, a dictionary mapping symbols to their frequency,
    calculate the canonical Huffman code.  Returns a tuple containing:
 
-   0. the canonical Huffman code as a dict mapping symbols to bitarrays
+   0. the canonical Huffman code as a dict mapping symbols to frozenbitarrays
    1. a list containing the number of symbols of each code length
    2. a list of symbols in canonical order
 
@@ -808,6 +831,8 @@ This sub-module was added in version 1.2.
 
    New in version 2.5
 
+   New in version 3.10: return a codedict mapping to frozenbitarrays
+
 
 ``correspond_all(a, b, /)`` -> tuple
    Return tuple with counts of: ~a & ~b, ~a & b, a & ~b, a & b
@@ -874,8 +899,10 @@ This sub-module was added in version 1.2.
 ``huffman_code(dict, /, endian=None)`` -> dict
    Given a frequency map, a dictionary mapping symbols to their frequency,
    calculate the Huffman code, i.e. a dict mapping those symbols to
-   bitarrays (with given bit-endianness).  Note that the symbols are not limited
-   to being strings.  Symbols may be any hashable object.
+   frozenbitarrays (with given bit-endianness).  Note that the symbols are not
+   limited to being strings.  Symbols may be any hashable object.
+
+   New in version 3.10: return a codedict mapping to frozenbitarrays
 
 
 ``int2ba(int, /, length=None, endian=None, signed=False)`` -> bitarray
@@ -910,7 +937,7 @@ This sub-module was added in version 1.2.
 
 
 ``pprint(bitarray, /, stream=None, group=8, indent=4, width=80)``
-   Pretty-print bitarray object to ``stream``, defaults is ``sys.stdout``.
+   Pretty-print bitarray object to ``stream``, defaults to ``sys.stdout``.
    By default, bits are grouped in bytes (8 bits), and 64 bits per line.
    Non-bitarray objects are printed using ``pprint.pprint()``.
 
@@ -921,8 +948,8 @@ This sub-module was added in version 1.2.
    Return (pseudo-) random bitarray of length ``n`` with ``k`` elements
    set to one.  Mathematically equivalent to setting (in a bitarray of
    length ``n``) all bits at indices ``random.sample(range(n), k)`` to one.
-   The random bitarrays are reproducible when giving Python's ``random.seed()``
-   a specific seed value.
+   The random bitarrays are reproducible when calling Python's ``random.seed()``
+   with a specific seed value.
 
    New in version 3.6
 
@@ -931,7 +958,7 @@ This sub-module was added in version 1.2.
    Return (pseudo-) random bitarray of length ``n``, where each bit has
    probability ``p`` of being one (independent of any other bits).  Mathematically
    equivalent to ``bitarray((random() < p for _ in range(n)), endian)``, but much
-   faster for large ``n``.  The random bitarrays are reproducible when giving
+   faster for large ``n``.  The random bitarrays are reproducible when calling
    Python's ``random.seed()`` with a specific seed value.
 
    This function requires Python 3.12 or higher, as it depends on the standard

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

@@ -19,6 +19,7 @@ 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).
@@ -57,9 +58,9 @@ 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.2
-    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.prefix: /Users/ilan/miniforge
+    bitarray version: 3.10.1
+    sys.version: 3.14.5 (main, May 20 2026) [Clang 20.1.8]
     sys.abiflags: ''
     sys._is_gil_enabled(): True
     pointer size: 64 bit
@@ -71,13 +72,13 @@ Once you have installed the package, you may want to test it:
     Py_GIL_DISABLED: 0
     Py_DEBUG: 0
     DEBUG: 0
-    .........................................................................
-    ................................................s........................
+    .....................................s...................................
+    ..........s.....................................s........................
     ......s.........................................................
     ----------------------------------------------------------------------
-    Ran 633 tests in 0.191s
+    Ran 640 tests in 0.192s
 
-    OK (skipped=2)
+    OK (skipped=4)
 
 The ``test()`` function is part of the API.  It will return
 a ``unittest.runner.TextTestResult`` object, such that one can verify that
@@ -322,7 +323,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 3.9.2 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 3.10.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.
@@ -431,6 +432,7 @@ bitarray methods:
    Given a prefix code (a dict mapping symbols to bitarrays, or ``decodetree``
    object), decode content of bitarray and return an iterator over
    corresponding symbols.
+   The prefix code length cannot exceed 256 bits.
 
    See also: `Bitarray 3 transition <https://github.com/ilanschnell/bitarray/blob/master/doc/bitarray3.rst>`__
 
@@ -643,6 +645,26 @@ decodeiterator data descriptors:
    New in version 3.9
 
 
+decodetree methods:
+-------------------
+
+``nodes()`` -> tuple
+   Return tuple with number of:
+
+   0. incomplete nodes (pointing to a single child node)
+   1. complete nodes (pointing to two child nodes)
+   2. leaf nodes (pointing to a symbol)
+
+   New in version 3.10
+
+
+``todict()`` -> dict
+   Return a dict mapping the symbols to frozenbitarrays.  This dict is a
+   reconstruction of the code dict which the object was created with.
+
+   New in version 3.10
+
+
 Other objects:
 --------------
 
@@ -657,6 +679,7 @@ Other objects:
 ``decodetree(code, /)`` -> decodetree
    Given a prefix code (a dict mapping symbols to bitarrays),
    create a binary tree object to be passed to ``.decode()``.
+   The prefix code length cannot exceed 256 bits.
 
    New in version 1.6
 
@@ -763,7 +786,7 @@ This sub-module was added in version 1.2.
    Given a frequency map, a dictionary mapping symbols to their frequency,
    calculate the canonical Huffman code.  Returns a tuple containing:
 
-   0. the canonical Huffman code as a dict mapping symbols to bitarrays
+   0. the canonical Huffman code as a dict mapping symbols to frozenbitarrays
    1. a list containing the number of symbols of each code length
    2. a list of symbols in canonical order
 
@@ -773,6 +796,8 @@ This sub-module was added in version 1.2.
 
    New in version 2.5
 
+   New in version 3.10: return a codedict mapping to frozenbitarrays
+
 
 ``correspond_all(a, b, /)`` -> tuple
    Return tuple with counts of: ~a & ~b, ~a & b, a & ~b, a & b
@@ -839,8 +864,10 @@ This sub-module was added in version 1.2.
 ``huffman_code(dict, /, endian=None)`` -> dict
    Given a frequency map, a dictionary mapping symbols to their frequency,
    calculate the Huffman code, i.e. a dict mapping those symbols to
-   bitarrays (with given bit-endianness).  Note that the symbols are not limited
-   to being strings.  Symbols may be any hashable object.
+   frozenbitarrays (with given bit-endianness).  Note that the symbols are not
+   limited to being strings.  Symbols may be any hashable object.
+
+   New in version 3.10: return a codedict mapping to frozenbitarrays
 
 
 ``int2ba(int, /, length=None, endian=None, signed=False)`` -> bitarray
@@ -875,7 +902,7 @@ This sub-module was added in version 1.2.
 
 
 ``pprint(bitarray, /, stream=None, group=8, indent=4, width=80)``
-   Pretty-print bitarray object to ``stream``, defaults is ``sys.stdout``.
+   Pretty-print bitarray object to ``stream``, defaults to ``sys.stdout``.
    By default, bits are grouped in bytes (8 bits), and 64 bits per line.
    Non-bitarray objects are printed using ``pprint.pprint()``.
 
@@ -886,8 +913,8 @@ This sub-module was added in version 1.2.
    Return (pseudo-) random bitarray of length ``n`` with ``k`` elements
    set to one.  Mathematically equivalent to setting (in a bitarray of
    length ``n``) all bits at indices ``random.sample(range(n), k)`` to one.
-   The random bitarrays are reproducible when giving Python's ``random.seed()``
-   a specific seed value.
+   The random bitarrays are reproducible when calling Python's ``random.seed()``
+   with a specific seed value.
 
    New in version 3.6
 
@@ -896,7 +923,7 @@ This sub-module was added in version 1.2.
    Return (pseudo-) random bitarray of length ``n``, where each bit has
    probability ``p`` of being one (independent of any other bits).  Mathematically
    equivalent to ``bitarray((random() < p for _ in range(n)), endian)``, but much
-   faster for large ``n``.  The random bitarrays are reproducible when giving
+   faster for large ``n``.  The random bitarrays are reproducible when calling
    Python's ``random.seed()`` with a specific seed value.
 
    This function requires Python 3.12 or higher, as it depends on the standard

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

@@ -27,8 +27,7 @@ class BufferInfo(NamedTuple):
 
 class decodetree:
     def __init__(self, code: CodeDict) -> None: ...
-    def complete(self) -> bool: ...
-    def nodes(self) -> int: ...
+    def nodes(self) -> tuple[int, int, int]: ...
     def todict(self) -> CodeDict: ...