runtimepy 5.12.2__tar.gz → 5.13.1__tar.gz

{runtimepy-5.12.2/runtimepy.egg-info → runtimepy-5.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.12.2
+Version: 5.13.1
 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: aiofiles
 Requires-Dist: psutil
+Requires-Dist: aiofiles
+Requires-Dist: svgen>=0.7.12
 Requires-Dist: websockets
 Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: svgen>=0.7.4
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -50,12 +50,12 @@ Dynamic: requires-python
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=c4f50a5547bbff6a73c98b12f4a8ee75
+    version=3.2.3
+    hash=69775d79c8c13f44e0ac000acdeb93e2
     =====================================
 -->
 
-# runtimepy ([5.12.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.1](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.12.2 → runtimepy-5.13.1}/README.md

@@ -1,12 +1,12 @@
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=c4f50a5547bbff6a73c98b12f4a8ee75
+    version=3.2.3
+    hash=69775d79c8c13f44e0ac000acdeb93e2
     =====================================
 -->
 
-# runtimepy ([5.12.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.1](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.12.2 → runtimepy-5.13.1}/pyproject.toml

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

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
-# hash=15077f6e9231129c803ebd9d9db1a5e1
+# version=3.2.3
+# hash=25280d90363095aa6b5717f2105ff685
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.12.2"
+VERSION = "5.13.1"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/__main__.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=b28a8111bcc727e854c1f6474a3c4232
 # =====================================
 """

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/app.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=a4deafb4ebcc179d8d85f9376d22dc92
 # =====================================
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/commands/all.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=1814b7f7fae3556a0dbeec37141e4182
 # =====================================
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/commands/server.py

@@ -48,7 +48,6 @@ def get_kwargs(args: _Namespace, **kwargs) -> dict[str, Any]:
     new_kwargs: dict[str, Any] = {**kwargs}
 
     # Pass additional arguments through.
-    print(args)
     for opt in PASSTHROUGH:
         value = getattr(args, opt, None)
         if value is not None:

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/data/css/main.css

@@ -52,6 +52,6 @@ body > :first-child {
   border-right: var(--bs-border-width) var(--bs-border-style) var(--bs-link-hover-color) !important;
 }
 
-canvas:focus {
+:focus {
   outline: none;
 }

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/entry.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=79c31d1280a6e97b5d326aecb758c597
 # =====================================
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/html/__init__.py

@@ -51,9 +51,10 @@ def create_app_shell(
     # Dark/light theme switch button.
     bootstrap_button(
         icon_str("lightbulb"),
-        tooltip=" Toggle light/dark.",
+        tooltip="Toggle light/dark.",
         id="theme-button",
         parent=button_column,
+        title="change theme button",
     )
 
     return container, button_column
@@ -112,6 +113,7 @@ def full_markdown_page(
         icon_str("printer"),
         tooltip="Printer-friendly view.",
         id="print-button",
+        title="print-view button",
         parent=div(tag="a", href="?print=true", parent=button_column),
     )
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/http/response.py

@@ -6,8 +6,12 @@ A module implementing HTTP-response interfaces.
 import http
 from io import StringIO
 import logging
+from pathlib import Path
+from typing import AsyncIterator, cast
 
 # third-party
+import aiofiles
+import aiofiles.os
 from vcorelib.logging import LoggerType
 
 # internal
@@ -83,3 +87,31 @@ class ResponseHeader(HeadersMixin):
             self.status_line,
             self.headers,
         )
+
+
+class AsyncResponse:
+    """
+    A class facilitating asynchronous server responses for e.g.
+    file-system files.
+    """
+
+    def __init__(self, path: Path, chunk_size: int = 1024) -> None:
+        """Initialize this instance."""
+
+        self.path = path
+        self.chunk_size = chunk_size
+
+    async def size(self) -> int:
+        """Get this response's size."""
+        return cast(int, await aiofiles.os.path.getsize(self.path))
+
+    async def process(self) -> AsyncIterator[bytes]:
+        """Yield chunks to write asynchronously."""
+
+        async with aiofiles.open(self.path, mode="rb") as path_fd:
+            while True:
+                data = await path_fd.read(self.chunk_size)
+                if data:
+                    yield data
+                else:
+                    break

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/server/__init__.py

@@ -21,11 +21,11 @@ from runtimepy.channel.environment.command import GLOBAL
 from runtimepy.net.html import full_markdown_page
 from runtimepy.net.http.header import RequestHeader
 from runtimepy.net.http.request_target import PathMaybeQuery
-from runtimepy.net.http.response import ResponseHeader
+from runtimepy.net.http.response import AsyncResponse, 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.server.markdown import markdown_for_dir
-from runtimepy.net.tcp.http import HttpConnection
+from runtimepy.net.tcp.http import HttpConnection, HttpResult
 from runtimepy.util import normalize_root, path_has_part, read_binary
 
 MIMETYPES_INIT = False
@@ -156,7 +156,9 @@ class RuntimepyServerConnection(HttpConnection):
 
         response["Content-Type"] = f"text/html; charset={DEFAULT_ENCODING}"
 
-        return document.encode_str().encode()
+        with StringIO() as stream:
+            document.render(stream)
+            return stream.getvalue().encode()
 
     async def render_markdown_file(
         self,
@@ -173,20 +175,20 @@ class RuntimepyServerConnection(HttpConnection):
 
     async def try_file(
         self, path: PathMaybeQuery, response: ResponseHeader
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Try serving this path as a file directly from the file-system."""
 
-        result = None
+        result: HttpResult = None
 
         # Keep track of directories encountered.
-        directories: list[Path] = []
+        directories: list[tuple[Path, Path]] = []
 
         # Build a list of all candidate files to check.
         candidates: list[Path] = []
         for search in self.paths:
             candidate = search.joinpath(path[0][1:])
             if candidate.is_dir():
-                directories.append(candidate)
+                directories.append((candidate, search))
                 candidates.append(candidate.joinpath("index.html"))
             else:
                 candidates.append(candidate)
@@ -206,6 +208,13 @@ class RuntimepyServerConnection(HttpConnection):
 
                 # Set MIME type if it can be determined.
                 if mime:
+                    # webhint suggestion
+                    if (
+                        mime.startswith("text")
+                        and DEFAULT_ENCODING not in mime
+                    ):
+                        mime += f"; charset={DEFAULT_ENCODING}"
+
                     response["Content-Type"] = mime
 
                 # We don't handle this yet.
@@ -214,14 +223,15 @@ class RuntimepyServerConnection(HttpConnection):
                 self.logger.info("Serving '%s' (MIME: %s)", candidate, mime)
 
                 # Return the file data.
-                result = await read_binary(candidate)
+                result = AsyncResponse(candidate)
                 break
 
         # Handle a directory as a last resort.
         if not result and directories:
+            candidate, search = directories[0]
             result = self.render_markdown(
                 markdown_for_dir(
-                    directories[0], {"applications": self.apps.keys()}
+                    candidate, search, {"applications": self.apps.keys()}
                 ),
                 response,
                 path[1],
@@ -259,7 +269,7 @@ class RuntimepyServerConnection(HttpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Handle POST requests."""
 
         request.log(self.logger, False, level=logging.INFO)
@@ -281,7 +291,7 @@ class RuntimepyServerConnection(HttpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Handle GET requests."""
 
         request.log(self.logger, False, level=logging.INFO)

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/server/app/env/tab/html.py

@@ -226,6 +226,7 @@ class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
         vert_container = flex(
             parent=container,
             kind="column",
+            tag="form",
         )
         vert_container.add_class("channel-column", "collapse", "show")
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/server/app/env/widgets.py

@@ -110,6 +110,7 @@ def channel_table_header(
         tooltip="Clear plotted channels.",
         icon="x-lg",
         id="clear-plotted-channels",
+        title="button for clearing plotted channels",
     ).add_class("pb-2")
 
     input_box(
@@ -124,6 +125,7 @@ def channel_table_header(
         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)

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/server/html.py

@@ -6,6 +6,7 @@ A module implementing HTML interfaces for web applications.
 from typing import Awaitable, Callable, Optional, TextIO
 
 # third-party
+from svgen.element import Element
 from svgen.element.html import Html
 from vcorelib import DEFAULT_ENCODING
 
@@ -20,10 +21,23 @@ HtmlApp = Callable[
 HtmlApps = dict[str, HtmlApp]
 
 
-def get_html() -> Html:
+def get_html(
+    title: str = HttpConnection.identity,
+    cache_control: str = "public",
+    **kwargs,
+) -> Html:
     """Get a default HTML document."""
 
-    return Html(HttpConnection.identity)
+    elem = Html(title, **kwargs)
+
+    elem.children.append(
+        Element(
+            tag="meta",
+            attrib={"http-equiv": "Cache-Control", "content": cache_control},
+        )
+    )
+
+    return elem
 
 
 async def html_handler(

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/server/markdown.py

@@ -11,14 +11,11 @@ from typing import Iterable, cast
 from vcorelib.io.file_writer import IndentedFileWriter
 from vcorelib.paths import rel
 
-LOGO_MARKDOWN = (
-    "[![logo](https://libre-embedded.com/static/"
-    "png/chip-circle-bootstrap/128x128.png)](https://libre-embedded.com)"
-)
+LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
 
 
 def markdown_for_dir(
-    path: Path, extra_links: dict[str, Iterable[str]] = None
+    path: Path, base: Path, extra_links: dict[str, Iterable[str]] = None
 ) -> str:
     """Get markdown data for a directory."""
 
@@ -29,24 +26,28 @@ def markdown_for_dir(
 
         if extra_links:
             for category, apps in extra_links.items():
-                writer.write(f"## {category}")
-                with writer.padding():
-                    for app in apps:
-                        writer.write(f"* [{app}]({app})")
-
-        writer.write(f"## `{path}`")
+                if apps:
+                    writer.write(f"## {category}")
+                    with writer.padding():
+                        for app in apps:
+                            writer.write(f"* [{app}]({app})")
+
+        curr_dir = rel(path, base=base)
+        writer.write(f"## `{curr_dir}`")
         writer.empty()
 
-        writer.write("* [..](..)")
+        # Link to go up a directory.
+        if curr_dir != Path():
+            writer.write(f"* [..](/{curr_dir.parent})")
 
         for item in path.iterdir():
-            curr = rel(item, base=path)
+            curr = rel(item, base=base)
 
-            name = f"`{curr}`"
+            name = f"`{curr.name}`"
             if item.is_dir():
                 name = f"**{name}**"
 
-            writer.write(f"* [{name}]({curr})")
+            writer.write(f"* [{name}](/{curr})")
 
         result: str = cast(StringIO, writer.stream).getvalue()
 

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/net/tcp/http/__init__.py

@@ -16,22 +16,24 @@ from vcorelib import DEFAULT_ENCODING
 from runtimepy import PKG_NAME, VERSION
 from runtimepy.net.http import HttpMessageProcessor
 from runtimepy.net.http.header import RequestHeader
-from runtimepy.net.http.response import ResponseHeader
+from runtimepy.net.http.response import AsyncResponse, ResponseHeader
 from runtimepy.net.tcp.connection import TcpConnection as _TcpConnection
 
+HttpResult = Optional[bytes | AsyncResponse]
+
 #
 # async def handler(
 #     response: ResponseHeader,
 #     request: RequestHeader,
 #     request_data: Optional[bytes],
-# ) -> Optional[bytes]:
+# ) -> HttpResult:
 #     """Sample handler."""
 #
 HttpRequestHandler = Callable[
     [ResponseHeader, RequestHeader, Optional[bytes]],
-    Awaitable[Optional[bytes]],
+    Awaitable[HttpResult],
 ]
-HttpResponse = Tuple[ResponseHeader, Optional[bytes]]
+HttpResponse = Tuple[ResponseHeader, HttpResult]
 
 HttpRequestHandlers = dict[http.HTTPMethod, HttpRequestHandler]
 
@@ -89,7 +91,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Sample handler."""
 
     async def post_handler(
@@ -97,7 +99,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Sample handler."""
 
     async def _process_request(
@@ -105,7 +107,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request_header: RequestHeader,
         request_data: Optional[bytes] = None,
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Process an individual request."""
 
         result = None
@@ -124,7 +126,11 @@ class HttpConnection(_TcpConnection):
             )
 
         # Set boilerplate header data.
-        response["server"] = self.identity
+
+        # webhint suggestions
+        # response["server"] = self.identity
+        response["server"] = PKG_NAME
+        response["X-Content-Type-Options"] = "nosniff"
 
         return result
 
@@ -137,7 +143,7 @@ class HttpConnection(_TcpConnection):
             # Set boilerplate header data.
             request["user-agent"] = self.identity
 
-            self._send(request, data)
+            await self._send(request, data)
             self.expecting_response = True
             result = await self.responses.get()
             self.expecting_response = False
@@ -153,21 +159,29 @@ class HttpConnection(_TcpConnection):
         """
         return to_json(await self.request(request, data))
 
-    def _send(
+    async def _send(
         self,
         header: Union[ResponseHeader, RequestHeader],
-        data: Optional[bytes] = None,
+        data: HttpResult = None,
     ) -> None:
         """Send a request or response to a request."""
 
         # Set content length.
         header["content-length"] = "0"
-        if data:
+
+        if isinstance(data, AsyncResponse):
+            header["content-length"] = str(await data.size())
+        elif data is not None:
             header["content-length"] = str(len(data))
 
         self.send_binary(bytes(header))
-        if data:
-            self.send_binary(data)
+
+        if data is not None:
+            if isinstance(data, AsyncResponse):
+                async for chunk in data.process():
+                    self.send_binary(chunk)
+            else:
+                self.send_binary(data)
 
         header.log(self.logger, True)
 
@@ -183,7 +197,7 @@ class HttpConnection(_TcpConnection):
             if not self.expecting_response:
                 # Process request.
                 response = ResponseHeader()
-                self._send(
+                await self._send(
                     response,
                     await self._process_request(
                         response, cast(RequestHeader, header), payload

{runtimepy-5.12.2 → runtimepy-5.13.1}/runtimepy/requirements.txt

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

{runtimepy-5.12.2 → runtimepy-5.13.1/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.12.2
+Version: 5.13.1
 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: aiofiles
 Requires-Dist: psutil
+Requires-Dist: aiofiles
+Requires-Dist: svgen>=0.7.12
 Requires-Dist: websockets
 Requires-Dist: vcorelib>=3.5.1
-Requires-Dist: svgen>=0.7.4
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -50,12 +50,12 @@ Dynamic: requires-python
 <!--
     =====================================
     generator=datazen
-    version=3.2.1
-    hash=c4f50a5547bbff6a73c98b12f4a8ee75
+    version=3.2.3
+    hash=69775d79c8c13f44e0ac000acdeb93e2
     =====================================
 -->
 
-# runtimepy ([5.12.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.1](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.12.2 → runtimepy-5.13.1}/runtimepy.egg-info/requires.txt

@@ -1,8 +1,8 @@
-aiofiles
 psutil
+aiofiles
+svgen>=0.7.12
 websockets
 vcorelib>=3.5.1
-svgen>=0.7.4
 
 [test]
 pylint

{runtimepy-5.12.2 → runtimepy-5.13.1}/setup.py

@@ -1,6 +1,6 @@
 # =====================================
 # generator=datazen
-# version=3.2.1
+# version=3.2.3
 # hash=23791ff25e92caf639fdcfe48ce010bf
 # =====================================