runtimepy 5.12.1__py3-none-any.whl → 5.13.0__py3-none-any.whl

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.1
-# hash=ba0d30a48267eea48f57090cd3a871b2
+# hash=35e5555173fdfd064e5047172de9b6a4
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.12.1"
+VERSION = "5.13.0"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/commands/server.py

@@ -48,7 +48,6 @@ def get_kwargs(args: _Namespace, **kwargs) -> dict[str, Any]:
     new_kwargs: dict[str, Any] = {**kwargs}
 
     # Pass additional arguments through.
-    print(args)
     for opt in PASSTHROUGH:
         value = getattr(args, opt, None)
         if value is not None:

runtimepy/net/http/response.py

@@ -6,8 +6,12 @@ A module implementing HTTP-response interfaces.
 import http
 from io import StringIO
 import logging
+from pathlib import Path
+from typing import AsyncIterator, cast
 
 # third-party
+import aiofiles
+import aiofiles.os
 from vcorelib.logging import LoggerType
 
 # internal
@@ -83,3 +87,31 @@ class ResponseHeader(HeadersMixin):
             self.status_line,
             self.headers,
         )
+
+
+class AsyncResponse:
+    """
+    A class facilitating asynchronous server responses for e.g.
+    file-system files.
+    """
+
+    def __init__(self, path: Path, chunk_size: int = 1024) -> None:
+        """Initialize this instance."""
+
+        self.path = path
+        self.chunk_size = chunk_size
+
+    async def size(self) -> int:
+        """Get this response's size."""
+        return cast(int, await aiofiles.os.path.getsize(self.path))
+
+    async def process(self) -> AsyncIterator[bytes]:
+        """Yield chunks to write asynchronously."""
+
+        async with aiofiles.open(self.path, mode="rb") as path_fd:
+            while True:
+                data = await path_fd.read(self.chunk_size)
+                if data:
+                    yield data
+                else:
+                    break

runtimepy/net/server/__init__.py

@@ -21,11 +21,11 @@ from runtimepy.channel.environment.command import GLOBAL
 from runtimepy.net.html import full_markdown_page
 from runtimepy.net.http.header import RequestHeader
 from runtimepy.net.http.request_target import PathMaybeQuery
-from runtimepy.net.http.response import ResponseHeader
+from runtimepy.net.http.response import AsyncResponse, ResponseHeader
 from runtimepy.net.server.html import HtmlApp, HtmlApps, get_html, html_handler
 from runtimepy.net.server.json import encode_json, json_handler
 from runtimepy.net.server.markdown import markdown_for_dir
-from runtimepy.net.tcp.http import HttpConnection
+from runtimepy.net.tcp.http import HttpConnection, HttpResult
 from runtimepy.util import normalize_root, path_has_part, read_binary
 
 MIMETYPES_INIT = False
