tsrkit-types 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

tsrkit_types/bytes.py

@@ -1,6 +1,4 @@
-from typing import Tuple, Union, ClassVar, Self
-import base64
-
+from typing import Tuple, Union, ClassVar
 from tsrkit_types.integers import Uint
 from tsrkit_types.itf.codable import Codable
 
@@ -22,7 +20,7 @@ class Bytes(bytes, Codable):
         return f"{self.__class__.__name__}({self.hex()})"
 
     @classmethod
-    def from_bits(cls, bits: list[bool], bit_order = "msb") -> Self:
+    def from_bits(cls, bits: list[bool], bit_order = "msb") -> "Bytes":
         # Sanitize input: make sure bits are 0 or 1
         bits = [int(bool(b)) for b in bits]
         n = len(bits)
@@ -79,7 +77,7 @@ class Bytes(bytes, Codable):
         return current_offset - offset
     
     @classmethod
-    def decode_from(cls, buffer: Union[bytes, bytearray, memoryview], offset: int = 0) -> Tuple[Self, int]:
+    def decode_from(cls, buffer: Union[bytes, bytearray, memoryview], offset: int = 0) -> Tuple["Bytes", int]:
         current_offset = offset
         _len = cls._length
         if _len is None:

tsrkit_types/choice.py

@@ -1,5 +1,4 @@
-from typing import ClassVar, Optional, Union, Tuple, Any, get_origin
-from typing_extensions import get_args
+from typing import ClassVar, Optional, Union, Tuple, Any
 
 from tsrkit_types.integers import Uint
 from tsrkit_types.itf.codable import Codable
@@ -113,7 +112,13 @@ class Choice(Codable):
 
     def encode_into(self, buf: bytearray, offset: int = 0) -> int:
         current_offset = offset
-        current_offset += Uint(self._choice_types.index(type(self._value))).encode_into(buf, current_offset)
+        # Find the first isinstance(self._value, type) for self._choice_types
+        for i, t in enumerate(self._choice_types):
+            if isinstance(self._value, t):
+                current_offset += Uint(i).encode_into(buf, current_offset)
+                break
+        else:
+            raise ValueError(f"Value {self._value} is not a valid choice")
         current_offset += self._value.encode_into(buf, current_offset)
         return current_offset - offset
 

tsrkit_types/dictionary.py

@@ -22,8 +22,9 @@ V = TypeVar("V", bound=Codable)
 class DictCheckMeta(abc.ABCMeta):
     """Meta class to check if the instance is a dictionary with the same key and value types"""
     def __instancecheck__(cls, instance):
-        _matches_key_type = getattr(cls, "_key_type", None) == getattr(instance, "_key_type", None)
-        _matches_value_type = getattr(cls, "_value_type", None) == getattr(instance, "_value_type", None)
+        # TODO - This needs more false positive testing
+        _matches_key_type = str(getattr(cls, "_key_type", None)) == str(getattr(instance, "_key_type", None))
+        _matches_value_type = str(getattr(cls, "_value_type", None)) == str(getattr(instance, "_value_type", None))
         return isinstance(instance, dict) and _matches_key_type and _matches_value_type
 
 

tsrkit_types/enum.py

@@ -20,8 +20,8 @@ class Enum(metaclass=EnumMeta):
     >>> assert decoded == value
     >>> assert bytes_read == 1
     >>>
-    >>> assert MyEnum.from_json(1,) == MyEnum.A
-    >>> assert MyEnum.from_json("A",) == MyEnum.A
+    >>> assert MyEnum.from_json(1) == MyEnum.A
+    >>> assert MyEnum.from_json("A") == MyEnum.A
     """
     
     @property
@@ -106,7 +106,7 @@ class Enum(metaclass=EnumMeta):
             The corresponding enum value
 
         Raises:
-            JsonDeserializationError: If the value is invalid
+            ValueError: If the value is invalid
         """
         for v in cls.__members__.values():
             if v._value_ == data or v._name_ == data:

tsrkit_types/null.py

@@ -1,4 +1,4 @@
-from typing import Optional, Self, Tuple, Union
+from typing import Optional, Tuple, Union
 
 
 class NullType:
@@ -22,7 +22,7 @@ class NullType:
         return 0
     
     @classmethod
-    def decode_from(cls, buffer: Union[bytes, bytearray, memoryview], offset: int = 0) -> Tuple[Self, int]:
+    def decode_from(cls, buffer: Union[bytes, bytearray, memoryview], offset: int = 0) -> Tuple['NullType', int]:
         return cls(), 0
     
     # ---------------------------------------------------------------------------- #
@@ -33,7 +33,7 @@ class NullType:
         return None
     
     @classmethod
-    def from_json(cls, json_str: Optional[str]) -> Self:
+    def from_json(cls, json_str: Optional[str]) -> 'NullType':
         if json_str is None:
             return cls()
         raise ValueError("Invalid JSON string for NullType")

tsrkit_types/sequences.py

@@ -84,7 +84,7 @@ class Seq(list, Codable, Generic[T], metaclass=SeqCheckMeta):
                 raise TypeError(f"{value!r} is not an instance of {self._element_type!r}")
 
     def _validate_self(self):
-        """For Resultant Self check - added to fns that alter size"""
+        """For Resultant self check - added to fns that alter size"""
         if  len(self) < self._min_length:
             raise ValueError(f"Vector: Expected sequence size to be >= {self._min_length}, resultant size {len(self)}")
         elif len(self) > self._max_length:

tsrkit_types/struct.py

@@ -3,11 +3,11 @@ from typing import Any, Tuple, Union
 from tsrkit_types.itf.codable import Codable
 
 
