sub-byte 0.0.7__py3-none-any.whl

sub_byte/factories.py

@@ -0,0 +1,288 @@
+import itertools
+from collections.abc import Iterable, Iterator, Callable, Hashable, Sequence
+import typing
+
+import more_itertools
+
+
+def get_bits(x: int) -> str:
+    """E.g. get_bits(13) == '1101'."""
+    return bin(x).removeprefix("0b")
+
+
+def all_ones_bit_mask(n: int) -> int:
+    """E.g. all_ones_bit_mask(8) == 255
+    Invariant property:  len(get_bits(all_ones_bit_mask(n))) - 2
+    """
+    return (1 << n) - 1
+
+
+def int_encoder(
+    integers: Iterable[int],
+    uint_bit_widths: Iterable[int],
+) -> Iterator[int]:
+    """If uint_bit_widths is an iterable that is not a container, e.g.
+    a once only iterator from a generator, it must yield the
+    same number of items or more, than len(integers).
+    i.e. the caller must handle cacheing of bit widths (or
+    repeating without cacheing).
+    """
+    bit_widths = itertools.cycle(uint_bit_widths)
+
+    # Initialise a buffer (an ordinary Number)
+    # and a bit counter.
+    buffer = 0
+    bits_used = 0
+
+    for i, integer in enumerate(integers):
+        bit_width = next(bit_widths, 0)
+
+        if bit_width == 0:
+            raise Exception(
+                f"No bit width specified for integer: {integer},  number: {i}"
+            )
+
+        # Left bitshift to make room for next integer, add it in and bump the bit counter.
+        buffer <<= bit_width
+        buffer |= integer
+        bits_used += bit_width
+
+        # Yield encoded bytes from the buffer
+        while bits_used >= 8:
+            # subtract bits to be yielded from counter, and yield them
+            bits_used -= 8
+            yield (buffer >> bits_used) & all_ones_bit_mask(8)
+
+        # Clear buffer of yielded bytes (only keep bits_used bits).
+        buffer &= all_ones_bit_mask(bits_used)
+
+    # Clear the buffer of any encoded integers, that were too few
+    # to completely fill a whole byte.
+    if bits_used >= 1:
+        # left shift the data to start of the bytes from the 
+        # highest order bits (no leading zeros)
+        yield buffer << (8 - bits_used)
+
+
+def int_decoder(
+    encoded: Iterable[int],
+    num_ints: int | None,
+    uint_bit_widths: Iterable[int]
+) -> Iterator[int]:
+    """If uint_bit_widths is an Iterable that is not a Container, e.g.
+    a once only iterator from a generator, the total of all its
+    widths yielded, must be >= (8 * the number of bytes from encoded)
+    i.e. as for int_encoder above, the caller must handle caching
+    of bit widths (or repeating them without caching).
+    When iteration of the decoder terminates, can be controlled by
+    by specifying the precise number of uints to decode, in num_ints.
+    encoded is always interpreted as whole bytes, so for example to decode
+    precisely 3 (and no more) 2-bit zeros (3* u2 0, or 3* 0b00) from a whole byte
+    (0b00000000), ignoring the last two bits, num_ints can be set to 3.
+    Alternatively, to support custom schemas, e.g. with dynamic data controlled 
+    bit widths, setting num_ints = None causes the int_decoder to decode uints
+    from encoded indefinitely.  In this case, the caller must terminate the 
+    (otherwise infinite) loop themselves.
+    """
+    bit_widths: Iterator[int] = itertools.cycle(uint_bit_widths)
+
+    if num_ints is not None:
+        bit_widths = itertools.islice(bit_widths, num_ints)
+
+    bytes_ = iter(encoded)
+
+    # Initialise a buffer (an ordinary Number)
+    # and a bit counter.
+    buffer = 0
+    buffer_width_in_bits = 0
+
+    j = 0
+
+    bit_width = next(bit_widths, 0)
+
+    for i, byte in enumerate(bytes_):
+        # Left shift 8 bits to make room for byte
+        buffer <<= 8
+        # Bump counter by 8
+        buffer_width_in_bits += 8
+        # Add in byte to buffer
+        buffer |= byte
+
+        if buffer_width_in_bits < bit_width:
+            continue
+
+        while buffer_width_in_bits >= bit_width and bit_width > 0:
+            buffer_width_in_bits -= bit_width
+            # mask is bit_width 1s followed by buffer_width_in_bits 0s up
+            # the same total width as the original value of buffer_width_in_bits
+            # before the previous line.
+            mask = all_ones_bit_mask(bit_width)
+            yield (buffer >> buffer_width_in_bits) & mask
+            j += 1
+            # Clear buffer of the bits that made up the yielded integer
+            # (the left most bit_width bits)
+            buffer &= all_ones_bit_mask(buffer_width_in_bits)
+
+            bit_width = next(bit_widths, 0)
+
+        if bit_width == 0:
+            if num_ints is not None and buffer_width_in_bits >= 1 and j < num_ints:
+                raise Exception(
+                    f"Not enough uint bit widths to decode remaining bits {buffer_width_in_bits} with.",
+                    f"Got: {num_ints=}.  Total ints decoded so far: {j=}. ", 
+                )
+
+            break
+
+
+def get_bit_widths_encodings_and_decodings[H: Hashable](
+    value_sets: Iterable[Iterable[H]],
+) -> tuple[list[int], list[dict[H, int]], list[list[H]]]:
+    bit_widths = []
+    decodings = []
+    encodings = []
+
+    for value_set in value_sets:
+        # A set would not preserve the order of the elements 
+        # in value_set, hence dict.fromkeys is used.
+        decoding = list(dict.fromkeys((value_set)))
+        if len(decoding) <= 1:
+            raise Exception(
+                "All symbols are the same, or no symbols have been given."
+                f"Value set: {value_set}"
+            )
+        decodings.append(decoding)
+
+        # Mapping starts at zero, so we subtract one from num of
+        # total symbols to get highest int.
+        binary_of_highest_mapped_int = get_bits(len(decoding) - 1)
+        bit_width = len(binary_of_highest_mapped_int)
+        bit_widths.append(bit_width)
+
+        encoding = {symbol: i for i, symbol in enumerate(decoding)}
+        encodings.append(encoding)
+
+    return bit_widths, encodings, decodings
+
+
+def map_symbols_to_integers[H: Hashable](
+    symbols: Iterable[H],
+    encodings: Iterable[dict[H, int]]
+) -> Iterator[int]:
+    for symbol, encoding in zip(symbols, itertools.cycle(encodings)):
+        yield encoding[symbol]
+
+
+def map_integers_to_symbols[H: Hashable](
+    unsigned_integers: Iterable[int],
+    decodings: Iterable[Sequence[H]]
+) -> Iterator[H]:
+    for unsigned_integer, decoding in zip(
+        unsigned_integers, itertools.cycle(decodings)
+    ):
+        yield decoding[unsigned_integer]
+
+
+def encoder_and_decoder_from_bit_widths_and_mappings[H: Hashable](
+    bit_widths: Iterable[int],
+    encodings: Iterable[dict[H, int]],
+    decodings: Iterable[list[H]], 
+    ):
+
+    def encoder(
+        symbols: Iterable[H],
+    ) -> Iterator[int]:
+        for unsigned_integer in int_encoder(
+            map_symbols_to_integers(symbols, encodings), bit_widths
+        ):
+            yield unsigned_integer
+
+    def decoder(
+        encoded: Iterable[int],
+        number_of_symbols: int,
+    ) -> Iterator[H]:
+        for symbol in map_integers_to_symbols(
+            int_decoder(encoded, number_of_symbols, bit_widths), decodings
+        ):
+            yield symbol
+
+    return encoder, decoder
+
+
+def make_sub_byte_encoder_and_decoder[H: Hashable](
+    value_sets: Iterable[Iterable[H]],
+) -> tuple[Callable[[Iterable[H]], Iterator[int]],
+           Callable[[Iterable[int], int], Iterator[H]],
+           list[int],
+           list[dict[H, int]],
+           list[list[H]]
+          ]:
+
+    bit_widths, encodings, decodings = get_bit_widths_encodings_and_decodings(
+        value_sets
+    )
+
+    encoder, decoder = encoder_and_decoder_from_bit_widths_and_mappings(
+        bit_widths, encodings, decodings)
+
+    return encoder, decoder, bit_widths, encodings, decodings
+
+
+
+def possible_numbers_of_symbols(
+    b: Sequence[int],
+    bit_widths: Iterable[int],  # Must be positive integers
+) -> Iterator[int]:
+
+    padding = [None] * 8
+    bit_widths_subsequences = more_itertools.windowed(
+        itertools.chain(padding, itertools.cycle(bit_widths)), 9
+    )
+
+    num_symbols = 0
+
+    num_bits = 0
+
+    for bit_widths_subsequence in bit_widths_subsequences:
+
+        last_bit_width = bit_widths_subsequence[-1]
+        
+        if last_bit_width is None or last_bit_width <= 0:
+            raise Exception(
+                f'Bit widths must be non-zero positive integers.  Got: {last_bit_width=} and {bit_widths_subsequence=})'
+            )
+
+
+        if num_bits + last_bit_width > 8 * len(b):
+            break
+
+        num_symbols += 1
+
+        assert last_bit_width >= 1
+        num_bits += last_bit_width
+    else:
+        raise Exception(
+            'Could not find last bit widths (up to 8). '
+            'Ensure bit_widths is non-empty '
+            f'(got: {bit_widths=}).'
+        )
+
+    up_to_last_8_bit_widths = bit_widths_subsequence[:9]
+
+    last_byte = b[-1]
+    last_byte_bits = get_bits(last_byte)
+    __, __, last_byte_trailing_zero_bits = last_byte_bits.rpartition("1")
+    num_zero_bits = len(last_byte_trailing_zero_bits)
+
+    for one_of_last_bit_widths in reversed(up_to_last_8_bit_widths):
+        yield num_symbols
+
+        if one_of_last_bit_widths is None:
+            break
+
+        num_zero_bits -= one_of_last_bit_widths
+
+        if num_zero_bits < 0:
+            break
+
+        num_symbols -= 1

