runtimepy 5.14.2__py3-none-any.whl → 5.15.1__py3-none-any.whl

runtimepy/enum/registry.py

@@ -6,6 +6,7 @@ A module implementing and enumeration registry.
 from enum import IntEnum as _IntEnum
 from typing import Optional as _Optional
 from typing import TypeVar
+from typing import Union as _Union
 from typing import cast as _cast
 
 # third-party
@@ -34,12 +35,15 @@ class EnumRegistry(_Registry[_RuntimeEnum]):
         kind: _EnumTypelike,
         items: _EnumMappingData = None,
         primitive: str = DEFAULT_ENUM_PRIMITIVE,
+        default: _Union[str, bool, int] = None,
     ) -> _Optional[_RuntimeEnum]:
         """Create a new runtime enumeration."""
 
         data: _JsonObject = {"type": _cast(str, kind), "primitive": primitive}
         if items is not None:
             data["items"] = items  # type: ignore
+        if default is not None:
+            data["default"] = default
         return self.register_dict(name, data)
 
 
@@ -68,6 +72,11 @@ class RuntimeIntEnum(_IntEnum):
         """Override in sub-class to coerce enum id."""
         return None
 
+    @classmethod
+    def default(cls: type[T]) -> _Optional[T]:
+        """Get a possible default value for this enumeration."""
+        return None
+
     @classmethod
     def primitive(cls) -> str:
         """The underlying primitive type for this runtime enumeration."""
@@ -81,7 +90,7 @@ class RuntimeIntEnum(_IntEnum):
     @classmethod
     def runtime_enum(cls, identifier: int) -> _RuntimeEnum:
         """Obtain a runtime enumeration from this class."""
