runtimepy 5.11.1__tar.gz → 5.11.3__tar.gz

{runtimepy-5.11.1/runtimepy.egg-info → runtimepy-5.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.11.1
+Version: 5.11.3
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,11 +17,11 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: psutil
+Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
 Requires-Dist: aiofiles
 Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: psutil
-Requires-Dist: svgen>=0.7.4
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -50,11 +50,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.1.4
-    hash=4ef876633bf905b103835e81db45e721
+    hash=8e8d3499d8579ca086dc80c977f6fd7f
     =====================================
 -->
 
-# runtimepy ([5.11.1](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.3](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.11.1 → runtimepy-5.11.3}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=4ef876633bf905b103835e81db45e721
+    hash=8e8d3499d8579ca086dc80c977f6fd7f
     =====================================
 -->
 
-# runtimepy ([5.11.1](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.3](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.11.1 → runtimepy-5.11.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.11.1"
+version = "5.11.3"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.12"

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=da21068ff2c7240dc103642dedb80cf5
+# hash=f45f335bfb519a5a33f13603258a4d33
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.11.1"
+VERSION = "5.11.3"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/codec/protocol/base.py

@@ -145,6 +145,7 @@ class ProtocolBase(PrimitiveArray):
             fields=_copy(self._fields),
             build=self._build,
             byte_order=self.byte_order,
+            identifier=self.id,
             serializables={
                 key: [val[0].copy_without_chain()]
                 for key, val in self.serializables.items()

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/codec/protocol/json.py

@@ -25,6 +25,7 @@ from runtimepy.primitives.field.manager import (
     VALUES_KEY,
     BitFieldsManager,
 )
+from runtimepy.primitives.serializable import SerializableMap
 
 BUILD_KEY = "build"
 META_KEY = "meta"
@@ -96,7 +97,11 @@ class JsonProtocol(ProtocolBase):
         return data
 
     @classmethod
-    def import_json(cls: type[T], data: dict[str, _JsonObject]) -> T:
+    def import_json(
+        cls: type[T],
+        data: dict[str, _JsonObject],
+        serializables: SerializableMap = None,
+    ) -> T:
         """Create a bit-fields manager from JSON data."""
 
         # Only set values once (at the end).
@@ -126,6 +131,7 @@ class JsonProtocol(ProtocolBase):
             identifier=_cast(int, data[META_KEY]["id"]),
             byte_order=_cast(str, data[META_KEY]["byte_order"]),
             alias=data[META_KEY]["alias"],  # type: ignore
+            serializables=serializables,
         )
 
         # Set values.

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/codec/system/__init__.py

@@ -3,23 +3,24 @@ A basic type-system implementation.
 """
 
 # built-in
-from typing import Iterable, Optional
+from typing import Iterable, Optional, Union
 
 # third-party
 from vcorelib.logging import LoggerMixin
 from vcorelib.namespace import CPP_DELIM, Namespace
 
 # internal
-from runtimepy import PKG_NAME
 from runtimepy.codec.protocol import Protocol
 from runtimepy.enum import RuntimeEnum
-from runtimepy.enum.registry import (
-    DEFAULT_ENUM_PRIMITIVE,
-    EnumRegistry,
-    RuntimeIntEnum,
+from runtimepy.enum.registry import DEFAULT_ENUM_PRIMITIVE, RuntimeIntEnum
+from runtimepy.primitives.byte_order import (
+    DEFAULT_BYTE_ORDER,
+    ByteOrder,
+    enum_registry,
 )
-from runtimepy.primitives.byte_order import ByteOrder
 from runtimepy.primitives.types import AnyPrimitiveType, PrimitiveTypes
+from runtimepy.registry.name import RegistryKey
+from runtimepy.util import Identifier
 
 
 def resolve_name(matches: Iterable[str]) -> str:
@@ -50,7 +51,9 @@ class TypeSystem(LoggerMixin):
 
         self.primitives: dict[str, AnyPrimitiveType] = {}
         self.custom: dict[str, Protocol] = {}
-        self._enums = EnumRegistry()
+        self.custom_ids = Identifier(scale=1)
+
+        self._enums = enum_registry(register_byte_order=False)
 
         global_namespace = Namespace(delim=CPP_DELIM)
 
@@ -61,9 +64,8 @@ class TypeSystem(LoggerMixin):
         self.root_namespace = global_namespace
 
         # Register enums.
-        with self.root_namespace.pushed(PKG_NAME):
-            for enum in [ByteOrder]:
-                self.runtime_int_enum(enum)
+        for enum in [ByteOrder]:
+            self.runtime_int_enum(enum)
 
         self.root_namespace = global_namespace.child(*namespace)
 
@@ -98,11 +100,21 @@ class TypeSystem(LoggerMixin):
         assert enum is not None
         self._register_primitive(name, enum.primitive)
 
-    def register(self, name: str, *namespace: str) -> Protocol:
+    def register(
+        self,
+        name: str,
+        *namespace: str,
+        byte_order: Union[ByteOrder, RegistryKey] = DEFAULT_BYTE_ORDER,
+    ) -> Protocol:
         """Register a custom type."""
 
         resolved = self._name(name, *namespace, check_available=True)
-        new_type = Protocol(self._enums, alias=resolved)
+        new_type = Protocol(
+            self._enums,
+            alias=resolved,
+            identifier=self.custom_ids(),
+            byte_order=byte_order,
+        )
         self.custom[resolved] = new_type
         return new_type
 

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/enum/registry.py

@@ -63,6 +63,11 @@ class RuntimeIntEnum(_IntEnum):
 
         return data
 
+    @classmethod
+    def id(cls) -> _Optional[int]:
+        """Override in sub-class to coerce enum id."""
+        return None
+
     @classmethod
     def primitive(cls) -> str:
         """The underlying primitive type for this runtime enumeration."""
@@ -89,6 +94,11 @@ class RuntimeIntEnum(_IntEnum):
 
         data = _RuntimeEnum.data_from_enum(cls)
         data["primitive"] = cls.primitive()
+
+        ident = cls.id()
+        if ident is not None:
+            data["id"] = ident
+
         result = registry.register_dict(name, data)
-        assert result is not None
+        assert result is not None, (name, data)
         return result

runtimepy-5.11.3/runtimepy/primitives/byte_order.py

@@ -0,0 +1,65 @@
+"""
+A module implementing an enumeration for byte ordering options.
+"""
+
+# built-in
+from typing import Optional
+
+# internal
+from runtimepy.enum.registry import EnumRegistry, RuntimeIntEnum
+
+
+class ByteOrder(RuntimeIntEnum):
+    """An enumeration for viable byte orders."""
+
+    NATIVE = 1
+    LITTLE_ENDIAN = 2
+    BIG_ENDIAN = 3
+    NETWORK = 4
+
+    @property
+    def fmt(self) -> str:
+        """Get the struct formatter for this byte order."""
+
+        if self is ByteOrder.NATIVE:
+            return "@"
+        if self is ByteOrder.LITTLE_ENDIAN:
+            return "<"
+        if self is ByteOrder.BIG_ENDIAN:
+            return ">"
+        return "!"
+
+    def __str__(self) -> str:
+        """Get this byte order as a string."""
+        return self.fmt
+
+    @classmethod
+    def id(cls) -> Optional[int]:
+        """Override in sub-class to coerce enum id."""
+        return 1
+
+
+# https://en.cppreference.com/w/cpp/types/endian
+STD_ENDIAN = {
+    "little": ByteOrder.LITTLE_ENDIAN,
+    "big": ByteOrder.BIG_ENDIAN,
+    "native": ByteOrder.NATIVE,
+}
+
+
+DEFAULT_BYTE_ORDER = ByteOrder.NETWORK
+
+
+def enum_registry(
+    *kinds: type[RuntimeIntEnum], register_byte_order: bool = True
+) -> EnumRegistry:
+    """Create an enum registry with the provided custom types registered."""
+
+    result = EnumRegistry()
+
+    if register_byte_order:
+        ByteOrder.register_enum(result)
+
+    for kind in kinds:
+        kind.register_enum(result)
+    return result

{runtimepy-5.11.1 → runtimepy-5.11.3}/runtimepy/util.py

@@ -34,10 +34,10 @@ def normalize_root(*src_parts: Union[str, Path]) -> Path:
 class Identifier:
     """A simple message indentifier interface."""
 
-    def __init__(self) -> None:
+    def __init__(self, start: int = 1, scale: int = 2) -> None:
         """Initialize this instance."""
-        self.curr_id: int = 1
-        self.scale = 2
+        self.curr_id = start
+        self.scale = scale
 
     def __call__(self) -> int:
         """Get the next identifier."""

{runtimepy-5.11.1 → runtimepy-5.11.3/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.11.1
+Version: 5.11.3
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,11 +17,11 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: psutil
+Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
 Requires-Dist: aiofiles
 Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: psutil
-Requires-Dist: svgen>=0.7.4
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -50,11 +50,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.1.4
-    hash=4ef876633bf905b103835e81db45e721
+    hash=8e8d3499d8579ca086dc80c977f6fd7f
     =====================================
 -->
 
-# runtimepy ([5.11.1](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.3](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/vkottler/runtimepy/workflows/Python%20Package/badge.svg)

runtimepy-5.11.1/runtimepy/primitives/byte_order.py

@@ -1,34 +0,0 @@
-"""
-A module implementing an enumeration for byte ordering options.
-"""
-
-# internal
-from runtimepy.enum.registry import RuntimeIntEnum as _RuntimeIntEnum
-
-
-class ByteOrder(_RuntimeIntEnum):
-    """An enumeration for viable byte orders."""
-
-    NATIVE = 1
-    LITTLE_ENDIAN = 2
-    BIG_ENDIAN = 3
-    NETWORK = 4
-
-    @property
-    def fmt(self) -> str:
-        """Get the struct formatter for this byte order."""
-
-        if self is ByteOrder.NATIVE:
-            return "@"
-        if self is ByteOrder.LITTLE_ENDIAN:
-            return "<"
-        if self is ByteOrder.BIG_ENDIAN:
-            return ">"
-        return "!"
-
-    def __str__(self) -> str:
-        """Get this byte order as a string."""
-        return self.fmt
-
-
-DEFAULT_BYTE_ORDER = ByteOrder.NETWORK