runtimepy 5.8.4__py3-none-any.whl → 5.9.1__py3-none-any.whl

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/data/js/markdown_page.js

@@ -10,15 +10,19 @@ function lightDarkClick(event) {
   window.location.hash = lightMode ? "#light-mode" : "";
 }
 
-let lightDarkButton = document.getElementById("theme-button");
-if (lightDarkButton) {
-  lightDarkButton.addEventListener("click", lightDarkClick);
-}
+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 (window.location.hash) {
+    let parts = window.location.hash.slice(1).split(",");
 
-  if (parts.includes("light-mode")) {
-    lightDarkButton.click();
+    if (parts.includes("light-mode")) {
+      lightDarkButton.click();
+    }
   }
-}
+
+  bootstrap_init();
+};

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/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/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/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/requirements.txt

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

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.dist-info → runtimepy-5.9.1.dist-info}/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.dist-info → runtimepy-5.9.1.dist-info}/METADATA

@@ -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: svgen>=0.7.4
-Requires-Dist: vcorelib>=3.4.8
 Requires-Dist: websockets
 Requires-Dist: psutil
 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.dist-info → runtimepy-5.9.1.dist-info}/RECORD

@@ -1,11 +1,11 @@
-runtimepy/__init__.py,sha256=oMrAywftcbstGYwY0z1DXS3TjHOgKgWR7CH65gdZkbQ,390
+runtimepy/__init__.py,sha256=WYh3eb-XrVkK9YtfaTCSVSalmUbmw6WkcNIFMdC2A7Y,390
 runtimepy/__main__.py,sha256=OPAed6hggoQdw-6QAR62mqLC-rCkdDhOq0wyeS2vDRI,332
 runtimepy/app.py,sha256=sTvatbsGZ2Hdel36Si_WUbNMtg9CzsJyExr5xjIcxDE,970
 runtimepy/dev_requirements.txt,sha256=j0dh11ztJAzfaUL0iFheGjaZj9ppDzmTkclTT8YKO8c,230
 runtimepy/entry.py,sha256=3672ccoslf2h8Wg5M_SuW6SoEx0oslRoi0ngZsgjNz8,1954
 runtimepy/mapping.py,sha256=VQK1vzmQVvYYKI85_II37-hIEbvgL3PzNy-WI6TTo80,5091
 runtimepy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-runtimepy/requirements.txt,sha256=06GUbnvKnIxnUcTivKEv2Ik34C9RU8Sm5Ko9uvI1f9s,124
+runtimepy/requirements.txt,sha256=PdID4t7w3qsEoNwrMR-SJoH5OQ9oIUcpesKJC4AiU64,124
 runtimepy/schemas.py,sha256=zTgxPm9DHZ0R_bmmOjNQMTXdtM_Hb1bE-Fog40jDCgg,839
 runtimepy/util.py,sha256=GuyIHVFGMS02OR6-O3LnlV3DqG5hj4-IUud0QM6WicA,1684
 runtimepy/channel/__init__.py,sha256=pf0RJ5g37_FVV8xoUNgzFGuIfbZEYSBA_cQlJSDTPDo,4774
@@ -60,7 +60,7 @@ runtimepy/data/js/audio.js,sha256=bLkBqbeHMiGGidfL3iXjmVoF9seK-ZeZ3kwgOrcpgk4,10
 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=nYIQ6O76EWqlzwX7oEwPXqC-LCUFCZYDADK9QbYRDKk,404
-runtimepy/data/js/markdown_page.js,sha256=pygLkO6P1AJnOy5PjIUH_px1OEiROrSNLGLUFuERMJc,610
+runtimepy/data/js/markdown_page.js,sha256=7PNELE79WB3YU_rGq_0v-uDB7kyYtn5U8zpBeBiVHqg,678
 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
