runtimepy 5.4.3__tar.gz → 5.5.0__tar.gz

{runtimepy-5.4.3/runtimepy.egg-info → runtimepy-5.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.4.3
+Version: 5.5.0
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,10 +17,10 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: websockets
 Requires-Dist: svgen>=0.6.8
-Requires-Dist: vcorelib>=3.3.1
 Requires-Dist: psutil
-Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.3.1
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -44,11 +44,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     generator=datazen
     version=3.1.4
-    hash=76ca13ab011b845de4580fd0bc1f9deb
+    hash=5c5edaf1332d842e9ca04a018455beba
     =====================================
 -->
 
-# runtimepy ([5.4.3](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.5.0](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)
@@ -90,7 +90,7 @@ This package is tested on the following platforms:
 $ ./venv3.12/bin/runtimepy -h
 
 usage: runtimepy [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
-                 {arbiter,server,task,tftp,tui,noop} ...
+                 {arbiter,mtu,server,task,tftp,tui,noop} ...
 
 A framework for implementing Python services.
 
@@ -104,9 +104,10 @@ options:
   -C DIR, --dir DIR     execute from a specific directory
 
 commands:
-  {arbiter,server,task,tftp,tui,noop}
+  {arbiter,mtu,server,task,tftp,tui,noop}
                         set of available commands
     arbiter             run a connection-arbiter application from a config
+    mtu                 probe for MTU size to some endpoint
     server              run a server for a specific connection factory
     task                run a task from a specific task factory
     tftp                perform a tftp interaction
@@ -138,6 +139,27 @@ options:
 
 ```
 
+### `mtu`
+
+```
+$ ./venv3.12/bin/runtimepy mtu -h
+
+usage: runtimepy mtu [-h] [--probe-size PROBE_SIZE] [--fallback FALLBACK] [-t]
+                     destination [destination ...]
+
+positional arguments:
+  destination           endpoint parameters (host, port[, flowinfo, scope_id])
+
+options:
+  -h, --help            show this help message and exit
+  --probe-size PROBE_SIZE
+                        data payload size to use for probe (default: 1432)
+  --fallback FALLBACK   fallback MTU value if probing doesn't succeed (i.e.
+                        not on Linux, default: 1500)
+  -t, --tcp             use TCP instead of UDP
+
+```
+
 ### `server`
 
 ```

{runtimepy-5.4.3 → runtimepy-5.5.0}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=76ca13ab011b845de4580fd0bc1f9deb
+    hash=5c5edaf1332d842e9ca04a018455beba
     =====================================
 -->
 
-# runtimepy ([5.4.3](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.5.0](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)
@@ -48,7 +48,7 @@ This package is tested on the following platforms:
 $ ./venv3.12/bin/runtimepy -h
 
 usage: runtimepy [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
-                 {arbiter,server,task,tftp,tui,noop} ...
+                 {arbiter,mtu,server,task,tftp,tui,noop} ...
 
 A framework for implementing Python services.
 
@@ -62,9 +62,10 @@ options:
   -C DIR, --dir DIR     execute from a specific directory
 
 commands:
-  {arbiter,server,task,tftp,tui,noop}
+  {arbiter,mtu,server,task,tftp,tui,noop}
                         set of available commands
     arbiter             run a connection-arbiter application from a config
+    mtu                 probe for MTU size to some endpoint
     server              run a server for a specific connection factory
     task                run a task from a specific task factory
     tftp                perform a tftp interaction
@@ -96,6 +97,27 @@ options:
 
 ```
 
+### `mtu`
+
+```
+$ ./venv3.12/bin/runtimepy mtu -h
+
+usage: runtimepy mtu [-h] [--probe-size PROBE_SIZE] [--fallback FALLBACK] [-t]
+                     destination [destination ...]
+
+positional arguments:
+  destination           endpoint parameters (host, port[, flowinfo, scope_id])
+
+options:
+  -h, --help            show this help message and exit
+  --probe-size PROBE_SIZE
+                        data payload size to use for probe (default: 1432)
+  --fallback FALLBACK   fallback MTU value if probing doesn't succeed (i.e.
+                        not on Linux, default: 1500)
+  -t, --tcp             use TCP instead of UDP
+
+```
+
 ### `server`
 
 ```

{runtimepy-5.4.3 → runtimepy-5.5.0}/pyproject.toml

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

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/__init__.py

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

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/channel/environment/__init__.py

@@ -29,11 +29,6 @@ class ChannelEnvironment(
 ):
     """A class integrating channel and enumeration registries."""
 
-    @property
-    def names(self) -> _Iterator[str]:
-        """Iterate over registered names in the environment."""
-        yield from self.channels.names.names
-
     def search_names(
         self, pattern: str, exact: bool = False
     ) -> _Iterator[str]:

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/channel/environment/array.py

@@ -4,6 +4,7 @@ A channel-environment extension for creating arrays of primitives.
 
 # built-in
 from typing import Iterable as _Iterable
+from typing import Iterator as _Iterator
 from typing import NamedTuple
 from typing import Optional as _Optional
 
@@ -23,9 +24,9 @@ class ChannelArray(NamedTuple):
     array: _PrimitiveArray
 
     @staticmethod
-    def create() -> "ChannelArray":
+    def create(**kwargs) -> "ChannelArray":
         """Create a new, empty channel array."""
-        return ChannelArray([], _PrimitiveArray())
+        return ChannelArray([], _PrimitiveArray(**kwargs))
 
 
 class ArrayChannelEnvironment(_BaseChannelEnvironment):
@@ -33,12 +34,19 @@ class ArrayChannelEnvironment(_BaseChannelEnvironment):
     A channel-environment extension for working with arrays of primitives.
     """
 
-    def array(self, keys: _Iterable[_RegistryKey]) -> ChannelArray:
+    @property
+    def names(self) -> _Iterator[str]:
+        """Iterate over registered names in the environment."""
+        yield from self.channels.names.names
+
+    def array(
+        self, keys: _Iterable[_RegistryKey] = None, **kwargs
+    ) -> ChannelArray:
         """
         Create a primitive array from an in-order iterable of registry keys.
         """
 
-        result = ChannelArray.create()
+        result = ChannelArray.create(**kwargs)
 
         curr_fields: _Optional[_BitFields] = None
         invalid_field_names: set[str] = set()
@@ -46,6 +54,9 @@ class ArrayChannelEnvironment(_BaseChannelEnvironment):
 
         names: set[str] = set()
 
+        if keys is None:
+            keys = self.names
+
         for key in keys:
             # All keys must be registered names.
             name = self.channels.names.name(key)

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/channel/environment/base.py

@@ -24,8 +24,6 @@ from runtimepy.enum import RuntimeEnum as _RuntimeEnum
 from runtimepy.enum.registry import EnumRegistry as _EnumRegistry
 from runtimepy.mixins.finalize import FinalizeMixin
 from runtimepy.primitives import BaseIntPrimitive, StrToBool
-
-# third-party
 from runtimepy.primitives.evaluation import EvalResult, Operator, sample_for
 from runtimepy.primitives.field import BitField as _BitField
 from runtimepy.primitives.field.fields import BitFields as _BitFields

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/channel/environment/sample.py

@@ -7,19 +7,18 @@ from random import randint, random
 
 # internal
 from runtimepy.channel.environment import ChannelEnvironment
+from runtimepy.enum import RuntimeEnum
 from runtimepy.primitives import Uint8
 from runtimepy.primitives.field import BitField, BitFlag
 
 
-def sample_env(env: ChannelEnvironment = None) -> ChannelEnvironment:
-    """Register sample enumerations and channels to an environment."""
+def sample_int_enum(
+    env: ChannelEnvironment, name: str = "SampleEnum"
+) -> RuntimeEnum:
+    """A sample integer enumeration."""
 
-    if env is None:
-        env = ChannelEnvironment()
-
-    # Register an enum.
-    sample_enum = env.enum(
-        "SampleEnum",
+    return env.enum(
+        name,
         "int",
         items={
             "zero": 0,
@@ -36,12 +35,16 @@ def sample_env(env: ChannelEnvironment = None) -> ChannelEnvironment:
         },
     )
 
-    # Boolean enumeration.
-    env.enum("OnOff", "bool", {"On": True, "Off": False})
-    env.bool_channel("sample_state", commandable=True, enum="OnOff")
 
-    env.enum(
-        "InsanelyLongEnumNameForTesting",
+def long_name_int_enum(
+    env: ChannelEnvironment,
+    name: str = "InsanelyLongEnumNameForTesting",
+    channel: str = "sample_enum",
+) -> RuntimeEnum:
+    """Add an integer enumeration with a long name."""
+
+    result = env.enum(
+        name,
         "int",
         {
             "very_long_member_name_0": 0,
@@ -50,40 +53,101 @@ def sample_env(env: ChannelEnvironment = None) -> ChannelEnvironment:
             "very_long_member_name_3": 3,
         },
     )
-    env.int_channel(
-        "sample_enum", commandable=True, enum="InsanelyLongEnumNameForTesting"
+
+    if channel:
+        env.int_channel(
+            channel,
+            commandable=True,
+            enum="InsanelyLongEnumNameForTesting",
+            description="A sample long-enum-name channel.",
+        )
+
+    return result
+
+
+def sample_bool_enum(
+    env: ChannelEnvironment, name: str = "OnOff", channel: str = "sample_state"
+) -> RuntimeEnum:
+    """A sample boolean enumeration."""
+
+    result = env.enum(name, "bool", {"On": True, "Off": False})
+
+    if channel:
+        env.bool_channel(
+            channel,
+            commandable=True,
+            enum="OnOff",
+            description="A sample on-off state channel.",
+        )
+
+    return result
+
+
+def sample_fields(env: ChannelEnvironment, enum: str = "SampleEnum") -> None:
+    """Add sample bit-fields to an environment."""
+
+    with env.names_pushed("fields"):
+        prim = Uint8()
+        env.int_channel("raw", prim)
+
+        # Add a bit field and flag.
+        env.add_field(BitFlag("flag1", prim, 0))
+        env.add_field(
+            BitFlag(
+                "flag2",
+                prim,
+                1,
+                commandable=True,
+                description="Sample bit flag.",
+            )
+        )
+        env.add_field(
+            BitField(
+                "field1",
+                prim,
+                2,
+                2,
+                enum=enum if enum else None,
+                commandable=True,
+                description="Sample bit field.",
+            )
+        )
+        env.add_field(BitField("field2", prim, 4, 4, commandable=True))
+
+
+def sample_float(
+    env: ChannelEnvironment,
+    channel: str = "sample_float",
+    kind: str = "double",
+) -> None:
+    """Add a sample floating-point channel."""
+
+    env.float_channel(
+        channel,
+        kind,
+        commandable=True,
+        description="A sample floating-point member.",
     )
-    env.float_channel("sample_float", "double", commandable=True)
+
+
+def sample_env(env: ChannelEnvironment = None) -> ChannelEnvironment:
+    """Register sample enumerations and channels to an environment."""
+
+    if env is None:
+        env = ChannelEnvironment()
+
+    # Register an enum.
+    sample_int_enum(env)
+
+    # Boolean enumeration.
+    sample_bool_enum(env)
+
+    long_name_int_enum(env)
+    sample_float(env)
 
     for name in ["a", "b", "c"]:
         with env.names_pushed(name):
-            with env.names_pushed("fields"):
-                prim = Uint8()
-                env.int_channel("raw", prim)
-
-                # Add a bit field and flag.
-                env.add_field(BitFlag("flag1", prim, 0))
-                env.add_field(
-                    BitFlag(
-                        "flag2",
-                        prim,
-                        1,
-                        commandable=True,
-                        description="Sample bit flag.",
-                    )
-                )
-                env.add_field(
-                    BitField(
-                        "field1",
-                        prim,
-                        2,
-                        2,
-                        enum=sample_enum.id,
-                        commandable=True,
-                        description="Sample bit field.",
-                    )
-                )
-                env.add_field(BitField("field2", prim, 4, 4, commandable=True))
+            sample_fields(env)
 
             for i in range(10):
                 with env.names_pushed(str(i)):

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/commands/all.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=5162b7ebed95a36719dad0f72cd0872f
+# hash=1814b7f7fae3556a0dbeec37141e4182
 # =====================================
 
 """
@@ -17,6 +17,7 @@ from vcorelib.args import CommandRegister as _CommandRegister
 
 # internal
 from runtimepy.commands.arbiter import add_arbiter_cmd
+from runtimepy.commands.mtu import add_mtu_cmd
 from runtimepy.commands.server import add_server_cmd
 from runtimepy.commands.task import add_task_cmd
 from runtimepy.commands.tftp import add_tftp_cmd
@@ -32,6 +33,11 @@ def commands() -> _List[_Tuple[str, str, _CommandRegister]]:
             "run a connection-arbiter application from a config",
             add_arbiter_cmd,
         ),
