runtimepy.net.server package

Subpackages

• runtimepy.net.server.app package
  • Subpackages
    • runtimepy.net.server.app.env package
      • Subpackages
      • Submodules
      • runtimepy.net.server.app.env.modal module
      • runtimepy.net.server.app.env.settings module
      • runtimepy.net.server.app.env.widgets module
      • Module contents
  • Submodules
  • runtimepy.net.server.app.base module
    • WebApplication
      • WebApplication.populate()
      • WebApplication.ui_classes
      • WebApplication.worker_classes
  • runtimepy.net.server.app.create module
    • config_param()
    • create_app()
    • create_cacheable_app()
  • runtimepy.net.server.app.elements module
    • kind()
  • runtimepy.net.server.app.files module
    • set_text_to_file()
    • set_text_to_kind()
  • runtimepy.net.server.app.landing_page module
    • landing_page()
  • runtimepy.net.server.app.placeholder module
    • DummyTab
      • DummyTab.compose()
    • dummy_tabs()
    • under_construction()
  • runtimepy.net.server.app.pyodide module
    • add_pyodide_js()
  • runtimepy.net.server.app.sound module
    • SoundTab
      • SoundTab.compose()
  • runtimepy.net.server.app.tab module
    • Tab
      • Tab.compose()
      • Tab.entry()
      • Tab.init()
      • Tab.write_js()
  • Module contents
    • launch_browser()
    • setup()
• runtimepy.net.server.struct package
  • Module contents
    • UiState
      • UiState.frame_period_ms
      • UiState.init_env()
      • UiState.json_metrics
      • UiState.poll()
      • UiState.singleton()
      • UiState.time_ms
      • UiState.use_psutil
• runtimepy.net.server.websocket package
  • Submodules
  • runtimepy.net.server.websocket.state module
    • TabState
      • TabState.add_logger()
      • TabState.callbacks
      • TabState.clear_loggers()
      • TabState.clear_telemetry()
      • TabState.create()
      • TabState.frame()
      • TabState.latest_ui_values
      • TabState.points
      • TabState.primitives
      • TabState.shown
      • TabState.tab_logger
  • Module contents
    • RuntimepyDataWebsocketConnection
    • RuntimepyWebsocketConnection
      • RuntimepyWebsocketConnection.async_init()
      • RuntimepyWebsocketConnection.command
      • RuntimepyWebsocketConnection.disable_extra()
      • RuntimepyWebsocketConnection.env
      • RuntimepyWebsocketConnection.id_responses
      • RuntimepyWebsocketConnection.ids_waiting
      • RuntimepyWebsocketConnection.init()
      • RuntimepyWebsocketConnection.list_handler
      • RuntimepyWebsocketConnection.logger
      • RuntimepyWebsocketConnection.markdown
      • RuntimepyWebsocketConnection.outgoing_commands
      • RuntimepyWebsocketConnection.poll_connection_metrics
      • RuntimepyWebsocketConnection.poll_governor
      • RuntimepyWebsocketConnection.processor
      • RuntimepyWebsocketConnection.remote_environments
      • RuntimepyWebsocketConnection.remote_meta
      • RuntimepyWebsocketConnection.send_interfaces
      • RuntimepyWebsocketConnection.tab_sender()
      • RuntimepyWebsocketConnection.tabs
      • RuntimepyWebsocketConnection.ui_time

Submodules

runtimepy.net.server.html module

A module implementing HTML interfaces for web applications.

runtimepy.net.server.html.get_html() → Html

Get a default HTML document.

async runtimepy.net.server.html.html_handler(apps: dict[str, Callable[[Html, RequestHeader, ResponseHeader, bytes | None], Awaitable[Html]]], stream: TextIO, request: RequestHeader, response: ResponseHeader, request_data: bytes | None, default_app: Callable[[Html, RequestHeader, ResponseHeader, bytes | None], Awaitable[Html]] = None) → bool

Render an HTML document in response to an HTTP request.

runtimepy.net.server.json module

A module implementing basic JSON-object response handling.

class runtimepy.net.server.json.Encoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

A custom JSON encoder.

default(o)

A simple override for default encoding behavior.

runtimepy.net.server.json.encode_json(stream: TextIO, response: ResponseHeader, data: dict[str, Any], response_type: str = 'json') → None

Encode a JSON message response.

runtimepy.net.server.json.json_handler(stream: TextIO, request: RequestHeader, response: ResponseHeader, request_data: bytes | None, data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None

Create an HTTP response from some JSON object data.

runtimepy.net.server.json.traverse_dict(data: dict[str, Any], *paths: str) → Any

Attempt to traverse a dictionary by path names.

runtimepy.net.server.markdown module

A module implementing web server markdown interfaces.

runtimepy.net.server.markdown.markdown_for_dir(path: Path, extra_links: dict[str, Iterable[str]] = None) → str

Get markdown data for a directory.

Module contents

A module implementing a server interface for this package.

class runtimepy.net.server.RuntimepyServerConnection(transport: Transport, protocol: QueueProtocol, **kwargs)

Bases: HttpConnection

A class implementing a server-connection interface for this package.

add_path(path: Path | str | None, front: bool = False) → None

Add a path.

classmethod add_redirect_path(dest: str | Path, *src_parts: str | Path) → None

Add a redirect path.

apps: dict[str, Callable[[Html, RequestHeader, ResponseHeader, bytes | None], Awaitable[Html]]] = {}

class_paths: list[Path | str | None] = [PosixPath('.'), PosixPath('/home/vkottler/src/libre-embedded/runtimepy/runtimepy/data')]

class_redirect_paths: dict[Path, str | Path] = {}

default_app: Callable[[Html, RequestHeader, ResponseHeader, bytes | None], Awaitable[Html]] | None = None

favicon_data: bytes

async get_handler(response: ResponseHeader, request: RequestHeader, request_data: bytes | None) → bytes | None

Handle GET requests.

handle_command(stream: TextIO, response: ResponseHeader, args: tuple[str, ...]) → None

Handle a command request.

init() → None

Initialize this instance.

json_data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = {'test': {'a': 1, 'b': 2, 'c': 3}}

log_paths() → None

Log search paths.

paths: list[Path]

async post_handler(response: ResponseHeader, request: RequestHeader, request_data: bytes | None) → bytes | None

Handle POST requests.

redirect_to(path: str, response: ResponseHeader, status: HTTPStatus = HTTPStatus.TEMPORARY_REDIRECT) → bytes

Handle responding with redirection status.

render_markdown(content: str, response: ResponseHeader, query: str | None, **kwargs) → bytes

Return rendered markdown content.

async render_markdown_file(path: Path, response: ResponseHeader, query: str | None, **kwargs) → bytes

Render a markdown file as HTML and return the result.

async try_file(path: Tuple[str, str | None], response: ResponseHeader) → bytes | None

Try serving this path as a file directly from the file-system.

async try_redirect(path: Tuple[str, str | None], response: ResponseHeader) → bytes | None

Try handling any HTTP redirect rules.

runtimepy.net.server.package_data_dir() → Path

Get this package’s data directory.