runtimepy 5.5.0__tar.gz → 5.6.1__tar.gz

{runtimepy-5.5.0/runtimepy.egg-info → runtimepy-5.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.5.0
+Version: 5.6.1
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -17,10 +17,10 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.3.1
 Requires-Dist: svgen>=0.6.8
+Requires-Dist: websockets
 Requires-Dist: psutil
-Requires-Dist: vcorelib>=3.3.1
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -44,11 +44,11 @@ Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") an
     =====================================
     generator=datazen
     version=3.1.4
-    hash=5c5edaf1332d842e9ca04a018455beba
+    hash=a82bbd8413b0036b345251da16b462c3
     =====================================
 -->
 
-# runtimepy ([5.5.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.6.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/vkottler/runtimepy/workflows/Python%20Package/badge.svg)
@@ -165,8 +165,10 @@ options:
 ```
 $ ./venv3.12/bin/runtimepy server -h
 
-usage: runtimepy server [-h] [-i] [-w] [--no-poller] [--host HOST] [-p PORT]
-                        [-u] [-l]
+usage: runtimepy server [-h] [-i] [-w] [--no-poller] [--cafile CAFILE]
+                        [--capath CAPATH] [--cadata CADATA]
+                        [--certfile CERTFILE] [--keyfile KEYFILE]
+                        [--host HOST] [-p PORT] [-u] [-l]
                         factory [configs ...]
 
 positional arguments:
@@ -181,6 +183,11 @@ options:
                         ensure that a 'wait_for_stop' application method is
                         run last
   --no-poller           don't run a connection-metrics poller task
+  --cafile CAFILE       passed directly to instantiation
+  --capath CAPATH       passed directly to instantiation
+  --cadata CADATA       passed directly to instantiation
+  --certfile CERTFILE   passed directly to instantiation
+  --keyfile KEYFILE     passed directly to instantiation
   --host HOST           host address to listen on (default: '0.0.0.0')
   -p PORT, --port PORT  port to listen on (default: 0)
   -u, --udp             whether or not this is a UDP-based server (otherwise

{runtimepy-5.5.0 → runtimepy-5.6.1}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=5c5edaf1332d842e9ca04a018455beba
+    hash=a82bbd8413b0036b345251da16b462c3
     =====================================
 -->
 
-# runtimepy ([5.5.0](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.6.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/vkottler/runtimepy/workflows/Python%20Package/badge.svg)
@@ -123,8 +123,10 @@ options:
 ```
 $ ./venv3.12/bin/runtimepy server -h
 
-usage: runtimepy server [-h] [-i] [-w] [--no-poller] [--host HOST] [-p PORT]
-                        [-u] [-l]
+usage: runtimepy server [-h] [-i] [-w] [--no-poller] [--cafile CAFILE]
+                        [--capath CAPATH] [--cadata CADATA]
+                        [--certfile CERTFILE] [--keyfile KEYFILE]
+                        [--host HOST] [-p PORT] [-u] [-l]
                         factory [configs ...]
 
 positional arguments:
@@ -139,6 +141,11 @@ options:
                         ensure that a 'wait_for_stop' application method is
                         run last
   --no-poller           don't run a connection-metrics poller task
+  --cafile CAFILE       passed directly to instantiation
+  --capath CAPATH       passed directly to instantiation
+  --cadata CADATA       passed directly to instantiation
+  --certfile CERTFILE   passed directly to instantiation
+  --keyfile KEYFILE     passed directly to instantiation
   --host HOST           host address to listen on (default: '0.0.0.0')
   -p PORT, --port PORT  port to listen on (default: 0)
   -u, --udp             whether or not this is a UDP-based server (otherwise

{runtimepy-5.5.0 → runtimepy-5.6.1}/pyproject.toml

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

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/__init__.py

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

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/commands/server.py

@@ -14,6 +14,9 @@ from vcorelib.args import CommandFunction as _CommandFunction
 from runtimepy.commands.arbiter import arbiter_cmd
 from runtimepy.commands.common import FACTORIES, arbiter_args, cmd_with_jit
 
+SSL_PASSTHROUGH = ["cafile", "capath", "cadata", "certfile"]
+PASSTHROUGH = SSL_PASSTHROUGH + ["keyfile"]
+
 
 def port_name(args: _Namespace, port: str = "port") -> str:
     """Get the name for a connection factory's port."""
@@ -25,7 +28,7 @@ def server_data(args: _Namespace) -> dict[str, Any]:
 
     return {
         "factory": args.factory,
-        "kwargs": {"port": f"${port_name(args)}", "host": args.host},
+        "kwargs": get_kwargs(args, port=f"${port_name(args)}", host=args.host),
     }
 
 
@@ -34,6 +37,26 @@ def is_websocket(args: _Namespace) -> bool:
     return "websocket" in args.factory.lower()
 
 
+def is_ssl(kwargs: dict[str, Any]) -> bool:
+    """Determine if server arugments indicate SSL use."""
+    return any(x in kwargs for x in SSL_PASSTHROUGH)
+
+
+def get_kwargs(args: _Namespace, **kwargs) -> dict[str, Any]:
+    """Get boilerplate kwargs."""
+
+    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:
+            new_kwargs[opt] = value
+
+    return new_kwargs
+
+
 def client_data(args: _Namespace) -> dict[str, Any]:
     """Get client data based on command-line arguments."""
 
@@ -43,7 +66,9 @@ def client_data(args: _Namespace) -> dict[str, Any]:
     kwargs: dict[str, Any] = {}
 
     if is_websocket(args):
-        arg_list.append(f"ws://localhost:{port}")
+        arg_list.append(
+            f"ws{'s' if is_ssl(get_kwargs(args)) else ''}://localhost:{port}"
+        )
     elif not args.udp:
         kwargs["host"] = "localhost"
         kwargs["port"] = port
@@ -76,7 +101,9 @@ def config_data(args: _Namespace) -> dict[str, Any]:
             {
                 "name": port_name(args, port="server"),
                 "factory": args.factory,
-                "kwargs": {"local_addr": ["0.0.0.0", f"${port_name(args)}"]},
+                "kwargs": get_kwargs(
+                    args, local_addr=["0.0.0.0", f"${port_name(args)}"]
+                ),
             }
         )
 
@@ -108,6 +135,11 @@ def add_server_cmd(parser: _ArgumentParser) -> _CommandFunction:
     """Add server-command arguments to its parser."""
 
     with arbiter_args(parser, nargs="*"):
+        for optional in PASSTHROUGH:
+            parser.add_argument(
+                f"--{optional}", help="passed directly to instantiation"
+            )
+
         parser.add_argument(
             "--host",
             default="0.0.0.0",

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/classes/App.js

@@ -53,6 +53,12 @@ class App {
           this.switchTab(hash.tab);
         }
 
+        /* Handle settings controls. */
+        loadSettings();
+
+        /* Handle individual settings. */
+        this.handleInitialMinTxPeriod();
+
         startMainLoop();
       }
     }, {once : true});