+        (
+            "mtu",
+            "probe for MTU size to some endpoint",
+            add_mtu_cmd,
+        ),
         (
             "server",
             "run a server for a specific connection factory",

runtimepy-5.5.0/runtimepy/commands/mtu.py

@@ -0,0 +1,57 @@
+"""
+An entry-point for the 'mtu' command.
+"""
+
+# built-in
+import argparse
+import socket
+
+# third-party
+from vcorelib.args import CommandFunction
+
+# internal
+from runtimepy.net.mtu import ETHERNET_MTU, UDP_DEFAULT_MTU, discover_mtu
+
+
+def mtu_cmd(args: argparse.Namespace) -> int:
+    """Execute the mtu command."""
+
+    discover_mtu(
+        args.destination[0],
+        *(int(x) for x in args.destination[1:]),
+        probe_size=args.probe_size,
+        fallback=args.fallback,
+        kind=socket.SOCK_STREAM if args.tcp else socket.SOCK_DGRAM,
+    )
+
+    return 0
+
+
+def add_mtu_cmd(parser: argparse.ArgumentParser) -> CommandFunction:
+    """Add mtu-command arguments to its parser."""
+
+    parser.add_argument(
+        "--probe-size",
+        type=int,
+        default=UDP_DEFAULT_MTU,
+        help="data payload size to use for probe (default: %(default)d)",
+    )
+    parser.add_argument(
+        "--fallback",
+        type=int,
+        default=ETHERNET_MTU,
+        help="fallback MTU value if probing doesn't succeed "
+        "(i.e. not on Linux, default: %(default)d)",
+    )
+
+    parser.add_argument(
+        "-t", "--tcp", action="store_true", help="use TCP instead of UDP"
+    )
+
+    parser.add_argument(
+        "destination",
+        nargs="+",
+        help="endpoint parameters (host, port[, flowinfo, scope_id])",
+    )
+
+    return mtu_cmd

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/commands/tftp.py

@@ -6,7 +6,6 @@ An entry-point for the 'tftp' command.
 import argparse
 import asyncio
 from pathlib import Path
-from socket import getaddrinfo
 
 # third-party
 from vcorelib.args import CommandFunction
@@ -16,13 +15,16 @@ from vcorelib.asyncio import run_handle_stop
 from runtimepy.net.udp.tftp import TFTP_PORT, tftp_read, tftp_write
 from runtimepy.net.udp.tftp.base import DEFAULT_TIMEOUT_S, REEMIT_PERIOD_S
 from runtimepy.net.udp.tftp.enums import DEFAULT_MODE
+from runtimepy.net.util import normalize_host
 
 
 def tftp_cmd(args: argparse.Namespace) -> int:
     """Execute the tftp command."""
 
+    host = normalize_host(args.host, args.port)
+
     # Resolve hostname as early as possible.
-    addr = (getaddrinfo(args.host, None)[0][4][0], args.port)
+    addr = host.address_str_tuple
 
     stop_sig = asyncio.Event()
     kwargs = {

{runtimepy-5.4.3 → runtimepy-5.5.0}/runtimepy/data/js/classes/TabInterface.js

@@ -43,6 +43,9 @@ class TabInterface {
         /* Update global reference. */
         shown_tab = this.name;
         hash.setTab(shown_tab);
+
+        /* Audit vertical bar position. */
+        this.correctVerticalBarPosition();
       }
       this.worker.send({kind : msg});
     } ];