@@ -144,7 +144,7 @@ runtimepy/net/manager.py,sha256=-M-ZSB9izay6HK1ytTayAYnSHYAz34dcwxaiNhC4lWg,4264
 runtimepy/net/mixin.py,sha256=5UlFK4lRrJ2O0nEUuScGbkYd4-El-RruFt_UcQR0aic,3039
 runtimepy/net/mtu.py,sha256=XnLXAFMsDxK1Lj5v_zgWaBrC3lNqf81DkbDc6hpMdmI,3495
 runtimepy/net/ssl.py,sha256=dj9uECPKDT5k-5vlR5I3Z7Go3WWZhbaJ9nb0rC3kJvg,854
-runtimepy/net/util.py,sha256=P6WnH4n8JJkEfKwepk1eP4lGPxWjqcFv0yL3N0mvtrw,5897
+runtimepy/net/util.py,sha256=XTQQ-Ql_ImhVd1_O8nSeDX9MY8xJwRBggvliSLCrsc8,5913
 runtimepy/net/apps/__init__.py,sha256=vjo7e19QXtJwe6V6B-QGvYiJveYobnYIfpkKZrnS17w,710
 runtimepy/net/arbiter/__init__.py,sha256=ptKF995rYKvkm4Mya92vA5QEDqcFq5NRD0IYGqZ6_do,740
 runtimepy/net/arbiter/base.py,sha256=hggbHBWkuJaEkBTenlI2eCtTywhicvUpAIeI-PPYUkY,14958
@@ -166,7 +166,7 @@ runtimepy/net/arbiter/struct/__init__.py,sha256=Vr38dp2X0PZOrAbjKsZ9xZdQ1j3z92s4
 runtimepy/net/arbiter/tcp/__init__.py,sha256=djNm8il_9aLNpGsYResJlFmyIqx9XNLqVay-mYnn8vc,1530
 runtimepy/net/arbiter/tcp/json.py,sha256=W9a_OwBPmIoB2XZf4iuAIWQhMg2qA9xejBhGBdNCPnI,742
 runtimepy/net/factories/__init__.py,sha256=rPdBVpgzzQYF61w6efQrEre71yMPHd6kanBpMdOX-3c,4672
-runtimepy/net/html/__init__.py,sha256=BQeGpZWfGSmMg1R0N9GaOZfyFn4UQGHKoFOhd-1G75Q,3983
+runtimepy/net/html/__init__.py,sha256=2wdkMAomTlKJURi7eIhFUcXYXPAC-WWAuCfKy5QFTac,4964
 runtimepy/net/html/arbiter.py,sha256=SkZZm-CmyCxbAcWZbvCLH-RwFUJPvrvR5yWysVVuvCM,951
 runtimepy/net/html/bootstrap/__init__.py,sha256=ONhwx68piWjsrf88FMpda84TWSPqgi-RZCBuWCci_ak,1444
 runtimepy/net/html/bootstrap/elements.py,sha256=NBdjg0_1LTxoyJrNQNw-2v8AWaiW2S1poJcDo4P6GWE,5355
@@ -178,7 +178,7 @@ 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=sYvvt7p3yTFCR2YXf4Qx3bKo_AafW0OjQ_30KKbg2DM,9488
+runtimepy/net/server/__init__.py,sha256=Kg1NenLXSDWYa7NFvQLu2hHU4p6sYXwspv2NSZ7VfSo,9647
 runtimepy/net/server/html.py,sha256=ufg0PQF_iUE7PT0n3Pn3jTcun7mspZUI6_ooblcNnvI,1217
 runtimepy/net/server/json.py,sha256=a7vM5yfq2er4DexzFqEMnxoMGDeuywKkVH4-uNJBAik,2522
 runtimepy/net/server/app/__init__.py,sha256=beU67t7zoKGlO7aldjQMUwYLm9mSlc78eMQazri-otw,3012
