runtimepy 5.15.4__tar.gz → 5.15.6__tar.gz

{runtimepy-5.15.4/runtimepy.egg-info → runtimepy-5.15.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.15.4
+Version: 5.15.6
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,11 +17,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vcorelib>=3.6.3
-Requires-Dist: websockets
-Requires-Dist: svgen>=0.8.0
 Requires-Dist: aiofiles
+Requires-Dist: svgen>=0.8.0
 Requires-Dist: psutil
+Requires-Dist: vcorelib>=3.6.4
+Requires-Dist: websockets
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -51,11 +51,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.2.3
-    hash=99eea1986d2105483ebb2fe566128f5f
+    hash=0f8ffdbd46445346cb834d066f58e765
     =====================================
 -->
 
-# runtimepy ([5.15.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.15.4 → runtimepy-5.15.6}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.2.3
-    hash=99eea1986d2105483ebb2fe566128f5f
+    hash=0f8ffdbd46445346cb834d066f58e765
     =====================================
 -->
 
-# runtimepy ([5.15.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
 
 [![python](https://img.shields.io/pypi/pyversions/runtimepy.svg)](https://pypi.org/project/runtimepy/)
 ![Build Status](https://github.com/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.15.4 → runtimepy-5.15.6}/pyproject.toml

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

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.3
-# hash=b0f0463a508c9a1312a071f5c0b06f3b
+# hash=08c1dda8bd5fefe13af6a8eb49063498
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.15.4"
+VERSION = "5.15.6"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/channel/environment/command/processor.py

@@ -20,6 +20,7 @@ from runtimepy.channel.environment.command.result import SUCCESS, CommandResult
 from runtimepy.mixins.environment import ChannelEnvironmentMixin
 from runtimepy.primitives.bool import Bool
 from runtimepy.primitives.field import BitField
+from runtimepy.ui.button import ActionButton
 
 CommandHook = Callable[[Namespace, Optional[FieldOrChannel]], None]
 
@@ -33,7 +34,11 @@ class ChannelCommandProcessor(ChannelEnvironmentMixin):
     """A command processing interface for channel environments."""
 
     def __init__(
-        self, env: ChannelEnvironment, logger: LoggerType, **kwargs
+        self,
+        env: ChannelEnvironment,
+        logger: LoggerType,
+        buttons: list[ActionButton] = None,
+        **kwargs,
     ) -> None:
         """Initialize this instance."""
 
@@ -49,6 +54,11 @@ class ChannelCommandProcessor(ChannelEnvironmentMixin):
 
         self.parser.initialize()
 
+        # Action buttons.
+        if buttons is None:
+            buttons = []
+        self.buttons: list[ActionButton] = buttons
+
     def register_custom_commands(
         self, *custom_commands: CustomCommand
     ) -> None:

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/css/bootstrap_extra.css

@@ -110,6 +110,10 @@ select:hover {
   background-image: linear-gradient(to bottom, var(--bs-tertiary-bg), rgba(var(--bs-tertiary-bg-rgb), 0), var(--bs-tertiary-bg));
 }
 
+.bg-gradient-tertiary-left-right {
+  background-image: linear-gradient(to right, var(--bs-tertiary-bg), rgba(var(--bs-tertiary-bg-rgb), 0), var(--bs-tertiary-bg));
+}
+
 .border-start-info-subtle {
   border-left: var(--bs-border-width) var(--bs-border-style) var(--bs-info-border-subtle);
 }

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/css/main.css

@@ -74,3 +74,11 @@ body > :first-child {
 .overscroll-behavior-none {
   overscroll-behavior: none;
 }
+
+.channel-views-min-width {
+  min-width: 5.5em;
+}
+
+.channel-filter-min-width {
+  min-width: 5.5em;
+}

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/dummy_load.yaml

@@ -1,4 +1,42 @@
 ---
+# UDP JSON clients.
+clients:
+  - factory: udp_json
+    name: udp_json_client
+    defer: true
+    kwargs:
+      remote_addr: [localhost, "$udp_json"]
+    views:
+      - [metrics, metrics]
+      - [transmit, tx]
+      - [receive, rx]
+    buttons: &buttons
+      - icon: tux
+        key: test
+        payload: {}
+      - icon: tux
+        key: test
+        text: asdf
+        payload: {}
+      - icon: tux
+        key: test
+        payload: {}
+        outline: false
+      - icon: tux
+        key: test
+        text: asdf
+        payload: {}
+        outline: false
+    markdown: |
+      # `udp_json_client`
+
+      Connects to `udp_json_server`.
+
+  - factory: udp_json
+    name: udp_json_server
+    kwargs:
+      local_addr: [localhost, "$udp_json"]
+
 # Add some sample tasks.
 tasks:
   # Chaos.
@@ -9,6 +47,7 @@ tasks:
       a: 1
       b: 2
       c: 3
+      buttons: *buttons
       views:
         - [zero, "\\.0\\."]
         - [one, "\\.1\\."]
@@ -49,27 +88,6 @@ tasks:
   # Drive interactions with runtime entities that won't otherwise be polled.
   - {name: app, factory: SampleApp, period_s: 0.25}
 
-# UDP JSON clients.
-clients:
-  - factory: udp_json
-    name: udp_json_client
-    defer: true
-    kwargs:
-      remote_addr: [localhost, "$udp_json"]
-    views:
-      - [metrics, metrics]
-      - [transmit, tx]
-      - [receive, rx]
-    markdown: |
-      # `udp_json_client`
-
-      Connects to `udp_json_server`.
-
-  - factory: udp_json
-    name: udp_json_server
-    kwargs:
-      local_addr: [localhost, "$udp_json"]
-
 # Add some sample structs.
 structs:
   - name: example.struct1
@@ -80,6 +98,8 @@ structs:
       b: 2
       c: 3
 
+      buttons: *buttons
+
       markdown: |
         # Docs for `example.struct1`
 

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/js/classes/WorkerInterface.js

@@ -10,7 +10,7 @@ class WorkerInterface {
 
   command(data) { this.send({kind : "command", value : data}); }
 
-  bus(data) { this.worker.postMessage({bus : data}); }
+  bus(key, data) { this.worker.postMessage({key : key, bus : data}); }
 
   toWorker(data, param) { return this.send({"worker" : data}, param); }
 }

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/js/sample.js

@@ -1,2 +1,2 @@
 console.log(`sample.js included (${tab.name})`);
-// tab.worker.bus({a: 1, b: 2, c: 3});
+// tab.worker.bus("test", {a: 1, b: 2, c: 3});

runtimepy-5.15.6/runtimepy/data/schemas/Button.yaml

@@ -0,0 +1,17 @@
+---
+type: object
+additionalProperties: false
+required: [key, payload]
+properties:
+  key:
+    type: string
+  payload:
+    type: object
+  text:
+    type: string
+  icon:
+    type: string
+  variant:
+    type: string
+  outline:
+    type: boolean

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/data/schemas/ClientConnectionConfig.yaml

@@ -4,6 +4,7 @@ includes:
   - has_name.yaml
   - has_markdown.yaml
   - has_views.yaml
+  - has_buttons.yaml
 
 properties:
   defer:

runtimepy-5.15.6/runtimepy/data/schemas/has_buttons.yaml

@@ -0,0 +1,6 @@
+---
+properties:
+  buttons:
+    type: array
+    items:
+      $ref: package://runtimepy/schemas/Button.yaml

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/arbiter/base.py

@@ -47,6 +47,7 @@ from runtimepy.net.manager import ConnectionManager as _ConnectionManager
 from runtimepy.net.server import RuntimepyServerConnection
 from runtimepy.subprocess.peer import RuntimepyPeer as _RuntimepyPeer
 from runtimepy.tui.mixin import CursesWindow, TuiMixin
+from runtimepy.ui.button import ActionButton
 
 ServerTask = _Awaitable[None]
 RuntimeProcessTask = tuple[
@@ -148,6 +149,7 @@ class BaseConnectionArbiter(_NamespaceMixin, _LoggerMixin, TuiMixin):
 
         self._commands: list[tuple[str, str]] = []
         self._views: dict[str, dict[str, str]] = {}
+        self._buttons: dict[str, list[ActionButton]] = {}
 
         self._init()
 
@@ -157,9 +159,16 @@ class BaseConnectionArbiter(_NamespaceMixin, _LoggerMixin, TuiMixin):
     def _register_connection(self, connection: _Connection, name: str) -> None:
         """Perform connection registration."""
 
+        # Handle views.
         if name in self._views:
             connection.env.views.update(self._views[name])
             del self._views[name]
+
+        # Handle buttons.
+        if name in self._buttons:
+            connection.command.buttons.extend(self._buttons[name])
+            del self._buttons[name]
+
         self._connections[name] = connection
         self.manager.queue.put_nowait(connection)
         connection.logger.info("Registered as '%s'.", name)
@@ -170,6 +179,7 @@ class BaseConnectionArbiter(_NamespaceMixin, _LoggerMixin, TuiMixin):
         *names: str,
         delim: str = None,
         views: dict[str, str] = None,
+        buttons: list[ActionButton] = None,
     ) -> bool:
         """Attempt to register a connection object."""
 
@@ -180,6 +190,8 @@ class BaseConnectionArbiter(_NamespaceMixin, _LoggerMixin, TuiMixin):
 
         if views:
             self._views[name] = views
+        if buttons:
+            self._buttons[name] = buttons
 
         if (
             name not in self._connections

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/arbiter/config/__init__.py

@@ -180,6 +180,7 @@ class ConfigConnectionArbiter(_ImportConnectionArbiter):
                 **fix_kwargs(kwargs),
                 views=client.get("views"),
                 markdown=client.get("markdown"),
+                buttons=client.get("buttons", []),
             ), f"Couldn't register client '{name}' ({factory})!"
 
         # Register servers.

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/arbiter/factory/connection.py

@@ -16,6 +16,7 @@ from runtimepy.net.arbiter.base import (
 from runtimepy.net.arbiter.base import ServerTask as _ServerTask
 from runtimepy.net.connection import Connection as _Connection
 from runtimepy.net.manager import ConnectionManager as _ConnectionManager
+from runtimepy.ui.button import ActionButton
 
 
 class ConnectionFactory:
@@ -90,6 +91,7 @@ class FactoryConnectionArbiter(_BaseConnectionArbiter):
             factory_inst = self._conn_factories[factory]
 
             views = kwargs.pop("views", {})
+            buttons = ActionButton.from_top_level(kwargs.pop("buttons", []))
 
             conn = factory_inst.client(name, *args, **kwargs)
             if not defer:
@@ -100,6 +102,7 @@ class FactoryConnectionArbiter(_BaseConnectionArbiter):
                 *self._conn_names[factory_inst],
                 name,
                 views=views,
+                buttons=buttons,
             )
 
         return result

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/server/app/env/tab/base.py

@@ -2,6 +2,9 @@
 A module implementing a channel-environment tab HTML interface.
 """
 
+# built-in
+from io import StringIO
+
 # third-party
 from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.logging import LoggerMixin
@@ -39,3 +42,11 @@ class ChannelEnvironmentTabBase(Tab, LoggerMixin, MarkdownMixin):
         # Logging.
         LoggerMixin.__init__(self, logger=self.command.logger)
         self.log_limiter = RateLimiter.from_s(1.0)
+
+    def _action_markdown(self) -> str:
+        """Get action-button markdown."""
+
+        with StringIO() as stream:
+            for button in self.command.buttons:
+                button.element().encode(stream)
+            return stream.getvalue()

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/server/app/env/tab/html.py

@@ -289,6 +289,16 @@ class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
         )
         logs.booleans.add("readonly")
 
+        if self.command.buttons:
+            centered_markdown(
+                vert_container,
+                self._action_markdown(),
+                "border-start",
+                "border-bottom",
+                "border-end",
+                "bg-gradient-tertiary-left-right",
+            )
+
         self.channel_table(vert_container)
 
         centered_markdown(

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/server/app/env/widgets.py

@@ -84,15 +84,16 @@ def views_dropdown(parent: Element, command: ChannelCommandProcessor) -> None:
     """Dropdown menu for channel environment views."""
 
     select = select_element(
-        parent=div(tag="th", parent=parent, class_str="p-0"),
+        parent=div(
+            tag="th", parent=parent, class_str="p-0 channel-views-min-width"
+        ),
         id="filter-view",
         title="Canonical channel filters.",
     ).add_class("border-end-0", "w-100")
     div(tag="option", value="", text="-", parent=select)
+    div(tag="option", value="^$", text="hide", parent=select)
     for text, value in command.env.views.items():
         div(tag="option", value=value, text=text, parent=select)
-    if not command.env.views:
-        select.booleans.add("disabled")
 
 
 def channel_table_header(
@@ -120,7 +121,11 @@ def channel_table_header(
     ).add_class(*TABLE_BUTTON_CLASSES)
 
     _, label, box = input_box(
-        div(tag="th", parent=ctl_row, class_str="p-0 border-end-0"),
+        div(
+            tag="th",
+            parent=ctl_row,
+            class_str="p-0 border-end-0 channel-filter-min-width",
+        ),
         description="Channel name filter.",
         pattern=".* ! @ $",
         label="filter",
@@ -137,7 +142,7 @@ def channel_table_header(
         parent=div(tag="th", parent=ctl_row, colspan="2", class_str="p-0")
     )
 
-    # Add a selection menu for custom commands. (need a data source for this)
+    # Add a selection menu for custom commands.
     select = select_element(
         parent=cell, id="custom-commands", title="Custom command selector."
     )
@@ -157,12 +162,7 @@ def channel_table_header(
             tooltip="Send selected command (left dropdown).",
         ).add_class(*TABLE_BUTTON_CLASSES)
     else:
-        div(
-            tag="option",
-            parent=select,
-            value="noop",
-            text="no custom commands",
-        )
+        div(tag="option", parent=select, value="noop", text="-")
         select.booleans.add("disabled")
 
     # Button for 'reset all defaults' if this tab has more than one channel

runtimepy-5.15.6/runtimepy/net/server/markdown.py

@@ -0,0 +1,101 @@
+"""
+A module implementing web server markdown interfaces.
+"""
+
+# built-in
+from io import StringIO
+import mimetypes
+from pathlib import Path
+from typing import Iterable, cast
+
+# third-party
+from svgen.element.html import div
+from vcorelib.io.file_writer import IndentedFileWriter
+from vcorelib.math.time import byte_count_str
+from vcorelib.paths import rel
+from vcorelib.paths import stats as _stats
+
+LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
+DIR_FILE = "dir.html"
+
+
+def file_preview(path: Path, link: Path) -> str:
+    """Get possible preview text for a file."""
+
+    preview = ""
+
+    if path.is_file():
+        mime, _ = mimetypes.guess_type(path, strict=False)
+        if mime and mime.startswith("image"):
+            preview = div(tag="img", src=f"/{link}", alt=str(link)).encode_str(
+                newlines=False
+            )
+
+    return preview
+
+
+def write_markdown_dir(
+    writer: IndentedFileWriter, path: Path, base: Path
+) -> None:
+    """Write markdown contents for a single directory."""
+
+    curr_dir = rel(path, base=base)
+
+    line = f"### `{base.name}/{curr_dir}`"
+
+    # Link to go up a directory.
+    if curr_dir != Path():
+        line += f" ([..](/{curr_dir.parent}/{DIR_FILE}))"
+
+    writer.write(line)
+    writer.empty()
+
+    writer.write("| name | size | preview |")
+    writer.write("|------|------|---------|")
+
+    for item in sorted(path.iterdir()):
+        curr = rel(item, base=base)
+
+        name = f"`{curr.name}`"
+        if item.is_dir():
+            name = f"**{name}**"
+
+        stats = _stats(item)
+        assert stats
+        size_str = byte_count_str(stats.st_size) if item.is_file() else ""
+
+        writer.write(
+            f"| [{name}](/{curr}) | {size_str} | {file_preview(item, curr)} |"
+        )
+
+    writer.empty()
+
+
+def markdown_for_dir(
+    paths_bases: Iterable[tuple[Path, Path]],
+    extra_links: dict[str, Iterable[str]] = None,
+) -> str:
+    """Get markdown data for a directory."""
+
+    with IndentedFileWriter.string() as writer:
+        writer.write(f"# Directory {LOGO_MARKDOWN} Viewer")
+        with writer.padding():
+            writer.write("---")
+
+        if extra_links:
+            for category, apps in extra_links.items():
+                if apps:
+                    writer.write(f"## {category}")
+                    with writer.padding():
+                        for app in apps:
+                            writer.write(f"* [{app}]({app})")
+
+        writer.write("## directories")
+        writer.empty()
+
+        for path, base in paths_bases:
+            write_markdown_dir(writer, path, base)
+
+        result: str = cast(StringIO, writer.stream).getvalue()
+
+    return result

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/net/server/websocket/__init__.py

@@ -96,7 +96,7 @@ class RuntimepyWebsocketConnection(WebsocketJsonMessageConnection):
 
             # Handle bus messages.
             if "bus" in inbox:
-                await BUS.send_ro("ui", inbox["bus"])
+                await BUS.send_ro(inbox["key"], inbox["bus"])
                 return
 
             # Handle frame messages.

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/requirements.txt

@@ -1,5 +1,5 @@
 aiofiles
-vcorelib>=3.6.3
+vcorelib>=3.6.4
 svgen>=0.8.0
 websockets
 psutil

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/struct/__init__.py

@@ -21,6 +21,7 @@ from runtimepy.channel.environment.command.processor import (
 from runtimepy.mixins.async_command import AsyncCommandProcessingMixin
 from runtimepy.mixins.environment import ChannelEnvironmentMixin
 from runtimepy.mixins.logging import LoggerMixinLevelControl
+from runtimepy.ui.button import ActionButton
 
 
 class RuntimeStructBase(
@@ -50,6 +51,7 @@ class RuntimeStructBase(
             self.setup_level_channel(self.env)
         self.command = ChannelCommandProcessor(self.env, self.logger)
         self.config = config
+        self.command.buttons.extend(ActionButton.from_top_level(self.config))
 
         async def poll(args: Namespace, __: Optional[FieldOrChannel]) -> None:
             """Handle a test command."""

{runtimepy-5.15.4 → runtimepy-5.15.6}/runtimepy/task/basic/periodic.py

@@ -33,6 +33,7 @@ from runtimepy.primitives import Bool as _Bool
 from runtimepy.primitives import Double as _Double
 from runtimepy.primitives import Float as _Float
 from runtimepy.primitives.evaluation import EvalResult as _EvalResult
+from runtimepy.ui.button import ActionButton
 from runtimepy.ui.controls import Controlslike
 
 
@@ -75,6 +76,7 @@ class PeriodicTask(
         self.env.views.update(self.config.get("views", {}))  # type: ignore
         self.setup_level_channel(self.env)
         self.command = ChannelCommandProcessor(self.env, self.logger)
+        self.command.buttons.extend(ActionButton.from_top_level(self.config))
         self.register_task_metrics(self.metrics)
 
         # State.