runtimepy 5.7.1__tar.gz → 5.7.2__tar.gz

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

@@ -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
@@ -18,9 +18,9 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: psutil
-Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: svgen>=0.6.8
 Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: aiofiles
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
@@ -45,11 +45,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     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 → runtimepy-5.7.2}/README.md

@@ -2,11 +2,11 @@
     =====================================
     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 → runtimepy-5.7.2}/pyproject.toml

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

{runtimepy-5.7.1 → runtimepy-5.7.2}/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-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.1 → 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.1 → 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.1 → 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.1 → runtimepy-5.7.2/runtimepy.egg-info}/PKG-INFO

@@ -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
@@ -18,9 +18,9 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: psutil
-Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: svgen>=0.6.8
 Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.4.2
 Requires-Dist: aiofiles
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
@@ -45,11 +45,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     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/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.1/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