runtimepy 5.15.6__py3-none-any.whl → 5.15.8__py3-none-any.whl

runtimepy/__init__.py

@@ -1,7 +1,7 @@
 # =====================================
 # generator=datazen
 # version=3.2.3
-# hash=08c1dda8bd5fefe13af6a8eb49063498
+# hash=be3f79364e840f1950bc121205810f02
 # =====================================
 
 """
@@ -10,7 +10,7 @@ Useful defaults and other package metadata.
 
 DESCRIPTION = "A framework for implementing Python services."
 PKG_NAME = "runtimepy"
-VERSION = "5.15.6"
+VERSION = "5.15.8"
 
 # runtimepy-specific content.
 METRICS_NAME = "metrics"

runtimepy/data/css/main.css

@@ -82,3 +82,7 @@ body > :first-child {
 .channel-filter-min-width {
   min-width: 5.5em;
 }
+
+.media-preview {
+  max-width: 70vw;
+}

runtimepy/net/http/response.py

@@ -3,11 +3,12 @@ A module implementing HTTP-response interfaces.
 """
 
 # built-in
+from abc import ABC, abstractmethod
 import http
 from io import StringIO
 import logging
 from pathlib import Path
-from typing import AsyncIterator, cast
+from typing import AsyncIterator, Optional, cast
 
 # third-party
 import aiofiles
@@ -96,19 +97,32 @@ class ResponseHeader(HeadersMixin):
         self["Cache-Control"] = value
 
 
-class AsyncResponse:
+class AsyncResponse(ABC):
+    """Interface for asynchronous responses."""
+
+    @abstractmethod
+    async def size(self) -> Optional[int]:
+        """Get this response's size."""
+
+    @abstractmethod
+    async def process(self) -> AsyncIterator[bytes]:
+        """Yield chunks to write asynchronously."""
+        yield bytes()  # pragma: nocover
+
+
+class AsyncFile(AsyncResponse):
     """
     A class facilitating asynchronous server responses for e.g.
     file-system files.
     """
 
-    def __init__(self, path: Path, chunk_size: int = 1024) -> None:
+    def __init__(self, path: Path, chunk_size: int = 4096) -> None:
         """Initialize this instance."""
 
         self.path = path
         self.chunk_size = chunk_size
 
-    async def size(self) -> int:
+    async def size(self) -> Optional[int]:
         """Get this response's size."""
         return cast(int, await aiofiles.os.path.getsize(self.path))
 

runtimepy/net/server/__init__.py

@@ -8,7 +8,7 @@ from io import StringIO
 import logging
 import mimetypes
 from pathlib import Path
-from typing import Any, Optional, TextIO, Union
+from typing import Any, Awaitable, Callable, Optional, TextIO, Union
 from urllib.parse import urlencode
 
 # third-party
@@ -22,7 +22,7 @@ from runtimepy.channel.environment.command import GLOBAL, global_command
 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 AsyncResponse, ResponseHeader
+from runtimepy.net.http.response import AsyncFile, 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 DIR_FILE, markdown_for_dir
@@ -41,11 +41,17 @@ def package_data_dir() -> Path:
     return result.parent
 
 
+CustomAsync = Callable[
+    [ResponseHeader, RequestHeader, Optional[bytearray]], Awaitable[HttpResult]
+]
+
+
 class RuntimepyServerConnection(HttpConnection):
     """A class implementing a server-connection interface for this package."""
 
     # Can register application methods to URL paths.
     apps: HtmlApps = {"/mux.html": mux_app}
+    custom: dict[str, CustomAsync] = {}
     default_app: Optional[HtmlApp] = None
 
     # Can load additional data into this dictionary for easy HTTP access.
@@ -245,7 +251,7 @@ class RuntimepyServerConnection(HttpConnection):
                 response.static_resource()
 
                 # Return the file data.
-                result = AsyncResponse(candidate)
+                result = AsyncFile(candidate)
                 break
 
         # Handle a directory as a last resort.
@@ -335,6 +341,12 @@ class RuntimepyServerConnection(HttpConnection):
                     response.static_resource()
                     return self.favicon_data
 
