runtimepy 5.11.2__tar.gz → 5.11.4__tar.gz

{runtimepy-5.11.2/runtimepy.egg-info → runtimepy-5.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.11.2
+Version: 5.11.4
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -18,10 +18,10 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiofiles
+Requires-Dist: vcorelib>=3.5.1
 Requires-Dist: psutil
-Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
-Requires-Dist: vcorelib>=3.5.1
+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=8a7622d7187fa17bfcc479f8f6f78d1a
+    hash=0a7881b3e47a699bb3a235518a84f5ab
     =====================================
 -->
 
-# runtimepy ([5.11.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.4](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.2 → runtimepy-5.11.4}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=8a7622d7187fa17bfcc479f8f6f78d1a
+    hash=0a7881b3e47a699bb3a235518a84f5ab
     =====================================
 -->
 
-# runtimepy ([5.11.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.4](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.2 → runtimepy-5.11.4}/pyproject.toml

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

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/__init__.py

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

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/channel/environment/base.py

@@ -440,5 +440,6 @@ class BaseChannelEnvironment(_NamespaceMixin, FinalizeMixin):
 
         for fields in self.to_add:
             self.fields.add(fields)
+        self.to_add = []
 
         super().finalize(strict=strict)

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/channel/environment/sample.py

@@ -91,10 +91,10 @@ def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
         env.int_channel("raw", prim)
 
         # Add a bit field and flag.
-        env.add_field(BitFlag("flag1", prim, 0))
+        env.add_field(BitFlag(env.namespace(name="flag1"), prim, 0))
         env.add_field(
             BitFlag(
-                "flag2",
+                env.namespace(name="flag2"),
                 prim,
                 1,
                 commandable=True,
@@ -103,7 +103,7 @@ def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
         )
         env.add_field(
             BitField(
-                "field1",
+                env.namespace(name="field1"),
                 prim,
                 2,
                 2,
@@ -112,7 +112,11 @@ def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
                 description="Sample bit field.",
             )
         )
-        env.add_field(BitField("field2", prim, 4, 4, commandable=True))
+        env.add_field(
+            BitField(
+                env.namespace(name="field2"), prim, 4, 4, commandable=True
+            )
+        )
 
 
 def sample_float(

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/codec/protocol/base.py

@@ -21,7 +21,7 @@ from runtimepy.enum import RuntimeEnum as _RuntimeEnum
 from runtimepy.enum.registry import EnumRegistry as _EnumRegistry
 from runtimepy.primitives import AnyPrimitive as _AnyPrimitive
 from runtimepy.primitives import Primitivelike as _Primitivelike
-from runtimepy.primitives import create as _create
+from runtimepy.primitives import normalize_instance as _normalize_instance
 from runtimepy.primitives.array import PrimitiveArray
 from runtimepy.primitives.byte_order import (
     DEFAULT_BYTE_ORDER as _DEFAULT_BYTE_ORDER,
@@ -40,7 +40,7 @@ class FieldSpec(NamedTuple):
     """Information specifying a protocol field."""
 
     name: str
-    kind: _Primitivelike
+    kind: str
     enum: _Optional[_RegistryKey] = None
     array_length: _Optional[int] = None
 
@@ -49,7 +49,7 @@ class FieldSpec(NamedTuple):
 
         result: _JsonObject = {
             "name": self.name,
-            "kind": _create(self.kind).kind.name,
+            "kind": self.kind,
             "array_length": self.array_length,
         }
         if self.enum is not None:
@@ -58,7 +58,7 @@ class FieldSpec(NamedTuple):
 
 
 T = _TypeVar("T", bound="ProtocolBase")
-ProtocolBuild = list[_Union[int, FieldSpec, tuple[str, int]]]
+ProtocolBuild = list[_Union[tuple[int, str], FieldSpec, tuple[str, int]]]
 
 
 class ProtocolBase(PrimitiveArray):
@@ -114,16 +114,15 @@ class ProtocolBase(PrimitiveArray):
         if build is None:
             build = []
         for item in build:
-            if isinstance(item, int):
-                self._add_bit_fields(self._fields.fields[item])
-            elif isinstance(item, FieldSpec):
+            if isinstance(item, FieldSpec):
                 self.add_field(
                     item.name,
                     item.kind,
                     enum=item.enum,
                     array_length=item.array_length,
                 )
-            else:
+
+            elif isinstance(item[0], str):
                 assert serializables, (item, serializables)
                 name = item[0]
                 self.add_serializable(
@@ -133,6 +132,11 @@ class ProtocolBase(PrimitiveArray):
                 )
                 del serializables[name]
 
+            elif isinstance(item[0], int):
+                self._add_bit_fields(
+                    item[1], self._fields.fields[item[0]], index=item[0]
+                )
+
         # Ensure all serializables were handled via build.
         assert not serializables, serializables
 
@@ -169,15 +173,18 @@ class ProtocolBase(PrimitiveArray):
 
         instances = self.add_to_end(serializable, array_length=array_length)
         self._build.append((name, len(instances)))
+
+        assert name not in self.serializables, name
         self.serializables[name] = instances
 
     def add_field(
         self,
         name: str,
-        kind: _Primitivelike = None,
+        kind: _Primitivelike | _Optional[_AnyPrimitive] = None,
         enum: _RegistryKey = None,
         serializable: Serializable = None,
         array_length: int = None,
+        track: bool = True,
     ) -> None:
         """Add a new field to the protocol."""
 
@@ -201,30 +208,39 @@ class ProtocolBase(PrimitiveArray):
                 kind = runtime_enum.primitive
 
         assert kind is not None
+        inst = _normalize_instance(kind)
 
-        self._regular_fields[name] = self.add(
-            _create(kind), array_length=array_length
-        )
+        assert name not in self._regular_fields, name
+        self._regular_fields[name] = self.add(inst, array_length=array_length)
 
-        self._build.append(
-            FieldSpec(name, kind, enum, array_length=array_length)
-        )
+        if track:
+            self._build.append(
+                FieldSpec(
+                    name, inst.kind.name, enum, array_length=array_length
+                )
+            )
 
-    def _add_bit_fields(self, fields: _BitFields) -> None:
+    def _add_bit_fields(
+        self, name: str, fields: _BitFields, index: int = None
+    ) -> None:
         """Add a bit-fields instance."""
 
-        self._build.append(self._fields.add(fields))
-        self.add(fields.raw)
+        # If the index is known, these fields are already registered.
+        if index is None:
+            index = self._fields.add(fields)
+
+        self._build.append((index, name))
+        self.add_field(name, kind=fields.raw, track=False)
 
     @contextmanager
     def add_bit_fields(
-        self, kind: _Primitivelike = "uint8"
+        self, name: str, kind: _Primitivelike | _AnyPrimitive = "uint8"
     ) -> _Iterator[_BitFields]:
         """Add a bit-fields primitive to the protocol."""
 
         new = _BitFields.new(value=kind)
         yield new
-        self._add_bit_fields(new)
+        self._add_bit_fields(name, new)
 
     def value(
         self, name: str, resolve_enum: bool = True, index: int = 0

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/codec/protocol/json.py

@@ -79,7 +79,9 @@ class JsonProtocol(ProtocolBase):
         )
 
         # Export the build specification.
-        build: list[_Union[int, _JsonObject, str, tuple[str, int]]] = []
+        build: list[
+            _Union[tuple[int, str], _JsonObject, str, tuple[str, int]]
+        ] = []
         for item in self._build:
             if isinstance(item, FieldSpec):
                 build.append(item.asdict())

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/codec/system/__init__.py

@@ -3,6 +3,7 @@ A basic type-system implementation.
 """
 
 # built-in
+from contextlib import suppress
 from typing import Iterable, Optional, Union
 
 # third-party
@@ -10,15 +11,14 @@ 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 DEFAULT_BYTE_ORDER, ByteOrder
 from runtimepy.primitives.types import AnyPrimitiveType, PrimitiveTypes
 from runtimepy.registry.name import RegistryKey
 from runtimepy.util import Identifier
@@ -54,7 +54,7 @@ class TypeSystem(LoggerMixin):
         self.custom: dict[str, Protocol] = {}
         self.custom_ids = Identifier(scale=1)
 
-        self._enums = EnumRegistry()
+        self._enums = enum_registry(register_byte_order=False)
 
         global_namespace = Namespace(delim=CPP_DELIM)
 
@@ -65,12 +65,22 @@ 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)
 
+    def is_enum(self, name: str, *namespace: str, exact: bool = True) -> bool:
+        """Determine if the arguments identify a registered enumeration."""
+
+        result = False
+
+        with suppress(KeyError, AssertionError):
+            self.get_enum(name, *namespace, exact=exact)
+            result = True
+
+        return result
+
     def get_enum(
         self, name: str, *namespace: str, exact: bool = True
     ) -> RuntimeEnum:
@@ -120,6 +130,19 @@ class TypeSystem(LoggerMixin):
         self.custom[resolved] = new_type
         return new_type
 
+    def is_custom(
+        self, name: str, *namespace: str, exact: bool = True
+    ) -> bool:
+        """Determine if the parameters identify a custom type."""
+
+        result = False
+
+        with suppress(KeyError, AssertionError):
+            self.get_protocol(name, *namespace, exact=exact)
+            result = True
+
+        return result
+
     def get_protocol(
         self, name: str, *namespace: str, exact: bool = True
     ) -> Protocol:

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/enum/registry.py

@@ -100,14 +100,5 @@ class RuntimeIntEnum(_IntEnum):
             data["id"] = ident
 
         result = registry.register_dict(name, data)
-        assert result is not None
+        assert result is not None, (name, data)
         return result
-
-
-def enum_registry(*kinds: type[RuntimeIntEnum]) -> EnumRegistry:
-    """Create an enum registry with the provided custom types registered."""
-
-    result = EnumRegistry()
-    for kind in kinds:
-        kind.register_enum(result)
-    return result

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/primitives/__init__.py

@@ -119,3 +119,13 @@ def normalize(value: Primitivelike) -> type[AnyPrimitive]:
 def create(value: Primitivelike, **kwargs) -> AnyPrimitive:
     """Create an instance of a primitive."""
     return normalize(value)(**kwargs)
+
+
+def normalize_instance(
+    value: Primitivelike | AnyPrimitive, **kwargs
+) -> AnyPrimitive:
+    """Creates a new instance only if necessary."""
+
+    if not isinstance(value, Primitive):
+        value = create(value, **kwargs)
+    return value

runtimepy-5.11.4/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.2 → runtimepy-5.11.4}/runtimepy/primitives/field/fields.py

@@ -14,8 +14,9 @@ from vcorelib.io.types import JsonObject as _JsonObject
 from vcorelib.io.types import JsonValue as _JsonValue
 
 # internal
+from runtimepy.primitives import AnyPrimitive as _AnyPrimitive
 from runtimepy.primitives import Primitivelike as _Primitivelike
-from runtimepy.primitives import normalize as _normalize
+from runtimepy.primitives import normalize_instance as _normalize_instance
 from runtimepy.primitives.field import BitField as _BitField
 from runtimepy.primitives.field import BitFieldBase as _BitFieldBase
 from runtimepy.primitives.field import BitFlag as _BitFlag
@@ -37,7 +38,7 @@ class BitFields(_RuntimepyDictCodec):
 
         # Create the underlying storage element.
         self.raw: _UnsignedInt = _cast(
-            _UnsignedInt, _normalize(_cast(str, data["type"]))()
+            _UnsignedInt, _normalize_instance(_cast(str, data["type"]))
         )
 
         self.curr_index = 0
@@ -194,6 +195,8 @@ class BitFields(_RuntimepyDictCodec):
     def claim_field(self, field: _BitField) -> _BitField:
         """Claim a bit field."""
 
+        self._claim_bits(field.width, index=field.index)
+
         assert field.name not in self.fields, field.name
         self.fields[field.name] = field
         self.by_index[field.index] = field
@@ -216,7 +219,7 @@ class BitFields(_RuntimepyDictCodec):
             _BitField(
                 name,
                 self.raw,
-                self._claim_bits(width, index=index),
+                index if index is not None else self.curr_index,
                 width,
                 enum=enum,
                 description=description,
@@ -225,7 +228,9 @@ class BitFields(_RuntimepyDictCodec):
         )
 
     @classmethod
-    def new(cls: type[T], value: _Primitivelike = "uint8") -> T:
+    def new(
+        cls: type[T], value: _Primitivelike | _AnyPrimitive = "uint8"
+    ) -> T:
         """Create a new bit-field storage entity."""
 
         return cls.create(

{runtimepy-5.11.2 → runtimepy-5.11.4}/runtimepy/primitives/field/manager/base.py

@@ -100,6 +100,7 @@ class BitFieldsManagerBase:
         for name, field in fields.fields.items():
             ident = self.registry.register_name(name)
             assert ident is not None, "Couldn't register bit-field '{name}'!"
+            assert name not in self.lookup, name
             self.lookup[name] = index
 
             # Also store the enum mapping.
@@ -220,7 +221,11 @@ class BitFieldsManagerBase:
             new_fields.raw = prim
             self.by_primitive[prim] = new_fields
 
-        self.by_primitive[prim].claim_field(field)
+        fields = self.by_primitive[prim]
+        fields.claim_field(field)
+
+        if not fields.bits_available:
+            del self.by_primitive[prim]
 
         # self.add(new_fields, finalize=False)
         return new_fields

{runtimepy-5.11.2 → runtimepy-5.11.4/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.11.2
+Version: 5.11.4
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -18,10 +18,10 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiofiles
+Requires-Dist: vcorelib>=3.5.1
 Requires-Dist: psutil
-Requires-Dist: svgen>=0.7.4
 Requires-Dist: websockets
-Requires-Dist: vcorelib>=3.5.1
+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=8a7622d7187fa17bfcc479f8f6f78d1a
+    hash=0a7881b3e47a699bb3a235518a84f5ab
     =====================================
 -->
 
-# runtimepy ([5.11.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.11.4](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.2/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