Merge pull request #307 from vkottler/dev/5.11.3

5.11.3 - Improve ByteOrder handling

Author: vkottler

.github/workflows/python-package.yml

@@ -77,7 +77,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=runtimepy version=5.11.2
+                            repo=runtimepy version=5.11.3
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=8a7622d7187fa17bfcc479f8f6f78d1a
+    hash=8e8d3499d8579ca086dc80c977f6fd7f
     =====================================
 -->
 
-# runtimepy ([5.11.2](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)

local/variables/package.yaml

@@ -1,5 +1,5 @@
 ---
 major: 5
 minor: 11
-patch: 2
+patch: 3
 entry: runtimepy

pyproject.toml

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

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=c5b165c61995fe302ea31f7500b6359f
+# hash=f45f335bfb519a5a33f13603258a4d33
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.11.2"
+VERSION = "5.11.3"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/codec/system/__init__.py

@@ -10,15 +10,14 @@
 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 +53,7 @@ def __init__(self, *namespace: str) -> None:
         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,9 +64,8 @@ def __init__(self, *namespace: str) -> None:
         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)
 

runtimepy/enum/registry.py

@@ -100,14 +100,5 @@ def register_enum(
             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/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 @@ 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

tests/codec/system/test_system.py

@@ -79,7 +79,7 @@ def test_type_system_basic():
 
     system = get_test_system()
 
-    assert system.size("runtimepy::ByteOrder") == 1
+    assert system.size("ByteOrder") == 1
 
     new_type = system.register("SomeStruct")
     assert system.size("SomeStruct") == 0

tests/codec/test_protocol.py

@@ -15,6 +15,7 @@
 from runtimepy.codec.protocol.base import FieldSpec
 from runtimepy.enum.registry import EnumRegistry, RuntimeIntEnum
 from runtimepy.primitives import Uint32
+from runtimepy.primitives.byte_order import enum_registry
 from runtimepy.primitives.serializable import PrefixedChunk
 
 # internal
@@ -260,8 +261,7 @@ def primitive(cls) -> str:
         return "uint16"
 
 
-ENUMS = EnumRegistry()
-Enum1.register_enum(ENUMS)
+ENUMS = enum_registry(Enum1)
 
 
 class Test1(ProtocolFactory):

tests/data/valid/enums/sample_enum.yaml

@@ -1,14 +1,14 @@
 ---
 int1:
-  id: 1
+  id: 2
   type: int
   items:
     a: 1
     b: 2
     c: 3
 
 bool1:
-  id: 2
+  id: 3
   type: bool
   items:
     valve_open: true

tests/enum/test_registry.py

@@ -10,7 +10,8 @@
 from vcorelib.paths.context import tempfile
 
 # module under test
-from runtimepy.enum.registry import EnumRegistry, RuntimeIntEnum, enum_registry
+from runtimepy.enum.registry import EnumRegistry, RuntimeIntEnum
+from runtimepy.primitives.byte_order import enum_registry
 
 # internal
 from tests.resources import resource
@@ -50,10 +51,10 @@ def test_enum_registry_basic():
 
     enums = EnumRegistry.decode(resource("enums", "sample_enum.yaml"))
     assert enums.get("int1") is not None
-    assert enums.get(1) is not None
+    assert enums.get(2) is not None
     assert enums["bool1"].is_boolean
-    assert enums[2].is_boolean
-    assert enums[1].is_integer
+    assert enums[3].is_boolean
+    assert enums[2].is_integer
 
     with raises(KeyError):
         assert enums["bool2"]
@@ -66,7 +67,7 @@ def test_enum_registry_basic():
         is not None
     )
     assert (
-        enums.register_dict("int2", {"id": 1, "type": "int", "items": {}})
+        enums.register_dict("int2", {"id": 2, "type": "int", "items": {}})
         is None
     )
     assert enums.register_dict("!@#$", {}) is None