runtimepy 5.7.6__py3-none-any.whl → 5.7.8__py3-none-any.whl

runtimepy/__init__.py

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

runtimepy/data/md/RuntimeStruct.md

@@ -1,3 +1,4 @@
 # Runtime Structures
 
+Containers for underlying primitives that can participate in binary messaging.
 To be continued.

runtimepy/metrics/channel.py

@@ -43,7 +43,7 @@ class ChannelMetrics:
     def __str__(self) -> str:
         """Get metrics as a string."""
 
-        return "\t".join(
+        return " | ".join(
             [
                 f"messages={self.messages.value}",
                 f"message_rate={self.message_rate.value:.2f}",

runtimepy/net/arbiter/housekeeping/__init__.py

@@ -52,7 +52,11 @@ class ConnectionMetricsPoller(_ArbiterTask):
 
         # Handle any incoming commands.
         processors: list[Awaitable[None]] = []
-        for mapping in self.app.connections.values(), self.app.tasks.values():
+        for mapping in (
+            self.app.connections.values(),
+            self.app.tasks.values(),
+            self.app.structs.values(),
+        ):
             for item in mapping:
                 if isinstance(item, AsyncCommandProcessingMixin):
                     processors.append(item.process_command_queue())

runtimepy/net/arbiter/info.py

@@ -6,6 +6,7 @@ A module implementing an application information interface.
 from abc import ABC as _ABC
 import asyncio as _asyncio
 from contextlib import AsyncExitStack as _AsyncExitStack
+from contextlib import contextmanager
 from dataclasses import dataclass
 from logging import getLogger as _getLogger
 from re import compile as _compile
@@ -57,13 +58,29 @@ class RuntimeStruct(RuntimeStructBase, _ABC):
 
     byte_order: ByteOrder = DEFAULT_BYTE_ORDER
 
+    # Set this for structs to automatically be polled when the application is
+    # going down.
+    final_poll = False
+
     def init_env(self) -> None:
         """Initialize this sample environment."""
 
+    @contextmanager
+    def _final_poll(self) -> _Iterator[None]:
+        """Poll when the context ends."""
+
+        try:
+            yield
+        finally:
+            self.poll()
+
     async def build(self, app: "AppInfo", **kwargs) -> None:
         """Build a struct instance's channel environment."""
 
         self.app = app
+        if self.final_poll:
+            self.app.stack.enter_context(self._final_poll())
+
         self.init_env()
         self.update_byte_order(self.byte_order, **kwargs)
 
@@ -102,6 +119,9 @@ class TrigStruct(RuntimeStruct, TrigMixin):
 class SampleStruct(TrigStruct):
     """A sample runtime structure."""
 
+    # For fun.
+    final_poll = True
+
     def init_env(self) -> None:
         """Initialize this sample environment."""
         super().init_env()

runtimepy/requirements.txt

@@ -1,5 +1,5 @@
 aiofiles
-vcorelib>=3.4.2
+vcorelib>=3.4.3
 svgen>=0.6.8
 websockets
 psutil

runtimepy/sample/peer.py

@@ -49,6 +49,9 @@ class SamplePeer(RuntimepyPeer):
                     )
                     sig = asyncio.Event()
                     task = asyncio.create_task(conn.process(stop_sig=sig))
-                    await conn.request(RequestHeader(target="/index.html"))
+
+                    for endpoint in ["/index.html", "/app.html"]:
+                        await conn.request(RequestHeader(target=endpoint))
+
                     sig.set()
                     await task

runtimepy/sample/program.py

@@ -63,6 +63,8 @@ async def run(app: AppInfo) -> int:
 
     prog = SampleProgram.singleton()
 
+    prog.send_poll(2)
+
     await prog.share_config({"config": app.original_config()})
 
     assert prog is not None

runtimepy/schemas.py

@@ -8,12 +8,17 @@ from typing import Optional as _Optional
 # third-party
 from vcorelib.dict.codec import DictCodec as _DictCodec
 from vcorelib.io import DEFAULT_INCLUDES_KEY
+from vcorelib.paths.find import PACKAGE_SEARCH
 from vcorelib.schemas.base import SchemaMap as _SchemaMap
 from vcorelib.schemas.json import JsonSchemaMap as _JsonSchemaMap
 
 # internal
 from runtimepy import PKG_NAME
 
+# Add this package to the search path.
+if PKG_NAME not in PACKAGE_SEARCH:
+    PACKAGE_SEARCH.insert(0, PKG_NAME)
+
 
 class RuntimepyDictCodec(_DictCodec):
     """

runtimepy/struct/__init__.py

@@ -3,7 +3,10 @@ A module implementing a runtime structure base.
 """
 
 # built-in
+from argparse import Namespace
+import asyncio
 from logging import getLogger as _getLogger
+from typing import Optional
 
 # third-party
 from vcorelib.io import MarkdownMixin
@@ -11,15 +14,20 @@ from vcorelib.io.types import JsonObject as _JsonObject
 
 # internal
 from runtimepy import PKG_NAME
+from runtimepy.channel.environment.command import FieldOrChannel
 from runtimepy.channel.environment.command.processor import (
     ChannelCommandProcessor,
 )
+from runtimepy.mixins.async_command import AsyncCommandProcessingMixin
 from runtimepy.mixins.environment import ChannelEnvironmentMixin
 from runtimepy.mixins.logging import LoggerMixinLevelControl
 
 
 class RuntimeStructBase(
-    LoggerMixinLevelControl, ChannelEnvironmentMixin, MarkdownMixin
+    LoggerMixinLevelControl,
+    ChannelEnvironmentMixin,
+    AsyncCommandProcessingMixin,
+    MarkdownMixin,
 ):
     """A base runtime structure."""
 
@@ -42,6 +50,23 @@ class RuntimeStructBase(
         self.command = ChannelCommandProcessor(self.env, self.logger)
         self.config = config
 
+        async def poll(args: Namespace, __: Optional[FieldOrChannel]) -> None:
+            """Handle a test command."""
+
+            count = 1
+            delay = 0.0
+
+            if args.extra:
+                count = int(args.extra[0])
+                if len(args.extra) > 1:
+                    delay = float(args.extra[1])
+
+            for _ in range(count):
+                self.poll()
+                await asyncio.sleep(delay)
+
+        self._setup_async_commands(poll)
+
     def poll(self) -> None:
         """
         A method that other runtime entities can call to perform canonical

{runtimepy-5.7.6.dist-info → runtimepy-5.7.8.dist-info}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Vaughn Kottler
+Copyright (c) 2024 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.7.6.dist-info → runtimepy-5.7.8.dist-info}/METADATA

@@ -1,27 +1,27 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 5.7.6
+Version: 5.7.8
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/vkottler/runtimepy
 Author: Vaughn Kottler
 Author-email: Vaughn Kottler <vaughn@libre-embedded.com>
 Maintainer-email: Vaughn Kottler <vaughn@libre-embedded.com>
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: Unix
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiofiles
 Requires-Dist: websockets
-Requires-Dist: vcorelib >=3.4.2
-Requires-Dist: psutil
 Requires-Dist: svgen >=0.6.8
+Requires-Dist: aiofiles
+Requires-Dist: psutil
+Requires-Dist: vcorelib >=3.4.3
 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=41ff8742602f69f2831092a4b666cddc
+    hash=310d6c6e0ee94ad235278f3b6a152499
     =====================================
 -->
 
-# runtimepy ([5.7.6](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.7.8](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)
@@ -72,8 +72,8 @@ Requires-Dist: uvloop ; (sys_platform != "win32" and sys_platform != "cygwin") a
 
 This package is tested with the following Python minor versions:
 
-* [`python3.11`](https://docs.python.org/3.11/)
 * [`python3.12`](https://docs.python.org/3.12/)
+* [`python3.13`](https://docs.python.org/3.13/)
 
 ## Platform Support
 

{runtimepy-5.7.6.dist-info → runtimepy-5.7.8.dist-info}/RECORD

@@ -1,12 +1,12 @@
-runtimepy/__init__.py,sha256=47z6hCc2pWcbeYdGuB007x_wR84imlspZBFz0Ue3_oc,390
+runtimepy/__init__.py,sha256=wHGtHvzNOvk1GbpkhbtXDcPA2-uVXlxUyWdAM-_eN30,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=77PnkPte9OZyyJg88wF_6su2H4XSvuN8rQH1tibLdv4,124
-runtimepy/schemas.py,sha256=NROlzVCZGLTJ9xe7d1eNIYmjzf0AOv3qHK-f6g1jGHk,678
+runtimepy/requirements.txt,sha256=Lzt3_FitEORFFXuxvGMIkj8hcHmAJSTvKYbGRvvazrI,124
+runtimepy/schemas.py,sha256=zTgxPm9DHZ0R_bmmOjNQMTXdtM_Hb1bE-Fog40jDCgg,839
 runtimepy/util.py,sha256=1279Ea7CNHa1U_JvUydGAb2oEI2TxilXkq5V1RseCwU,1437
 runtimepy/channel/__init__.py,sha256=pf0RJ5g37_FVV8xoUNgzFGuIfbZEYSBA_cQlJSDTPDo,4774
 runtimepy/channel/registry.py,sha256=nk36qM_Bf6qK6AFR0plaZHR1PU7b4LZqbQ0feJqk4lc,4784
@@ -85,7 +85,7 @@ runtimepy/data/js/third-party/webgl-debug.js,sha256=AtuSr5qje8a37S2ZE-ztA01QuGlG
 runtimepy/data/js/unused/pyodide.js,sha256=tcfj4XcYdhJSwFdHOQYpIHu0_2fGwkpWp4ZFyIRmmrc,864
 runtimepy/data/md/Connection.md,sha256=gh0KIQObDOYEf_DNxLcb8U3ngjTYtmsgOhvz_O7QYpY,32
 runtimepy/data/md/PeriodicTask.md,sha256=86JR4cgUjhFU3pnUXvKIETVEtmskYtQ_Ip-v2_10G0Y,35
-runtimepy/data/md/RuntimeStruct.md,sha256=-hci789w_x098IxoSv0-euP8GQ2B1CF-hxPuRpljEng,39
+runtimepy/data/md/RuntimeStruct.md,sha256=W6R0JQLGGXPJt71pssakHPEOBa7Mntjh4ErwoNoM0Bs,118
 runtimepy/data/md/RuntimepyPeer.md,sha256=ayjL1V5KXRBEixG0vfxIajY2Dt_H5SYaZGSscXHSL4E,34
 runtimepy/data/md/SinusoidTask.md,sha256=nTGmZXFv-r9d-ZgmmIHr6SKSp-K-nzJW-B6NKhg7FQ8,739
 runtimepy/data/schemas/BitFields.yaml,sha256=7tSjEQNo_j458EN16AgIaC5eh0iEXCj9EbVTVc-EkB8,926
@@ -125,7 +125,7 @@ runtimepy/message/handlers.py,sha256=He9NC7MCkaV2clKc8dTSZ_T8N2l3ATjaTFzBr9n1T34
 runtimepy/message/interface.py,sha256=vg25Uhp7wrDFH6v2iRKUBwnCBpjc3JAFjwdu3KArrLo,11285
 runtimepy/message/types.py,sha256=vajDWKW32LjzsfH-eVCCxZTWVctj4_-tjanhnmCqUis,821
 runtimepy/metrics/__init__.py,sha256=NyCcB3uJi4_tGMO-ws3CPRA2fph2t15BcW_tfeV9fmc,357
-runtimepy/metrics/channel.py,sha256=YhALSMCPHESkYChzzE6dNAxKX-2bPqVe02E_qeyyt5E,2526
+runtimepy/metrics/channel.py,sha256=rCF_NZ4UaIYV4NExmw0Mskzyd2Npy-c_hFiRe36_bzg,2527
 runtimepy/metrics/connection.py,sha256=FiN0BQ79eDBf5qCh1sx7m6CSDbMMW7WMi7li96mHkoo,808
 runtimepy/metrics/task.py,sha256=g6CttQ3SS217DJRBFnj-rDUq6uauZdMOcTOjHgSEfWo,1911
 runtimepy/mixins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -148,7 +148,7 @@ runtimepy/net/util.py,sha256=P6WnH4n8JJkEfKwepk1eP4lGPxWjqcFv0yL3N0mvtrw,5897
 runtimepy/net/apps/__init__.py,sha256=vjo7e19QXtJwe6V6B-QGvYiJveYobnYIfpkKZrnS17w,710
 runtimepy/net/arbiter/__init__.py,sha256=ptKF995rYKvkm4Mya92vA5QEDqcFq5NRD0IYGqZ6_do,740
 runtimepy/net/arbiter/base.py,sha256=w5IFDRU1Zfw7sfg0eS8hj7_Ip6bHHYQ4S212Ic-Kj-c,14817
-runtimepy/net/arbiter/info.py,sha256=zipdr928xN32Dt5Wl_FbCCAf7XOlT0GGNHiv4DoI-94,9216
+runtimepy/net/arbiter/info.py,sha256=tlzfbn3soyejArxfZ4lrLbaBVOjiz4nX52wa6XMfXuo,9684
 runtimepy/net/arbiter/result.py,sha256=PHZo5qj4SI08ZeWPFk_8OZ1umI6L0dp5nJpjjS8QUpM,2871
 runtimepy/net/arbiter/task.py,sha256=APcc5QioAG8uueIzxJU-vktIn8Ys3yJd_CFlRWb6Ieo,795
 runtimepy/net/arbiter/udp.py,sha256=-ecHJs-utcsiTfr5wSb73hUUuYFBeRVT_D1znYp5q6A,893
@@ -159,7 +159,7 @@ runtimepy/net/arbiter/config/util.py,sha256=MezLSil5mEwioI5kxDOZa9y118st1_t0El8D
 runtimepy/net/arbiter/factory/__init__.py,sha256=jC1szUYucH4Us3jbb0mhFgnklHlorya5DYGGw2pqfe4,334
 runtimepy/net/arbiter/factory/connection.py,sha256=uSwnvIWGJcDd2ReK-s9lBx-NcRQ1JH_7VbwkWjE_8zA,3690
 runtimepy/net/arbiter/factory/task.py,sha256=YLRv55dnDBqHRJIMYgO9_uHi0AW-8hwa0n3wHAKyncE,1959
-runtimepy/net/arbiter/housekeeping/__init__.py,sha256=80vzksjCq1r9Kx25YeOKTJu2Ek98YWvEEgrsC8qzwJM,3469
+runtimepy/net/arbiter/housekeeping/__init__.py,sha256=mgrYnDdL1DSP6fXdtk2VU9uqTvtgX2VX5q2Q9EfcJus,3545
 runtimepy/net/arbiter/imports/__init__.py,sha256=W7-kkM4B_zDU42Fyh0PmZL56JslS_0_qzvpzUhN6aDU,5041
 runtimepy/net/arbiter/imports/util.py,sha256=d4_HnWphrkiHQkyYr8YJKvSSTXoMf3Bct_7jg_CS9eA,1086
 runtimepy/net/arbiter/struct/__init__.py,sha256=Vr38dp2X0PZOrAbjKsZ9xZdQ1j3z92s4QuvRtYYVuNI,5990
@@ -259,9 +259,9 @@ runtimepy/registry/bool.py,sha256=ri56paLqwIOUo9JkSpwvrWmed9lHA851gke-0m8vGew,73
 runtimepy/registry/item.py,sha256=HPqxmzuK8aOc1siHzYScgxYxSMZ4RVTmnsRW2oNcW34,852
 runtimepy/registry/name.py,sha256=uhxmijwUT7x59NUYV4hJSe7VcnAbLDUSAPaKhR6K-N0,1749
 runtimepy/sample/__init__.py,sha256=N7P6hnCLF9NwnkZA1h3LzS2C334SAO48Fu8adHxWGLU,56
-runtimepy/sample/peer.py,sha256=eZJ3gmvGsXoRTIyJ_OS71T5C1kjysbvd-yF5xZxedLU,1621
-runtimepy/sample/program.py,sha256=wL61OzdUYrHw3Lwbd_eeBDARhS7kEzdifGOFgXvvnAw,2332
-runtimepy/struct/__init__.py,sha256=B8sb-fEXX_rpJ8ssVuZiZPmnmxKdY1DY6I_mrGm578c,1491
+runtimepy/sample/peer.py,sha256=uNlIPAv1-wjGUWdR0AM3L9NUMjnIMJBqQ9ZsHdTLx3Q,1688
+runtimepy/sample/program.py,sha256=I8_JGjEAh-d3eEw4M9l9CxEw4KG4s8f4i8STwRei5IY,2355
+runtimepy/struct/__init__.py,sha256=wFjLwX83ztCF1CuFxnldetzMOoBs_UMirLV778GBGZc,2220
 runtimepy/subprocess/__init__.py,sha256=VAiFrYFCU5ETDVoWLOVlrrSsx2d1_atYXUfXYc_OQ9g,4059
 runtimepy/subprocess/interface.py,sha256=rYvM8bgoT4DoXGhdidhfmivzrjmEoW6788DjGyAdJ7A,8032
 runtimepy/subprocess/peer.py,sha256=oYw9a0yKAPR18Z6Qt24wYWrcX6EizeQE64htL11WVjM,7593
@@ -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.7.6.dist-info/LICENSE,sha256=okYCYhGsx_BlzvFdoNVBVpw_Cfb4SOqHA_VAARml4Hc,1071
-runtimepy-5.7.6.dist-info/METADATA,sha256=p5qI1xHfkh1RGygCvs5SsLxk4NzECG15G_5699VRsl8,9308
-runtimepy-5.7.6.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-runtimepy-5.7.6.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.7.6.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.7.6.dist-info/RECORD,,
+runtimepy-5.7.8.dist-info/LICENSE,sha256=s2ILEylm2dAJJXL25nM92IWLRKmJW92zQRQe_cfdsHo,1071
+runtimepy-5.7.8.dist-info/METADATA,sha256=jrQxlQMMJm89zoa8zaEoyzk5tkDJHdUGEV29q7un7xI,9308
+runtimepy-5.7.8.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+runtimepy-5.7.8.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.7.8.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.7.8.dist-info/RECORD,,