@@ -173,10 +173,10 @@ class RuntimepyServerConnection(HttpConnection):
 
     async def try_file(
         self, path: PathMaybeQuery, response: ResponseHeader
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Try serving this path as a file directly from the file-system."""
 
-        result = None
+        result: HttpResult = None
 
         # Keep track of directories encountered.
         directories: list[Path] = []
@@ -214,7 +214,7 @@ class RuntimepyServerConnection(HttpConnection):
                 self.logger.info("Serving '%s' (MIME: %s)", candidate, mime)
 
                 # Return the file data.
-                result = await read_binary(candidate)
+                result = AsyncResponse(candidate)
                 break
 
         # Handle a directory as a last resort.
@@ -259,7 +259,7 @@ class RuntimepyServerConnection(HttpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Handle POST requests."""
 
         request.log(self.logger, False, level=logging.INFO)
@@ -281,7 +281,7 @@ class RuntimepyServerConnection(HttpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Handle GET requests."""
 
         request.log(self.logger, False, level=logging.INFO)

runtimepy/net/tcp/http/__init__.py

@@ -16,22 +16,24 @@ from vcorelib import DEFAULT_ENCODING
 from runtimepy import PKG_NAME, VERSION
 from runtimepy.net.http import HttpMessageProcessor
 from runtimepy.net.http.header import RequestHeader
-from runtimepy.net.http.response import ResponseHeader
+from runtimepy.net.http.response import AsyncResponse, ResponseHeader
 from runtimepy.net.tcp.connection import TcpConnection as _TcpConnection
 
+HttpResult = Optional[bytes | AsyncResponse]
+
 #
 # async def handler(
 #     response: ResponseHeader,
 #     request: RequestHeader,
 #     request_data: Optional[bytes],
-# ) -> Optional[bytes]:
+# ) -> HttpResult:
 #     """Sample handler."""
 #
 HttpRequestHandler = Callable[
     [ResponseHeader, RequestHeader, Optional[bytes]],
-    Awaitable[Optional[bytes]],
+    Awaitable[HttpResult],
 ]
-HttpResponse = Tuple[ResponseHeader, Optional[bytes]]
+HttpResponse = Tuple[ResponseHeader, HttpResult]
 
 HttpRequestHandlers = dict[http.HTTPMethod, HttpRequestHandler]
 
@@ -89,7 +91,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Sample handler."""
 
     async def post_handler(
@@ -97,7 +99,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request: RequestHeader,
         request_data: Optional[bytes],
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Sample handler."""
 
     async def _process_request(
@@ -105,7 +107,7 @@ class HttpConnection(_TcpConnection):
         response: ResponseHeader,
         request_header: RequestHeader,
         request_data: Optional[bytes] = None,
-    ) -> Optional[bytes]:
+    ) -> HttpResult:
         """Process an individual request."""
 
         result = None
@@ -137,7 +139,7 @@ class HttpConnection(_TcpConnection):
             # Set boilerplate header data.
             request["user-agent"] = self.identity
 
-            self._send(request, data)
+            await self._send(request, data)
             self.expecting_response = True
             result = await self.responses.get()
             self.expecting_response = False
@@ -153,21 +155,29 @@ class HttpConnection(_TcpConnection):
         """
         return to_json(await self.request(request, data))
 
-    def _send(
+    async def _send(
         self,
         header: Union[ResponseHeader, RequestHeader],
-        data: Optional[bytes] = None,
+        data: HttpResult = None,
     ) -> None:
         """Send a request or response to a request."""
 
         # Set content length.
         header["content-length"] = "0"
-        if data:
+
+        if isinstance(data, AsyncResponse):
+            header["content-length"] = str(await data.size())
+        elif data is not None:
             header["content-length"] = str(len(data))
 
         self.send_binary(bytes(header))
-        if data:
-            self.send_binary(data)
+
+        if data is not None:
+            if isinstance(data, AsyncResponse):
+                async for chunk in data.process():
+                    self.send_binary(chunk)
+            else:
+                self.send_binary(data)
 
         header.log(self.logger, True)
 
@@ -183,7 +193,7 @@ class HttpConnection(_TcpConnection):
             if not self.expecting_response:
                 # Process request.
                 response = ResponseHeader()
-                self._send(
+                await self._send(
                     response,
                     await self._process_request(
                         response, cast(RequestHeader, header), payload

{runtimepy-5.12.1.dist-info → runtimepy-5.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.12.1
+Version: 5.13.0
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -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.5.1
-Requires-Dist: psutil
 Requires-Dist: aiofiles
+Requires-Dist: psutil
 Requires-Dist: websockets
+Requires-Dist: vcorelib>=3.5.1
 Provides-Extra: test
 Requires-Dist: pylint; extra == "test"
 Requires-Dist: flake8; extra == "test"
@@ -51,11 +51,11 @@ Dynamic: requires-python
     =====================================
     generator=datazen
     version=3.2.1
-    hash=6b0b773eaaa04369914e4480e7e90086
+    hash=4f0e82dc45d3ea9c4ccf5b262413c206
     =====================================
 -->
 
-# runtimepy ([5.12.1](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.13.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/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)
@@ -65,6 +65,8 @@ Dynamic: requires-python
 
 *A framework for implementing Python services.*
 
+Consider [sponsoring development](https://github.com/sponsors/libre-embedded).
+
 ([interface documentation](https://libre-embedded.github.io/python/runtimepy))
 
 ## Python Version Support

{runtimepy-5.12.1.dist-info → runtimepy-5.13.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-runtimepy/__init__.py,sha256=aVwCNKJ1UuAVGt2ygKy9jh9rKssg7ylq5gWjnll6ZCo,391
+runtimepy/__init__.py,sha256=HxjInsMBuhZ8HVgWbkL2C4cBfavqCLORI0hiaUc4Lq0,391
 runtimepy/__main__.py,sha256=3IFTvHw-vqPIFy6ZZjzl00oDwFLzcDmV5WHo3ohPKbc,332
 runtimepy/app.py,sha256=xhqZOvBcBCawUR2Qd5oyvrmNdOJhdChgddb0GiJOnPc,970
 runtimepy/dev_requirements.txt,sha256=VZhW6bJ5YbwaoN4d_XxZFuN5BbDLaG7ngKrGnugVPRw,245
@@ -33,7 +33,7 @@ runtimepy/commands/all.py,sha256=nANQ5v5PlIhY8TZejcckGoZmqjOr7tYA7LstordQUDk,161
 runtimepy/commands/arbiter.py,sha256=CtTMRYpqCAN3vWHkkr9jqWpoF7JGNXafKIBFmkarAfc,1567
 runtimepy/commands/common.py,sha256=NvZdeIFBHAF52c1n7vqD59DW6ywc-rG5iC5MpuhGf-c,2449
 runtimepy/commands/mtu.py,sha256=LFFjTU4SsuV3j7Mhx_WuKa5lfdfMm70zJvDWToVrP7E,1357
-runtimepy/commands/server.py,sha256=G1q6bgq0HpsKvDFcPyAC--f3-OuZqtnR4FK7b36Rqv8,4671
+runtimepy/commands/server.py,sha256=q49WlQQWYBcHrKQo7hCc3Y6hNbG2DNLMXIlLg8Mc8lA,4655
 runtimepy/commands/task.py,sha256=6xRVlRwpEZVhrcY18sQcfdWEOxeQZLeOF-6UrUURtO4,1435
 runtimepy/commands/tftp.py,sha256=djFQzYDxy2jvUseHJ4fDR3CowPxQ-Tu0IJz1SwapXX0,2361
 runtimepy/commands/tui.py,sha256=9hWA3_YATibUUDTVQr7UnKzPTDVJ7WxWKTYYQpLoyrE,1869
@@ -190,10 +190,10 @@ runtimepy/net/http/__init__.py,sha256=4TjFp_ajAVcOEvwtjlF6mG-9EbEePqFZht-QpWIKVB
 runtimepy/net/http/common.py,sha256=vpoO6XwRmrZmTkCu9bkI0HnyaD8MWTpV7ADesCNrfRE,2237
 runtimepy/net/http/header.py,sha256=AECSdvhBA9_5Pg3UdwMzsmBpcqgsiPj41xnIGPm5g5E,2296
 runtimepy/net/http/request_target.py,sha256=EE1aI5VSARw1h93jyZvP56ir5O5fjd6orYK-1FM4JNk,1550
-runtimepy/net/http/response.py,sha256=Sup8W_A0ADNzR5olKrQsVNhsQXUwPOD-eJLlLOgYlAY,2316
+runtimepy/net/http/response.py,sha256=y33KLUJNE7zx6biUMwTkUfQ1bXiKV6pjrcxuh8U3WCE,3216
 runtimepy/net/http/state.py,sha256=qCMN8aWfCRfU9XP-cIhSOo2RqfljTjbQRCflfcy2bfY,1626
 runtimepy/net/http/version.py,sha256=mp6rgIM7-VUVKLCA0Uw96CmBkL0ET860lDVVEewpZ7w,1098
-runtimepy/net/server/__init__.py,sha256=RojwvQgqc0rTl36rXDSiM56tVXtD15T5OkpuJanlNjY,10438
+runtimepy/net/server/__init__.py,sha256=R6xV5wUqrCwB0pa0FMjcZ-txkT87H_B9AgWq0RrJQsU,10458
 runtimepy/net/server/html.py,sha256=ufg0PQF_iUE7PT0n3Pn3jTcun7mspZUI6_ooblcNnvI,1217
 runtimepy/net/server/json.py,sha256=a7vM5yfq2er4DexzFqEMnxoMGDeuywKkVH4-uNJBAik,2522
 runtimepy/net/server/markdown.py,sha256=DFjGbvIST4HXRhtTTvXVQ9ZAwrIfVzPlcU1dW8JYya8,1381
@@ -227,7 +227,7 @@ runtimepy/net/tcp/__init__.py,sha256=OOWohegpoioSTf8M7uDf-4EV1IDungz7-U19L_2yW4I
 runtimepy/net/tcp/connection.py,sha256=sYWj2aDiAHQf70zfRJM24cHraFd_TuzTD4fRWeSQZXE,8811
 runtimepy/net/tcp/create.py,sha256=zZsRs5KYpO3bNGh-DwEOEzjUDE4ixj-UBHYgZ0GvC7c,2013
 runtimepy/net/tcp/protocol.py,sha256=vEnIX3gUX2nrw9ofT_e4KYU4VY2k4WP0WuOi4eE_OOQ,1444
-runtimepy/net/tcp/http/__init__.py,sha256=BY9ra0s7kHkoUQKIRHsnk3_WDWP7Xt-FxQ90K14nwkc,5737
+runtimepy/net/tcp/http/__init__.py,sha256=SPvrZvIM1poE_jgCNY6gjgV2bXfMmPH_0zdx8x4JSVI,6080
 runtimepy/net/tcp/scpi/__init__.py,sha256=aWCWQfdeyfoU9bpOnOtyIQbT1swl4ergXLFn5kXAH28,2105
 runtimepy/net/tcp/telnet/__init__.py,sha256=96eJFb301I3H2ivDtGMQtDDw09Xm5NRvM9VEC-wjt8c,4768
 runtimepy/net/tcp/telnet/codes.py,sha256=1-yyRe-Kz_W7d6B0P3iT1AaSNR3_Twmn-MUjKCJJknY,3518
@@ -300,9 +300,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.12.1.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
-runtimepy-5.12.1.dist-info/METADATA,sha256=rxNyFXioax6ETUP7icHD1ZopQsJCx8u-OifIMcBjFMw,9188
-runtimepy-5.12.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-runtimepy-5.12.1.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.12.1.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.12.1.dist-info/RECORD,,
+runtimepy-5.13.0.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
+runtimepy-5.13.0.dist-info/METADATA,sha256=TEucfXpt7dgg0L_P1F-WItb0l7MJuXLyuejhWBc1Uv0,9268
+runtimepy-5.13.0.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+runtimepy-5.13.0.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.13.0.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.13.0.dist-info/RECORD,,

{runtimepy-5.12.1.dist-info → runtimepy-5.13.0.dist-info}/WHEEL

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