runtimepy 5.7.1__py3-none-any.whl → 5.7.2__py3-none-any.whl

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=405585c0fbfcc966ef193f744f21fa59
+# 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.1"
+VERSION = "5.7.2"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/data/js/main.js

@@ -1,6 +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(window.location.origin + "/json")).json(),
-                 worker))
+  await (
+      new App(
+          await (await fetch(changeFileName(window.location, "json"))).json(),
+          worker))
       .main();
 };

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/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/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/util.py

@@ -2,6 +2,25 @@
 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."""
@@ -16,3 +35,26 @@ class 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.1.dist-info → runtimepy-5.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.1
+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: websockets
-Requires-Dist: svgen >=0.6.8
-Requires-Dist: psutil
 Requires-Dist: aiofiles
-Requires-Dist: vcorelib >=3.4.2
+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") a
     =====================================
     generator=datazen
     version=3.1.4
-    hash=8247340c8c4e6982a54b831c311f2c0b
+    hash=618546df79dd7f387faa6f84f9a58c79
     =====================================
 -->
 
-# runtimepy ([5.7.1](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.1.dist-info → runtimepy-5.7.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-runtimepy/__init__.py,sha256=5cxrac3CYhDfd63ssWuRNlnKUGeMyi01Ivyg3V_as0I,390
+runtimepy/__init__.py,sha256=52lFAvkdOBUthOa7tJ66FInklDlbnSn3q9BoqWKadlY,390
 runtimepy/__main__.py,sha256=OPAed6hggoQdw-6QAR62mqLC-rCkdDhOq0wyeS2vDRI,332
 runtimepy/app.py,sha256=sTvatbsGZ2Hdel36Si_WUbNMtg9CzsJyExr5xjIcxDE,970
 runtimepy/dev_requirements.txt,sha256=j0dh11ztJAzfaUL0iFheGjaZj9ppDzmTkclTT8YKO8c,230
@@ -7,7 +7,7 @@ runtimepy/mapping.py,sha256=VQK1vzmQVvYYKI85_II37-hIEbvgL3PzNy-WI6TTo80,5091
 runtimepy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/requirements.txt,sha256=77PnkPte9OZyyJg88wF_6su2H4XSvuN8rQH1tibLdv4,124
 runtimepy/schemas.py,sha256=NROlzVCZGLTJ9xe7d1eNIYmjzf0AOv3qHK-f6g1jGHk,678
-runtimepy/util.py,sha256=q1Spqt8AiG8_64COh1fU5cUKl-cZhp8BK1CHw_IOya0,399
+runtimepy/util.py,sha256=1279Ea7CNHa1U_JvUydGAb2oEI2TxilXkq5V1RseCwU,1437
 runtimepy/channel/__init__.py,sha256=pf0RJ5g37_FVV8xoUNgzFGuIfbZEYSBA_cQlJSDTPDo,4774
 runtimepy/channel/registry.py,sha256=nk36qM_Bf6qK6AFR0plaZHR1PU7b4LZqbQ0feJqk4lc,4784
 runtimepy/channel/environment/__init__.py,sha256=0Jj8g7Y4bdDvmWtzpegB9D4milGPhsZokoYxmps5zgU,1612
@@ -58,7 +58,7 @@ runtimepy/data/js/JsonConnection.js,sha256=rclZrbmWc_zSs6I_JhOgxnVPFIyPMo5WdjAe8
 runtimepy/data/js/audio.js,sha256=bLkBqbeHMiGGidfL3iXjmVoF9seK-ZeZ3kwgOrcpgk4,1092
 runtimepy/data/js/events.js,sha256=rgz3Q_8J6sfU_7Sa7fG1mZD0pQ4S3vwN2mqcvQfePkM,554
 runtimepy/data/js/init.js,sha256=IeFqfab7CM2-Z4fIbyGaUD4M2orUT8uLwcVlleQqXzg,1522
-runtimepy/data/js/main.js,sha256=r0P_0xx5Czd1jfTjsB-tLfwhp4iPNoajlYC858u0ltc,211
+runtimepy/data/js/main.js,sha256=nYIQ6O76EWqlzwX7oEwPXqC-LCUFCZYDADK9QbYRDKk,404
 runtimepy/data/js/util.js,sha256=Xc8pHUiFDBDvIqTamWrCYUOpF7iR9VNvPDCSCQAfLDA,1424
 runtimepy/data/js/worker.js,sha256=V9deGAynjvUr1D-WGi3wUW8rxoaNLvBvayMoLFZk3w0,2444
 runtimepy/data/js/classes/App.js,sha256=nnY42Q3tlNzf8JZtuGKyxJZLLNMfResdww8svOQMC3U,3402
@@ -171,10 +171,10 @@ runtimepy/net/http/request_target.py,sha256=EE1aI5VSARw1h93jyZvP56ir5O5fjd6orYK-
 runtimepy/net/http/response.py,sha256=Sup8W_A0ADNzR5olKrQsVNhsQXUwPOD-eJLlLOgYlAY,2316
 runtimepy/net/http/state.py,sha256=qCMN8aWfCRfU9XP-cIhSOo2RqfljTjbQRCflfcy2bfY,1626
 runtimepy/net/http/version.py,sha256=mp6rgIM7-VUVKLCA0Uw96CmBkL0ET860lDVVEewpZ7w,1098
-runtimepy/net/server/__init__.py,sha256=J8gl91YltD8Wo2y_AXxaL6liLu3vomfzUz_nULa3e2Y,6707
+runtimepy/net/server/__init__.py,sha256=sxAOQc6jywBYqqZOCuq_jRJMVoA0ZFaFy2hDpgoOtSs,7845
 runtimepy/net/server/html.py,sha256=xaTGelH4zrwndQjU24kbCj9Yqu-D17nK5682P6xa-cU,1153
-runtimepy/net/server/json.py,sha256=RfNt7Gr4-X5DMinV1UeiWneTIJr0LO6BXo2GzE0C1PQ,2475
-runtimepy/net/server/app/__init__.py,sha256=9gJr7qcrJNQacAOFpZLfpnzDHzx5KXBMNxPlqQsdwB8,2790
+runtimepy/net/server/json.py,sha256=a7vM5yfq2er4DexzFqEMnxoMGDeuywKkVH4-uNJBAik,2522
+runtimepy/net/server/app/__init__.py,sha256=Q5NWlAkIZE2oEHkGdILFyQoX1Fw1lMR1lVQyMVkJ_Hc,2989
 runtimepy/net/server/app/base.py,sha256=9PnonII2qZIf1O9BQ8T-wOAgAVHctpLqyZkWGX2M2r4,2104
 runtimepy/net/server/app/create.py,sha256=N-g3kClBsG4pKOd9tx947rOq4sfgrH_FAMVfZacjhFA,2666
 runtimepy/net/server/app/elements.py,sha256=KJt9vWqkfvniJMiLOJN467JjPPrEqJYZXmDuY1JoY1g,455
@@ -280,9 +280,9 @@ runtimepy/tui/task.py,sha256=nUZo9fuOC-k1Wpqdzkv9v1tQirCI28fZVgcC13Ijvus,1093
 runtimepy/tui/channels/__init__.py,sha256=evDaiIn-YS9uGhdo8ZGtP9VK1ek6sr_P1nJ9JuSET0o,4536
 runtimepy/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/ui/controls.py,sha256=yvT7h3thbYaitsakcIAJ90EwKzJ4b-jnc6p3UuVf_XE,1241
-runtimepy-5.7.1.dist-info/LICENSE,sha256=okYCYhGsx_BlzvFdoNVBVpw_Cfb4SOqHA_VAARml4Hc,1071
-runtimepy-5.7.1.dist-info/METADATA,sha256=eqlwkUrGcPJFbn5jXvluP9ldQxHabTy2-tfbUNdiP8s,9308
-runtimepy-5.7.1.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-runtimepy-5.7.1.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.7.1.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.7.1.dist-info/RECORD,,
+runtimepy-5.7.2.dist-info/LICENSE,sha256=okYCYhGsx_BlzvFdoNVBVpw_Cfb4SOqHA_VAARml4Hc,1071
+runtimepy-5.7.2.dist-info/METADATA,sha256=alklDGCCJxGdAWxIyShsmg-yZJlbN_arrXDTnMG3QaQ,9308
+runtimepy-5.7.2.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+runtimepy-5.7.2.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.7.2.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.7.2.dist-info/RECORD,,