bier 0.0.1__tar.gz

bier-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rudolf Kolbe (K0lb3)
+
+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.

bier-0.0.1/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include src *.cpp
+recursive-include src *.hpp
+recursive-include src *.c
+recursive-include src *.h

bier-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: bier
+Version: 0.0.1
+Author-email: Rudolf Kolbe <rkolbe96@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/K0lb3/bier
+Project-URL: Bug Tracker, https://github.com/K0lb3/bier/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: bier[tests]; extra == "dev"
+Dynamic: license-file
+
+# BInaryhelpER
+
+A small python package to make binary serialization faster and easier.
+
+modules:
+
+- EndianedBinaryIO - for parsing and writing streamed binary data.
+- ComplexStreams (TODO)
+  - BlockStream - for more performant handling of e.g. streams consisting of compressed and/or encrypted blocks
+  - MultiStream - for handling concatent streams as single streams
+- struct (TODO) - extrend struct module with additional features
+  - c - null terminated string
+  - v - varint
+  - () - tuples (groups)
+  - x\*y - read an x, then read x times y (e.g. i*s for strings with their lengths described with a prior int)
+- serialization - annotation based class serialization
+
+## Serialization
+
+### BinarySerializable
+
+__Annotation Types__
+- ints:
+  - u8
+  - u16
+  - u32
+  - u64
+  - i8
+  - i16
+  - i32
+  - i64
+- floats:
+  - f16
+  - f32
+  - f64
+- strings:
+  - cstr (null terminated string)
+  - str (default delimited length)
+  - str_d[T] (delimited length of type T)
+- lists:
+  - list[S] (default delimited length)
+  - list_d[S, T] (delimited length of type T)
+- tuples:
+  - tuple[T1, T2, ...]
+- objects
+  - class (has to inherit from BinarySerializible as well)
+- bytes:
+  - bytes (default delimited length)
+  - bytes_d[T] (delimited length of type T)
+
+__Example__
+```py
+class MyStruct(BinarySerializable):
+    field1: u8
+    field2: cstr
+    field3: str_d[u16]
+    field4: list_d[f32, u8]
+    field5: list_d[list_d[u16, u8], u8]
+    field6: tuple[u8, u16]
+
+class MyStruct2(BinarySerializable):
+    field1: MyStruct
+    field2: list_d["MyStruct2", u8]
+
+
+class MyStruct3(BinarySerializable[u32]):
+    field: str
+    field2: list[tuple[f16, f16, f16]]
+```

bier-0.0.1/README.md

@@ -0,0 +1,69 @@
+# BInaryhelpER
+
+A small python package to make binary serialization faster and easier.
+
+modules:
+
+- EndianedBinaryIO - for parsing and writing streamed binary data.
+- ComplexStreams (TODO)
+  - BlockStream - for more performant handling of e.g. streams consisting of compressed and/or encrypted blocks
+  - MultiStream - for handling concatent streams as single streams
+- struct (TODO) - extrend struct module with additional features
+  - c - null terminated string
+  - v - varint
+  - () - tuples (groups)
+  - x\*y - read an x, then read x times y (e.g. i*s for strings with their lengths described with a prior int)
+- serialization - annotation based class serialization
+
+## Serialization
+
+### BinarySerializable
+
+__Annotation Types__
+- ints:
+  - u8
+  - u16
+  - u32
+  - u64
+  - i8
+  - i16
+  - i32
+  - i64
+- floats:
+  - f16
+  - f32
+  - f64
+- strings:
+  - cstr (null terminated string)
+  - str (default delimited length)
+  - str_d[T] (delimited length of type T)
+- lists:
+  - list[S] (default delimited length)
+  - list_d[S, T] (delimited length of type T)
+- tuples:
+  - tuple[T1, T2, ...]
+- objects
+  - class (has to inherit from BinarySerializible as well)
+- bytes:
+  - bytes (default delimited length)
+  - bytes_d[T] (delimited length of type T)
+
+__Example__
+```py
+class MyStruct(BinarySerializable):
+    field1: u8
+    field2: cstr
+    field3: str_d[u16]
+    field4: list_d[f32, u8]
+    field5: list_d[list_d[u16, u8], u8]
+    field6: tuple[u8, u16]
+
+class MyStruct2(BinarySerializable):
+    field1: MyStruct
+    field2: list_d["MyStruct2", u8]
+
+
+class MyStruct3(BinarySerializable[u32]):
+    field: str
+    field2: list[tuple[f16, f16, f16]]
+```

