Merge pull request #271 from vkottler/dev/5.6.4

5.6.4 - Initial file-polling task

.github/workflows/python-package.yml

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

.pylintrc

@@ -2,7 +2,7 @@
 max-args=10
 max-positional-arguments=10
 max-attributes=15
-max-parents=13
+max-parents=14
 max-public-methods=22
 max-branches=13
 

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=ac4d0a4097094aeb4e3f43c5f1128115
+    hash=41c5a2511c80b2cbbaee668bb6a75bd2
     =====================================
 -->
 
-# runtimepy ([5.6.3](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.6.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)

local/configs/package.yaml

@@ -7,7 +7,8 @@ entry: {{entry}}
 time_command: true
 
 requirements:
-  - vcorelib>=3.3.1
+  - aiofiles
+  - vcorelib>=3.4.2
   - svgen>=0.6.8
   - websockets
   - psutil
@@ -39,5 +40,9 @@ init_local: |
   METRICS_NAME = "metrics"
   DEFAULT_EXT = "yaml"
 
+mypy_local: |
+  [mypy-aiofiles.*]
+  ignore_missing_imports = True
+
 ci_local:
   - "- run: mk python-editable"

local/configs/python.yaml

@@ -1,7 +1,7 @@
 ---
 author_info:
   name: Vaughn Kottler
-  email: vaughnkottler@gmail.com
+  email: vaughn@libre-embedded.com
   username: vkottler
 versions: ["3.11", "3.12"]
 

local/variables/package.yaml

@@ -1,5 +1,5 @@
 ---
 major: 5
 minor: 6
-patch: 3
+patch: 4
 entry: runtimepy

mypy.ini

@@ -13,3 +13,7 @@ warn_unused_ignores = False
 strict = False
 disallow_any_generics = False
 strict_equality = False
+
+# runtimepy-specific configurations.
+[mypy-aiofiles.*]
+ignore_missing_imports = True

pyproject.toml

@@ -4,15 +4,15 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.6.3"
+version = "5.6.4"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.11"
 authors = [
-  {name = "Vaughn Kottler", email = "vaughnkottler@gmail.com"}
+  {name = "Vaughn Kottler", email = "vaughn@libre-embedded.com"}
 ]
 maintainers = [
-  {name = "Vaughn Kottler", email = "vaughnkottler@gmail.com"}
+  {name = "Vaughn Kottler", email = "vaughn@libre-embedded.com"}
 ]
 classifiers = [
   "Programming Language :: Python :: 3.11",

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=9547492b6c819241db9f6c010450b6ce
+# hash=beefe82269955725f177c01474f7cea1
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.6.3"
+VERSION = "5.6.4"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/channel/environment/command/__init__.py

@@ -15,6 +15,7 @@
 from vcorelib.io import ARBITER, JsonObject
 from vcorelib.logging import DEFAULT_TIME_FORMAT, LoggerMixin
 from vcorelib.math import default_time_ns, nano_str
+from vcorelib.names import name_search
 
 # internal
 from runtimepy.channel.environment import ChannelEnvironment
@@ -26,7 +27,6 @@
 )
 from runtimepy.channel.registry import ParsedEvent
 from runtimepy.mapping import DEFAULT_PATTERN
