runtimepy 4.2.2__tar.gz → 4.3.0__tar.gz

{runtimepy-4.2.2/runtimepy.egg-info → runtimepy-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 4.2.2
+Version: 4.3.0
 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: psutil
+Requires-Dist: websockets
 Requires-Dist: vcorelib>=3.2.4
 Requires-Dist: svgen>=0.6.6
-Requires-Dist: websockets
+Requires-Dist: psutil
 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=5f56531d1be3002a8547ddb013d713f9
+    hash=2adcb8a8e9a6b4dffec41ec316de0fee
     =====================================
 -->
 
-# runtimepy ([4.2.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([4.3.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)

{runtimepy-4.2.2 → runtimepy-4.3.0}/README.md

@@ -2,11 +2,11 @@
     =====================================
     generator=datazen
     version=3.1.4
-    hash=5f56531d1be3002a8547ddb013d713f9
+    hash=2adcb8a8e9a6b4dffec41ec316de0fee
     =====================================
 -->
 
-# runtimepy ([4.2.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([4.3.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)

{runtimepy-4.2.2 → runtimepy-4.3.0}/pyproject.toml

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

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/__init__.py

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

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/data/dummy_load.yaml

@@ -45,5 +45,13 @@ structs:
 processes:
   - name: proc1
     factory: sample_peer
-    config: *cfg
+
+    # The peer itself runs an arbiter process.
+    config:
+      includes:
+        - package://runtimepy/server.yaml
+
+      app: runtimepy.sample.program.run
+      config: *cfg
+
     program: runtimepy.sample.program.SampleProgram

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/message/interface.py

@@ -108,6 +108,13 @@ class JsonMessageInterface:
     async def poll_handler(self) -> None:
         """Poll this instance."""
 
+    def send_poll(self, loopback: int = 1) -> None:
+        """
+        Send a poll message with a default loopback of 1, so that this instance
+        will also be polled.
+        """
+        self.send_json({"poll": {"loopback": loopback}})
+
     async def _poll_handler(
         self, outbox: JsonMessage, inbox: JsonMessage
     ) -> None:
@@ -193,6 +200,16 @@ class JsonMessageInterface:
             self.processor.encode_json(stream, data)
             self.write(stream.getvalue(), addr=addr)
 
+    def handle_log_message(self, message: JsonMessage) -> None:
+        """Handle a log message."""
+
+        if "msg" in message and message["msg"]:
+            self.logger.log(
+                message.get("level", logging.INFO),
+                "remote: " + message["msg"],
+                *message.get("args", []),
+            )
+
     def _handle_reserved(
         self, data: JsonMessage, response: JsonMessage
     ) -> bool:
@@ -218,12 +235,7 @@ class JsonMessageInterface:
         # Log messages sent by the peer.
         if "__log_messages__" in data:
             for message in data["__log_messages__"]:
-                if "msg" in message and message["msg"]:
-                    self.logger.log(
-                        message.get("level", logging.INFO),
-                        "remote: " + message["msg"],
-                        *message.get("args", []),
-                    )
+                self.handle_log_message(message)
             del data["__log_messages__"]
 
         return should_respond

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/net/server/app/env/__init__.py

@@ -14,6 +14,7 @@ from runtimepy.net.server.app.env.modal import Modal
 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
+from runtimepy.subprocess.program import PROGRAM
 
 
 def channel_environments(app: AppInfo, tabs: TabbedContent) -> None:
@@ -44,7 +45,7 @@ def channel_environments(app: AppInfo, tabs: TabbedContent) -> None:
         ).entry()
 
     # Subprocess tabs.
-    for name, peer in app.peers.items():
+    for peer in app.peers.values():
         # Host side.
         ChannelEnvironmentTab(
             peer.struct.name, peer.struct.command, app, tabs, icon="cpu-fill"
@@ -56,6 +57,23 @@ def channel_environments(app: AppInfo, tabs: TabbedContent) -> None:
             peer.peer_name, peer.peer, app, tabs, icon="cpu"
         ).entry()
 
