Python: package runtimepy.task.trig

__class_getitem__(...) from builtins.type: Parameterizes a generic class.

At least, parameterizing a generic class is the *main* thing this
method does. For example, for some generic class `Foo`, this is called
when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.

However, note that this method is also called when defining generic
classes in the first place with `class Foo[T]: ...`.

__init_subclass__(...) from builtins.type: Function to initialize subclasses.

class SinusoidTask(runtimepy.net.arbiter.task.ArbiterTask, runtimepy.mixins.trig.TrigMixin)

SinusoidTask(name: 'str', average_depth: 'int' = 10, metrics: 'PeriodicTaskMetrics' = None, period_s: 'float' = 1.0, env: 'ChannelEnvironment' = None) -> 'None'

A task for logging metrics.

Method resolution order:: SinusoidTask; runtimepy.net.arbiter.task.ArbiterTask; runtimepy.task.basic.periodic.PeriodicTask; runtimepy.mixins.logging.LoggerMixinLevelControl; vcorelib.logging.LoggerMixin; runtimepy.mixins.environment.ChannelEnvironmentMixin; abc.ABC; runtimepy.mixins.trig.TrigMixin; builtins.object

Methods defined here:

async dispatch(self) -> bool: Dispatch an iteration of this task.

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

auto_finalize = True

Methods inherited from runtimepy.net.arbiter.task.ArbiterTask:

async init(self, app: runtimepy.net.arbiter.info.AppInfo) -> None: Initialize this task with application information.

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.

Methods inherited from runtimepy.mixins.trig.TrigMixin:

dispatch_trig(self, step: int) -> None: Dispatch trig channel updates.