-from runtimepy.util import name_search
 
 # Declared so we re-export FieldOrChannel after moving where it's declared.
 __all__ = [

runtimepy/channel/environment/telemetry.py

@@ -6,6 +6,9 @@
 from contextlib import ExitStack, contextmanager
 from typing import BinaryIO, Iterator, Optional, cast
 
+# third-party
+from vcorelib.names import name_search
+
 # internal
 from runtimepy.channel.environment.base import (
     BaseChannelEnvironment as _BaseChannelEnvironment,
@@ -14,7 +17,6 @@
 from runtimepy.channel.registry import ParsedEvent
 from runtimepy.mapping import DEFAULT_PATTERN
 from runtimepy.metrics.channel import ChannelMetrics
-from runtimepy.util import name_search
 
 
 class TelemetryChannelEnvironment(_BaseChannelEnvironment):

runtimepy/data/css/bootstrap_extra.css

@@ -42,6 +42,7 @@
 
 .table-container {
   overflow-x: scroll;
+  min-height: fit-content;
 }
 
 .channel-column {

runtimepy/data/css/main.css

@@ -17,6 +17,10 @@ body > :first-child {
   height: 100%;
 }
 
+#runtimepy-tabs {
+  width: min-content;
+}
+
 #runtimepy-splash {
   position: fixed;
   top: 0;

runtimepy/data/dummy_load.yaml

@@ -9,7 +9,19 @@ tasks:
   # Sinusoids.
   - {name: wave1, factory: sinusoid, period_s: 0.01}
   - {name: wave2, factory: sinusoid, period_s: 0.02}
-  - {name: wave3, factory: sinusoid, period_s: 0.03}
+  - name: wave3
+    factory: sinusoid
+    period_s: 0.03
+    markdown: |
+      # Markdown for wave3
+
+      * list element 1
+      * list element 2
+      * list element 3
+
+      To be continued.
+
+      `peace`
 
   # Drive interactions with runtime entities that won't otherwise be polled.
   - {name: app, factory: SampleApp, period_s: 0.25}
@@ -21,6 +33,11 @@ clients:
     defer: true
     kwargs:
       remote_addr: [localhost, "$udp_json"]
+    markdown: |
+      # `udp_json_client`
+
+      Connects to `udp_json_server`.
+
   - factory: udp_json
     name: udp_json_server
     kwargs:
@@ -36,8 +53,19 @@ structs:
       b: 2
       c: 3
 
+      markdown: |
+        # Docs for `example.struct1`
+
+        Should be shown for peer process as well?
+
   - name: struct2
     factory: sample_struct
+    config:
+      markdown: |
+        # `struct2`
+
+        One of the structs of all time.
+
   - name: struct3
     factory: sample_struct
 
@@ -46,6 +74,11 @@ processes:
   - name: proc1
     factory: sample_peer
 
+    markdown: |
+      # Markdown for `proc1`
+
+      A process that
+
     # The peer itself runs an arbiter process.
     config:
       includes:

runtimepy/data/md/Connection.md

@@ -0,0 +1,3 @@
+# Connections
+
+To be continued.

runtimepy/data/md/PeriodicTask.md

@@ -0,0 +1,3 @@
+# Periodic Tasks
+
+To be continued.

runtimepy/data/md/RuntimeStruct.md

@@ -0,0 +1,3 @@
+# Runtime Structures
+
+To be continued.

runtimepy/data/md/RuntimepyPeer.md

@@ -0,0 +1,3 @@
+# Peer Programs
+
+To be continued.

runtimepy/data/md/SinusoidTask.md

@@ -0,0 +1,20 @@
+# Sinusoid Tasks
+
+## Intent
+
+These tasks compute
+[`math.sin`](https://docs.python.org/3/library/math.html#math.sin) and
+[`math.cos`](https://docs.python.org/3/library/math.html#math.cos) on every
+iteration, which advances one "step" per dispatch where the "step angle"
+advanced depends on the `steps` control.
+
+Once the current "step angle" is computed, controls `amplitude` and phase
+angles are considered for final `sin` and `cos` channel values.
+
+## Discussion
+
+* Is it worth adding a `tan` channel that computes
+[`math.tan`](https://docs.python.org/3/library/math.html#math.tan) and/or other
+trigonometric functions?
+* Is it worth adding a "number of steps" control, such that one task iteration
+could advance multiple waveform steps?

runtimepy/data/schemas/ClientConnectionConfig.yaml

@@ -2,6 +2,7 @@
 includes:
   - has_factory.yaml
   - has_name.yaml
+  - has_markdown.yaml
 
 properties:
   defer:

runtimepy/data/schemas/PeerProcessConfig.yaml

@@ -3,6 +3,7 @@ includes:
   - has_factory.yaml
   - has_name.yaml
   - has_config.yaml
+  - has_markdown.yaml
 
 required: [program]
 

runtimepy/data/schemas/TaskConfig.yaml

@@ -2,6 +2,7 @@
 includes:
   - has_factory.yaml
   - has_name.yaml
+  - has_markdown.yaml
 
 properties:
   period_s:

runtimepy/data/schemas/has_markdown.yaml

@@ -0,0 +1,4 @@
+---
+properties:
+  markdown:
+    type: string

runtimepy/mapping.py

@@ -13,10 +13,10 @@
 
 # third-party
 from vcorelib.logging import LoggerMixin
+from vcorelib.names import name_search
 
 # internal
 from runtimepy.mixins.regex import RegexMixin as _RegexMixin
-from runtimepy.util import name_search
 
 # This determines types that are valid as keys.
 T = _TypeVar("T", int, bool)

runtimepy/message/interface.py

@@ -11,7 +11,7 @@
 
 # third-party
 from vcorelib.dict.codec import JsonCodec
-from vcorelib.logging import LoggerType
+from vcorelib.logging import ListLogger, LoggerType
 from vcorelib.target.resolver import TargetResolver
 
 # internal
@@ -39,7 +39,7 @@
     T,
     TypedHandler,
 )
-from runtimepy.util import Identifier, ListLogger
+from runtimepy.util import Identifier
 
 
 class JsonMessageInterface:

runtimepy/mixins/environment.py

@@ -30,11 +30,14 @@ def __hash__(self) -> int:
         return id(self.env)
 
     def register_task_metrics(
-        self, metrics: PeriodicTaskMetrics, namespace: str = METRICS_NAME
+        self,
+        metrics: PeriodicTaskMetrics,
+        *names: str,
+        namespace: str = METRICS_NAME,
     ) -> None:
         """Register periodic task metrics."""
 
-        with self.env.names_pushed(namespace):
+        with self.env.names_pushed(namespace, *names):
             self.env.channel(
                 "dispatches",
                 metrics.dispatches,
@@ -104,11 +107,14 @@ def register_channel_metrics(
             )
 
     def register_connection_metrics(
-        self, metrics: ConnectionMetrics, namespace: str = METRICS_NAME
+        self,
+        metrics: ConnectionMetrics,
+        *names: str,
+        namespace: str = METRICS_NAME,
     ) -> None:
         """Register connection metrics."""
 
-        with self.env.names_pushed(namespace):
+        with self.env.names_pushed(namespace, *names):
             for name, direction, verb in [
                 ("tx", metrics.tx, "transmitted"),
                 ("rx", metrics.rx, "received"),