sub_byte-0.0.7.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: sub-byte
+Version: 0.0.7
+Summary: Encodes and decodes sequences of unsigned integers with known widths (and sequences of symbols from finite sets). 
+Project-URL: Homepage, https://github.com/NumberzGame/sub_byte
+Project-URL: Bug Tracker, https://github.com/NumberzGame/sub_byte/issues
+Author-email: James Parrott <james.parrott@proton.me>
+License: MIT License
+        
+        Copyright (c) 2024-present James Parrott
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE.md
+Keywords: Encoders,Serialization
+Classifier: Programming Language :: Python
+Requires-Python: >=3.12
+Requires-Dist: more-itertools
+Provides-Extra: mypy
+Requires-Dist: mypy; extra == 'mypy'
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Sub_Byte
+
+Bit packer and depacker.  Encodes and decodes sequences of integers with known bit-widths (and sequences of symbols equivalent to integers under some mapping).
+
+## Overview
+
+Sub Byte stores data without wasting bits, while preserving its structure, without requiring compression or decompression.  Simple bit packing is used, supporting using less than a byte of storage for <=7 bit fields, crossing byte 
+boundaries if necessary.
+
+A bit width for each symbol is required.  The bit width sequence (a simple codec) can be associated with the encoded data as meta data.  The decoder can be passed the total number of symbols to decode (e.g. whether a null byte (0b00000000), is 8 1-bit zeros, 4 2-bit zeros, 2 u4 zeros or a single u8 zero).  
+
+Alternatively, more dynamic codecs can be supported by passing null for the number of symbols to the decoder.  Axtra custom code 
+must then be written by the user, to determine when iteration ceases.  This can be used e.g. to encode the actual bit widths first (in some other fixed bit widths), to encode the number of symbols or cycles, and to implement any other codec that determines bit widths, and termination of iteration, according to the user's code.
+
+Data validation (e.g. checksums or hashes) must be done by the user, but an extra field can easily be appended to a bit width cycle.
+
+## Implementations
+
+### Python
+Calculate a cache of data in Python.
+
+```shell
+uv pip install sub_byte
+```
+
+
+### Typescript/Javascript
+Decode a cache of data in Javascript, even in browser.
+
+```shell
+npm i sub_byte
+```
+
+
+## Alternatives
+
+### Sub 4kB datasets
+This library is not needed for data storage.  Neither Sub_byte nor anything else, will reduce the disk space used.
+If the size of the un-encoded data set is less 4kB for example (or the page size of the file system on which the data will be stored, e.g. ext4, NTFS, APFS) then it is already below the minimum file size for that file system. 
+
+### A bespoke protocol using custom width integer types
+
+Up to 8 u1s (bits), up to 4 u2s, or up to 2 u3s or u4s per byte.
+Each developer must create their own implementation and tests.
+Interoperability between different private implementations is untestable.
+
+### Protocol buffers
+
+Encodes max symbol per byte. Variable byte encoding - uses continuation bits.
+
+### Zipping (data compression)
+
+- Exploits statistical distributions (e.g. "E" being more common in English text than "Q") and patterns.
+- Unstructured until the end user unzips the archive.
+
+## Changelog
+### v0.05
+Configured npm module for Typescript.
+### v0.04
+Support dynamic codecs (null/None number of elements to decode).
+
+## Development
+
+### Type checking and linting:
+#### Python
+##### MyPy
+```shell
+mypy --python-executable=path/to/venv/where/deps/installed/python.exe src/sub_byte
+```
+
+##### Pyright
+Activate venv where deps installed
+```shell
+pyright src/sub_byte/factories.py
+```
+
+#### TS
+##### Typescipt compiler
+```shell
+npm run typecheck
+```
+##### Eslint
+```shell
+npm run eslint
+```
+
+##### Prettier
+###### Check
+```shell
+npm run prettier
+```
+
+###### Auto fix
+```shell
+npm run prettier:write
+```
+
+### Publishing
+
+Bump version in package.json to x.y.z
+
+#### NPM
+```shell
+npm run prepublish
+npm pack
+```
+Double check contents of sub_byte-x.y.z.tgz
+
+```shell
+npm publish
+```
+Sign in (currently requires being the author).
+
+#### PyPi
+
+

sub_byte-0.0.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+sub_byte/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sub_byte/factories.py,sha256=IxrnsVsxSyUdUXnOFYoyt9mHtF0mAkKvSdjaD1rrj2E,9183
+sub_byte/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sub_byte-0.0.7.dist-info/METADATA,sha256=YbM68APsyREAEjdWN7iMV78A4RIEFDIx2YcoX9nJyx0,5230
+sub_byte-0.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sub_byte-0.0.7.dist-info/licenses/LICENSE.md,sha256=j8A9Ejfu8YaNnQvQRJFdWixi8XViJtdekrqa--pweiQ,1078
+sub_byte-0.0.7.dist-info/RECORD,,

sub_byte-0.0.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sub_byte-0.0.7.dist-info/licenses/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present James Parrott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.