| | |
- runtimepy.net.arbiter.task.ArbiterTask(runtimepy.task.basic.periodic.PeriodicTask)
-
- AppBase
class AppBase(runtimepy.net.arbiter.task.ArbiterTask) |
| |
AppBase(name: 'str', average_depth: 'int' = 10, metrics: 'PeriodicTaskMetrics' = None, period_s: 'float' = 1.0, env: 'ChannelEnvironment' = None) -> 'None'
A base TUI application.
|
| |
- Method resolution order:
- AppBase
- runtimepy.net.arbiter.task.ArbiterTask
- runtimepy.task.basic.periodic.PeriodicTask
- runtimepy.mixins.logging.LoggerMixinLevelControl
- vcorelib.logging.LoggerMixin
- runtimepy.mixins.environment.ChannelEnvironmentMixin
- abc.ABC
- builtins.object
Methods defined here:
- async dispatch(self) -> bool
- Dispatch an iteration of this task.
- draw(self) -> None
- Draw the application.
- async handle_char(self, char: int) -> None
- Handle user input.
- async init(self, app: runtimepy.net.arbiter.info.AppInfo) -> None
- Initialize this task with application information.
Readonly properties defined here:
- cursor
- Get this instance's cursor.
- window
- Get this instance's window.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {'app': <class 'runtimepy.net.arbiter.info.AppInfo'>, 'input_queue': asyncio.queues.Queue[int]}
Data and other attributes inherited from runtimepy.net.arbiter.task.ArbiterTask:
- auto_finalize = False
Methods inherited from runtimepy.task.basic.periodic.PeriodicTask:
- __init__(self, name: 'str', average_depth: 'int' = 10, metrics: 'PeriodicTaskMetrics' = None, period_s: 'float' = 1.0, env: 'ChannelEnvironment' = None) -> 'None'
- Initialize this task.
- disable(self) -> 'bool'
- Disable this task, return whether or not any action was taken.
- async run(self, period_s: 'float' = None, stop_sig: '_asyncio.Event' = None) -> 'None'
- Run this task by executing the dispatch method at the specified period
until a dispatch iteration fails or the task is otherwise disabled.
- set_period(self, period_s: 'float' = None) -> 'bool'
- Attempt to set a new period for this task.
- async stop(self) -> 'bool'
- Wait for this task to stop running (if it is).
- async stop_extra(self) -> 'None'
- Extra actions to perform when this task is stopping.
- async task(self, period_s: 'float' = None, stop_sig: '_asyncio.Event' = None) -> '_asyncio.Task[None]'
- Create an event-loop task for this periodic.
Methods inherited from runtimepy.mixins.logging.LoggerMixinLevelControl:
- setup_level_channel(self, env: runtimepy.channel.environment.ChannelEnvironment, name: str = 'log_level', initial: str = 'info', description: str = 'Text-log level filter for this environment.') -> None
- Add a commandable log-level channel to the environment.
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
Data descriptors inherited from vcorelib.logging.LoggerMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:
- register_channel_metrics(self, name: str, channel: runtimepy.metrics.channel.ChannelMetrics, verb: str) -> None
- Register individual channel metrics.
- register_connection_metrics(self, metrics: runtimepy.metrics.connection.ConnectionMetrics, namespace: str = 'metrics') -> None
- Register connection metrics.
- register_task_metrics(self, metrics: runtimepy.metrics.task.PeriodicTaskMetrics, namespace: str = 'metrics') -> None
- Register periodic task metrics.
| |