-def struct(_cls=None, *, frozen=False, **kwargs):
+def structure(_cls=None, *, frozen=False, **kwargs):
     """Extension of dataclass to support serialization and json operations. 
 
     Usage:
-        >>> @struct
+        >>> @structure
         >>> class Person:
         >>>     name: String = field(metadata={"name": "first_name"})
         >>>     age: Uint[8] = field(metadata={"default": 0})
@@ -80,3 +80,7 @@ def struct(_cls=None, *, frozen=False, **kwargs):
         return new_cls
 
     return wrap if _cls is None else wrap(_cls)
+
+
+# Backward compatibility alias
+struct = structure

{tsrkit_types-0.1.0.dist-info → tsrkit_types-0.1.2.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: tsrkit-types
-Version: 0.1.0
-Summary: High-performance Python library for type-safe binary serialization, JSON encoding, and data validation with zero dependencies
+Version: 0.1.2
+Summary: Performant Python Typings library for type-safe binary serialization, JSON encoding, and data validation with zero dependencies
 Author-email: chainscore-labs <hello@chainscore.finance>, prasad-kumkar <prasad@chainscore.finance>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/chainscore/tsrkit-types
@@ -15,6 +15,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -26,7 +27,7 @@ Classifier: Topic :: Utilities
 Classifier: Topic :: System :: Archiving
 Classifier: Topic :: Communications
 Classifier: Typing :: Typed
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: dev
@@ -40,7 +41,7 @@ Dynamic: license-file
 
 # TSRKit Types
 
-Performant Python library for type-safe binary serialization, JSON encoding, and data validation with zero dependencies.
+Performant Python Typings library for type-safe binary serialization, JSON encoding, and data validation with zero dependencies.
 
 Perfect for network protocols, game state serialization, configuration files, and any application requiring efficient, validated data handling.
 
@@ -62,7 +63,7 @@ pip install tsrkit-types
 
 ## Type Categories
 
-### Integer Types
+### Integer Types (extension of Python int)
 
 #### Unsigned Integers (`Uint`)
 
@@ -70,13 +71,13 @@ The `Uint` class provides both fixed-size and variable-size unsigned integers.
 
 **Fixed-Size Integers:**
 ```python
-from tsrkit_types.integers import Uint, U8, U16, U32, U64
+from tsrkit_types.integers import Uint
 
 # Pre-defined types
-value = U8(255)        # 8-bit unsigned integer (0-255)
-value = U16(65535)     # 16-bit unsigned integer (0-65535) 
-value = U32(42949)     # 32-bit unsigned integer
-value = U64(1844674)   # 64-bit unsigned integer
+value = Uint[8](255)        # 8-bit unsigned integer (0-255)
+value = Uint[16](65535)     # 16-bit unsigned integer (0-65535) 
+value = Uint[32](42949)     # 32-bit unsigned integer
+value = Uint[64](1844674)   # 64-bit unsigned integer
 
 # Dynamic size specification
 U128 = Uint[128]       # 128-bit unsigned integer
@@ -96,9 +97,9 @@ encoded = num.encode()
 decoded = Uint.decode(encoded)
 
 # Arithmetic operations preserve type
-a = U8(10)
-b = U8(20)
-result = a + b         # result is U8(30)
+a = Uint[8](10)
+b = Uint[8](20)
+result = a + b         # result is Uint[8](30)
 ```
 
 **Encoding Details:**
@@ -107,7 +108,7 @@ result = a + b         # result is U8(30)
 - Values < 2^7 are encoded in 1 byte
 - Larger values use a variable-length prefix encoding
 
-### String Types
+### String Types (extension of Python str)
 
 #### UTF-8 Strings (`String`)
 
@@ -161,27 +162,11 @@ restored = Bool.from_json("true")
 
 ### Null Types
 
-#### Null and Nullable
-
 ```python
-from tsrkit_types.null import Null, Nullable
+from tsrkit_types.null import Null
 
 # Null type
 null_val = Null                  # Singleton null value
-
-# Nullable wrapper for optional values
-maybe_string = Nullable[String](String("hello"))
-empty_val = Nullable[String]()   # Contains null
-
-# Check for null
-if maybe_string.is_null():
-    print("Value is null")
-else:
-    value = maybe_string.unwrap()  # Get the wrapped value
-
-# Encoding
-encoded = maybe_string.encode()  # 1 byte flag + optional value
-decoded = Nullable[String].decode(encoded)
 ```
 
 ### Choice and Option Types
@@ -219,7 +204,7 @@ encoded = result.encode()        # [variant_index][value]
 decoded = Result.decode(encoded)
 ```
 
-#### Option (Optional Values)
+#### Option (Optional Value - T | Null)
 
 ```python
 from tsrkit_types.option import Option
@@ -240,7 +225,7 @@ decoded = Option[U32].decode(encoded)
 
 ### Container Types
 
-#### Sequences (Arrays and Vectors)
+#### Sequences (Extension of Python list)
 
 ```python
 from tsrkit_types.sequences import Array, Vector, TypedArray, TypedVector
@@ -274,7 +259,7 @@ decoded = TypedDynamicVector.decode(encoded)
 
 **Sequence Types:**
 - `Array[N]`: Fixed size, any element type
-- `Vector[max]`: Variable size up to max, any element type  
+- `Vector`: Variable size, any element type  
 - `TypedArray[T, N]`: Fixed size with typed elements
 - `TypedVector[T]`: Variable size with typed elements
 - `BoundedVector[min, max]`: Size constrained vector
@@ -314,7 +299,7 @@ restored = StringToInt.from_json(json_data)
 
 ### Bytes Types
 
-#### Raw Bytes
+#### Bytes (extension of Python in-built bytes)
 
 ```python
 from tsrkit_types.bytes import Bytes
@@ -323,6 +308,10 @@ from tsrkit_types.bytes import Bytes
 data = Bytes(b"Hello, binary world!")
 data = Bytes([0x01, 0x02, 0x03, 0x04])
 
+# Bytes <-> Bits Operations
+data.to_bits()          # [True, False, True, ...]
+Bytes.from_bits([True, False, True, ...])
+
 # Operations
 length = len(data)               # Byte length
 raw_bytes = bytes(data)         # Convert to Python bytes
@@ -336,7 +325,7 @@ json_str = data.to_json()        # "48656c6c6f2c2062696e61727920776f726c6421"
 restored = Bytes.from_json(json_str)
 ```
 
-#### Bit Arrays
+#### Bit Arrays (Sequence of bool)
 
 ```python
 from tsrkit_types.bits import BitArray
@@ -361,7 +350,7 @@ encoded = bits.encode()          # [length][packed_bits]
 decoded = BitArray.decode(encoded)
 ```
 
-### Enumeration Types
+### Enum (Extension of Python Enum, with Codable + JSON support)
 
 ```python
 from tsrkit_types.enum import Enum
@@ -391,7 +380,7 @@ restored = Color.from_json("GREEN")
 
 ### Structured Types
 
-#### Struct Decorator
+#### Struct Decorator (Extension of dataclasses)
 
 ```python
 from tsrkit_types.struct import struct
@@ -399,12 +388,12 @@ from tsrkit_types.string import String
 from tsrkit_types.integers import U8, U32
 from dataclasses import field
 
-@struct
+@structure
 class Person:
     name: String
     age: U8
     
-@struct  
+@structure  
 class Employee:
     person: Person
     employee_id: U32
@@ -427,7 +416,7 @@ encoded = employee.encode()      # Concatenated field encodings
 decoded = Employee.decode(encoded)
 
 # JSON serialization with custom field names
-@struct
+@structure
 class CustomPerson:
     name: String = field(metadata={"name": "full_name"})
     age: U8
@@ -479,7 +468,7 @@ class Point3D(Codable):
 
 ```python
 # Optimize for specific use cases
-@struct(frozen=True)             # Immutable structs
+@structure(frozen=True)             # Immutable structs
 class ImmutableData:
     value: U64
 
@@ -575,8 +564,8 @@ offset += value2.encode_into(buffer, offset)
 
 ### Network Protocol
 
-```python
-@struct
+```**python**
+@structure
 class NetworkPacket:
     packet_type: U8
     session_id: U32
@@ -601,7 +590,7 @@ received_packet = NetworkPacket.decode(wire_data)
 ### Configuration File
 
 ```python
-@struct
+@structure
 class DatabaseConfig:
     host: String
     port: U16
@@ -637,19 +626,19 @@ class GameEntityType(Enum):
     ENEMY = 1
     ITEM = 2
 
-@struct
+@structure
 class Position:
     x: U16
     y: U16
 
-@struct  
+@structure  
 class GameEntity:
     entity_type: GameEntityType
     position: Position
     health: U8
     name: String
 
-@struct
+@structure
 class GameState:
     level: U8
     score: U32
@@ -745,6 +734,6 @@ Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for gui
 
 ## Requirements
 
-- **Python**: >= 3.12
+- **Python**: >= 3.11
 - **Runtime Dependencies**: None (zero dependencies!)
 - **Development Dependencies**: pytest and plugins (see `pyproject.toml`) 

tsrkit_types-0.1.2.dist-info/RECORD

@@ -0,0 +1,19 @@
+tsrkit_types/__init__.py,sha256=Vw03Fv9RnfmZGqzBpFhuglyewh4MxKR8T5bdWdal1VU,1870
+tsrkit_types/bits.py,sha256=ggx2lDRWtBBIYQBtKEx-XirwYTJdajctCEpd3VmuXrc,3275
+tsrkit_types/bool.py,sha256=anu5RquxV8xdDMj7aIwOOCP3WnK6vMNst4WUPlfeKm4,1460
+tsrkit_types/bytes.py,sha256=rw0sjw1fO9bOElftWehs8oLCZFMXWeajjCyOH-5kChU,3756
+tsrkit_types/choice.py,sha256=L4Pb0ZBvaoCW2h9VBLclmmgIJvfO0Yeb2khPniFN2Xo,5113
+tsrkit_types/dictionary.py,sha256=EktyMKH27HVoR1xNhrkV8fW6KfcxpbHiiYPYoCrFdoI,5614
+tsrkit_types/enum.py,sha256=3MyLW15_ToQQdctJjcMY8Xb3OsS_Ad997OOEo8FjVeA,4256
+tsrkit_types/integers.py,sha256=GT9xVZYBNMcPpShJIlSazwiZYGhoBowhR0MA_cGO5Q0,7200
+tsrkit_types/null.py,sha256=OwHVhWLdazaFLXXR8iHPaHe67NPmYHDCavBxUfcZ53s,1318
+tsrkit_types/option.py,sha256=V4J8SmhUDjINqMM6Ml3ho0YwTy2UT-avrjoYh32Swyg,879
+tsrkit_types/sequences.py,sha256=6aseAdoAkD3RG20ag6CTzVZPR_YlJfLHo82JrNZY3dE,8092
+tsrkit_types/string.py,sha256=8rvg0BwvyhQnbMW3qornmBFTQHeTQFUfwD7OC0eVgcY,2575
+tsrkit_types/struct.py,sha256=ni8jwZlfT_wehardfImBJ0AsvnO-oCW-3APplLXsqGY,3206
+tsrkit_types/itf/codable.py,sha256=jWfoYZ31MZ6k3nlHb2IwJdjD3G0pVPyZWlF0Sv9MAWs,2794
+tsrkit_types-0.1.2.dist-info/licenses/LICENSE,sha256=TwnDvVCPwHadHWLUuY1sPx03XNw1jzh_ZmoDBNai9Uc,1072
+tsrkit_types-0.1.2.dist-info/METADATA,sha256=Yt9wxA4VDq7jhjzPGrrpcQ4rhjgMUQN3hoTl9rjT3ec,19353
+tsrkit_types-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tsrkit_types-0.1.2.dist-info/top_level.txt,sha256=pnVhnUsnZ_A0FIj1zHwDw3suMGrfMJwusp-4GPVY1CM,13
+tsrkit_types-0.1.2.dist-info/RECORD,,

tsrkit_types-0.1.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-tsrkit_types/__init__.py,sha256=Vw03Fv9RnfmZGqzBpFhuglyewh4MxKR8T5bdWdal1VU,1870
-tsrkit_types/bits.py,sha256=ggx2lDRWtBBIYQBtKEx-XirwYTJdajctCEpd3VmuXrc,3275
-tsrkit_types/bool.py,sha256=anu5RquxV8xdDMj7aIwOOCP3WnK6vMNst4WUPlfeKm4,1460
-tsrkit_types/bytes.py,sha256=t4GeqbYMloKrTu4XyGSRquMhQL4Ayr-S4vgZhZBS9BU,3771
-tsrkit_types/choice.py,sha256=eEHkXT2ymk4WwP0IxllErM1ixWjRrwGLcKIPTuiTkd4,4915
-tsrkit_types/dictionary.py,sha256=yXhz3ZaVEgLgxSeGuYzVBLDGIFsy7m6PkRGUji8njmc,5538
-tsrkit_types/enum.py,sha256=0PZUuydhGVN6zmAscQNzq4Vnn5mUUPIxlDoQBodqf7g,4272
-tsrkit_types/integers.py,sha256=GT9xVZYBNMcPpShJIlSazwiZYGhoBowhR0MA_cGO5Q0,7200
-tsrkit_types/null.py,sha256=IcYYY5ZT7cZ5q5oyc0mCFGUCVCdhAXB_ftyAM9z5_Ek,1312
-tsrkit_types/option.py,sha256=V4J8SmhUDjINqMM6Ml3ho0YwTy2UT-avrjoYh32Swyg,879
-tsrkit_types/sequences.py,sha256=2vJeO47rmIN7WQjFGKudDhzDVifTNmrj1whE03npz3c,8092
-tsrkit_types/string.py,sha256=8rvg0BwvyhQnbMW3qornmBFTQHeTQFUfwD7OC0eVgcY,2575
-tsrkit_types/struct.py,sha256=P5xIvYr0V5Hrhs7bnn0jgvAtkY29XtXuCIISgeP7oks,3148
-tsrkit_types/itf/codable.py,sha256=jWfoYZ31MZ6k3nlHb2IwJdjD3G0pVPyZWlF0Sv9MAWs,2794
-tsrkit_types-0.1.0.dist-info/licenses/LICENSE,sha256=TwnDvVCPwHadHWLUuY1sPx03XNw1jzh_ZmoDBNai9Uc,1072
-tsrkit_types-0.1.0.dist-info/METADATA,sha256=Uz8n_Q2q57blki1O4OrN2wr4I36KJK_HRxZkaQ90c5A,19376
-tsrkit_types-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-tsrkit_types-0.1.0.dist-info/top_level.txt,sha256=pnVhnUsnZ_A0FIj1zHwDw3suMGrfMJwusp-4GPVY1CM,13
-tsrkit_types-0.1.0.dist-info/RECORD,,