5.15.5 - add 'hide' default filter (#334)

vkottler · web-flow · commit 80240a058b28 · 2025-07-04T10:29:30.000-05:00
* 5.15.5 - add 'hide' default filter

* buttons schema and implementation
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -78,7 +78,7 @@ jobs:
 
       - run: |
           mk python-release owner=libre-embedded \
-                            repo=runtimepy version=5.15.4
+                            repo=runtimepy version=5.15.5
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
diff --git a/.pylintrc b/.pylintrc
@@ -1,7 +1,7 @@
 [DESIGN]
 max-args=10
 max-positional-arguments=10
-max-attributes=16
+max-attributes=17
 max-parents=14
 max-public-methods=22
 max-branches=13
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.2.3
-    hash=99eea1986d2105483ebb2fe566128f5f
+    hash=fd0e57419cf9437a64c4f82cae3625f0
     =====================================
 -->
 
-# runtimepy ([5.15.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.5](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)
diff --git a/local/configs/package.yaml b/local/configs/package.yaml
@@ -8,7 +8,7 @@ time_command: true
 
 requirements:
   - aiofiles
-  - vcorelib>=3.6.3
+  - vcorelib>=3.6.4
   - svgen>=0.8.0
   - websockets
   - psutil
diff --git a/local/variables/package.yaml b/local/variables/package.yaml
@@ -1,5 +1,5 @@
 ---
 major: 5
 minor: 15
-patch: 4
+patch: 5
 entry: runtimepy
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta:__legacy__"
 
 [project]
 name = "runtimepy"
-version = "5.15.4"
+version = "5.15.5"
 description = "A framework for implementing Python services."
 readme = "README.md"
 requires-python = ">=3.12"
diff --git a/runtimepy/__init__.py b/runtimepy/__init__.py
@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.3
-# hash=b0f0463a508c9a1312a071f5c0b06f3b
+# hash=8ce7abe0f8c0e64d9afc0b5e4de6e2ad
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.15.4"
+VERSION = "5.15.5"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"
diff --git a/runtimepy/channel/environment/command/processor.py b/runtimepy/channel/environment/command/processor.py
@@ -20,6 +20,7 @@
 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 @@ def __init__(
 
         self.parser.initialize()
 
+        # Action buttons.
+        if buttons is None:
+            buttons = []
+        self.buttons: list[ActionButton] = buttons
+
     def register_custom_commands(
         self, *custom_commands: CustomCommand
     ) -> None:
diff --git a/runtimepy/data/css/bootstrap_extra.css b/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);
 }
diff --git a/runtimepy/data/css/main.css b/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;
+}
diff --git a/runtimepy/data/dummy_load.yaml b/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`
 
diff --git a/runtimepy/data/js/classes/WorkerInterface.js b/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); }
 }
diff --git a/runtimepy/data/js/sample.js b/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});
diff --git a/runtimepy/data/schemas/Button.yaml b/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
diff --git a/runtimepy/data/schemas/ClientConnectionConfig.yaml b/runtimepy/data/schemas/ClientConnectionConfig.yaml
@@ -4,6 +4,7 @@ includes:
   - has_name.yaml
   - has_markdown.yaml
   - has_views.yaml
+  - has_buttons.yaml
 
 properties:
   defer:
diff --git a/runtimepy/data/schemas/has_buttons.yaml b/runtimepy/data/schemas/has_buttons.yaml
@@ -0,0 +1,6 @@
+---
+properties:
+  buttons:
+    type: array
+    items:
+      $ref: package://runtimepy/schemas/Button.yaml
diff --git a/runtimepy/net/arbiter/base.py b/runtimepy/net/arbiter/base.py
@@ -47,6 +47,7 @@
 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 @@ def __init__(
 
         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 @@ def _init(self) -> None:
     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 @@ def register_connection(
         *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 @@ def register_connection(
 
         if views:
             self._views[name] = views
+        if buttons:
+            self._buttons[name] = buttons
 
         if (
             name not in self._connections
diff --git a/runtimepy/net/arbiter/config/__init__.py b/runtimepy/net/arbiter/config/__init__.py
@@ -180,6 +180,7 @@ async def process_config(
                 **fix_kwargs(kwargs),
                 views=client.get("views"),
                 markdown=client.get("markdown"),
+                buttons=client.get("buttons", []),
             ), f"Couldn't register client '{name}' ({factory})!"
 
         # Register servers.
diff --git a/runtimepy/net/arbiter/factory/connection.py b/runtimepy/net/arbiter/factory/connection.py
@@ -16,6 +16,7 @@
 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 @@ async def factory_client(
             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 @@ async def factory_client(
                 *self._conn_names[factory_inst],
                 name,
                 views=views,
+                buttons=buttons,
             )
 
         return result
diff --git a/runtimepy/net/server/app/env/tab/base.py b/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 @@ def __init__(
         # 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()
diff --git a/runtimepy/net/server/app/env/tab/html.py b/runtimepy/net/server/app/env/tab/html.py
@@ -289,6 +289,16 @@ def compose(self, parent: Element) -> None:
         )
         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(
diff --git a/runtimepy/net/server/app/env/widgets.py b/runtimepy/net/server/app/env/widgets.py
diff --git a/runtimepy/net/server/websocket/__init__.py b/runtimepy/net/server/websocket/__init__.py
diff --git a/runtimepy/requirements.txt b/runtimepy/requirements.txt
diff --git a/runtimepy/struct/__init__.py b/runtimepy/struct/__init__.py
diff --git a/runtimepy/task/basic/periodic.py b/runtimepy/task/basic/periodic.py
diff --git a/runtimepy/ui/button.py b/runtimepy/ui/button.py
diff --git a/tests/net/server/__init__.py b/tests/net/server/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,10 @@ select:hover {`
`110`	`110`	`background-image: linear-gradient(to bottom, var(--bs-tertiary-bg), rgba(var(--bs-tertiary-bg-rgb), 0), var(--bs-tertiary-bg));`
`111`	`111`	`}`
`112`	`112`
	`113`	`+.bg-gradient-tertiary-left-right {`
	`114`	`+ background-image: linear-gradient(to right, var(--bs-tertiary-bg), rgba(var(--bs-tertiary-bg-rgb), 0), var(--bs-tertiary-bg));`
	`115`	`+}`
	`116`	`+`
`113`	`117`	`.border-start-info-subtle {`
`114`	`118`	`border-left: var(--bs-border-width) var(--bs-border-style) var(--bs-info-border-subtle);`
`115`	`119`	`}`