@@ -62,6 +68,33 @@ class App {
 
     bootstrap_init();
   }
+
+  handleInitialMinTxPeriod() {
+    if ("min-tx-period-ms" in settings) {
+      /* Set up event handle. */
+      setupCursorContext(settings["min-tx-period-ms"], (elem, down, move,
+                                                        up) => {
+        setupCursorMove(
+            elem, down, move, up,
+            (event) => { this.updateMinTxPeriod(Number(event.target.value)); });
+      });
+
+      /* Set slider to correct value. */
+      settings["min-tx-period-ms"].value = hash.minTxPeriod;
+      settings["min-tx-period-ms"].title = hash.minTxPeriod;
+    }
+
+    this.updateMinTxPeriod();
+  }
+
+  updateMinTxPeriod(value) {
+    if (value || value === 0) {
+      hash.setMinTxPeriod(value);
+      settings["min-tx-period-ms"].title = value;
+    }
+    this.worker.postMessage(
+        {"event" : {"worker" : {"min-tx-period-ms" : hash.minTxPeriod}}});
+  }
 }
 
 function startMainLoop() {

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/classes/PlotModalManager.js

@@ -6,6 +6,8 @@ class PlotModalManager {
     this.body = this.container.querySelector(".modal-body");
     this.footer = this.container.querySelector(".modal-footer");
 
+    this.plotStatus = this.container.querySelector("#plot-status-inner");
+
     this.byEnv = {};
   }
 
@@ -34,7 +36,7 @@ class PlotModalManager {
       }
     }
 
