Merge pull request #300 from vkottler/dev/5.10.0

5.10.0 - Peer process management improvements

Author: vkottler

.github/workflows/python-package.yml

@@ -77,7 +77,7 @@ jobs:
 
       - run: |
           mk python-release owner=vkottler \
-                            repo=runtimepy version=5.9.2
+                            repo=runtimepy version=5.10.0
         if: |
           matrix.python-version == '3.12'
           && matrix.system == 'ubuntu-latest'

README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=663b9a39a640cae079d35c0621ae20f9
+    hash=cbacac02049e2f568e5ebad3cc428033
     =====================================
 -->
 
-# runtimepy ([5.9.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.10.0](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)

local/variables/package.yaml

@@ -1,5 +1,5 @@
 ---
 major: 5
-minor: 9
-patch: 2
+minor: 10
+patch: 0
 entry: runtimepy

pyproject.toml

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

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.1.4
-# hash=ba2f544d63fad56dd7605cf937fe52d8
+# hash=a9a53fbeb974140d3611fecadbce5da4
 # =====================================
 
 """
@@ -10,7 +10,7 @@
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.9.2"
+VERSION = "5.10.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/data/dummy_load.yaml

@@ -98,10 +98,9 @@ processes:
 
     # The peer itself runs an arbiter process.
     config:
+      config: *cfg
       includes:
         - package://runtimepy/server.yaml
-
       app: runtimepy.sample.program.run
-      config: *cfg
 
     program: runtimepy.sample.program.SampleProgram

runtimepy/data/factories.yaml

@@ -45,6 +45,7 @@ factories:
 
   # Useful subprocess peer interfaces.
   - {name: runtimepy.sample.peer.SamplePeer}
+  - {name: runtimepy.subprocess.peer.RuntimepyPeer}
 
 ports:
   # Reserve ports for JSON listeners.

runtimepy/data/schemas/PeerProcessConfig.yaml

@@ -5,8 +5,7 @@ includes:
   - has_config.yaml
   - has_markdown.yaml
 
-required: [program]
-
 properties:
   program:
     type: string
+    default: runtimepy.subprocess.program.PeerProgram

runtimepy/message/__init__.py

@@ -4,7 +4,7 @@
 
 # built-in
 from io import BytesIO as _BytesIO
-from json import dumps, loads
+from json import JSONEncoder, dumps, loads
 from typing import Any
 from typing import Iterator as _Iterator
 
@@ -18,6 +18,18 @@
 JsonMessage = dict[str, Any]
 
 
+class StrFallbackJSONEncoder(JSONEncoder):
+    """Custom JSON encoder."""
+
+    def default(self, o):
+        """Use a string conversion if necessary."""
+
+        try:
+            return super().default(o)
+        except TypeError:
+            return str(o)
+
+
 class MessageProcessor:
     """A class for parsing size-delimited messages."""
 
@@ -48,7 +60,11 @@ def encode(self, stream: _BytesIO, data: bytes | str) -> None:
 
     def encode_json(self, stream: _BytesIO, data: JsonMessage) -> None:
         """Encode a message as JSON."""
-        self.encode(stream, dumps(data, separators=(",", ":")))
+
+        self.encode(
+            stream,
+            dumps(data, cls=StrFallbackJSONEncoder, separators=(",", ":")),
+        )
 
     def messages(self, data: bytes) -> _Iterator[JsonMessage]:
         """Iterate over incoming messages."""

runtimepy/sample/program.py

@@ -9,13 +9,15 @@
 from vcorelib.math import RateLimiter
 
 # internal
-from runtimepy.net.arbiter.info import AppInfo
+from runtimepy.net.arbiter.info import AppInfo, SampleStruct
 from runtimepy.subprocess.program import PeerProgram
 
 
 class SampleProgram(PeerProgram):
     """A sample peer program."""
 
+    struct_type = SampleStruct
+
     stderr_task: asyncio.Task[None]
 
     async def log_message_sender(
@@ -91,4 +93,6 @@ async def run(app: AppInfo) -> int:
 
     await prog.wait_json({"a": 1, "b": 2, "c": 3})
 
+    await app.stop.wait()
+
     return 0