ezmsg.dashboard.server#

Functions

build_parser()[source]#
Return type:

ArgumentParser

cmdline(argv=None)[source]#
Return type:

None

Parameters:

argv (list[str] | None)

create_dashboard_app(*, graph_address=None)[source]#
Parameters:

graph_address (str | Address | None)

dashboard_url(host, port)[source]#
Return type:

str

Parameters:
handle_dashboard(args)[source]#
Return type:

None

Parameters:

args (Namespace)

serve_dashboard(*, graph_address=None, host=None, port=None, log_level='info', open_browser=False)[source]#
Return type:

None

Parameters:

  • graph_address (str | Address | None)

  • host (str | None)

  • port (int | None)

  • log_level (str)

  • open_browser (bool)

setup_dashboard_cmdline(subparsers)[source]#
Return type:

None

Parameters:

subparsers (_SubParsersAction)

start_dashboard_server(*, graph_address=None, host='127.0.0.1', port=8000, log_level='info')[source]#
Return type:

DashboardServerHandle

Parameters:

  • graph_address (str | Address | None)

  • host (str)

  • port (int)

  • log_level (str)

Classes

class DashboardServerHandle(server, thread, host, port)[source]#

Bases: object

Parameters:
server: Server#
thread: Thread#
host: str#
port: int#
property url: str#
stop(*, timeout=10.0)[source]#
Return type:

None

Parameters:

timeout (float)

__init__(server, thread, host, port)#
Parameters:
Return type:

None

Exceptions

exception DashboardGraphServerUnavailableError[source]#

Bases: RuntimeError