runtimepy 5.8.4__tar.gz → 5.9.1__tar.gz

{runtimepy-5.8.4 → runtimepy-5.9.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Libre Embedded
+Copyright (c) 2025 Libre Embedded
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{runtimepy-5.8.4/runtimepy.egg-info → runtimepy-5.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: runtimepy
-Version: 5.8.4
+Version: 5.9.1
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -18,10 +18,10 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websockets
-Requires-Dist: aiofiles
 Requires-Dist: psutil
-Requires-Dist: vcorelib>=3.4.8
 Requires-Dist: svgen>=0.7.4
+Requires-Dist: aiofiles
+Requires-Dist: vcorelib>=3.5.1
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -40,16 +40,20 @@ Requires-Dist: types-psutil; extra == "test"
 Requires-Dist: setuptools-wrapper; extra == "test"
 Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") and extra == "test"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
 
 <!--
     =====================================
     generator=datazen
     version=3.1.4
-    hash=f89c565370dd68d4215345aeab6feff4
+    hash=f3a77d6dfc0bda171a9716c3731531c5
     =====================================
 -->
 
-# runtimepy ([5.8.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.9.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)

{runtimepy-5.8.4 → runtimepy-5.9.1}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=f89c565370dd68d4215345aeab6feff4
+    hash=f3a77d6dfc0bda171a9716c3731531c5
     =====================================
 -->
 
-# runtimepy ([5.8.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.9.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)

{runtimepy-5.8.4 → runtimepy-5.9.1}/pyproject.toml

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

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=99838ab674af55409015e5abdd55fc6e
+# hash=47ca3ea38190cecfff6abaeec5ce0939
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.8.4"
+VERSION = "5.9.1"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy-5.9.1/runtimepy/data/js/markdown_page.js

@@ -0,0 +1,28 @@
+/* Dark is hard-coded initial state (in HTML). */
+let lightMode = false;
+
+function lightDarkClick(event) {
+  lightMode = !lightMode;
+
+  document.getElementById("runtimepy")
+      .setAttribute("data-bs-theme", lightMode ? "light" : "dark");
+
+  window.location.hash = lightMode ? "#light-mode" : "";
+}
+
+window.onload = () => {
+  let lightDarkButton = document.getElementById("theme-button");
+  if (lightDarkButton) {
+    lightDarkButton.addEventListener("click", lightDarkClick);
+  }
+
+  if (window.location.hash) {
+    let parts = window.location.hash.slice(1).split(",");
+
+    if (parts.includes("light-mode")) {
+      lightDarkButton.click();
+    }
+  }
+
+  bootstrap_init();
+};

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/net/html/__init__.py

@@ -4,7 +4,8 @@ A module implementing HTML-related interfaces.
 
 # built-in
 from io import StringIO
-from typing import Optional
+from typing import Any, Optional
+from urllib.parse import parse_qs
 
 # third-party
 from svgen.element import Element
@@ -12,6 +13,7 @@ from svgen.element.html import Html, div
 from vcorelib import DEFAULT_ENCODING
 from vcorelib.io import IndentedFileWriter
 from vcorelib.paths import find_file
+from vcorelib.python import StrToBool
 
 # internal
 from runtimepy import PKG_NAME
@@ -26,18 +28,25 @@ from runtimepy.net.html.bootstrap.elements import (
 )
 
 
-def create_app_shell(parent: Element, **kwargs) -> tuple[Element, Element]:
+def create_app_shell(
+    parent: Element,
+    bootstrap_theme: str = "dark",
+    use_button_column: bool = True,
+    **kwargs,
+) -> tuple[Element, Element]:
     """Create a bootstrap-based application shell."""
 
     container = div(parent=parent, **kwargs)
     container.add_class("d-flex", "align-items-start", "bg-body")
 
     # Dark theme.
-    container["data-bs-theme"] = "dark"
+    container["data-bs-theme"] = bootstrap_theme
 
     # Buttons.
-    button_column = div(parent=container)
-    button_column.add_class("d-flex", "flex-column", "h-100", "bg-dark-subtle")
+    button_column = div(parent=container if use_button_column else None)
+    button_column.add_class(
+        "d-flex", "flex-column", "h-100", f"bg-{bootstrap_theme}-subtle"
+    )
 
     # Dark/light theme switch button.
     bootstrap_button(
@@ -50,14 +59,18 @@ def create_app_shell(parent: Element, **kwargs) -> tuple[Element, Element]:
     return container, button_column
 
 
-def markdown_page(parent: Element, markdown: str, **kwargs) -> None:
+def markdown_page(
+    parent: Element, markdown: str, **kwargs
+) -> tuple[Element, Element]:
     """Compose a landing page."""
 
-    container = centered_markdown(
-        create_app_shell(parent, **kwargs)[0], markdown, "h-100", "text-body"
-    )
+    parent, button_column = create_app_shell(parent, **kwargs)
+
+    container = centered_markdown(parent, markdown, "h-100", "text-body")
     container.add_class("overflow-y-auto")
 
+    return container, button_column
+
 
 def common_css(document: Html) -> None:
     """Add common CSS to an HTML document."""
@@ -69,14 +82,38 @@ def common_css(document: Html) -> None:
     )
 
 
-def full_markdown_page(document: Html, markdown: str) -> None:
+def full_markdown_page(
+    document: Html, markdown: str, uri_query: Optional[str] = None
+) -> None:
     """Render a full markdown HTML app."""
 
     common_css(document)
-    markdown_page(document.body, markdown, id=PKG_NAME)
+
+    markdown_kwargs: dict[str, Any] = {"id": PKG_NAME}
+
+    if uri_query:
+        parsed = parse_qs(uri_query)
+
+        # Handle pages optimized for document creation.
+        if "print" in parsed and any(
+            StrToBool.check(x) for x in parsed["print"]
+        ):
+            markdown_kwargs["bootstrap_theme"] = "light"
+            markdown_kwargs["use_button_column"] = False
+
+    _, button_column = markdown_page(
+        document.body, markdown, **markdown_kwargs
+    )
+
+    bootstrap_button(
+        icon_str("printer"),
+        tooltip="Printer-friendly view.",
+        id="print-button",
+        parent=div(tag="a", href="?print=true", parent=button_column),
+    )
 
     # JavaScript.
-    append_kind(document.body, "markdown_page")
+    append_kind(document.body, "util", "markdown_page")
     add_bootstrap_js(document.body)
 
 

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/net/server/__init__.py

@@ -136,7 +136,11 @@ class RuntimepyServerConnection(HttpConnection):
         return result
 
     def render_markdown(
-        self, content: str, response: ResponseHeader, **kwargs
+        self,
+        content: str,
+        response: ResponseHeader,
+        query: Optional[str],
+        **kwargs,
     ) -> bytes:
         """Return rendered markdown content."""
 
@@ -146,6 +150,7 @@ class RuntimepyServerConnection(HttpConnection):
             full_markdown_page(
                 document,
                 writer.stream.getvalue(),  # type: ignore
+                uri_query=query,
             )
 
         response["Content-Type"] = f"text/html; charset={DEFAULT_ENCODING}"
@@ -153,12 +158,16 @@ class RuntimepyServerConnection(HttpConnection):
         return document.encode_str().encode()
 
     async def render_markdown_file(
-        self, path: Path, response: ResponseHeader, **kwargs
+        self,
+        path: Path,
+        response: ResponseHeader,
+        query: Optional[str],
+        **kwargs,
     ) -> bytes:
         """Render a markdown file as HTML and return the result."""
 
         return self.render_markdown(
-            (await read_binary(path)).decode(), response, **kwargs
+            (await read_binary(path)).decode(), response, query, **kwargs
         )
 
     async def try_file(
@@ -177,7 +186,7 @@ class RuntimepyServerConnection(HttpConnection):
                 md_candidate = candidate.with_suffix(".md")
                 if md_candidate.is_file():
                     return await self.render_markdown_file(
-                        md_candidate, response
+                        md_candidate, response, path[1]
                     )
 
             if candidate.is_file():

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/net/util.py

@@ -159,7 +159,7 @@ def hostname(ip_address: str) -> str:
 def address_str(name: str, fallback_host: str = "localhost", **kwargs) -> str:
     """Get an IP address string for a given name."""
 
-    return _socket.getaddrinfo(
+    return _socket.getaddrinfo(  # type: ignore
         name if name else fallback_host, None, **kwargs
     )[0][4][0]
 

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/primitives/int.py

@@ -40,6 +40,17 @@ class BaseIntPrimitive(PrimitiveIsCloseMixin[int]):
         self.set_value(new_val, timestamp_ns=timestamp_ns)
         return new_val
 
+    async def wait_for_increment(
+        self, timeout: float, count: int = 1
+    ) -> EvalResult:
+        """Wait for this primitive to increment by a certain amount."""
+
+        return await self.wait_for_value(
+            self.raw.value + count,
+            timeout,
+            operation=Operator.LESS_THAN_OR_EQUAL,
+        )
+
     async def wait_for_value(
         self,
         value: int | float,

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/requirements.txt

@@ -1,5 +1,5 @@
 aiofiles
-vcorelib>=3.4.8
+vcorelib>=3.5.1
 svgen>=0.7.4
 websockets
 psutil

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy/task/basic/periodic.py

@@ -136,6 +136,15 @@ class PeriodicTask(
             self._enabled.clear()
         return result
 
+    async def wait_iterations(self, timeout: float, count: int = 1) -> bool:
+        """Wait for a task to complete a certain number of iterations."""
+
+        return bool(
+            await self.metrics.dispatches.wait_for_increment(
+                timeout, count=count
+            )
+        )
+
     async def run(
         self, period_s: float = None, stop_sig: _asyncio.Event = None
     ) -> None:

{runtimepy-5.8.4 → runtimepy-5.9.1/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: runtimepy
-Version: 5.8.4
+Version: 5.9.1
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
@@ -18,10 +18,10 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: websockets
-Requires-Dist: aiofiles
 Requires-Dist: psutil
-Requires-Dist: vcorelib>=3.4.8
 Requires-Dist: svgen>=0.7.4
+Requires-Dist: aiofiles
+Requires-Dist: vcorelib>=3.5.1
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -40,16 +40,20 @@ Requires-Dist: types-psutil; extra == "test"
 Requires-Dist: setuptools-wrapper; extra == "test"
 Requires-Dist: types-setuptools; extra == "test"
 Requires-Dist: uvloop; (sys_platform != "win32" and sys_platform != "cygwin") and extra == "test"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
 
 <!--
     =====================================
     generator=datazen
     version=3.1.4
-    hash=f89c565370dd68d4215345aeab6feff4
+    hash=f3a77d6dfc0bda171a9716c3731531c5
     =====================================
 -->
 
-# runtimepy ([5.8.4](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.9.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)

{runtimepy-5.8.4 → runtimepy-5.9.1}/runtimepy.egg-info/requires.txt

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

runtimepy-5.8.4/runtimepy/data/js/markdown_page.js

@@ -1,24 +0,0 @@
-/* Dark is hard-coded initial state (in HTML). */
-let lightMode = false;
-
-function lightDarkClick(event) {
-  lightMode = !lightMode;
-
-  document.getElementById("runtimepy")
-      .setAttribute("data-bs-theme", lightMode ? "light" : "dark");
-
-  window.location.hash = lightMode ? "#light-mode" : "";
-}
-
-let lightDarkButton = document.getElementById("theme-button");
-if (lightDarkButton) {
-  lightDarkButton.addEventListener("click", lightDarkClick);
-}
-
-if (window.location.hash) {
-  let parts = window.location.hash.slice(1).split(",");
-
-  if (parts.includes("light-mode")) {
-    lightDarkButton.click();
-  }
-}