5.8.0 - More UI enhancements

vkottler · vkottler · commit a215d9638d61 · 2024-11-20T22:37:56.000-08:00
Mostly markdown related

websockets ugprade
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -77,7 +77,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=runtimepy version=5.7.10
+                            repo=runtimepy version=5.8.0
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=1e8298e9f6423ee6f9836f5ec04cc3ab
+    hash=0cb0fecd5f4e84d1b639d4c155ab541c
     =====================================
 -->
 
-# runtimepy ([5.7.10](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)
diff --git a/config b/config
@@ -1 +1 @@
-Subproject commit 8638bb3062920b2c624f15f864e6f453db1114ab
+Subproject commit cc5ae1f0fcb14eeb2a6bc1317cab57e48dfe5b56
diff --git a/local/configs/package.yaml b/local/configs/package.yaml
@@ -8,8 +8,8 @@ time_command: true
 
 requirements:
   - aiofiles
-  - vcorelib>=3.4.5
-  - svgen>=0.6.8
+  - vcorelib>=3.4.6
+  - svgen>=0.7.4
   - websockets
   - psutil
   - "windows-curses; sys_platform == 'win32' and python_version < '3.12'"
diff --git a/local/variables/package.yaml b/local/variables/package.yaml
@@ -1,5 +1,5 @@
 ---
 major: 5
-minor: 7
-patch: 10
+minor: 8
+patch: 0
 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.7.10"
+version = "5.8.0"
 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.1.4
-# hash=01934a9c90fba4488654f035acc8b84e
+# hash=3f66411c94ea81080e4fff8589bd828b
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.7.10"
+VERSION = "5.8.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"
diff --git a/runtimepy/data/dummy_load.yaml b/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}
 
diff --git a/runtimepy/data/schemas/TaskConfig.yaml b/runtimepy/data/schemas/TaskConfig.yaml
@@ -1,5 +1,6 @@
 ---
 includes:
+  - has_config.yaml
   - has_factory.yaml
   - has_name.yaml
   - has_markdown.yaml
diff --git a/runtimepy/net/arbiter/config/__init__.py b/runtimepy/net/arbiter/config/__init__.py
@@ -203,6 +203,7 @@ async def process_config(
                 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.
diff --git a/runtimepy/net/connection.py b/runtimepy/net/connection.py
@@ -13,7 +13,7 @@
 
 # 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
diff --git a/runtimepy/net/html/bootstrap/elements.py b/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)
diff --git a/runtimepy/net/server/app/env/tab/base.py b/runtimepy/net/server/app/env/tab/base.py
@@ -3,7 +3,7 @@
 """
 
 # third-party
-from vcorelib.io import MarkdownMixin
+from vcorelib.io.markdown import MarkdownMixin
 from vcorelib.logging import LoggerMixin
 from vcorelib.math import RateLimiter
 
diff --git a/runtimepy/net/tcp/http/__init__.py b/runtimepy/net/tcp/http/__init__.py
@@ -174,9 +174,11 @@ def _send(
     async def process_binary(self, data: bytes) -> bool:
         """Process a binary frame."""
 
-        for header, payload in self.processor.ingest(
+        kind = RequestHeader if not self.expecting_response else ResponseHeader
+
+        for header, payload in self.processor.ingest(  # type: ignore
             data,
-            RequestHeader if not self.expecting_response else ResponseHeader,
+            kind,  # type: ignore
         ):
             header.log(self.logger, False)
 
diff --git a/runtimepy/net/websocket/connection.py b/runtimepy/net/websocket/connection.py
@@ -21,15 +21,11 @@
 # 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 @@ def server_handler(
         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 @@ async def create_pair(
 
         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 @@ async def serve(
         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 @@ async def app(
         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."""
diff --git a/runtimepy/requirements.txt b/runtimepy/requirements.txt
@@ -1,6 +1,6 @@
 aiofiles
-vcorelib>=3.4.5
-svgen>=0.6.8
+vcorelib>=3.4.6
+svgen>=0.7.4
 websockets
 psutil
 windows-curses; sys_platform == 'win32' and python_version < '3.12'
diff --git a/runtimepy/struct/__init__.py b/runtimepy/struct/__init__.py
@@ -9,7 +9,7 @@
 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
diff --git a/runtimepy/subprocess/interface.py b/runtimepy/subprocess/interface.py
@@ -12,7 +12,7 @@
 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
 
diff --git a/runtimepy/task/basic/periodic.py b/runtimepy/task/basic/periodic.py
@@ -13,7 +13,8 @@
 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,15 @@ def __init__(
         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)
+
+        # need to pass schema_data
+        self.set_markdown(markdown=markdown, config=config, package=PKG_NAME)
+
         LoggerMixinLevelControl.__init__(self, logger=_getLogger(self.name))
         self._task: _Optional[_asyncio.Task[None]] = None
 
diff --git a/tests/net/websocket/test_connection.py b/tests/net/websocket/test_connection.py
@@ -9,7 +9,7 @@
 # third-party
 from pytest import mark
 from vcorelib.asyncio import log_exceptions
-from websockets.server import WebSocketServer
+from websockets.asyncio.server import Server
 
 # module under test
 from runtimepy.net import sockname
@@ -73,7 +73,7 @@ async def conn_init(conn: SampleWebsocketConnection) -> bool:
         assert conn
         return True
 
-    def serve_cb(server: WebSocketServer) -> None:
+    def serve_cb(server: Server) -> None:
         """Publish the server host."""
         server_queue.put_nowait(sockname(list(server.sockets)[0]))
 