-        return _RuntimeEnum.from_enum(cls, identifier)
+        return _RuntimeEnum.from_enum(cls, identifier, default=cls.default())
 
     @classmethod
     def register_enum(
@@ -99,6 +108,9 @@ class RuntimeIntEnum(_IntEnum):
         if ident is not None:
             data["id"] = ident
 
+        if cls.default() is not None:
+            data["default"] = cls.default()
+
         result = registry.register_dict(name, data)
         assert result is not None, (name, data)
         return result

runtimepy/message/__init__.py

@@ -9,7 +9,7 @@ from typing import Any
 from typing import Iterator as _Iterator
 
 # third-party
-from vcorelib.io import ByteFifo
+from vcorelib.io import BinaryMessage, ByteFifo
 
 # internal
 from runtimepy.primitives import Uint32, UnsignedInt
@@ -48,7 +48,7 @@ class MessageProcessor:
 
         self.message_length_out = self.message_length_kind()
 
-    def encode(self, stream: _BytesIO, data: bytes | str) -> None:
+    def encode(self, stream: _BytesIO, data: BinaryMessage | str) -> None:
         """Encode a message to a stream."""
 
         if isinstance(data, str):
@@ -72,7 +72,7 @@ class MessageProcessor:
         for message in self.process(data):
             yield loads(message.decode())
 
-    def process(self, data: bytes) -> _Iterator[bytes]:
+    def process(self, data: BinaryMessage) -> _Iterator[bytearray]:
         """Process an incoming message."""
 
         self.buffer.ingest(data)

runtimepy/mixins/logging.py

@@ -6,7 +6,7 @@ A module implementing a logger-mixin extension.
 from contextlib import AsyncExitStack
 import io
 import logging
-from typing import Any, Iterable
+from typing import Any, Iterable, Optional
 
 # third-party
 import aiofiles
@@ -27,6 +27,11 @@ class LogLevel(RuntimeIntEnum):
     ERROR = logging.ERROR
     CRITICAL = logging.CRITICAL
 
+    @classmethod
+    def id(cls) -> Optional[int]:
+        """Override in sub-class to coerce enum id."""
+        return 2
+
 
 LogLevellike = LogLevel | int | str
 

runtimepy/net/__init__.py

@@ -5,7 +5,6 @@ A module aggregating commonly used networking interface.
 # internal
 from runtimepy.net.backoff import ExponentialBackoff
 from runtimepy.net.connection import (
-    BinaryMessage,
     Connection,
     EchoConnection,
     NullConnection,
@@ -24,7 +23,6 @@ from runtimepy.net.util import (
 )
 
 __all__ = [
-    "BinaryMessage",
     "Connection",
     "EchoConnection",
     "NullConnection",

runtimepy/net/arbiter/info.py

@@ -3,29 +3,33 @@ A module implementing an application information interface.
 """
 
 # built-in
-from abc import ABC as _ABC
 import asyncio as _asyncio
 from contextlib import AsyncExitStack as _AsyncExitStack
 from contextlib import contextmanager
 from dataclasses import dataclass
+from importlib import import_module
 from logging import getLogger as _getLogger
 from re import compile as _compile
 from typing import Awaitable as _Awaitable
 from typing import Callable as _Callable
 from typing import Iterator as _Iterator
 from typing import MutableMapping as _MutableMapping
+from typing import Optional
 from typing import TYPE_CHECKING, Any
 from typing import TypeVar as _TypeVar
 from typing import Union as _Union
+from typing import cast
 
 # third-party
 from vcorelib.io.types import JsonObject as _JsonObject
 from vcorelib.logging import LoggerMixin as _LoggerMixin
 from vcorelib.logging import LoggerType as _LoggerType
+from vcorelib.names import import_str_and_item
 from vcorelib.namespace import Namespace as _Namespace
 
 # internal
 from runtimepy.channel.environment.sample import poll_sample_env, sample_env
+from runtimepy.codec.protocol import Protocol, ProtocolFactory
 from runtimepy.mapping import DEFAULT_PATTERN
 from runtimepy.mixins.trig import TrigMixin
 from runtimepy.net.arbiter.result import OverallResult, results
@@ -50,11 +54,13 @@ V = _TypeVar("V", bound=PeriodicTask)
 Z = _TypeVar("Z")
 
 
-class RuntimeStruct(RuntimeStructBase, _ABC):
+class RuntimeStruct(RuntimeStructBase):
     """A class implementing a base runtime structure."""
 
     app: "AppInfo"
     array: PrimitiveArray
+    recv: Optional[Protocol]
+    send: Optional[Protocol]
 
     byte_order: ByteOrder = DEFAULT_BYTE_ORDER
 
@@ -81,13 +87,39 @@ class RuntimeStruct(RuntimeStructBase, _ABC):
         if self.final_poll:
             self.app.stack.enter_context(self._final_poll())
 
+        byte_order = type(self).byte_order
+
+        self.recv = None
+        self.send = None
+        if "protocol_factory" in self.config:
+            module, name = import_str_and_item(
+                cast(str, self.config["protocol_factory"])
+            )
+            factory: type[ProtocolFactory] = getattr(
+                import_module(module), name
+            )
+            if ProtocolFactory in factory.__bases__:
+                self.recv = factory.singleton()
+                byte_order = self.recv.byte_order
+                with self.env.names_pushed("rx"):
+                    self.env.register_protocol(self.recv, False)
+
+                self.send = factory.instance()
+                with self.env.names_pushed("tx"):
+                    self.env.register_protocol(self.send, True)
+
         self.init_env()
-        self.update_byte_order(self.byte_order, **kwargs)
+        self.update_byte_order(byte_order, **kwargs)
 
     def update_byte_order(self, byte_order: ByteOrder, **kwargs) -> None:
         """Update the over-the-wire byte order for this struct."""
 
-        self.array = self.env.array(byte_order=byte_order, **kwargs).array
+        if self.recv is None:
+            self.array = self.env.array(byte_order=byte_order, **kwargs).array
+        else:
+            # Can't change byte order at runtime in this configuration.
+            assert byte_order == self.recv.byte_order
+            self.array = self.recv
 
 
 W = _TypeVar("W", bound=RuntimeStruct)

runtimepy/net/arbiter/struct/__init__.py

@@ -7,6 +7,7 @@ from io import BytesIO
 from typing import Generic, Iterator, Optional, TypeVar
 
 # third-party
+from vcorelib.io import BinaryMessage
 from vcorelib.math import default_time_ns
 from vcorelib.math.keeper import TimeSource
 
@@ -67,7 +68,7 @@ class TimestampedStruct(RuntimeStruct):
         self.array.update(data, timestamp_ns=timestamp_ns)
         return timestamp_ns
 
-    def process_datagram(self, data: bytes) -> Iterator[int]:
+    def process_datagram(self, data: BinaryMessage) -> Iterator[int]:
         """Process an array message."""
 
         size = self.array.size
@@ -190,7 +191,7 @@ class UdpStructTransceiver(UdpConnection, Generic[T]):
         """Handle individual struct updates."""
 
     async def process_datagram(
-        self, data: bytes, addr: tuple[str, int]
+        self, data: BinaryMessage, addr: tuple[str, int]
     ) -> bool:
         """Process an array of struct instances."""
 

runtimepy/net/connection.py

@@ -13,6 +13,7 @@ from typing import Union as _Union
 
 # third-party
 from vcorelib.asyncio import log_exceptions as _log_exceptions
+from vcorelib.io import BinaryMessage
 from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.logging import LoggerType as _LoggerType
 
@@ -29,8 +30,6 @@ from runtimepy.net.backoff import ExponentialBackoff
 from runtimepy.primitives import Bool, Uint8
 from runtimepy.primitives.byte_order import DEFAULT_BYTE_ORDER, ByteOrder
 
-BinaryMessage = _Union[bytes, bytearray, memoryview]
-
 
 class Connection(
     LoggerMixinLevelControl, ChannelEnvironmentMixin, MarkdownMixin, _ABC
@@ -142,7 +141,7 @@ class Connection(
         """Process a text frame."""
         raise NotImplementedError
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
         raise NotImplementedError
 
@@ -251,9 +250,9 @@ class Connection(
             await backoff.sleep()
             if await self.restart():
                 self._set_enabled(True)
-                self._restarts.raw.value += 1
+                self._restarts.increment()
 
-            self._restart_attempts.raw.value += 1
+            self._restart_attempts.increment()
 
     @asynccontextmanager
     async def process_then_disable(self, **kwargs) -> AsyncIterator[None]:
@@ -391,7 +390,7 @@ class EchoConnection(Connection):
         self.send_text(data)
         return True
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
         self.send_binary(data)
         return True
@@ -404,6 +403,6 @@ class NullConnection(Connection):
         """Process a text frame."""
         return True
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
         return True

runtimepy/net/html/__init__.py

@@ -5,7 +5,7 @@ A module implementing HTML-related interfaces.
 # built-in
 from io import StringIO
 from typing import Any, Optional
-from urllib.parse import parse_qs
+from urllib.parse import parse_qs, urlencode
 
 # third-party
 from svgen.element import Element
@@ -13,7 +13,6 @@ from svgen.element.html import Html, div
 from vcorelib import DEFAULT_ENCODING
 from vcorelib.io import IndentedFileWriter
 from vcorelib.paths import find_file
-from vcorelib.python import StrToBool
 
 # internal
 from runtimepy import PKG_NAME
@@ -37,20 +36,30 @@ def create_app_shell(
     """Create a bootstrap-based application shell."""
 
     container = div(parent=parent, **kwargs)
-    container.add_class("d-flex", "align-items-start", "bg-body")
+    container.add_class("d-flex", "align-items-start", "bg-body", "h-100")
 
     # Dark theme.
     container["data-bs-theme"] = bootstrap_theme
 
     # Buttons.
-    button_column = div(parent=container if use_button_column else None)
+    button_column = div(
+        id="button-column",
+        parent=container if use_button_column else None,
+        head_child=div(
+            class_str="flex-grow-1 border-bottom "
+            "bg-gradient-secondary-to-bottom"
+        ),
+        tail_child=div(
+            class_str="flex-grow-1 border-top bg-gradient-secondary-to-top"
+        ),
+    )
     button_column.add_class(
         "d-flex", "flex-column", "h-100", f"bg-{bootstrap_theme}-subtle"
     )
 
     # Dark/light theme switch button.
     bootstrap_button(
-        icon_str("lightbulb"),
+        icon_str("highlights"),
         tooltip="Toggle light/dark.",
         id="theme-button",
         parent=button_column,
@@ -95,26 +104,35 @@ def full_markdown_page(
 
     markdown_kwargs: dict[str, Any] = {"id": PKG_NAME}
 
+    params: dict[str, str] = {"print": "true"}
     if uri_query:
         parsed = parse_qs(uri_query)
+        for key, val in parsed.items():
+            params[key] = val[-1]
 
         # Handle pages optimized for document creation.
-        if "print" in parsed and any(
-            StrToBool.check(x) for x in parsed["print"]
-        ):
-            markdown_kwargs["bootstrap_theme"] = "light"
-            markdown_kwargs["use_button_column"] = False
+        # from vcorelib.python import StrToBool
+        # if "print" in parsed and any(
+        #     StrToBool.check(x) for x in parsed["print"]
+        # ):
+        #     markdown_kwargs["bootstrap_theme"] = "light"
+        #     markdown_kwargs["use_button_column"] = False
 
     _, button_column = markdown_page(
         document.body, markdown, **markdown_kwargs
     )
+    button_column.add_class("border-end")
 
     bootstrap_button(
         icon_str("printer"),
         tooltip="Printer-friendly view.",
         id="print-button",
         title="print-view button",
-        parent=div(tag="a", href="?print=true", parent=button_column),
+        parent=div(
+            tag="a",
+            href=f"?{urlencode(params)}#light-mode",
+            parent=button_column,
+        ),
     )
 
     # JavaScript.

runtimepy/net/html/bootstrap/__init__.py

@@ -8,8 +8,8 @@ from svgen.element import Element
 from svgen.element.html import div
 
 CDN = "cdn.jsdelivr.net"
-BOOTSTRAP_VERSION = "5.3.3"
-ICONS_VERSION = "1.11.3"
+BOOTSTRAP_VERSION = "5.3.6"
+ICONS_VERSION = "1.13.1"
 
 
 def icon_str(icon: str, classes: list[str] = None) -> str:

runtimepy/net/html/bootstrap/elements.py

@@ -4,7 +4,6 @@ A module for creating various bootstrap-related elements.
 
 # built-in
 from io import StringIO
-from typing import Optional
 
 # third-party
 from svgen.element import Element
@@ -15,7 +14,7 @@ from vcorelib.io.file_writer import IndentedFileWriter
 from runtimepy.net.html.bootstrap import icon_str
 
 TEXT = "font-monospace"
-BOOTSTRAP_BUTTON = f"rounded-0 {TEXT} button-bodge text-nowrap"
+BOOTSTRAP_BUTTON = f"rounded-0 {TEXT} text-start text-nowrap"
 
 
 def flex(kind: str = "row", **kwargs) -> Element:
@@ -26,21 +25,28 @@ def flex(kind: str = "row", **kwargs) -> Element:
     return container
 
 
-def set_tooltip(element: Element, data: str, placement: str = "right") -> None:
+DEFAULT_PLACEMENT = "right"
+
+
+def set_tooltip(
+    element: Element, data: str, placement: str = DEFAULT_PLACEMENT
+) -> None:
     """Set a tooltip on an element."""
 
     element["data-bs-title"] = data
     element["data-bs-placement"] = placement
-
-    # Should we use another mechanism for this?
-    element["class"] += " has-tooltip"
+    element.add_class("has-tooltip")
 
 
 BUTTON_COLOR = "secondary"
 
 
 def bootstrap_button(
-    text: str, tooltip: str = None, color: str = BUTTON_COLOR, **kwargs
+    text: str,
+    tooltip: str = None,
+    color: str = BUTTON_COLOR,
+    placement: str = DEFAULT_PLACEMENT,
+    **kwargs,
 ) -> Element:
     """Create a bootstrap button."""
 
@@ -52,7 +58,7 @@ def bootstrap_button(
         class_str=f"btn btn-{color} " + BOOTSTRAP_BUTTON,
     )
     if tooltip:
-        set_tooltip(button, tooltip)
+        set_tooltip(button, tooltip, placement=placement)
     return button
 
 
@@ -66,8 +72,9 @@ def collapse_button(
     """Create a collapse button."""
 
     collapse = bootstrap_button(icon_str(icon), tooltip=tooltip, **kwargs)
-    collapse["data-bs-toggle"] = toggle
-    collapse["data-bs-target"] = target
+    if target:
+        collapse["data-bs-toggle"] = toggle
+        collapse["data-bs-target"] = target
 
     return collapse
 
@@ -75,14 +82,18 @@ def collapse_button(
 def toggle_button(
     parent: Element,
     icon: str = "toggles",
-    title: Optional[str] = "toggle value",
+    title: str = None,
     icon_classes: list[str] = None,
     tooltip: str = None,
+    placement: str = "top",
     **kwargs,
 ) -> Element:
     """Add a boolean-toggle button."""
 
-    if title and not tooltip:
+    # if title and not tooltip:
+    if not title and tooltip:
+        kwargs["title"] = "see tooltip"
+    elif title:
         kwargs["title"] = title
 
     button = div(
@@ -90,31 +101,36 @@ def toggle_button(
         type="button",
         text=icon_str(icon, classes=icon_classes),
         parent=parent,
-        class_str="btn " + BOOTSTRAP_BUTTON,
+        class_str=f"btn {BOOTSTRAP_BUTTON}",
         **kwargs,
     )
     if tooltip:
-        set_tooltip(button, tooltip)
+        set_tooltip(button, tooltip, placement=placement)
 
     return button
 
 
 def input_box(
     parent: Element,
-    label: str = "filter",
+    label: str = "",
     pattern: str = ".*",
     description: str = None,
+    placement: str = "top",
+    icon: str = "",
     **kwargs,
-) -> None:
+) -> tuple[Element, Element, Element]:
     """Create command input box."""
 
     container = div(parent=parent, class_str="input-group")
 
-    label_elem = div(tag="span", parent=container, text=label)
+    label_elem = div(tag="span", parent=container)
     label_elem.add_class("input-group-text", "rounded-0", TEXT)
 
     if description:
-        set_tooltip(label_elem, description)
+        set_tooltip(label_elem, description, placement=placement)
+
+    if icon:
+        div(text=icon_str(icon), parent=label_elem)
 
     box = div(
         tag="input",
@@ -127,6 +143,8 @@ def input_box(
     )
     box.add_class("form-control", "rounded-0", TEXT)
 
+    return container, label_elem, box
+
 
 def slider(
     min_val: int | float, max_val: int | float, steps: int, **kwargs
@@ -180,17 +198,19 @@ def centered_markdown(
     container.add_class(
         "flex-grow-1",
         "d-flex",
-        "flex-column",
+        "flex-row",
         "justify-content-between",
         *container_classes,
     )
 
-    div(parent=container)
+    div(parent=container, class_str="flex-grow-1")
 
     horiz_container = div(parent=container)
-    horiz_container.add_class("d-flex", "flex-row", "justify-content-between")
+    horiz_container.add_class(
+        "d-flex", "flex-column", "justify-content-between"
+    )
 
-    div(parent=horiz_container)
+    div(parent=horiz_container, class_str="flex-grow-1")
 
     with StringIO() as stream:
         writer = IndentedFileWriter(stream)
@@ -216,8 +236,8 @@ def centered_markdown(
             preformatted=True,
         )
 
-    div(parent=horiz_container)
+    div(parent=horiz_container, class_str="flex-grow-1")
 
-    div(parent=container)
+    div(parent=container, class_str="flex-grow-1")
 
     return container

runtimepy/net/html/bootstrap/tabs.py

@@ -53,9 +53,7 @@ def create_nav_container(
 ) -> Element:
     """Create a navigation container element."""
 
-    content = div(
-        id=f"{name}-{item}", role="tabpanel", tabindex="0", parent=parent
-    )
+    content = div(id=f"{name}-{item}", role="tabpanel", parent=parent)
     content["aria-labelledby"] = f"{name}-{item}-tab"
 
     content.add_class("tab-pane", "fade")
@@ -86,16 +84,25 @@ class TabbedContent:
         self.container, self.button_column = create_app_shell(parent, id=name)
 
         # Toggle tabs button.
-        self.add_button("Toggle tabs", f"#{PKG_NAME}-tabs", id="tabs-button")
+        self.add_button(
+            "Toggle tabs",
+            f"#{PKG_NAME}-tabs",
+            id="tabs-button",
+            icon="list-task",
+        )
 
         # Create tab container.
         self.tabs = div(id=f"{PKG_NAME}-tabs", parent=self.container)
         self.tabs.add_class(
             "nav",
             "flex-column",
+            "flex-shrink-0",
+            "flex-nowrap",
             "nav-pills",
             "show",
-            "flex-column-scroll-bodge",
+            "h-100",
+            "overflow-y-scroll",
+            "overscroll-behavior-none",
         )
 
         # Create content container.
@@ -108,14 +115,14 @@ class TabbedContent:
         """Set classes on content element."""
 
         self.content["class"] = ""
-        self.content.add_class("tab-content", "tab-content-bodge")
+        self.content.add_class("tab-content", "w-100", "h-100")
         if scroll:
-            self.content.add_class("scroll")
+            self.content.add_class("overflow-scroll")
 
     def create(self, name: str) -> tuple[Element, Element]:
         """Only the first tab is active."""
 
-        container = flex(parent=self.tabs)
+        container = flex(parent=self.tabs).add_class("border-start")
 
         # Open in new window button.
         toggle_button(
@@ -123,9 +130,8 @@ class TabbedContent:
             id=name,
             icon="window-plus",
             title=f"Open '{name}' in a new window.",
-        ).add_class(
-            "border-start", "border-bottom", "window-button", "btn-link"
-        )
+            tabindex="-1",
+        ).add_class("border-bottom", "window-button", "btn-link")
 
         # Navigate to tab button.
         button = create_nav_button(
@@ -133,6 +139,7 @@ class TabbedContent:
             self.name,
             name,
             self.active_tab,
+            tabindex="-1",
             class_str="border-bottom border-end flex-grow-1",
         )
 

runtimepy/net/http/__init__.py

@@ -6,7 +6,7 @@ A module implementing an HTTP-message processing interface.
 from typing import Iterator, Optional, cast
 
 # third-party
-from vcorelib.io import ByteFifo
+from vcorelib.io import BinaryMessage, ByteFifo
 
 # internal
 from runtimepy.net.http.common import HeadersMixin
@@ -29,8 +29,8 @@ class HttpMessageProcessor:
         self.current_header: Optional[HeadersMixin] = None
 
     def ingest(
-        self, data: bytes, kind: type[T]
-    ) -> Iterator[tuple[T, Optional[bytes]]]:
+        self, data: BinaryMessage, kind: type[T]
+    ) -> Iterator[tuple[T, Optional[bytearray]]]:
         """Process a binary frame."""
 
         self.buffer.ingest(data)