Web UI

The web UI provides a graphical inspection interface that covers the most of the telnet commands.

Added in version 0.6.0.

aiomonitor.webui.app

The main implementation of the aiohttp-based webapp implementation.

class aiomonitor.webui.app.ListFilterParams(**data)[source]
filter: str
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

persistent: bool
class aiomonitor.webui.app.NavigationItem(title, current)[source]
current: bool
title: str
class aiomonitor.webui.app.TaskIdParams(**data)[source]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_id: str
class aiomonitor.webui.app.TaskTypeParams(**data)[source]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

task_type: TaskTypes
class aiomonitor.webui.app.TaskTypes(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]
RUNNING = 'running'
TERMINATED = 'terminated'
class aiomonitor.webui.app.WebUIContext(monitor, jenv)[source]
jenv: Environment
monitor: Monitor
async aiomonitor.webui.app.cancel_task(request)[source]
Return type:

Response

async aiomonitor.webui.app.get_live_task_list(request)[source]
Return type:

Response

aiomonitor.webui.app.get_navigation_info(route)[source]
Return type:

Tuple[NavigationItem, Mapping[str, NavigationItem]]

async aiomonitor.webui.app.get_task_count(request)[source]
Return type:

Response

async aiomonitor.webui.app.get_terminated_task_list(request)[source]
Return type:

Response

async aiomonitor.webui.app.get_version(request)[source]
Return type:

Response

async aiomonitor.webui.app.init_webui(monitor)[source]
Return type:

Application

async aiomonitor.webui.app.show_about_page(request)[source]
Return type:

Response

async aiomonitor.webui.app.show_list_page(request)[source]
Return type:

Response

async aiomonitor.webui.app.show_trace_page(request)[source]
Return type:

Response

aiomonitor.webui.utils

It contains a set of utility functions to validate and process the HTTP handler arguments.

class aiomonitor.webui.utils.APIParams(**data)[source]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

aiomonitor.webui.utils.check_params(request, model_class)[source]
Return type:

AsyncIterator[TypeVar(T_APIParams, bound= APIParams)]