BinaryPacking 1.0.0__cp313-cp313-win_amd64.whl

BinaryPacking/Packing.pyi

@@ -0,0 +1,187 @@
+"""Pack and unpack numeric values as binary data.
+
+Fixed-width helpers use little-endian encoding by default and validate that
+values fit the requested width. ``big`` reverses byte order; ``baremetal-*``
+selects the same fixed width with the stated byte order; ``dense-*`` removes
+redundant leading zero/sign-extension bytes and therefore produces variable
+length output. Dense encodings are useful for compact storage but are not
+interchangeable with fixed-width formats.
+
+Examples:
+    >>> from Obex.Encoding import BinaryPacking
+    >>> BinaryPacking.PackInt32(258)
+    b'\\x02\\x01\\x00\\x00'
+    >>> BinaryPacking.UnPackInt32(b"\\x02\\x01\\x00\\x00")
+    258
+    >>> BinaryPacking.PackUInt32(0x1234, "big")
+    b'\\x00\\x00\\x12\\x34'
+    >>> BinaryPacking.UnPackFloat32(BinaryPacking.PackFloat32(1.5))
+    1.5
+    >>> BinaryPacking.UnPackBools(BinaryPacking.PackBools([True, False, True]))[:3]
+    [True, False, True]
+
+Unpack functions require the exact fixed-width input size, except dense integer
+formats, which accept non-empty variable-length encodings. Float helpers use
+IEEE-754 binary formats. Boolean arrays store the first value in the least
+significant bit for little-endian modes and in the most significant bit for
+big-endian modes. Pointer helpers encode an unsigned 64-bit integer.
+"""
+
+from typing import Literal
+
+Endian = Literal[
+    "little",
+    "big",
+    "baremetal-little",
+    "baremetal-big",
+    "dense-little",
+    "dense-big",
+]
+
+def ValidateEndian(Endian: str) -> tuple[str, bool]:
+    """Validate an endian option and return its byte order and dense-mode flag."""
+    ...
+
+def RoundRatio(Numerator: int, Denominator: int) -> int:
+    """Round an integer ratio to nearest, resolving ties to an even result."""
+    ...
+
+def ValidateFloatFormat(ExponentBits: int, FractionBits: int) -> int:
+    """Validate IEEE-like field widths and return their total bit count."""
+    ...
+
+def PackInteger(Value: int, BitCount: int, Endian: Endian, Signed: bool) -> bytes:
+    """Encode an integer with an explicit width, signedness, and byte order."""
+    ...
+
+def UnPackInteger(Value: bytes, BitCount: int, Endian: Endian, Signed: bool) -> int:
+    """Decode an integer encoded by PackInteger."""
+    ...
+
+def FloatToBits(Value: float, ExponentBits: int, FractionBits: int) -> int:
+    """Encode a floating-point value as an integer IEEE-style bit pattern."""
+    ...
+
+def BitsToFloat(Value: int, ExponentBits: int, FractionBits: int) -> float:
+    """Decode an integer IEEE-style bit pattern as a Python float."""
+    ...
+
+def PackFloat(Value: float, ExponentBits: int, FractionBits: int, Endian: Endian) -> bytes:
+    """Pack a float using the selected exponent/fraction bit widths."""
+    ...
+
+def UnPackFloat(Value: bytes, ExponentBits: int, FractionBits: int, Endian: Endian) -> float:
+    """Unpack a float using the selected exponent/fraction bit widths."""
+    ...
+
+def PackInt8(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack a signed 8-bit integer (range -128 through 127)."""
+    ...
+
+def PackInt16(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack a signed 16-bit integer (range -32768 through 32767)."""
+    ...
+
+def PackInt32(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack a signed 32-bit integer."""
+    ...
+
+def PackInt64(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack a signed 64-bit integer."""
+    ...
+
+def PackUInt8(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack an unsigned 8-bit integer (range 0 through 255)."""
+    ...
+
+def PackUInt16(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack an unsigned 16-bit integer."""
+    ...
+
+def PackUInt32(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack an unsigned 32-bit integer."""
+    ...
+
+def PackUInt64(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack an unsigned 64-bit integer."""
+    ...
+
+def PackFloat16(Value: float, Endian: Endian = "little") -> bytes:
+    """Pack an IEEE-754 binary16 value into two bytes."""
+    ...
+
+def PackFloat32(Value: float, Endian: Endian = "little") -> bytes:
+    """Pack an IEEE-754 binary32 value into four bytes."""
+    ...
+
+def PackFloat64(Value: float, Endian: Endian = "little") -> bytes:
+    """Pack an IEEE-754 binary64 value into eight bytes."""
+    ...
+
+def PackBool(Value: bool, Endian: Endian = "little") -> bytes:
+    """Pack one Boolean as a single byte containing zero or one."""
+    ...
+
+def PackBools(Value: list[bool], Endian: Endian = "little") -> bytes:
+    """Pack Boolean values densely, eight values per output byte."""
+    ...
+
+def PackPointer(Value: int, Endian: Endian = "little") -> bytes:
+    """Pack an unsigned 64-bit integer used to represent a pointer value."""
+    ...
+
+def UnPackInt8(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack a signed 8-bit integer from exactly one byte."""
+    ...
+
+def UnPackInt16(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack a signed 16-bit integer from exactly two bytes."""
+    ...
+
+def UnPackInt32(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack a signed 32-bit integer from exactly four bytes."""
+    ...
+
+def UnPackInt64(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack a signed 64-bit integer from exactly eight bytes."""
+    ...
+
+def UnPackUInt8(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack an unsigned 8-bit integer from exactly one byte."""
+    ...
+
+def UnPackUInt16(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack an unsigned 16-bit integer from exactly two bytes."""
+    ...
+
+def UnPackUInt32(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack an unsigned 32-bit integer from exactly four bytes."""
+    ...
+
+def UnPackUInt64(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack an unsigned 64-bit integer from exactly eight bytes."""
+    ...
+
+def UnPackFloat16(Value: bytes, Endian: Endian = "little") -> float:
+    """Unpack an IEEE-754 binary16 value from exactly two bytes."""
+    ...
+
+def UnPackFloat32(Value: bytes, Endian: Endian = "little") -> float:
+    """Unpack an IEEE-754 binary32 value from exactly four bytes."""
+    ...
+
+def UnPackFloat64(Value: bytes, Endian: Endian = "little") -> float:
+    """Unpack an IEEE-754 binary64 value from exactly eight bytes."""
+    ...
+
+def UnPackBool(Value: bytes, Endian: Endian = "little") -> bool:
+    """Unpack a Boolean byte; only zero and one are valid."""
+    ...
+
+def UnPackBools(Value: bytes, Endian: Endian = "little") -> list[bool]:
+    """Unpack each input byte into eight Booleans in the selected bit order."""
+    ...
+
+def UnPackPointer(Value: bytes, Endian: Endian = "little") -> int:
+    """Unpack an unsigned 64-bit pointer representation."""
+    ...

BinaryPacking/__init__.py

@@ -0,0 +1,3 @@
+"""Binary packing and unpacking."""
+
+from BinaryPacking.Packing import *

BinaryPacking/setup.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+
+from setuptools import Extension, setup
+
+here = Path(__file__).parent
+
+setup(
+    name="BinaryPacking",
+    version="1.0.0",
+    description="Fast C extension for packing and unpacking numeric values as binary data.",
+    long_description=(here / "README.md").read_text(encoding="utf-8"),
+    long_description_content_type="text/markdown",
+    author="ItsRealAwi",
+    license="MIT",
+    license_files=["LICENSE"],
+    url="https://github.com/ItsRealAwi/BinaryPacking",
+    python_requires=">=3.10,<3.17",
+    packages=["BinaryPacking"],
+    package_dir={"BinaryPacking": "."},
+    package_data={"BinaryPacking": ["Packing.pyi", "py.typed"]},
+    include_package_data=True,
+    ext_modules=[Extension("BinaryPacking.Packing", sources=["Packing.c"])],
+    zip_safe=False,
+    keywords=["binary", "pack", "unpack", "struct", "serialization"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: C",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
+        "Programming Language :: Python :: 3.15",
+        "Programming Language :: Python :: 3.16",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Typing :: Typed",
+    ],
+)

binarypacking-1.0.0.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: BinaryPacking
+Version: 1.0.0
+Summary: Fast C extension for packing and unpacking numeric values as binary data.
+Home-page: https://github.com/ItsRealAwi/BinaryPacking
+Author: ItsRealAwi
+License: MIT
+Keywords: binary,pack,unpack,struct,serialization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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 :: 3.15
+Classifier: Programming Language :: Python :: 3.16
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Typing :: Typed
+Requires-Python: >=3.10,<3.17
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# BinaryPacking
+
+C extension for packing and unpacking numeric values (ints, floats, bools, pointers) as binary data.
+Supports fixed-width little/big-endian formats and dense variable-length integers.
+
+## Install
+
+```
+pip install BinaryPacking
+```
+
+## Usage
+
+```python
+from BinaryPacking import Packing
+
+Packing.PackInt32(258)            # b'\x02\x01\x00\x00'
+Packing.UnPackInt32(b"\x02\x01\x00\x00")  # 258
+Packing.PackUInt32(0x1234, "big") # b'\x00\x00\x12\x34'
+```
+
+## Build from source
+
+- Windows: `build.bat` (also `build.bat wheel`, `build.bat clean`)
+- Make: `make build`, `make wheel`, `make dist`, `make upload`, `make clean`
+
+## License
+
+MIT

binarypacking-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+BinaryPacking/Packing.cp313-win_amd64.pyd,sha256=GCpeY55mSidkxlrguMfTzIgWs4alhzrQG01GWCsE_CQ,39936
+BinaryPacking/Packing.pyi,sha256=CV0UefZ9267P2Aobgb-iJjCF-TI-vCYz6f_PEN6y8jk,6910
+BinaryPacking/__init__.py,sha256=RcvDh9Q_rlkOQA4vARglsx5Qz9CGn84m4XUesK3D0VI,74
+BinaryPacking/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+BinaryPacking/setup.py,sha256=t9GqY2BxCZFxFM5Aa4x7FsqJgDrri3eeppXqsPKP2aw,1602
+binarypacking-1.0.0.dist-info/licenses/LICENSE,sha256=3iXok-LX-sIhyUHh5ksnOzSMHo14vhqin5cg4T6cAHc,1088
+binarypacking-1.0.0.dist-info/METADATA,sha256=hds_pyXkFlb4INK8mWPJji37BqxrU9OqdmVVILPFMXA,1977
+binarypacking-1.0.0.dist-info/WHEEL,sha256=0LUNoHxLvcpw9db_x0XozE5jW73-_GOAO7fDDJ4Xt4Q,101
+binarypacking-1.0.0.dist-info/top_level.txt,sha256=Bc0NroXTIcwaob20BzZwKxSd6ORYsPFmaKbs3VpupAo,14
+binarypacking-1.0.0.dist-info/RECORD,,

binarypacking-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win_amd64
+

binarypacking-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ItsRealAwi
+
+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.

binarypacking-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+BinaryPacking