+    # If we are a peer program, load environments.
+    if PROGRAM is not None:
+        # Host side.
+        ChannelEnvironmentTab(
+            PROGRAM.struct.name,
+            PROGRAM.struct.command,
+            app,
+            tabs,
+            icon="cpu-fill",
+        ).entry()
+
+        # Remote side.
+        assert PROGRAM.peer is not None
+        ChannelEnvironmentTab(
+            PROGRAM.peer_name, PROGRAM.peer, app, tabs, icon="cpu"
+        ).entry()
+
     # Toggle channel-table button.
     tabs.add_button(
         "Toggle channel table",

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/sample/peer.py

@@ -6,6 +6,8 @@ A sample peer program interface.
 import asyncio
 
 # internal
+from runtimepy.net.http.header import RequestHeader
+from runtimepy.net.tcp.http import HttpConnection
 from runtimepy.subprocess.peer import RuntimepyPeer
 
 
@@ -35,3 +37,18 @@ class SamplePeer(RuntimepyPeer):
         await asyncio.sleep(0)
 
         self.struct.poll()
+
+        # Query UI.
+        if self.peer_config is not None and "servers" in self.peer_config:
+            for server in self.peer_config["servers"]:
+                if server["factory"] == "runtimepy_http":
+                    port = server["kwargs"]["port"]
+
+                    conn = await HttpConnection.create_connection(
+                        host="localhost", port=port
+                    )
+                    sig = asyncio.Event()
+                    task = asyncio.create_task(conn.process(stop_sig=sig))
+                    await conn.request(RequestHeader(target="/index.html"))
+                    sig.set()
+                    await task

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/sample/program.py

@@ -6,6 +6,7 @@ A module implementing a sample peer-program interface.
 import asyncio
 
 # internal
+from runtimepy.net.arbiter.info import AppInfo
 from runtimepy.subprocess.program import PeerProgram
 
 
@@ -35,36 +36,46 @@ class SampleProgram(PeerProgram):
         with self.streaming_events():
             self.struct.poll()
 
-    async def main(self, argv: list[str]) -> None:
-        """Program entry."""
+    async def cleanup(self) -> None:
+        """Runs when program 'running' context exits."""
 
-        del argv
+        # Cancel stderr task.
+        if hasattr(self, "stderr_task"):
+            self.stderr_task.cancel()
+            await self.stderr_task
 
-        self.struct.poll()
 
-        # Send remote commands.
-        assert self.peer is not None
-        for cmd in [
-            "set a.0.really_really_long_enum very_long_member_name_2",
-            "set -f a.0.enum one",
-        ]:
-            self.peer.command(cmd)
-            await self.process_command_queue()
+async def run(app: AppInfo) -> int:
+    """A network application that doesn't do anything."""
 
-        # Register other async tasks.
-        did_write = asyncio.Event()
-        self.stderr_task = asyncio.create_task(
-            self.log_message_sender(0.1, did_write)
-        )
-        await did_write.wait()
+    await app.all_finalized()
 
-        self.struct.poll()
+    prog = SampleProgram.singleton()
 
-        await self.wait_json({"a": 1, "b": 2, "c": 3})
+    await prog.share_config({"config": app.original_config()})
 
-    async def cleanup(self) -> None:
-        """Runs when program 'running' context exits."""
+    assert prog is not None
 
-        # Cancel stderr task.
-        self.stderr_task.cancel()
-        await self.stderr_task
+    prog.struct.poll()
+
+    # Send remote commands.
+    assert prog.peer is not None
+    for cmd in [
+        "set a.0.really_really_long_enum very_long_member_name_2",
+        "set -f a.0.enum one",
+    ]:
+        prog.peer.command(cmd)
+        await prog.process_command_queue()
+
+    # Register other async tasks.
+    did_write = asyncio.Event()
+    prog.stderr_task = asyncio.create_task(
+        prog.log_message_sender(0.1, did_write)
+    )
+    await did_write.wait()
+
+    prog.struct.poll()
+
+    await prog.wait_json({"a": 1, "b": 2, "c": 3})
+
+    return 0

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/subprocess/interface.py

@@ -6,7 +6,8 @@ A module implementing a runtimepy peer interface.
 from argparse import Namespace
 import asyncio
 from io import BytesIO
-from logging import getLogger
+from json import dumps
+from logging import INFO, getLogger
 from typing import Optional
 
 # third-party
@@ -48,6 +49,8 @@ class RuntimepyPeerInterface(
         self.struct = self.struct_type(self.basename + HOST_SUFFIX, config)
 
         self.peer: Optional[RemoteCommandProcessor] = None
+        self.peer_config: Optional[JsonMessage] = None
+        self.peer_config_event = asyncio.Event()
         self._peer_env_event = asyncio.Event()
 
         # Set these for JsonMessageInterface.
@@ -63,6 +66,18 @@ class RuntimepyPeerInterface(
     def struct_pre_finalize(self) -> None:
         """Configure struct before finalization."""
 
+    def handle_log_message(self, message: JsonMessage) -> None:
+        """Handle a log message."""
+
+        logger = self.logger
+        msg = "remote: " + message["msg"]
+
+        if self.peer is not None:
+            logger = self.peer.logger
+            msg = message["msg"]
+
+        logger.log(message.get("level", INFO), msg, *message.get("args", []))
+
     @property
     def peer_name(self) -> str:
         """Get the name of the peer's environment."""
@@ -131,6 +146,27 @@ class RuntimepyPeerInterface(
 
         self.basic_handler("env", env_handler)
 
+        async def config_handler(
+            outbox: JsonMessage, inbox: JsonMessage
+        ) -> None:
+            """Store peer's configuration."""
+
+            if self.peer_config is None:
+                self.peer_config = inbox["config"]
+                outbox["config"] = self.struct.config
+                self.logger.info(
+                    "Peer's configuration: '%s'.",
+                    dumps(self.peer_config, indent=4),
+                )
+                self.peer_config_event.set()
+
+        self.basic_handler("config", config_handler)
+
+    async def share_config(self, data: JsonMessage) -> None:
+        """Exchange configuration data."""
+
+        await self.wait_json({"config": data})
+
     async def share_environment(self) -> None:
         """Exchange channel environments."""
 

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/subprocess/peer.py

@@ -10,7 +10,7 @@ from sys import executable
 from typing import AsyncIterator, Type, TypeVar
 
 # third-party
-from vcorelib.io import ARBITER
+from vcorelib.io import ARBITER, DEFAULT_INCLUDES_KEY
 from vcorelib.io.file_writer import IndentedFileWriter
 from vcorelib.io.types import JsonObject
 from vcorelib.paths.context import tempfile
@@ -73,7 +73,6 @@ class RuntimepyPeer(RuntimepyPeerInterface):
             with suppress(AssertionError):
                 if await self.loopback():
                     await self.wait_json({"meta": self.meta})
-
                     await self.share_environment()
 
             yield self
@@ -122,7 +121,7 @@ class RuntimepyPeer(RuntimepyPeerInterface):
 
         writer.write("import sys")
         writer.write("from vcorelib.asyncio import run_handle_interrupt")
-        writer.write("from vcorelib.io import ARBITER")
+        writer.write("from vcorelib.io import ARBITER, DEFAULT_INCLUDES_KEY")
 
         from_str, to_import = import_str_and_item(import_str)
         writer.write(f"from {from_str} import {to_import}")
@@ -135,7 +134,8 @@ class RuntimepyPeer(RuntimepyPeerInterface):
             writer.write(
                 f'run_handle_interrupt({to_import}.run("{name}", '
                 "ARBITER.decode(CONFIG_PATH, "
-                "require_success=True).data, sys.argv))"
+                "require_success=True, includes_key=DEFAULT_INCLUDES_KEY"
+                ").data, sys.argv))"
             )
             writer.write("sys.exit(0)")
 
@@ -155,6 +155,14 @@ class RuntimepyPeer(RuntimepyPeerInterface):
             # Encode configuration data.
             assert ARBITER.encode(config_path, config)[0]
 
+            # Decode to load includes.
+            config = ARBITER.decode(
+                config_path,
+                require_success=True,
+                includes_key=DEFAULT_INCLUDES_KEY,
+            ).data
+            assert ARBITER.encode(config_path, config)[0]
+
             with tempfile(suffix=".py") as path:
                 # Write file contents.
                 with IndentedFileWriter.from_path(

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/subprocess/program.py

@@ -9,18 +9,22 @@ import logging
 import os
 import signal
 import sys
-from typing import AsyncIterator, BinaryIO, Iterator, Type, TypeVar
+from typing import AsyncIterator, BinaryIO, Iterator, Optional, Type, TypeVar
 
 # third-party
+from vcorelib.io import ARBITER
 from vcorelib.io.types import JsonObject
+from vcorelib.paths.context import tempfile
 
 # internal
 from runtimepy.metrics.channel import ChannelMetrics
 from runtimepy.mixins.psutil import PsutilMixin
+from runtimepy.net.arbiter import ConnectionArbiter
 from runtimepy.net.arbiter.info import RuntimeStruct, SampleStruct
 from runtimepy.subprocess.interface import RuntimepyPeerInterface
 
 T = TypeVar("T", bound="PeerProgram")
+PROGRAM: Optional["PeerProgram"] = None
 
 
 class PeerProgram(RuntimepyPeerInterface, PsutilMixin):
@@ -32,6 +36,16 @@ class PeerProgram(RuntimepyPeerInterface, PsutilMixin):
 
     struct_type: Type[RuntimeStruct] = SampleStruct
 
+    got_eof: asyncio.Event
+
+    _singleton: Optional["PeerProgram"] = None
+
+    @classmethod
+    def singleton(cls: type[T]) -> T:
+        """Get a shared single instance of a protocol for this class."""
+        assert cls._singleton is not None
+        return cls._singleton  # type: ignore
+
     @contextmanager
     def streaming_events(self) -> Iterator[None]:
         """Stream events to the stream output."""
@@ -104,6 +118,9 @@ class PeerProgram(RuntimepyPeerInterface, PsutilMixin):
                     self.stdin_metrics.increment(accumulator)
                     accumulator = 0
 
+        # Signal the end of input processing.
+        self.got_eof.set()
+
     @classmethod
     def run_standard(
         cls: Type[T], name: str, config: JsonObject
@@ -113,13 +130,28 @@ class PeerProgram(RuntimepyPeerInterface, PsutilMixin):
         peer = cls(name, config)
         peer.json_output = sys.stdout.buffer
         peer.stream_output = sys.stderr.buffer
+        peer.got_eof = asyncio.Event()
         peer.stream_metrics = ChannelMetrics()
 
+        global PROGRAM  # pylint: disable=global-statement
+        PROGRAM = peer
+        assert cls._singleton is None
+        cls._singleton = peer
+
         return asyncio.create_task(peer.io_task(sys.stdin.buffer)), peer
 
     async def main(self, argv: list[str]) -> None:
         """Program entry."""
 
+        del argv
+
+        with tempfile(suffix=".json") as config_path:
+            arbiter = ConnectionArbiter(stop_sig=self.got_eof)
+            ARBITER.encode(config_path, self.struct.config)
+            await arbiter.load_configs([config_path], wait_for_stop=True)
+
+        await arbiter.app()
+
     async def cleanup(self) -> None:
         """Runs when program 'running' context exits."""
 

{runtimepy-4.2.2 → runtimepy-4.3.0}/runtimepy/task/sample.py

@@ -66,7 +66,7 @@ class SampleAppTask(ArbiterTask):
 
         # Send poll message to peer process.
         for peer in self.app.peers.values():
-            peer.send_json({"poll": {"loopback": 1}})
+            peer.send_poll()
 
         return True
 

{runtimepy-4.2.2 → runtimepy-4.3.0/runtimepy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runtimepy
-Version: 4.2.2
+Version: 4.3.0
 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: psutil
+Requires-Dist: websockets
 Requires-Dist: vcorelib>=3.2.4
 Requires-Dist: svgen>=0.6.6
-Requires-Dist: websockets
+Requires-Dist: psutil
 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=5f56531d1be3002a8547ddb013d713f9
+    hash=2adcb8a8e9a6b4dffec41ec316de0fee
     =====================================
 -->
 
-# runtimepy ([4.2.2](https://pypi.org/project/runtimepy/))
+# runtimepy ([4.3.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)