@@ -51,6 +54,11 @@ class TabInterface {
     this.initCommand();
     this.initControls();
     this.initButton();
+
+    /* Ensure vertical divider is always visible. */
+    window.addEventListener(
+        "resize",
+        ((event) => { this.correctVerticalBarPosition(); }).bind(this));
   }
 
   initCommand() {
@@ -131,9 +139,9 @@ class TabInterface {
     }
 
     /* Initialize channel table and plot divider. */
-    let divider = this.query(".vertical-divider");
-    if (divider) {
-      this.setupVerticalDivider(divider);
+    this.divider = this.query(".vertical-divider");
+    if (this.divider) {
+      this.setupVerticalDivider(this.divider);
     }
 
     /* Initialize sliders. */
@@ -185,12 +193,22 @@ class TabInterface {
 
       let origX = event.clientX || event.touches[0].clientX;
 
+      let barWidth = 0;
+      if (this.divider) {
+        barWidth = this.divider.clientWidth;
+      }
+
       /* Track mouse movement while the mouse is held down. */
       let handleMouse = (event) => {
         let eventX = event.clientX || event.touches[0].clientX;
 
         let deltaX = origX - eventX;
-        elem.style.width = elem.getBoundingClientRect().width - deltaX + "px";
+
+        let rect = elem.getBoundingClientRect();
+
+        /* No use in allowing dragging out of view. */
+        let minWidth = window.innerWidth - (rect.left + barWidth);
+        elem.style.width = Math.min(minWidth, rect.width - deltaX) + "px";
         origX = eventX;
       };
       document.addEventListener(move, handleMouse);
@@ -206,6 +224,21 @@ class TabInterface {
     setupCursorContext(elem, this.setupVerticalDividerEvents.bind(this));
   }
 
+  correctVerticalBarPosition(elem) {
+    if (shown_tab == this.name && this.divider) {
+      let margin =
+          window.innerWidth - this.divider.getBoundingClientRect().right;
+
+      if (margin < 0) {
+        let column = this.query(".channel-column");
+        if (column) {
+          column.style.width =
+              column.getBoundingClientRect().width + margin + "px";
+        }
+      }
+    }
+  }
+
   initPlot() {
     let plot = this.query(`#${this.queryName}-plot`);
     if (plot) {

runtimepy-5.5.0/runtimepy/data/sample_telemetry.yaml

@@ -0,0 +1,29 @@
+---
+factories:
+  - {name: runtimepy.telemetry.sample.SampleTelemetry}
+  - {name: runtimepy.telemetry.sample.SampleTelemetryStruct}
+  - {name: runtimepy.telemetry.sample.SampleTelemetryPeriodic}
+
+structs:
+  - name: tx
+    factory: SampleTelemetryStruct
+  - name: rx
+    factory: SampleTelemetryStruct
+
+tasks:
+  - {name: tlm_periodic, factory: sample_telemetry_periodic, period_s: 0.01}
+
+ports:
+  - {name: udp_sample_telemetry, type: udp}
+
+clients:
+  - factory: SampleTelemetry
+    name: rx_conn
+    kwargs:
+      local_addr: ["0.0.0.0", "$udp_sample_telemetry"]
+
+  - factory: SampleTelemetry
+    name: tx_conn
+    defer: true
+    kwargs:
+      remote_addr: ["127.0.0.1", "$udp_sample_telemetry"]