runtimepy 5.14.2__py3-none-any.whl → 5.15.0__py3-none-any.whl

runtimepy/net/server/app/env/widgets.py

@@ -14,6 +14,7 @@ from runtimepy.channel.environment.command.processor import (
     ChannelCommandProcessor,
 )
 from runtimepy.enum import RuntimeEnum
+from runtimepy.net.html.bootstrap import icon_str
 from runtimepy.net.html.bootstrap.elements import (
     flex,
     input_box,
@@ -25,7 +26,9 @@ from runtimepy.net.html.bootstrap.elements import (
 def plot_checkbox(parent: Element, name: str) -> None:
     """Add a checkbox for individual channel plot status."""
 
-    container = div(tag="td", parent=parent, class_str="text-center p-0")
+    container = div(tag="td", parent=parent, class_str="text-center p-0 fs-5")
+
+    title = f"Enable plotting channel '{name}'."
 
     set_tooltip(
         div(
@@ -34,10 +37,11 @@ def plot_checkbox(parent: Element, name: str) -> None:
             value="",
             id=f"plot-{name}",
             allow_no_end_tag=True,
-            parent=container,
-            class_str="form-check-input",
+            parent=div(tag="label", parent=container),
+            class_str="form-check-input rounded-0",
+            title=title,
         ),
-        f"Enable plotting channel '{name}'.",
+        title,
         placement="left",
     )
 
@@ -45,7 +49,10 @@ def plot_checkbox(parent: Element, name: str) -> None:
 def select_element(**kwargs) -> Element:
     """Create a select element."""
 
-    select = div(tag="select", class_str="form-select m-1", **kwargs)
+    select = div(tag="select", **kwargs)
+    select.add_class(
+        "form-select", "rounded-0", "border-top-0", "border-bottom-0"
+    )
     if "title" in kwargs:
         select["aria-label"] = kwargs["title"]
     return select
@@ -53,7 +60,7 @@ def select_element(**kwargs) -> Element:
 
 def enum_dropdown(
     parent: Element, name: str, enum: RuntimeEnum, current: int | bool
-) -> None:
+) -> Element:
     """Implement a drop down for enumeration options."""
 
     select = select_element(
@@ -67,8 +74,10 @@ def enum_dropdown(
         if current == val:
             opt.booleans.add("selected")
 
+    return select
+
 
-TABLE_BUTTON_CLASSES = ("p-1", "pt-2")
+TABLE_BUTTON_CLASSES = ("border-top-0", "border-bottom-0")
 
 
 def channel_table_header(
@@ -78,73 +87,45 @@ def channel_table_header(
 
     env = command.env
 
-    # Add header.
-    header_row = div(
-        tag="tr", parent=parent, class_str="border-start border-end"
-    )
-    for heading, desc in [
-        ("plot", "Toggle plotting for channels."),
-        ("name", "Channel names."),
-        ("value", "Channel values."),
-        ("ctl", "Type-specific channel controls."),
-        ("type", "Channel types."),
-    ]:
-        set_tooltip(
-            div(
-                tag="th",
-                scope="col",
-                parent=header_row,
-                text=heading,
-                class_str="text-secondary p-1",
-            ),
-            desc,
-            placement="left",
-        )
-
     # Add some controls.
-    ctl_row = div(tag="tr", parent=parent, class_str="border-start border-end")
+    ctl_row = div(
+        tag="tr",
+        parent=parent,
+        class_str="bg-body-tertiary border-start border-end",
+    )
 
     # Button for clearing plotted channels.
     toggle_button(
         div(tag="th", parent=ctl_row, class_str="text-center p-0"),
         tooltip="Clear plotted channels.",
         icon="x-lg",
+        placement="left",
         id="clear-plotted-channels",
         title="button for clearing plotted channels",
-    ).add_class("pb-2")
+    ).add_class(*TABLE_BUTTON_CLASSES)
 
-    input_box(
-        div(tag="th", parent=ctl_row, class_str="p-0 pb-1"),
+    _, label, box = input_box(
+        div(tag="th", parent=ctl_row, colspan="2", class_str="p-0"),
         description="Channel name filter.",
+        pattern=".* ! @ $",
+        label="filter",
         id="channel-filter",
+        icon="funnel",
+        spellcheck="false",
     )
+    label.add_class("border-top-0", "border-bottom-0")
+    box.add_class("border-top-0", "border-bottom-0")
 
-    # Button for clearing plot points.
-    toggle_button(
-        div(tag="th", parent=ctl_row, class_str="p-0"),
-        icon="trash",
-        tooltip="Clear all plot points.",
-        id="clear-plotted-points",
-        title="button for clearing plot point data",
-    ).add_class("pb-2")
-
-    cell = flex(tag="th", parent=ctl_row)
-    cell.add_class("p-0")
-
-    # Button for 'reset all defaults' if this tab has more than one channel
-    # with a default value.
-    if env.num_defaults > 1:
-        toggle_button(
-            cell,
-            id="set-defaults",
-            icon="arrow-counterclockwise",
-            tooltip="Reset all channels to their default values.",
-        ).add_class(*TABLE_BUTTON_CLASSES)
+    cell = flex(
+        parent=div(tag="th", parent=ctl_row, colspan="2", class_str="p-0")
+    )
 
     # Add a selection menu for custom commands.
     select = select_element(
         parent=cell, id="custom-commands", title="Custom command selector."
     )
+    select.add_class("border-start-0")
+
     if command.custom_commands:
         for key in command.custom_commands:
             opt = div(tag="option", value=key, text=key, parent=select)
@@ -156,7 +137,8 @@ def channel_table_header(
             cell,
             icon="send",
             id="send-custom-commands",
-            title="Send selected command.",
+            title="send selected command button",
+            tooltip="Send selected command (left dropdown).",
         ).add_class(*TABLE_BUTTON_CLASSES)
     else:
         div(
@@ -167,8 +149,79 @@ def channel_table_header(
         )
         select.booleans.add("disabled")
 
-    # Empty for now.
-    div(tag="th", parent=ctl_row, class_str="p-0")
+    # Button for 'reset all defaults' if this tab has more than one channel
+    # with a default value.
+    if env.num_defaults > 1:
+        toggle_button(
+            cell,
+            id="set-defaults",
+            icon="arrow-counterclockwise",
+            tooltip="Reset all channels to their default values.",
+        ).add_class(*TABLE_BUTTON_CLASSES)
+
+    toggle_button(
+        cell,
+        icon="eye-slash",
+        tooltip="Toggle command channels.",
+        id="toggle-command-channels",
+        title="button for toggling command-channel visibility",
+        icon_classes=["text-info-emphasis"],
+    ).add_class(*TABLE_BUTTON_CLASSES)
+    toggle_button(
+        cell,
+        icon="eye-slash-fill",
+        tooltip="Toggle regular channels.",
+        id="toggle-regular-channels",
+        title="button for toggling regular-channel visibility",
+    ).add_class(*TABLE_BUTTON_CLASSES)
+    toggle_button(
+        cell,
+        icon="trash",
+        tooltip="Clear all plot points.",
+        id="clear-plotted-points",
+        title="button for clearing plot point data",
+    ).add_class("me-auto", *TABLE_BUTTON_CLASSES)
+
+    # Add header.
+    header_row = div(
+        tag="tr",
+        parent=parent,
+        class_str="border-end text-center bg-body-tertiary",
+    )
+    icon_classes = ["text-primary-emphasis"]
+    for heading, desc in [
+        (
+            icon_str("activity", classes=icon_classes) + "?",
+            "Toggle plotting for channels.",
+        ),
+        (
+            icon_str("pen", classes=icon_classes) + " name",
+            "Channel names.",
+        ),
+        (
+            icon_str("database", classes=icon_classes) + " value",
+            "Channel values.",
+        ),
+        (
+            icon_str("controller", classes=icon_classes) + " controls",
+            "Type-specific channel controls.",
+        ),
+        (
+            icon_str("braces", classes=icon_classes) + " type",
+            "Channel types.",
+        ),
+    ]:
+        set_tooltip(
+            div(
+                tag="th",
+                scope="col",
+                parent=header_row,
+                text=heading,
+                class_str="text-secondary p-1 border-start text-nowrap",
+            ),
+            "(column) " + desc,
+            placement="left",
+        )
 
 
 def value_input_box(name: str, parent: Element) -> Element:
@@ -186,15 +239,16 @@ def value_input_box(name: str, parent: Element) -> Element:
         "rounded-0",
         "font-monospace",
         "form-control",
-        "m-1",
         "p-0",
-        "ps-1",
+        "ps-2",
+        "border-0",
+        "text-secondary-emphasis",
     )
     toggle_button(
         input_container,
         icon="send",
         id=name,
         title=f"Send command value for '{name}'.",
-    ).add_class(*TABLE_BUTTON_CLASSES)
+    ).add_class("pt-0", "pb-0", *TABLE_BUTTON_CLASSES)
 
     return input_container

runtimepy/net/server/app/landing_page.py

@@ -20,7 +20,7 @@ def landing_page(
     document: Html,
     request: RequestHeader,
     response: ResponseHeader,
-    request_data: Optional[bytes],
+    request_data: Optional[bytearray],
 ) -> Html:
     """Create a landing page application"""
 

runtimepy/net/server/html.py

@@ -16,7 +16,7 @@ from runtimepy.net.http.response import ResponseHeader
 from runtimepy.net.tcp.http import HttpConnection
 
 HtmlApp = Callable[
-    [Html, RequestHeader, ResponseHeader, Optional[bytes]], Awaitable[Html]
+    [Html, RequestHeader, ResponseHeader, Optional[bytearray]], Awaitable[Html]
 ]
 HtmlApps = dict[str, HtmlApp]
 
@@ -58,7 +58,7 @@ async def html_handler(
     stream: TextIO,
     request: RequestHeader,
     response: ResponseHeader,
-    request_data: Optional[bytes],
+    request_data: Optional[bytearray],
     default_app: HtmlApp = None,
     **kwargs,
 ) -> bool:

runtimepy/net/server/json.py

@@ -87,7 +87,7 @@ def json_handler(
     stream: TextIO,
     request: RequestHeader,
     response: ResponseHeader,
-    request_data: Optional[bytes],
+    request_data: Optional[bytearray],
     data: JsonObject,
 ) -> None:
     """Create an HTTP response from some JSON object data."""

runtimepy/net/server/markdown.py

@@ -12,10 +12,12 @@ from vcorelib.io.file_writer import IndentedFileWriter
 from vcorelib.paths import rel
 
 LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
+DIR_FILE = "dir.html"
 
 
 def markdown_for_dir(
-    path: Path, base: Path, extra_links: dict[str, Iterable[str]] = None
+    paths_bases: Iterable[tuple[Path, Path]],
+    extra_links: dict[str, Iterable[str]] = None,
 ) -> str:
     """Get markdown data for a directory."""
 
@@ -32,22 +34,26 @@ def markdown_for_dir(
                         for app in apps:
                             writer.write(f"* [{app}]({app})")
 
-        curr_dir = rel(path, base=base)
-        writer.write(f"## `{curr_dir}`")
+        writer.write("## directories")
         writer.empty()
 
-        # Link to go up a directory.
-        if curr_dir != Path():
-            writer.write(f"* [..](/{curr_dir.parent})")
+        for path, base in paths_bases:
+            curr_dir = rel(path, base=base)
+            writer.write(f"### `{base.name}/{curr_dir}`")
+            writer.empty()
 
-        for item in path.iterdir():
-            curr = rel(item, base=base)
+            # Link to go up a directory.
+            if curr_dir != Path():
+                writer.write(f"* [..](/{curr_dir.parent}/{DIR_FILE})")
 
-            name = f"`{curr.name}`"
-            if item.is_dir():
-                name = f"**{name}**"
+            for item in sorted(path.iterdir()):
+                curr = rel(item, base=base)
 
-            writer.write(f"* [{name}](/{curr})")
+                name = f"`{curr.name}`"
+                if item.is_dir():
+                    name = f"**{name}**"
+
+                writer.write(f"* [{name}](/{curr})")
 
         result: str = cast(StringIO, writer.stream).getvalue()
 

runtimepy/net/server/mux.py

@@ -0,0 +1,29 @@
+"""
+A module implementing an interface for serving a web application that allows
+iframe-based grid multiplexing.
+"""
+
+# built-in
+from typing import Optional
+
+# third-party
+from svgen.element.html import Html
+
+# internal
+from runtimepy.net.http.header import RequestHeader
+from runtimepy.net.http.response import ResponseHeader
+
+
+async def mux_app(
+    document: Html,
+    request: RequestHeader,
+    response: ResponseHeader,
+    request_data: Optional[bytearray],
+) -> Html:
+    """An iframe multiplexing application."""
+
+    del request
+    del response
+    del request_data
+
+    return document

runtimepy/net/stream/__init__.py

@@ -4,10 +4,11 @@ A module aggregating stream-oriented connection interfaces.
 
 # built-in
 from typing import BinaryIO as _BinaryIO
-from typing import Tuple
+
+# third-party
+from vcorelib.io import BinaryMessage
 
 # internal
-from runtimepy.net.connection import BinaryMessage
 from runtimepy.net.stream.base import PrefixedMessageConnection
 from runtimepy.net.stream.string import StringMessageConnection
 from runtimepy.net.tcp.connection import TcpConnection
@@ -34,14 +35,14 @@ class UdpPrefixedMessageConnection(PrefixedMessageConnection, UdpConnection):
     """A UDP implementation for size-prefixed messages."""
 
     async def process_datagram(
-        self, data: bytes, addr: Tuple[str, int]
+        self, data: BinaryMessage, addr: tuple[str, int]
     ) -> bool:
         """Process a datagram."""
 
         return await self.process_binary(data, addr=addr)
 
     def _send_message(
-        self, data: BinaryMessage, addr: Tuple[str, int] = None
+        self, data: BinaryMessage, addr: tuple[str, int] = None
     ) -> None:
         """Underlying data send."""
 
@@ -52,7 +53,7 @@ class EchoMessageConnection(PrefixedMessageConnection):
     """A connection that just echoes what it was sent."""
 
     async def process_single(
-        self, stream: _BinaryIO, addr: Tuple[str, int] = None
+        self, stream: _BinaryIO, addr: tuple[str, int] = None
     ) -> bool:
         """Process a single message."""
 

runtimepy/net/stream/base.py

@@ -6,9 +6,11 @@ A module implementing a base, stream-oriented connection interface.
 from io import BytesIO as _BytesIO
 from typing import BinaryIO as _BinaryIO
 
+# third-party
+from vcorelib.io import BinaryMessage
+
 # internal
 from runtimepy.message import MessageProcessor
-from runtimepy.net.connection import BinaryMessage
 from runtimepy.net.connection import Connection as _Connection
 
 
@@ -58,7 +60,7 @@ class PrefixedMessageConnection(_Connection):
         return True
 
     async def process_binary(
-        self, data: bytes, addr: tuple[str, int] = None
+        self, data: BinaryMessage, addr: tuple[str, int] = None
     ) -> bool:
         """Process an incoming message."""
 

runtimepy/net/tcp/connection.py

@@ -17,10 +17,12 @@ from typing import Optional as _Optional
 from typing import TypeVar as _TypeVar
 from typing import Union as _Union
 
+# third-party
+from vcorelib.io import BinaryMessage
+
 # internal
 from runtimepy.net import sockname as _sockname
 from runtimepy.net.backoff import ExponentialBackoff
-from runtimepy.net.connection import BinaryMessage as _BinaryMessage
 from runtimepy.net.connection import Connection as _Connection
 from runtimepy.net.connection import EchoConnection as _EchoConnection
 from runtimepy.net.connection import NullConnection as _NullConnection
@@ -91,7 +93,7 @@ class TcpConnection(_Connection, _TransportMixin):
         """Determine if this connection uses SSL."""
         return self._transport.get_extra_info("sslcontext") is not None
 
-    async def _await_message(self) -> _Optional[_Union[_BinaryMessage, str]]:
+    async def _await_message(self) -> _Optional[_Union[BinaryMessage, str]]:
         """Await the next message. Return None on error or failure."""
 
         data = await self._protocol.queue.get()
@@ -103,7 +105,7 @@ class TcpConnection(_Connection, _TransportMixin):
         """Enqueue a text message to send."""
         self.send_binary(data.encode())
 
-    def send_binary(self, data: _BinaryMessage) -> None:
+    def send_binary(self, data: BinaryMessage) -> None:
         """Enqueue a binary message tos end."""
         self._transport.write(data)
         self.metrics.tx.increment(len(data))

runtimepy/net/tcp/http/__init__.py

@@ -11,6 +11,7 @@ from typing import Any, Awaitable, Callable, Optional, Tuple, Union, cast
 
 # third-party
 from vcorelib import DEFAULT_ENCODING
+from vcorelib.io import BinaryMessage
 
 # internal
 from runtimepy import PKG_NAME, VERSION
@@ -19,18 +20,18 @@ from runtimepy.net.http.header import RequestHeader
 from runtimepy.net.http.response import AsyncResponse, ResponseHeader
 from runtimepy.net.tcp.connection import TcpConnection as _TcpConnection
 
-HttpResult = Optional[bytes | AsyncResponse]
+HttpResult = Optional[BinaryMessage | AsyncResponse]
 
 #
 # async def handler(
 #     response: ResponseHeader,
 #     request: RequestHeader,
-#     request_data: Optional[bytes],
+#     request_data: Optional[bytearray],
 # ) -> HttpResult:
 #     """Sample handler."""
 #
 HttpRequestHandler = Callable[
-    [ResponseHeader, RequestHeader, Optional[bytes]],
+    [ResponseHeader, RequestHeader, Optional[bytearray]],
     Awaitable[HttpResult],
 ]
 HttpResponse = Tuple[ResponseHeader, HttpResult]
@@ -99,7 +100,7 @@ class HttpConnection(_TcpConnection):
         self,
         response: ResponseHeader,
         request: RequestHeader,
-        request_data: Optional[bytes],
+        request_data: Optional[bytearray],
     ) -> HttpResult:
         """Sample handler."""
 
@@ -107,7 +108,7 @@ class HttpConnection(_TcpConnection):
         self,
         response: ResponseHeader,
         request: RequestHeader,
-        request_data: Optional[bytes],
+        request_data: Optional[bytearray],
     ) -> HttpResult:
         """Sample handler."""
 
@@ -115,7 +116,7 @@ class HttpConnection(_TcpConnection):
         self,
         response: ResponseHeader,
         request_header: RequestHeader,
-        request_data: Optional[bytes] = None,
+        request_data: Optional[bytearray] = None,
     ) -> HttpResult:
         """Process an individual request."""
 
@@ -141,7 +142,7 @@ class HttpConnection(_TcpConnection):
         return result
 
     async def request(
-        self, request: RequestHeader, data: Optional[bytes] = None
+        self, request: RequestHeader, data: Optional[BinaryMessage] = None
     ) -> HttpResponse:
         """Make an HTTP request."""
 
@@ -157,7 +158,7 @@ class HttpConnection(_TcpConnection):
         return result
 
     async def request_json(
-        self, request: RequestHeader, data: Optional[bytes] = None
+        self, request: RequestHeader, data: Optional[BinaryMessage] = None
     ) -> Any:
         """
         Perform a request and convert the response to a data structure by
@@ -191,7 +192,7 @@ class HttpConnection(_TcpConnection):
 
         header.log(self.logger, True)
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
 
         for header, payload in self.processor.ingest(

runtimepy/net/tcp/protocol.py

@@ -9,10 +9,10 @@ from logging import getLogger as _getLogger
 from typing import Optional as _Optional
 
 # third-party
+from vcorelib.io import BinaryMessage
 from vcorelib.logging import LoggerType as _LoggerType
 
 # internal
-from runtimepy.net.connection import BinaryMessage as _BinaryMessage
 from runtimepy.net.connection import Connection as _Connection
 from runtimepy.net.mixin import (
     BinaryMessageQueueMixin as _BinaryMessageQueueMixin,
@@ -26,7 +26,7 @@ class QueueProtocol(_BinaryMessageQueueMixin, _Protocol):
     logger: _LoggerType
     conn: _Connection
 
-    def data_received(self, data: _BinaryMessage) -> None:
+    def data_received(self, data: BinaryMessage) -> None:
         """Handle incoming data."""
         self.queue.put_nowait(data)
 

runtimepy/net/tcp/scpi/__init__.py

@@ -5,6 +5,9 @@ A module implementing an SCPI interface.
 # built-in
 import asyncio
 
+# third-party
+from vcorelib.io import BinaryMessage
+
 # internal
 from runtimepy.net.arbiter.tcp import TcpConnectionFactory
 from runtimepy.net.tcp import TcpConnection
@@ -34,9 +37,9 @@ class ScpiConnection(TcpConnection):
 
         return True
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
-        return await self.process_text(data.decode())
+        return await self.process_text(bytes(data).decode())
 
     async def send_command(
         self,

runtimepy/net/tcp/telnet/__init__.py

@@ -10,6 +10,7 @@ from typing import BinaryIO as _BinaryIO
 
 # third-party
 from vcorelib import DEFAULT_ENCODING
+from vcorelib.io import BinaryMessage
 
 # internal
 from runtimepy.net.tcp.connection import TcpConnection as _TcpConnection
@@ -65,7 +66,7 @@ class Telnet(_TcpConnection):
     ) -> None:
         """Process a telnet option."""
 
-    async def process_binary(self, data: bytes) -> bool:
+    async def process_binary(self, data: BinaryMessage) -> bool:
         """Process a binary frame."""
 
         result = True