-    this.body.innerHTML = content;
+    this.plotStatus.innerHTML = content;
   }
 }
 

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/classes/WindowHashManager.js

@@ -9,6 +9,7 @@ class WindowHashManager {
     this.channelsShown = true;
     this.plotChannels = {};
     this.filters = {};
+    this.minTxPeriod = 0.0;
   }
 
   tabClick(event) {
@@ -160,8 +161,13 @@ class WindowHashManager {
       for (let item of split) {
         if (item.includes("=")) {
           let keyVal = item.split("=");
-          if (keyVal.length == 2 && keyVal[0] == "filter" && keyVal[1]) {
-            this.updateTabFilter(keyVal[1]);
+          if (keyVal.length == 2) {
+            if (keyVal[0] == "filter" && keyVal[1]) {
+              this.updateTabFilter(keyVal[1]);
+            }
+            if (keyVal[0] == "min-tx-period-ms") {
+              this.minTxPeriod = Number(keyVal[1]);
+            }
           }
         }
       }
@@ -176,6 +182,11 @@ class WindowHashManager {
     return result;
   }
 
+  setMinTxPeriod(value) {
+    this.minTxPeriod = value;
+    this.update();
+  }
+
   buildHash() {
     let hash = this.tab;
 
@@ -189,6 +200,10 @@ class WindowHashManager {
       hash += ",hide-channels"
     }
 
+    if (this.minTxPeriod != 0.0) {
+      hash += `,min-tx-period-ms=${this.minTxPeriod}`;
+    }
+
     for (let tab in tabs) {
       let firstChan = true;
 

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/init.js

@@ -46,3 +46,15 @@ function setupCursorMove(elem, down, move, up, handleMove) {
 function randomHexColor() {
   return "#" + (Math.random() * 0xFFFFFF << 0).toString(16).padStart(6, "0");
 }
+
+/* Load settings control mappings. */
+let settings = {};
+
+function loadSettings() {
+  for (const key of ["min-tx-period-ms"]) {
+    let elem = document.getElementById(`setting-${key}`);
+    if (elem) {
+      settings[key] = elem;
+    }
+  }
+}

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/util.js

@@ -1,6 +1,15 @@
 function worker_config(config) {
   let worker_cfg = {};
 
+  let port_name = "runtimepy_websocket";
+  let uri_prefix = "ws";
+
+  /* Ensured TLS is handled properly. */
+  if (location.protocol.includes("https")) {
+    port_name = "runtimepy_secure_websocket";
+    uri_prefix += "s";
+  }
+
   /* Look for connections to establish. */
   let ports = config["config"]["ports"];
   for (let port_idx in ports) {
@@ -10,11 +19,11 @@ function worker_config(config) {
     let hostname = window.location.hostname;
 
     /* This business logic could use some work. */
-    if (port["name"].includes("runtimepy_websocket")) {
+    if (port["name"].includes(port_name)) {
       if (port["name"].includes("data")) {
-        worker_cfg["data"] = "ws://" + hostname + ":" + port["port"];
+        worker_cfg["data"] = `${uri_prefix}://${hostname}:` + port["port"];
       } else {
-        worker_cfg["json"] = "ws://" + hostname + ":" + port["port"];
+        worker_cfg["json"] = `${uri_prefix}://${hostname}:` + port["port"];
       }
     }
   }

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/data/js/worker.js

@@ -13,11 +13,16 @@ function create_connections(config) {
 
 const plots = new PlotManager();
 
+/* Used to control messaging rate with server. */
+let minTxPeriod = 0.0;
+
 async function message(data) {
   if ("plot" in data) {
     /* Forward the 'name' field. */
     data["plot"]["name"] = data["name"];
     await plots.handleMessage(data["plot"]);
+  } else if ("min-tx-period-ms" in data) {
+    minTxPeriod = data["min-tx-period-ms"];
   } else {
     console.log(`Message for worker:`);
     console.log(data);
@@ -38,9 +43,14 @@ async function start(config) {
   onmessage = async (event) => {
     /* Handle messages meant for this thread. */
     if ("event" in event.data && "worker" in event.data["event"]) {
+      let data = event.data["event"]["worker"];
+
       /* Forward the 'name' field. */
-      event.data["event"]["worker"]["name"] = event.data["name"];
-      await message(event.data["event"]["worker"]);
+      if ("name" in event.data) {
+        data["name"] = event.data["name"];
+      }
+
+      await message(data);
     }
     /* Forward all other messages to the server. */
     else {
@@ -63,13 +73,18 @@ async function start(config) {
   /* Tell main thread we're ready to go. */
   postMessage(0);
 
+  let messageTxTime = 0.0;
+
   /* Set up the main request-animation-frame loop. */
   function render(time) {
     /* Render plot. */
     plots.render(time);
 
     /* Keep the server synchronized with frames. */
-    conns["json"].send_json({"ui" : {"time" : time}});
+    if (messageTxTime + minTxPeriod <= time) {
+      conns["json"].send_json({"ui" : {"time" : time}});
+      messageTxTime = time;
+    }
 
     requestAnimationFrame(render);
   }

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/net/arbiter/tcp/__init__.py

@@ -42,6 +42,7 @@ class TcpConnectionFactory(_ConnectionFactory, _Generic[T]):
         """Create a task that will run a connection server."""
 
         assert not [*args], "Only keyword arguments are used!"
+
         return self.kind.app(
             stop_sig,
             manager=manager,

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/net/server/app/__init__.py

@@ -27,26 +27,27 @@ async def launch_browser(app: AppInfo) -> None:
     """
 
     # Launch browser based on config option.
-    if config_param(app, "xdg_open_http", False):
-
-        port: Any
-        for port in app.config["root"]["ports"]:  # type: ignore
-            if "http_server" in port["name"]:
-                # URI parameters.
-                hostname = config_param(app, "xdg_host", "localhost")
-
-                # Assemble URI.
-                uri = f"http://{hostname}:{port['port']}/"
-
-                # Add a fragment if one was specified.
-                fragment = config_param(app, "xdg_fragment", "")
-                if fragment:
-                    uri += "#" + fragment
-
-                with suppress(FileNotFoundError):
-                    await app.stack.enter_async_context(
-                        spawn_exec("xdg-open", uri)
-                    )
+    for prefix in ["http", "https"]:
+        if config_param(app, f"xdg_open_{prefix}", False):
+
+            port: Any
+            for port in app.config["root"]["ports"]:  # type: ignore
+                if f"{prefix}_server" in port["name"]:
+                    # URI parameters.
+                    hostname = config_param(app, "xdg_host", "localhost")
+
+                    # Assemble URI.
+                    uri = f"{prefix}://{hostname}:{port['port']}/"
+
+                    # Add a fragment if one was specified.
+                    fragment = config_param(app, "xdg_fragment", "")
+                    if fragment:
+                        uri += "#" + fragment
+
+                    with suppress(FileNotFoundError):
+                        await app.stack.enter_async_context(
+                            spawn_exec("xdg-open", uri)
+                        )
 
 
 # Could add an interface for adding multiple applications.

{runtimepy-5.5.0 → runtimepy-5.6.1}/runtimepy/net/server/app/env/__init__.py

@@ -11,6 +11,7 @@ from runtimepy.net.arbiter.info import AppInfo
 from runtimepy.net.server.app.bootstrap.elements import input_box
 from runtimepy.net.server.app.bootstrap.tabs import TabbedContent
 from runtimepy.net.server.app.env.modal import Modal
+from runtimepy.net.server.app.env.settings import plot_settings
 from runtimepy.net.server.app.env.tab import ChannelEnvironmentTab
 from runtimepy.net.server.app.placeholder import dummy_tabs, under_construction
 from runtimepy.net.server.app.sound import SoundTab
@@ -85,8 +86,7 @@ def channel_environments(app: AppInfo, tabs: TabbedContent) -> None:
     )
 
     # Plot settings modal.
-    plot_settings = Modal(tabs, name="plot", icon="graph-up")
-    under_construction(plot_settings.footer)
+    plot_settings(tabs)
 
     # Experimental features.
     if app.config_param("experimental", False):

runtimepy-5.6.1/runtimepy/net/server/app/env/settings.py

@@ -0,0 +1,59 @@
+"""
+A module implementing an application-settings modal.
+"""
+
+# third-party
+from svgen.element.html import div
+
+# internal
+from runtimepy.net.server.app.bootstrap.elements import flex, slider
+from runtimepy.net.server.app.bootstrap.tabs import TabbedContent
+from runtimepy.net.server.app.env.modal import Modal
+from runtimepy.net.server.app.placeholder import under_construction
+
+
+def plot_settings(tabs: TabbedContent) -> None:
+    """Create the plot settings modal."""
+
+    modal = Modal(tabs, name="plot", icon="graph-up")
+    under_construction(modal.footer)
+
+    div(tag="h1", text="settings", parent=modal.body)
+    div(tag="hr", parent=modal.body)
+
+    div(tag="h2", text="plot status", parent=modal.body)
+    div(id="plot-status-inner", parent=modal.body)
+    div(tag="hr", parent=modal.body)
+
+    div(tag="h2", text="minimum transmit period (ms)", parent=modal.body)
+
+    div(
+        tag="p",
+        text=(
+            "Can be used to throttle the rate of "
+            "client <-> server communication. Use the 'ui' tab's metrics to "
+            "determine performance impact. Note that only this browser tab's "
+            "messaging rate can be controlled (not other connected clients')."
+        ),
+        parent=modal.body,
+    )
+
+    container = flex(parent=modal.body)
+
+    div(
+        text="0 ms ('high', run at native refresh rate)",
+        parent=container,
+        class_str="text-nowrap text-primary",
+    )
+
+    slider(
+        0, 100, 100, parent=container, value=0, id="setting-min-tx-period-ms"
+    ).add_class("ms-3 me-3")
+
+    div(
+        text="100 ms ('low', 10 Hz)",
+        parent=container,
+        class_str="text-nowrap text-primary",
+    )
+
+    div(tag="hr", parent=modal.body)

runtimepy-5.6.1/runtimepy/net/ssl.py

@@ -0,0 +1,33 @@
+"""
+A module implementing SSL-related interfaces.
+"""
+
+# built-in
+import ssl
+from typing import Any
+
+
+def handle_possible_ssl(client: bool = True, **kwargs) -> dict[str, Any]:
+    """Handle creating an SSL context based on keyword arguments."""
+
+    args = ["cafile", "capath", "cadata"]
+    if (
+        kwargs.pop("use_ssl", False)
+        or any(x in kwargs for x in args)
+        or "certfile" in kwargs
+    ):
+        context = ssl.create_default_context(
+            purpose=(
+                ssl.Purpose.SERVER_AUTH if client else ssl.Purpose.CLIENT_AUTH
+            ),
+            **{x: kwargs.pop(x, None) for x in args},
+        )
+
+        if "certfile" in kwargs:
+            context.load_cert_chain(
+                kwargs.pop("certfile"), keyfile=kwargs.pop("keyfile", None)
+            )
+
+        kwargs["ssl"] = context
+
+    return kwargs