runtimepy 5.7.9__tar.gz → 5.8.0__tar.gz

{runtimepy-5.7.9/runtimepy.egg-info → runtimepy-5.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.9
+Version: 5.8.0
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,11 +17,11 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiofiles
-Requires-Dist: vcorelib>=3.4.5
+Requires-Dist: vcorelib>=3.4.7
 Requires-Dist: websockets
+Requires-Dist: aiofiles
+Requires-Dist: svgen>=0.7.4
 Requires-Dist: psutil
-Requires-Dist: svgen>=0.6.8
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -45,11 +45,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     generator=datazen
     version=3.1.4
-    hash=9fbafffa1da655b349a05dfa48addf0b
+    hash=0cb0fecd5f4e84d1b639d4c155ab541c
     =====================================
 -->
 
-# runtimepy ([5.7.9](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.8.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)

{runtimepy-5.7.9 → runtimepy-5.8.0}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=9fbafffa1da655b349a05dfa48addf0b
+    hash=0cb0fecd5f4e84d1b639d4c155ab541c
     =====================================
 -->
 
-# runtimepy ([5.7.9](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.8.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)

{runtimepy-5.7.9 → runtimepy-5.8.0}/pyproject.toml

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

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=5d30f53776c61076df3ffeca2fdb30a1
+# hash=3f66411c94ea81080e4fff8589bd828b
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.7.9"
+VERSION = "5.8.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/data/css/bootstrap_extra.css

@@ -88,6 +88,10 @@ textarea.text-logs {
   flex-shrink: 0;
 }
 
+pre {
+  color: var(--bs-code-color);
+}
+
 .vertical-divider:hover {
   cursor: col-resize;
   background-color: var(--bs-highlight-bg) !important;

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/data/dummy_load.yaml

@@ -2,7 +2,24 @@
 # Add some sample tasks.
 tasks:
   # Chaos.
-  - {name: sample1, factory: Sample, period_s: 0.9}
+  - name: sample1
+    factory: Sample
+    period_s: 0.9
+    config:
+      a: 1
+      b: 2
+      c: 3
+    markdown: |
+      # This is a Test
+
+      ```
+      todo
+
+      does this work?
+
+      todo
+      ```
+
   - {name: sample2, factory: Sample, period_s: 1.0}
   - {name: sample3, factory: Sample, period_s: 1.1}
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/data/schemas/TaskConfig.yaml

@@ -1,5 +1,6 @@
 ---
 includes:
+  - has_config.yaml
   - has_factory.yaml
   - has_name.yaml
   - has_markdown.yaml

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/arbiter/config/__init__.py

@@ -203,6 +203,7 @@ class ConfigConnectionArbiter(_ImportConnectionArbiter):
                 period_s=task["period_s"],
                 average_depth=task["average_depth"],
                 markdown=task.get("markdown"),
+                config=task.get("config"),
             ), f"Couldn't register task '{name}' ({factory})!"
 
         # Register structs.

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/arbiter/housekeeping/__init__.py

@@ -21,6 +21,8 @@ TASK_NAME = "housekeeping"
 class ConnectionMetricsPoller(_ArbiterTask):
     """A class that periodically polls connection metrics."""
 
+    processors: list[Awaitable[None]]
+
     def __init__(
         self,
         name: str,
@@ -31,6 +33,7 @@ class ConnectionMetricsPoller(_ArbiterTask):
 
         super().__init__(name, **kwargs)
         self.manager = manager
+        self.processors = []
 
     def _init_state(self) -> None:
         """Add channels to this instance's channel environment."""
@@ -51,7 +54,6 @@ class ConnectionMetricsPoller(_ArbiterTask):
             self.manager.poll_metrics()
 
         # Handle any incoming commands.
-        processors: list[Awaitable[None]] = []
         for mapping in (
             self.app.connections.values(),
             self.app.tasks.values(),
@@ -59,14 +61,15 @@ class ConnectionMetricsPoller(_ArbiterTask):
         ):
             for item in mapping:
                 if isinstance(item, AsyncCommandProcessingMixin):
-                    processors.append(item.process_command_queue())
+                    self.processors.append(item.process_command_queue())
 
         # Service connection tasks. The connection manager should probably do
         # this on its own at some point.
-        processors += list(self.app.conn_manager.connection_tasks)
+        self.processors += list(self.app.conn_manager.connection_tasks)
 
-        if processors:
-            await asyncio.gather(*processors)
+        if self.processors:
+            await asyncio.gather(*self.processors)
+            self.processors.clear()
 
         return True
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/connection.py

@@ -13,7 +13,7 @@ from typing import Union as _Union
 
 # third-party
 from vcorelib.asyncio import log_exceptions as _log_exceptions
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.logging import LoggerType as _LoggerType
 
 # internal

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/html/bootstrap/elements.py

@@ -193,6 +193,7 @@ def centered_markdown(
             text=stream.getvalue(),
             parent=horiz_container,
             class_str="text-body p-3 pb-0",
+            preformatted=True,
         )
 
     div(parent=horiz_container)

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/server/__init__.py

@@ -11,7 +11,6 @@ from pathlib import Path
 from typing import Any, Optional, TextIO, Union
 
 # third-party
-import aiofiles
 from vcorelib import DEFAULT_ENCODING
 from vcorelib.io import IndentedFileWriter, JsonObject
 from vcorelib.paths import Pathlike, find_file, normalize
@@ -26,7 +25,7 @@ from runtimepy.net.http.response import ResponseHeader
 from runtimepy.net.server.html import HtmlApp, HtmlApps, get_html, html_handler
 from runtimepy.net.server.json import encode_json, json_handler
 from runtimepy.net.tcp.http import HttpConnection
-from runtimepy.util import normalize_root, path_has_part
+from runtimepy.util import normalize_root, path_has_part, read_binary
 
 MIMETYPES_INIT = False
 
@@ -158,10 +157,9 @@ class RuntimepyServerConnection(HttpConnection):
     ) -> bytes:
         """Render a markdown file as HTML and return the result."""
 
-        async with aiofiles.open(path, mode="r") as path_fd:
-            return self.render_markdown(
-                await path_fd.read(), response, **kwargs
-            )
+        return self.render_markdown(
+            (await read_binary(path)).decode(), response, **kwargs
+        )
 
     async def try_file(
         self, path: PathMaybeQuery, response: ResponseHeader
@@ -195,8 +193,7 @@ class RuntimepyServerConnection(HttpConnection):
                 self.logger.info("Serving '%s' (MIME: %s)", candidate, mime)
 
                 # Return the file data.
-                async with aiofiles.open(candidate, mode="rb") as path_fd:
-                    result = await path_fd.read()
+                result = await read_binary(candidate)
 
                 break
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/server/app/env/tab/base.py

@@ -3,7 +3,7 @@ A module implementing a channel-environment tab HTML interface.
 """
 
 # third-party
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.logging import LoggerMixin
 from vcorelib.math import RateLimiter
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/server/app/env/tab/message.py

@@ -69,9 +69,7 @@ class ChannelEnvironmentTabMessaging(ChannelEnvironmentTabBase):
             for name in env.names:
                 self._setup_callback(name, state)
         else:
-            # Remove callbacks for primitives.
-            for name, val in state.callbacks.items():
-                state.primitives[name].remove_callback(val)
+            state.clear_telemetry()
 
         # Save current UI state.
         state.latest_ui_values.update(latest)

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/server/websocket/state.py

@@ -53,19 +53,36 @@ class TabState:
 
         return result
 
+    def clear_telemetry(self) -> None:
+        """Clear all telemetry interactions."""
+
+        # Remove callbacks for primitives.
+        for name, val in self.callbacks.items():
+            self.primitives[name].remove_callback(val)
+        self.callbacks.clear()
+        self.primitives.clear()
+
+        # Clear points.
+        self.points.clear()
+
     def clear_loggers(self) -> None:
         """Clear all logging handlers."""
 
+        # Remove handlers.
         for logger in self._loggers:
             logger.removeHandler(self.tab_logger)
+        self._loggers.clear()
+
         self.tab_logger.drain_str()
-        self._loggers = []
+
+        self.clear_telemetry()
 
     def add_logger(self, logger: logging.Logger) -> None:
         """Add a logger."""
 
-        logger.addHandler(self.tab_logger)
-        self._loggers.append(logger)
+        if logger not in self._loggers:
+            logger.addHandler(self.tab_logger)
+            self._loggers.append(logger)
 
     @staticmethod
     def create() -> "TabState":

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/net/websocket/connection.py

@@ -21,15 +21,11 @@ from typing import Union as _Union
 # third-party
 from vcorelib.asyncio import log_exceptions as _log_exceptions
 import websockets
-from websockets.client import (
-    WebSocketClientProtocol as _WebSocketClientProtocol,
-)
+from websockets.asyncio.client import ClientConnection as _ClientConnection
+from websockets.asyncio.server import Server as _Server
+from websockets.asyncio.server import ServerConnection as _ServerConnection
+from websockets.asyncio.server import serve as _serve
 from websockets.exceptions import ConnectionClosed as _ConnectionClosed
-from websockets.server import (
-    WebSocketServerProtocol as _WebSocketServerProtocol,
-)
-from websockets.server import WebSocketServer as _WebSocketServer
-from websockets.server import serve as _serve
 
 # internal
 from runtimepy.net import sockname as _sockname
@@ -50,7 +46,7 @@ class WebsocketConnection(Connection):
 
     def __init__(
         self,
-        protocol: _Union[_WebSocketClientProtocol, _WebSocketServerProtocol],
+        protocol: _Union[_ClientConnection, _ServerConnection],
         **kwargs,
     ) -> None:
         """Initialize this connection."""
@@ -125,13 +121,13 @@ class WebsocketConnection(Connection):
         init: ConnectionInit[T] = None,
         stop_sig: _asyncio.Event = None,
         manager: _ConnectionManager = None,
-    ) -> _Callable[[_WebSocketServerProtocol], _Awaitable[None]]:
+    ) -> _Callable[[_ServerConnection], _Awaitable[None]]:
         """
         A wrapper for passing in a websocket handler and initializing a
         connection.
         """
 
-        async def _handler(protocol: _WebSocketServerProtocol) -> None:
+        async def _handler(protocol: _ServerConnection) -> None:
             """A handler that runs the callers initialization function."""
 
             conn = cls(protocol)
@@ -176,12 +172,11 @@ class WebsocketConnection(Connection):
 
         server_conn: _Optional[T] = None
 
-        async def server_init(protocol: _WebSocketServerProtocol) -> bool:
+        async def server_init(protocol: _ServerConnection) -> None:
             """Create one side of the connection and update the reference."""
             nonlocal server_conn
             assert server_conn is None
             server_conn = cls(protocol)
-            return True
 
         async with _AsyncExitStack() as stack:
             if serve_kwargs is None:
@@ -213,7 +208,7 @@ class WebsocketConnection(Connection):
         stop_sig: _asyncio.Event = None,
         manager: _ConnectionManager = None,
         **kwargs,
-    ) -> _AsyncIterator[_WebSocketServer]:
+    ) -> _AsyncIterator[_Server]:
         """Serve a WebSocket server."""
 
         kwargs = handle_possible_ssl(client=False, **kwargs)
@@ -237,7 +232,7 @@ class WebsocketConnection(Connection):
         stop_sig: _asyncio.Event,
         init: ConnectionInit[T] = None,
         manager: _ConnectionManager = None,
-        serving_callback: _Callable[[_WebSocketServer], None] = None,
+        serving_callback: _Callable[[_Server], None] = None,
         **kwargs,
     ) -> None:
         """Run a WebSocket-server application."""

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/requirements.txt

@@ -1,6 +1,6 @@
 aiofiles
-vcorelib>=3.4.5
-svgen>=0.6.8
+vcorelib>=3.4.7
+svgen>=0.7.4
 websockets
 psutil
 windows-curses; sys_platform == 'win32' and python_version < '3.12'

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/struct/__init__.py

@@ -9,7 +9,7 @@ from logging import getLogger as _getLogger
 from typing import Optional
 
 # third-party
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.io.types import JsonObject as _JsonObject
 
 # internal

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/subprocess/interface.py

@@ -12,7 +12,7 @@ from logging import INFO, getLogger
 from typing import Optional
 
 # third-party
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.io.types import JsonObject
 from vcorelib.math import RateLimiter
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/task/basic/periodic.py

@@ -13,7 +13,8 @@ from logging import getLogger as _getLogger
 from typing import Optional as _Optional
 
 # third-party
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
+from vcorelib.io.types import JsonObject as _JsonObject
 from vcorelib.math import DEFAULT_DEPTH as _DEFAULT_DEPTH
 from vcorelib.math import MovingAverage as _MovingAverage
 from vcorelib.math import RateTracker as _RateTracker
@@ -50,11 +51,14 @@ class PeriodicTask(
         env: ChannelEnvironment = None,
         period_controls: Controlslike = "period",
         markdown: str = None,
+        config: _JsonObject = None,
     ) -> None:
         """Initialize this task."""
 
         self.name = name
-        self.set_markdown(markdown=markdown, package=PKG_NAME)
+
+        self.set_markdown(markdown=markdown, config=config, package=PKG_NAME)
+
         LoggerMixinLevelControl.__init__(self, logger=_getLogger(self.name))
         self._task: _Optional[_asyncio.Task[None]] = None
 

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy/util.py

@@ -8,11 +8,20 @@ from pathlib import Path
 from typing import Iterator, Union
 
 # third-party
+import aiofiles
 from vcorelib.paths import normalize
 
 ROOT_PATH = Path(sep)
 
 
+async def read_binary(path: Path) -> bytes:
+    """An async wrapper for reading file contents."""
+
+    async with aiofiles.open(path, mode="rb") as path_fd:
+        result = await path_fd.read()
+    return result  # type: ignore
+
+
 def normalize_root(*src_parts: Union[str, Path]) -> Path:
     """Make paths absolute that aren't. Useful for HTTP-request pathing."""
 

{runtimepy-5.7.9 → runtimepy-5.8.0/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.9
+Version: 5.8.0
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,11 +17,11 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiofiles
-Requires-Dist: vcorelib>=3.4.5
+Requires-Dist: vcorelib>=3.4.7
 Requires-Dist: websockets
+Requires-Dist: aiofiles
+Requires-Dist: svgen>=0.7.4
 Requires-Dist: psutil
-Requires-Dist: svgen>=0.6.8
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -45,11 +45,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     generator=datazen
     version=3.1.4
-    hash=9fbafffa1da655b349a05dfa48addf0b
+    hash=0cb0fecd5f4e84d1b639d4c155ab541c
     =====================================
 -->
 
-# runtimepy ([5.7.9](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.8.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)

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy.egg-info/SOURCES.txt

@@ -296,4 +296,5 @@ runtimepy/ui/__init__.py
 runtimepy/ui/controls.py
 tests/test_entry.py
 tests/test_mapping.py
-tests/test_resources.py
+tests/test_resources.py
+tests/test_util.py

{runtimepy-5.7.9 → runtimepy-5.8.0}/runtimepy.egg-info/requires.txt

@@ -1,8 +1,8 @@
-aiofiles
-vcorelib>=3.4.5
+vcorelib>=3.4.7
 websockets
+aiofiles
+svgen>=0.7.4
 psutil
-svgen>=0.6.8
 
 [test]
 pylint

runtimepy-5.8.0/tests/test_util.py

@@ -0,0 +1,19 @@
+"""
+Test the 'util' module.
+"""
+
+# third-party
+from pytest import mark
+
+# module under test
+from runtimepy.util import read_binary
+
+# internal
+from tests.resources import resource
+
+
+@mark.asyncio
+async def test_read_binary():
+    """Test 'read_binary' invocations."""
+
+    assert await read_binary(resource("test.txt"))