+                # Check for a custom handler.
+                if path in self.custom:
+                    return await self.custom[path](
+                        response, request, request_data
+                    )
+
                 # Try serving a file and handling redirects.
                 for handler in [self.try_redirect, self.try_file]:
                     result = await handler(

runtimepy/net/server/markdown.py

@@ -5,6 +5,7 @@ A module implementing web server markdown interfaces.
 # built-in
 from io import StringIO
 import mimetypes
+from os import stat_result
 from pathlib import Path
 from typing import Iterable, cast
 
@@ -17,19 +18,46 @@ from vcorelib.paths import stats as _stats
 
 LOGO_MARKDOWN = "[![logo](/static/png/chip-circle-bootstrap/128x128.png)](/)"
 DIR_FILE = "dir.html"
+AUTOPLAY_PREVIEW_SIZE = 100 * (1024 * 1024)  # 100 MiB
 
 
-def file_preview(path: Path, link: Path) -> str:
+def file_preview(path: Path, link: Path, stats: stat_result) -> str:
     """Get possible preview text for a file."""
 
     preview = ""
 
-    if path.is_file():
-        mime, _ = mimetypes.guess_type(path, strict=False)
-        if mime and mime.startswith("image"):
-            preview = div(tag="img", src=f"/{link}", alt=str(link)).encode_str(
-                newlines=False
-            )
+    if not path.is_file():
+        return preview
+
+    mime, _ = mimetypes.guess_type(path, strict=False)
+    if mime:
+        # Image previews.
+        if mime.startswith("image"):
+            preview = div(
+                tag="img",
+                src=f"/{link}",
+                alt=str(link),
+                class_str="media-preview",
+            ).encode_str(newlines=False)
+
+        # Video previews.
+        elif mime.startswith("video"):
+            elem = div(tag="video", class_str="media-preview")
+            elem.booleans.add("loop")
+            elem.booleans.add("controls")
+
+            if stats.st_size < AUTOPLAY_PREVIEW_SIZE:
+                elem.booleans.add("autoplay")
+
+            div(parent=elem, tag="source", src=f"/{link}", type=mime)
+
+            preview = elem.encode_str(newlines=False)
+
+        # Audio previews.
+        elif mime.startswith("audio"):
+            elem = div(tag="audio", src=f"/{link}")
+            elem.booleans.add("controls")
+            preview = elem.encode_str(newlines=False)
 
     return preview
 
@@ -65,7 +93,8 @@ def write_markdown_dir(
         size_str = byte_count_str(stats.st_size) if item.is_file() else ""
 
         writer.write(
-            f"| [{name}](/{curr}) | {size_str} | {file_preview(item, curr)} |"
+            f"| [{name}](/{curr}) | {size_str} | "
+            f"{file_preview(item, curr, stats)} |"
         )
 
     writer.empty()

runtimepy/net/tcp/http/__init__.py

@@ -173,13 +173,13 @@ class HttpConnection(_TcpConnection):
     ) -> None:
         """Send a request or response to a request."""
 
-        # Set content length.
-        header["content-length"] = "0"
-
+        size = None
         if isinstance(data, AsyncResponse):
-            header["content-length"] = str(await data.size())
+            size = await data.size()
         elif data is not None:
-            header["content-length"] = str(len(data))
+            size = len(data)
+        if size is not None:
+            header["content-length"] = str(size)
 
         self.send_binary(bytes(header))
 

{runtimepy-5.15.6.dist-info → runtimepy-5.15.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: runtimepy
-Version: 5.15.6
+Version: 5.15.8
 Summary: A framework for implementing Python services.
 Home-page: https://github.com/libre-embedded/runtimepy
 Author: Libre Embedded
@@ -17,11 +17,11 @@ Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiofiles
-Requires-Dist: svgen>=0.8.0
-Requires-Dist: websockets
 Requires-Dist: psutil
 Requires-Dist: vcorelib>=3.6.4
+Requires-Dist: websockets
+Requires-Dist: svgen>=0.8.0
+Requires-Dist: aiofiles
 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.3
-    hash=0f8ffdbd46445346cb834d066f58e765
+    hash=c354cb6439439285d244ad2bdcc32cc8
     =====================================
 -->
 
-# runtimepy ([5.15.6](https://pypi.org/project/runtimepy/))
+# runtimepy ([5.15.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/libre-embedded/runtimepy/workflows/Python%20Package/badge.svg)

{runtimepy-5.15.6.dist-info → runtimepy-5.15.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-runtimepy/__init__.py,sha256=qAS3P1hKgQCdNqiMTEqhiSnIM9BIwdZqBvOQfrZCBC4,391
+runtimepy/__init__.py,sha256=uc9YAPW-YaZX4q8Y53kePOKLHa19DXc_OwE9dc7py2M,391
 runtimepy/__main__.py,sha256=IKioH2xOtsXwrwb9zABDQEJvuAX--Lnh84TeSz0XSs0,332
 runtimepy/app.py,sha256=Er1ZKKrG9U0FV0gQg_GYF9xDb89HgYnVzS5SjxGa2Tg,970
 runtimepy/dev_requirements.txt,sha256=VZhW6bJ5YbwaoN4d_XxZFuN5BbDLaG7ngKrGnugVPRw,245
@@ -55,7 +55,7 @@ runtimepy/data/server_dev.yaml,sha256=nQsPh7LuQig3pzHfdg_aD3yOUiCj1sKKfI-WwW3hXm
 runtimepy/data/tftp_server.yaml,sha256=-bFOWJSagI-fEQQcT8k7eDMJVfSPm2XAxLVG3dqUTa4,204
 runtimepy/data/css/bootstrap_extra.css,sha256=0NiTnZWnIYf04n9NHVe-nVSOLwePJ6X-3uCgUgAEKPI,3101
 runtimepy/data/css/font.css,sha256=Pe82E66rNi-cwlQ-_1GHAuhPGu5L4x5KqgV0dbDe51w,977
-runtimepy/data/css/main.css,sha256=B3cBrwz6Leox1tYHTzJ7dW7Le0gf5_qZDCNlRsu-0aY,1316
+runtimepy/data/css/main.css,sha256=ohZ98-ffw6U1h2Azj8ToYiXFurQo1rH9r6kFQZkrtQ0,1355
 runtimepy/data/js/DataConnection.js,sha256=DnX8FMehjJXqmI62UMYXSvl_XdfQMzq3XUDFbLu2GgI,98
 runtimepy/data/js/JsonConnection.js,sha256=rclZrbmWc_zSs6I_JhOgxnVPFIyPMo5WdjAe8alyZ3o,2729
 runtimepy/data/js/audio.js,sha256=bLkBqbeHMiGGidfL3iXjmVoF9seK-ZeZ3kwgOrcpgk4,1092
@@ -199,13 +199,13 @@ runtimepy/net/http/__init__.py,sha256=cMKNPyYZpdT03OR-HNfwzZbaKGchzlGIrK712daRK4
 runtimepy/net/http/common.py,sha256=vpoO6XwRmrZmTkCu9bkI0HnyaD8MWTpV7ADesCNrfRE,2237
 runtimepy/net/http/header.py,sha256=AECSdvhBA9_5Pg3UdwMzsmBpcqgsiPj41xnIGPm5g5E,2296
 runtimepy/net/http/request_target.py,sha256=EfcOozUeXqOuQaMXH9cErfJqUkG0A5v9HEK4tCorSf4,1543
-runtimepy/net/http/response.py,sha256=fD0R_BUgmNwdwKQtXvYfTYM7DyJlwsGmlNVi5HkCOhU,3409
+runtimepy/net/http/response.py,sha256=rLllTaaFn3-ABMhq3jM_6-kqq8ym5VJGVWNwmBr3kAI,3823
 runtimepy/net/http/state.py,sha256=qCMN8aWfCRfU9XP-cIhSOo2RqfljTjbQRCflfcy2bfY,1626
 runtimepy/net/http/version.py,sha256=mp6rgIM7-VUVKLCA0Uw96CmBkL0ET860lDVVEewpZ7w,1098
-runtimepy/net/server/__init__.py,sha256=ppfMgymYGRz13MvHvwXyy9WAos2wWgaZDf1TW8D1ILU,11813
+runtimepy/net/server/__init__.py,sha256=NHs8cXTRTEreVhk5QW9dMTW-pyUCd3NfuATm1a-5V6Y,12191
 runtimepy/net/server/html.py,sha256=OB2K37kA7MHtcKqp0pZE1q_XgiyvfooigzS0-OQFCCM,1900
 runtimepy/net/server/json.py,sha256=AaMPw-G-7xX67mf1LvQAipNdwrnmbLDunVlkWf6iOz0,2526
-runtimepy/net/server/markdown.py,sha256=KuPKYh7nj5oy70Ff8LRAXwr_Ga4r8_3KksvDfPfFqYM,2690
+runtimepy/net/server/markdown.py,sha256=kKKSGF_HwH8ADnNm5fNnWq4XXh7Td9Iu_QUj_u-qmts,3595
 runtimepy/net/server/mux.py,sha256=ejET7NpJzzJjkVwR8laSuZYR79DOT3XazmAIm6rENSE,598
 runtimepy/net/server/app/__init__.py,sha256=0eCcqYvmby_wQTGqAiGbGM5LCxKM2qpjuIT0gLHsoDU,3157
 runtimepy/net/server/app/base.py,sha256=46aOqZwRss_nh_WfEH1cMJ9GUVoLJjERd7cTRFu6mXE,1878
@@ -237,7 +237,7 @@ runtimepy/net/tcp/__init__.py,sha256=OOWohegpoioSTf8M7uDf-4EV1IDungz7-U19L_2yW4I
 runtimepy/net/tcp/connection.py,sha256=FL9SlODVAehECYgF9eKk8sbDMmTMBGlsGJlGaMncQh4,8793
 runtimepy/net/tcp/create.py,sha256=zZsRs5KYpO3bNGh-DwEOEzjUDE4ixj-UBHYgZ0GvC7c,2013
 runtimepy/net/tcp/protocol.py,sha256=vT4HOH-WLrM0j4kUpQA_ZZOwA-kJPMP9M40ptuL84_0,1412
-runtimepy/net/tcp/http/__init__.py,sha256=0nEB6KFqV9GxMwFKqKIswA0wihHfbLP5UD-r5ulgTj0,6391
+runtimepy/net/tcp/http/__init__.py,sha256=7Pnge4d50hG6QjcTXb1lZW1Xcver-vLVubBhj-WUduQ,6369
 runtimepy/net/tcp/scpi/__init__.py,sha256=FcNouVQh0A27-x16lzTbt7vZfWs4bRU9uZqbeVjDfiU,2173
 runtimepy/net/tcp/telnet/__init__.py,sha256=2pGaG-IlZA29BM6QAvI4q9w484fgvypX4fOIioDem94,4814
 runtimepy/net/tcp/telnet/codes.py,sha256=1-yyRe-Kz_W7d6B0P3iT1AaSNR3_Twmn-MUjKCJJknY,3518
@@ -311,9 +311,9 @@ runtimepy/tui/channels/__init__.py,sha256=evDaiIn-YS9uGhdo8ZGtP9VK1ek6sr_P1nJ9Ju
 runtimepy/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runtimepy/ui/button.py,sha256=8MXnhqmVvANwbbTA8gu3b8N4IIvRYicnwxFQD6SZy3U,2045
 runtimepy/ui/controls.py,sha256=L55Af-4vGq6ZHewdoA7C_mAYq35WXl8NzOdcsmQIo7M,1868
-runtimepy-5.15.6.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
-runtimepy-5.15.6.dist-info/METADATA,sha256=MoIujpmp5ifEdr-DxKZrNXyHuFSUoeS6iX0iIyqdW2w,9268
-runtimepy-5.15.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-runtimepy-5.15.6.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
-runtimepy-5.15.6.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
-runtimepy-5.15.6.dist-info/RECORD,,
+runtimepy-5.15.8.dist-info/licenses/LICENSE,sha256=yKBRwbO-cOPBrlpsZmJkkSa33DfY31aE8t7lZ0DwlUo,1071
+runtimepy-5.15.8.dist-info/METADATA,sha256=FwB_Vl_qyjXiREOidJFwlPKEK0nCqvTrgq5ao57doHo,9268
+runtimepy-5.15.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+runtimepy-5.15.8.dist-info/entry_points.txt,sha256=-btVBkYv7ybcopqZ_pRky-bEzu3vhbaG3W3Z7ERBiFE,51
+runtimepy-5.15.8.dist-info/top_level.txt,sha256=0jPmh6yqHyyJJDwEID-LpQly-9kQ3WRMjH7Lix8peLg,10
+runtimepy-5.15.8.dist-info/RECORD,,