runtimepy 5.11.1__py3-none-any.whl → 5.11.3__py3-none-any.whl

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/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/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/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/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/primitives/byte_order.py

@@ -2,11 +2,14 @@
 A module implementing an enumeration for byte ordering options.
 """
 
+# built-in
+from typing import Optional
+
 # internal
-from runtimepy.enum.registry import RuntimeIntEnum as _RuntimeIntEnum
+from runtimepy.enum.registry import EnumRegistry, RuntimeIntEnum
 
 
-class ByteOrder(_RuntimeIntEnum):
+class ByteOrder(RuntimeIntEnum):
     """An enumeration for viable byte orders."""
 
     NATIVE = 1
@@ -30,5 +33,33 @@ class ByteOrder(_RuntimeIntEnum):
         """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/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.dist-info → runtimepy-5.11.3.dist-info}/METADATA

@@ -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: websockets
 Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: aiofiles
+Requires-Dist: psutil
 Requires-Dist: svgen>=0.7.4
-Requires-Dist: websockets
+Requires-Dist: aiofiles
 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.dist-info → runtimepy-5.11.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-runtimepy/__init__.py,sha256=jnVk66eyyfxqRlrnXybadQhrpwK0h8K50mULrq-N3xg,391
+runtimepy/__init__.py,sha256=RJTUf2wSfvc8jMmH7nL4hTPvTdBOQNL3-pYVsf-5Dp8,391
 runtimepy/__main__.py,sha256=OPAed6hggoQdw-6QAR62mqLC-rCkdDhOq0wyeS2vDRI,332
 runtimepy/app.py,sha256=sTvatbsGZ2Hdel36Si_WUbNMtg9CzsJyExr5xjIcxDE,970
 runtimepy/dev_requirements.txt,sha256=j0dh11ztJAzfaUL0iFheGjaZj9ppDzmTkclTT8YKO8c,230
@@ -7,7 +7,7 @@ runtimepy/mapping.py,sha256=VQK1vzmQVvYYKI85_II37-hIEbvgL3PzNy-WI6TTo80,5091
 runtimepy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/requirements.txt,sha256=PdID4t7w3qsEoNwrMR-SJoH5OQ9oIUcpesKJC4AiU64,124
 runtimepy/schemas.py,sha256=zTgxPm9DHZ0R_bmmOjNQMTXdtM_Hb1bE-Fog40jDCgg,839
-runtimepy/util.py,sha256=GuyIHVFGMS02OR6-O3LnlV3DqG5hj4-IUud0QM6WicA,1684
+runtimepy/util.py,sha256=ZHSucNi-gbrcajoCv2dNjQs48dJPC3mTM_wZHx7AW1U,1719
 runtimepy/channel/__init__.py,sha256=pf0RJ5g37_FVV8xoUNgzFGuIfbZEYSBA_cQlJSDTPDo,4774
 runtimepy/channel/registry.py,sha256=nk36qM_Bf6qK6AFR0plaZHR1PU7b4LZqbQ0feJqk4lc,4784
 runtimepy/channel/environment/__init__.py,sha256=0Jj8g7Y4bdDvmWtzpegB9D4milGPhsZokoYxmps5zgU,1612
@@ -25,9 +25,9 @@ runtimepy/channel/event/__init__.py,sha256=9LCSNa1Iiwr6Q6JkwQGELDQ7rWfU_xjAMh6qM
 runtimepy/channel/event/header.py,sha256=eDRZgzzM5HZQ8QtV4DjyAsrAhEZyM7IfwqK6WB5ACEw,868
 runtimepy/codec/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/codec/protocol/__init__.py,sha256=Rg7RSKGn2UBpGMpwq1aCLUBA5h4pORdh53NfR7Cjw0U,1530
-runtimepy/codec/protocol/base.py,sha256=NRLB1ld0oB2IED5QRkwDwYsnHFG8gKtg3T7OHJ9_VkQ,10432
-runtimepy/codec/protocol/json.py,sha256=oiaJLCzptJ5uajnpO8EDYET8gIspZIrVuyLjLuAC5dw,4142
-runtimepy/codec/system/__init__.py,sha256=1Yy4RkNoh8tf6MTKZO1EszlCnE6jTevN2du4LU_-vxw,6933
+runtimepy/codec/protocol/base.py,sha256=aIQCuUYPhe7-jgaYaoNzq3UU57lnBzrLqIr0H7fnHFc,10464
+runtimepy/codec/protocol/json.py,sha256=gYGB_OEfZYySKQ_n3eDxYNs6Ku80FdawY5zDqjx9ctc,4315
+runtimepy/codec/system/__init__.py,sha256=MLmczvxKnZoPnaPb_22EVC4TdVEj6P0IClejv5WCZ18,7245
 runtimepy/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/commands/all.py,sha256=jH2dsmkqyBFe_2ZlPFpko0UCMW3fFfJsuGIbeJFbDoQ,1619
 runtimepy/commands/arbiter.py,sha256=CtTMRYpqCAN3vWHkkr9jqWpoF7JGNXafKIBFmkarAfc,1567
