runtimepy 5.7.0__tar.gz → 5.7.2__tar.gz

{runtimepy-5.7.0/runtimepy.egg-info → runtimepy-5.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.0
+Version: 5.7.2
 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.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vcorelib>=3.4.2
+Requires-Dist: psutil
 Requires-Dist: svgen>=0.6.8
 Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: aiofiles
-Requires-Dist: psutil
 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=aa59dcef7f11c767458b14ad97f9de59
+    hash=618546df79dd7f387faa6f84f9a58c79
     =====================================
 -->
 
-# runtimepy ([5.7.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.7.2](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.0 → runtimepy-5.7.2}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=aa59dcef7f11c767458b14ad97f9de59
+    hash=618546df79dd7f387faa6f84f9a58c79
     =====================================
 -->
 
-# runtimepy ([5.7.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.7.2](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.0 → runtimepy-5.7.2}/pyproject.toml

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

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=c51f4ac6cf134b3c3fa872a096e83489
+# hash=0a0c607a8f78dc35cf48427539c9bafa
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.7.0"
+VERSION = "5.7.2"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/data/css/bootstrap_extra.css

@@ -98,13 +98,8 @@ button:hover {
   width: 6em;
 }
 
-/*
- * Should probably build the bootstrap stuff from source and set custom Sass:
- * https://getbootstrap.com/docs/5.3/customize/sass/
- */
-
-:root {
-  /* Prefer 'Arial' and 'Consolas' at the highest priority. */
-  --bs-font-sans-serif: Arial, "Noto Sans", "Liberation Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
-  --bs-font-monospace: Consolas, "Liberation Mono", "Courier New", monospace;
+/* Prefer 'CascadiaCode' and 'CascadiaMono' at the highest priority. */
+:root, [data-bs-theme=dark], [data-bs-theme=light] {
+  --bs-font-sans-serif: CascadiaCode, system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", "Noto Sans", "Liberation Sans", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+  --bs-font-monospace: CascadiaMono, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
 }

runtimepy-5.7.2/runtimepy/data/css/font.css

@@ -0,0 +1,47 @@
+@font-face {
+  font-family: CascadiaCode;
+  src: url("/static/woff2/CascadiaCode-Regular.woff2");
+}
+
+@font-face {
+  font-family: CascadiaCode;
+  src: url("/static/woff2/CascadiaCode-Bold.woff2");
+  font-weight: bold;
+}
+
+@font-face {
+  font-family: CascadiaCode;
+  src: url("/static/woff2/CascadiaCode-BoldItalic.woff2");
+  font-weight: bold;
+  font-style: italic;
+}
+
+@font-face {
+  font-family: CascadiaCode;
+  src: url("/static/woff2/CascadiaCode-Italic.woff2");
+  font-style: italic;
+}
+
+@font-face {
+  font-family: CascadiaMono;
+  src: url("/static/woff2/CascadiaMono-Regular.woff2");
+}
+
+@font-face {
+  font-family: CascadiaMono;
+  src: url("/static/woff2/CascadiaMono-Bold.woff2");
+  font-weight: bold;
+}
+
+@font-face {
+  font-family: CascadiaMono;
+  src: url("/static/woff2/CascadiaMono-BoldItalic.woff2");
+  font-weight: bold;
+  font-style: italic;
+}
+
+@font-face {
+  font-family: CascadiaMono;
+  src: url("/static/woff2/CascadiaMono-Italic.woff2");
+  font-style: italic;
+}

runtimepy-5.7.2/runtimepy/data/js/main.js

@@ -0,0 +1,14 @@
+function changeFileName(urlObj, newFileName) {
+  let pathParts = urlObj.pathname.split('/');
+  pathParts[pathParts.length - 1] = newFileName;
+  return pathParts.join('/');
+}
+
+/* Load configuration data then run application entry. */
+window.onload = async () => {
+  await (
+      new App(
+          await (await fetch(changeFileName(window.location, "json"))).json(),
+          worker))
+      .main();
+};

runtimepy-5.7.2/runtimepy/data/static/svg/chip-circle-bootstrap.svg

@@ -0,0 +1,22 @@
+<svg viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg">
+  <circle r="50.0" cx="50.0" cy="50.0" style="fill: #ADB5BD" />
+  <rect x="16.666666666666664" y="33.333333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="16.666666666666664" y="45.833333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="16.666666666666664" y="58.333333333333336" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="58.33333333333333" y="16.666666666666664" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="45.83333333333333" y="16.666666666666664" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="33.33333333333333" y="16.666666666666664" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="33.333333333333336" y="66.66666666666667" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="45.833333333333336" y="66.66666666666667" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="58.333333333333336" y="66.66666666666667" width="8.333333333333334" height="16.666666666666668" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="66.66666666666667" y="58.33333333333333" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="66.66666666666667" y="45.83333333333333" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="66.66666666666667" y="33.33333333333333" width="16.666666666666668" height="8.333333333333334" rx="4.166666666666667" ry="4.166666666666667" style="fill: #495057" />
+  <rect x="25.0" y="25.0" width="50.0" height="50.0" rx="8.333333333333334" ry="8.333333333333334" style="fill: #212529" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="31.25" y1="50.0" x2="40.625" y2="59.375" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="31.25" y1="50.0" x2="40.625" y2="40.625" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="68.75" y1="50.0" x2="59.375" y2="59.375" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="68.75" y1="50.0" x2="59.375" y2="40.625" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="45.3125" y1="61.71875" x2="50.0" y2="50.0" />
+  <line stroke-linecap="round" style="stroke:#DEE2E6;stroke-width:3.125" x1="54.6875" y1="38.28125" x2="50.0" y2="50.0" />
+</svg>

runtimepy-5.7.2/runtimepy/data/static/woff2/README.md

@@ -0,0 +1,9 @@
+# [Cascadia Code](https://github.com/microsoft/cascadia-code)
+
+Assets sourced from
+[this release](https://github.com/microsoft/cascadia-code/releases/tag/v2404.23).
+
+See also:
+[LICENSE](https://github.com/microsoft/cascadia-code/blob/main/LICENSE).
+
+**Fonts are used from release as-is.**

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/net/server/__init__.py

@@ -3,11 +3,12 @@ A module implementing a server interface for this package.
 """
 
 # built-in
+import http
 from io import StringIO
 import logging
 import mimetypes
 from pathlib import Path
-from typing import Any, Optional, TextIO
+from typing import Any, Optional, TextIO, Union
 
 # third-party
 from vcorelib.io import JsonObject
@@ -22,6 +23,7 @@ from runtimepy.net.http.response import ResponseHeader
 from runtimepy.net.server.html import HtmlApp, HtmlApps, 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
 
 MIMETYPES_INIT = False
 
@@ -48,6 +50,7 @@ class RuntimepyServerConnection(HttpConnection):
 
     paths: list[Path]
     class_paths: list[Pathlike] = [Path(), package_data_dir()]
+    class_redirect_paths: dict[Path, Union[str, Path]] = {}
 
     def add_path(self, path: Pathlike, front: bool = False) -> None:
         """Add a path."""
@@ -60,6 +63,19 @@ class RuntimepyServerConnection(HttpConnection):
 
         self.log_paths()
 
+    @classmethod
+    def add_redirect_path(
+        cls, dest: Union[str, Path], *src_parts: Union[str, Path]
+    ) -> None:
+        """Add a redirect path."""
+
+        source = normalize_root(*src_parts)
+        assert source not in cls.class_redirect_paths, (
+            source,
+            cls.class_redirect_paths,
+        )
+        cls.class_redirect_paths[source] = dest
+
     def log_paths(self) -> None:
         """Log search paths."""
 
@@ -90,6 +106,23 @@ class RuntimepyServerConnection(HttpConnection):
                 with favicon.open("rb") as favicon_fd:
                     type(self).favicon_data = favicon_fd.read()
 
+    def try_redirect(
+        self, path: PathMaybeQuery, response: ResponseHeader
+    ) -> Optional[bytes]:
+        """Try handling any HTTP redirect rules."""
+
+        result = None
+
+        curr = Path(path[0])
+        if curr in self.class_redirect_paths:
+            response["Location"] = str(self.class_redirect_paths[curr])
+            response.status = http.HTTPStatus.TEMPORARY_REDIRECT
+
+            # No data payload, but signal to caller that a response is ready.
+            result = bytes()
+
+        return result
+
     def try_file(
         self, path: PathMaybeQuery, response: ResponseHeader
     ) -> Optional[bytes]:
@@ -188,13 +221,14 @@ class RuntimepyServerConnection(HttpConnection):
                     response["Content-Type"] = "image/x-icon"
                     return self.favicon_data
 
-                # Try serving the path as a file.
-                result = self.try_file(request.target.origin_form, response)
-                if result is not None:
-                    return result
+                # Try serving a file and handling redirects.
+                for handler in [self.try_redirect, self.try_file]:
+                    result = handler(request.target.origin_form, response)
+                    if result is not None:
+                        return result
 
                 # Handle raw data queries.
-                if path.startswith("/json"):
+                if path_has_part(request.target.path):
                     json_handler(
                         stream,
                         request,

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/net/server/app/__init__.py

@@ -73,6 +73,11 @@ async def setup(app: AppInfo) -> int:
     RuntimepyServerConnection.apps["/app.html"] = web_app
     RuntimepyServerConnection.default_app = web_app
 
+    # Register redirects.
+    redirects: dict[str, str] = app.config_param("http_redirects", {})
+    for key, val in redirects.items():
+        RuntimepyServerConnection.add_redirect_path(val, key)
+
     # Register custom applications.
     for key, app_method in APPS.items():
         app_cfg: dict[str, Any] = app.config_param(key, {})

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/net/server/app/base.py

@@ -52,10 +52,9 @@ class WebApplication:
     def populate(self, document: Html, app: TabPopulater) -> None:
         """Populate the body element with the application."""
 
-        # Third-party dependencies.
+        # CSS.
+        append_kind(document.head, "font", kind="css", tag="style")
         add_bootstrap_css(document.head)
-
-        # Internal CSS.
         append_kind(
             document.head, "main", "bootstrap_extra", kind="css", tag="style"
         )

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/net/server/app/env/tab/html.py

@@ -50,6 +50,9 @@ def create_name_td(parent: Element) -> Element:
     return div(tag="td", parent=parent, class_str="p-0 text-nowrap")
 
 
+COMMANDABLE = "text-info-emphasis"
+
+
 class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
     """A channel-environment tab interface."""
 
@@ -67,7 +70,7 @@ class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
 
         name_elem = div(tag="span", text=name, parent=name_td)
         if chan.commandable:
-            name_elem.add_class("text-success")
+            name_elem.add_class(COMMANDABLE)
 
         if description:
             set_tooltip(name_elem, description, placement="left")
@@ -105,7 +108,7 @@ class ChannelEnvironmentTabHtml(ChannelEnvironmentTabControls):
 
         name_elem = div(tag="span", text=name, parent=name_td)
         if field.commandable:
-            name_elem.add_class("text-success")
+            name_elem.add_class(COMMANDABLE)
 
         if field.description:
             description = field.description

{runtimepy-5.7.0 → runtimepy-5.7.2}/runtimepy/net/server/json.py

@@ -13,6 +13,7 @@ from vcorelib.io import ARBITER, JsonObject
 # internal
 from runtimepy.net.http.header import RequestHeader
 from runtimepy.net.http.response import ResponseHeader
+from runtimepy.util import parse_path_parts
 
 
 class Encoder(JSONEncoder):
@@ -94,7 +95,7 @@ def json_handler(
     del request_data
 
     # Traverse path.
-    data = traverse_dict(data, *request.target.path.split("/")[2:])
+    data = traverse_dict(data, *parse_path_parts(request.target.path))
 
     # Use a convention for indexing data to non-dictionary leaf nodes.
     if not isinstance(data, dict):

runtimepy-5.7.2/runtimepy/util.py

@@ -0,0 +1,60 @@
+"""
+A module implementing package utilities.
+"""
+
+# built-in
+from os import sep
+from pathlib import Path
+from typing import Iterator, Union
+
+# third-party
+from vcorelib.paths import normalize
+
+ROOT_PATH = Path(sep)
+
+
+def normalize_root(*src_parts: Union[str, Path]) -> Path:
+    """Make paths absolute that aren't. Useful for HTTP-request pathing."""
+
+    result = normalize(*src_parts)
+    if not result.is_absolute():
+        result = ROOT_PATH.joinpath(result)
+    return result
+
+
+class Identifier:
+    """A simple message indentifier interface."""
+
+    def __init__(self) -> None:
+        """Initialize this instance."""
+        self.curr_id: int = 1
+        self.scale = 2
+
+    def __call__(self) -> int:
+        """Get the next identifier."""
+        curr = self.curr_id
+        self.curr_id += self.scale
+        return curr
+
+
+def path_has_part(path: str, key: str = "json") -> bool:
+    """Determine if a key appears as a part of a path."""
+
+    # Ignore '/' component (intended for URI paths).
+    return key in path.split("/")[1:]
+
+
+def parse_path_parts(path: str, key: str = "json") -> Iterator[str]:
+    """
+    Parse a path such that all parts appearing after a possible 'key' appears
+    are yielded.
+    """
+
+    key_found = False
+
+    # Ignore '/' component (intended for URI paths).
+    for item in path.split("/")[1:]:
+        if key_found:
+            yield item
+        elif item == key:
+            key_found = True

{runtimepy-5.7.0 → runtimepy-5.7.2/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.0
+Version: 5.7.2
 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.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: vcorelib>=3.4.2
+Requires-Dist: psutil
 Requires-Dist: svgen>=0.6.8
 Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: aiofiles
-Requires-Dist: psutil
 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=aa59dcef7f11c767458b14ad97f9de59
+    hash=618546df79dd7f387faa6f84f9a58c79
     =====================================
 -->
 
-# runtimepy ([5.7.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.7.2](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.0 → runtimepy-5.7.2}/runtimepy.egg-info/SOURCES.txt

@@ -61,6 +61,7 @@ runtimepy/data/server_base.yaml
 runtimepy/data/server_dev.yaml
 runtimepy/data/tftp_server.yaml
 runtimepy/data/css/bootstrap_extra.css
+runtimepy/data/css/font.css
 runtimepy/data/css/main.css
 runtimepy/data/js/DataConnection.js
 runtimepy/data/js/JsonConnection.js
@@ -114,6 +115,16 @@ runtimepy/data/schemas/has_factory.yaml
 runtimepy/data/schemas/has_markdown.yaml
 runtimepy/data/schemas/has_name.yaml
 runtimepy/data/schemas/has_request_flag.yaml
+runtimepy/data/static/svg/chip-circle-bootstrap.svg
+runtimepy/data/static/woff2/CascadiaCode-Bold.woff2
+runtimepy/data/static/woff2/CascadiaCode-BoldItalic.woff2
+runtimepy/data/static/woff2/CascadiaCode-Italic.woff2
+runtimepy/data/static/woff2/CascadiaCode-Regular.woff2
+runtimepy/data/static/woff2/CascadiaMono-Bold.woff2
+runtimepy/data/static/woff2/CascadiaMono-BoldItalic.woff2
+runtimepy/data/static/woff2/CascadiaMono-Italic.woff2
+runtimepy/data/static/woff2/CascadiaMono-Regular.woff2
+runtimepy/data/static/woff2/README.md
 runtimepy/enum/__init__.py
 runtimepy/enum/registry.py
 runtimepy/enum/types.py

runtimepy-5.7.0/runtimepy/data/js/main.js

@@ -1,6 +0,0 @@
-/* Load configuration data then run application entry. */
-window.onload = async () => {
-  await (new App(await (await fetch(window.location.origin + "/json")).json(),
-                 worker))
-      .main();
-};

runtimepy-5.7.0/runtimepy/util.py

@@ -1,18 +0,0 @@
-"""
-A module implementing package utilities.
-"""
-
-
-class Identifier:
-    """A simple message indentifier interface."""
-
-    def __init__(self) -> None:
-        """Initialize this instance."""
-        self.curr_id: int = 1
-        self.scale = 2
-
-    def __call__(self) -> int:
-        """Get the next identifier."""
-        curr = self.curr_id
-        self.curr_id += self.scale
-        return curr