bier-0.0.1/bier/EndianedBinaryIO/C/EndianedBytesIO.pyi

@@ -0,0 +1,3 @@
+from ..EndianedBytesIO import EndianedBytesIO
+
+__all__ = ["EndianedBytesIO"]

bier-0.0.1/bier/EndianedBinaryIO/C/EndianedIOBase.pyi

@@ -0,0 +1,3 @@
+from ..EndianedIOBase import EndianedIOBase
+
+__all__ = ["EndianedIOBase"]

bier-0.0.1/bier/EndianedBinaryIO/C/EndianedStreamIO.pyi

@@ -0,0 +1,3 @@
+from ..EndianedStreamIO import EndianedStreamIO
+
+__all__ = ["EndianedStreamIO"]

bier-0.0.1/bier/EndianedBinaryIO/C/__init__.py

@@ -0,0 +1,4 @@
+from .EndianedBytesIO import EndianedBytesIO as EndianedBytesIO
+from .EndianedStreamIO import EndianedStreamIO as EndianedStreamIO
+# disabled for now, because it is slower than the pure python version
+# from .EndianedIOBase import EndianedIOBase as EndianedIOBase

bier-0.0.1/bier/EndianedBinaryIO/EndianedBufferedReader.py

@@ -0,0 +1,14 @@
+from io import BufferedReader, RawIOBase
+
+from .EndianedIOBase import EndianedIOBase, Endianess
+
+
+class EndianedBufferedReader(BufferedReader, EndianedIOBase):
+    def __init__(
+        self, raw: RawIOBase, buffer_size: int = 8192, endian: Endianess = "<"
+    ) -> None:
+        BufferedReader.__init__(self, raw, buffer_size)
+        self.endian = endian
+
+
+__all__ = ("EndianedBufferedReader",)

bier-0.0.1/bier/EndianedBinaryIO/EndianedBufferedWriter.py

@@ -0,0 +1,14 @@
+from io import BufferedWriter, RawIOBase
+
+from .EndianedIOBase import EndianedIOBase, Endianess
+
+
+class EndianedBufferedWriter(BufferedWriter, EndianedIOBase):
+    def __init__(
+        self, raw: RawIOBase, buffer_size: int = 8192, endian: Endianess = "<"
+    ) -> None:
+        BufferedWriter.__init__(self, raw, buffer_size)
+        self.endian = endian
+
+
+__all__ = ("EndianedBufferedWriter",)

bier-0.0.1/bier/EndianedBinaryIO/EndianedBytesIO.py

@@ -0,0 +1,14 @@
+from io import BytesIO
+
+from collections.abc import Buffer
+
+from .EndianedIOBase import EndianedIOBase, Endianess
+
+
+class EndianedBytesIO(BytesIO, EndianedIOBase):
+    def __init__(self, initial_bytes: Buffer = b"", endian: Endianess = "<") -> None:
+        BytesIO.__init__(self, initial_bytes)
+        self.endian = endian
+
+
+__all__ = ("EndianedBytesIO",)

bier-0.0.1/bier/EndianedBinaryIO/EndianedFileIO.py

@@ -0,0 +1,25 @@
+from io import FileIO
+from os import PathLike
+from typing import Callable, Optional, Union
+
+from .EndianedIOBase import EndianedIOBase, Endianess
+
+StrOrBytesPath = Union[str, bytes, PathLike[str], PathLike[bytes]]
+FileDescriptorOrPath = Union[int, StrOrBytesPath]
+_Opener = Callable[[str, int], int]
+
+
+class EndianedFileIO(FileIO, EndianedIOBase):
+    def __init__(
+        self,
+        file: FileDescriptorOrPath,
+        mode: str = "r",
+        closefd: bool = True,
+        opener: Optional[_Opener] = None,
+        endian: Endianess = "<",
+    ) -> None:
+        FileIO.__init__(self, file, mode, closefd, opener)
+        self.endian = endian
+
+
+__all__ = ("EndianedFileIO",)