@@ -118,7 +118,7 @@ runtimepy/data/static/woff2/CascadiaMono-Italic.woff2,sha256=S31PimDgq0GV7XMRV-Y
 runtimepy/data/static/woff2/CascadiaMono-Regular.woff2,sha256=hHPAFO0U10TCKBw-UofHN2BLjax9qNClzN9oWGKkQx0,143936
 runtimepy/data/static/woff2/README.md,sha256=flHwSRmDxd6OnWhzxmnXzwio1Mong5tB4d8VgieWCOs,289
 runtimepy/enum/__init__.py,sha256=WIBMOaogauR1u7mK-I4Z5BZUoWANU7alIlrz82QdCmY,5820
-runtimepy/enum/registry.py,sha256=EU7oUejI60kzrhdtzgWpnFYP8h4CFLy_fxvGTwq1Uvc,2631
+runtimepy/enum/registry.py,sha256=b_oW8l-yNXvrVGfwQ2kKs2bqBk5pT48WBc2vXUTkJks,2861
 runtimepy/enum/types.py,sha256=uQYGvaAJVm5tUdwxn_SLHkTZHJpEf7364rTSL27necA,1027
 runtimepy/message/__init__.py,sha256=X5PZqSPGhNT4MruaiQjN4MwJHhy8gV9W32QXyxgS9-E,3004
 runtimepy/message/handlers.py,sha256=He9NC7MCkaV2clKc8dTSZ_T8N2l3ATjaTFzBr9n1T34,3775
@@ -233,7 +233,7 @@ runtimepy/noise/__init__.py,sha256=EJM7h3t_z74wwrn6FAFQwYE2yUcOZQ1K1IQqOb8Z0AI,3
 runtimepy/primitives/__init__.py,sha256=nwWJH1e0KN2NsVwQ3wvRtUpl9s9Ap8Q32NNZLGol0wU,2323
 runtimepy/primitives/base.py,sha256=BaGPUTeVMnLnTPcpjqnS2lzPN74Pe5C0XaQdgrTfW7A,9185
 runtimepy/primitives/bool.py,sha256=lATPgb1e62rjLn5XlJX8lP3tVYR3DlxV8RT9HpOMdT0,1640
-runtimepy/primitives/byte_order.py,sha256=80mMk1Sj_l49XvAtvrPmoYFpFYSM1HgYuwR2-P7os3Q,767
+runtimepy/primitives/byte_order.py,sha256=J2Pg3gXg8Lmu_uU2mduNJt3mnP_enwDI4Y-X8kWAUP0,1456
 runtimepy/primitives/evaluation.py,sha256=0N7mT8uoiJaY-coF2PeEXU2WO-FmbyN2Io9_EaghO9Q,4657
 runtimepy/primitives/float.py,sha256=6vzNKnnLzzM4vP10V4E0PHZQH6vTvIl34pId1oFtlqc,2146
 runtimepy/primitives/int.py,sha256=Ia2vtzXXfBb8fj1mgwu_PFpblrL2qzsN4Qwjvk5NhT4,3618
@@ -285,9 +285,9 @@ runtimepy/tui/task.py,sha256=nUZo9fuOC-k1Wpqdzkv9v1tQirCI28fZVgcC13Ijvus,1093
 runtimepy/tui/channels/__init__.py,sha256=evDaiIn-YS9uGhdo8ZGtP9VK1ek6sr_P1nJ9JuSET0o,4536
 runtimepy/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/ui/controls.py,sha256=yvT7h3thbYaitsakcIAJ90EwKzJ4b-jnc6p3UuVf_XE,1241
-runtimepy-5.11.1.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
-runtimepy-5.11.1.dist-info/METADATA,sha256=nTdV1gy7arFtuBI5Y-yZvzR5mao4DJwlu2dgKv14ra4,9395
-runtimepy-5.11.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-runtimepy-5.11.1.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.11.1.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.11.1.dist-info/RECORD,,
+runtimepy-5.11.3.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
+runtimepy-5.11.3.dist-info/METADATA,sha256=jorcstJRpdgXA-aUoZoyvC_cECYSEZSHA6XP0UWWxyU,9395
+runtimepy-5.11.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+runtimepy-5.11.3.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.11.3.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.11.3.dist-info/RECORD,,