@@ -235,7 +235,7 @@ runtimepy/primitives/bool.py,sha256=c-IRpVZ84m-pOreCHC382tOW0NFKEwSTiEeXAtlJjvk,
 runtimepy/primitives/byte_order.py,sha256=80mMk1Sj_l49XvAtvrPmoYFpFYSM1HgYuwR2-P7os3Q,767
 runtimepy/primitives/evaluation.py,sha256=0N7mT8uoiJaY-coF2PeEXU2WO-FmbyN2Io9_EaghO9Q,4657
 runtimepy/primitives/float.py,sha256=aeEsj0xRJM57Hcv04OtLfT_sTBocZldbn19HpQq3Hxs,1946
-runtimepy/primitives/int.py,sha256=Zch7iIW9xsLmAtmIYWY9lWOJpv6dbZT102J2Yey66gc,3018
+runtimepy/primitives/int.py,sha256=OSJ5_lPrzJfLMDssMQHSbB0PzuqQRvCtJSRen7G9QBc,3352
 runtimepy/primitives/scaling.py,sha256=Vtxp2CSBahqPp4i2-IS4wjbcC023xwf-dqZMbYWf3V4,1144
 runtimepy/primitives/string.py,sha256=ic5VKhXCSIwEOUfqIb1VUpZPwjdAcBul-cLLIihVkQI,2532
 runtimepy/primitives/array/__init__.py,sha256=qPH8SN8vqRZR-J3OZsm-46tKqfnXpGLb1lw9Jni1udI,8362
@@ -272,7 +272,7 @@ runtimepy/task/asynchronous.py,sha256=w4oEUCyj-X-zDVFmlsAtRL1gv66ahQ78QKE0GmLGT1
 runtimepy/task/sample.py,sha256=_nbLj5Julwa1NJC_-WQsotI0890G-TlOWftVHEKiclY,2735
 runtimepy/task/basic/__init__.py,sha256=NryfG-JmSyqYh-TNG4NLO6-9RJFVq5vn1Z-oV3qTVvg,243
 runtimepy/task/basic/manager.py,sha256=2P_swKZlFfPHCmX6sMVGSYePWEZOqXp9B4YPyRYSGCo,1858
-runtimepy/task/basic/periodic.py,sha256=_EhX5XfvOJlTr0jUuO6r0mbgF7UE1TT2VVt8jFeWptk,6989
+runtimepy/task/basic/periodic.py,sha256=VevcEzxMsKwqDU18ejOgmbhMYEwjkc-uePSQV7qumCA,7286
 runtimepy/task/trig/__init__.py,sha256=GuGNb9eLuFEnl3nAI7Mi_eS5mqJ4MOhEy2Wfv48RFic,785
 runtimepy/telemetry/__init__.py,sha256=G_JLZsp0EZMGaxSQ12fYgbG2kN4QkvVG4lExV_TzEhM,268
 runtimepy/telemetry/sample.py,sha256=1weoGSH-yGg-fOaLysZAsO3dSTM6yAXX3XdulAiqi3s,3216
@@ -284,9 +284,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.8.4.dist-info/LICENSE,sha256=s2ILEylm2dAJJXL25nM92IWLRKmJW92zQRQe_cfdsHo,1071
-runtimepy-5.8.4.dist-info/METADATA,sha256=xOJmQiU6_1njXfp36M4IuEavC0ddklFVwz-kWL7vur4,9288
-runtimepy-5.8.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-runtimepy-5.8.4.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.8.4.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.8.4.dist-info/RECORD,,
+runtimepy-5.9.1.dist-info/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
+runtimepy-5.9.1.dist-info/METADATA,sha256=1_fDtWfB-WZA3Jn79TabypVK4cR3UArOAj3Z6puQ124,9371
+runtimepy-5.9.1.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+runtimepy-5.9.1.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.9.1.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.9.1.dist-info/RECORD,,

{runtimepy-5.8.4.dist-info → runtimepy-5.9.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (76.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any