| | |
- runtimepy.mixins.environment.ChannelEnvironmentMixin(builtins.object)
-
- ChannelCommandProcessor
-
- RemoteCommandProcessor
class ChannelCommandProcessor(runtimepy.mixins.environment.ChannelEnvironmentMixin) |
| |
ChannelCommandProcessor(env: runtimepy.channel.environment.ChannelEnvironment, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], **kwargs) -> None
A command processing interface for channel environments.
|
| |
- Method resolution order:
- ChannelCommandProcessor
- runtimepy.mixins.environment.ChannelEnvironmentMixin
- builtins.object
Methods defined here:
- __init__(self, env: runtimepy.channel.environment.ChannelEnvironment, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], **kwargs) -> None
- Initialize this instance.
- command(self, value: str) -> runtimepy.channel.environment.command.result.CommandResult
- Process a command.
- do_set(self, args: argparse.Namespace) -> runtimepy.channel.environment.command.result.CommandResult
- Attempt to set a channel value.
- do_toggle(self, args: argparse.Namespace, channel: Union[runtimepy.primitives.field.BitField, runtimepy.channel.Channel[runtimepy.primitives.int.Int8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int64Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint64Primitive], runtimepy.channel.Channel[runtimepy.primitives.float.FloatPrimitive], runtimepy.channel.Channel[runtimepy.primitives.float.DoublePrimitive], runtimepy.channel.Channel[runtimepy.primitives.bool.BooleanPrimitive]]) -> runtimepy.channel.environment.command.result.CommandResult
- Attempt to toggle a channel.
- get_suggestion(self, value: str) -> Optional[str]
- Get an input suggestion.
- handle_command(self, args: argparse.Namespace) -> runtimepy.channel.environment.command.result.CommandResult
- Handle a command from parsed arguments.
- parse(self, value: str) -> Optional[argparse.Namespace]
- Attempt to parse arguments.
Data and other attributes defined here:
- __annotations__ = {}
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.
Data descriptors inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
|
class RemoteCommandProcessor(ChannelCommandProcessor) |
| |
RemoteCommandProcessor(env: runtimepy.channel.environment.ChannelEnvironment, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], **kwargs) -> None
A command processing interface for channel environments.
|
| |
- Method resolution order:
- RemoteCommandProcessor
- ChannelCommandProcessor
- runtimepy.mixins.environment.ChannelEnvironmentMixin
- builtins.object
Methods defined here:
- handle_command(self, args: argparse.Namespace) -> runtimepy.channel.environment.command.result.CommandResult
- Handle a command from parsed arguments.
Data and other attributes defined here:
- __annotations__ = {}
Methods inherited from ChannelCommandProcessor:
- __init__(self, env: runtimepy.channel.environment.ChannelEnvironment, logger: Union[logging.Logger, logging.LoggerAdapter[Any]], **kwargs) -> None
- Initialize this instance.
- command(self, value: str) -> runtimepy.channel.environment.command.result.CommandResult
- Process a command.
- do_set(self, args: argparse.Namespace) -> runtimepy.channel.environment.command.result.CommandResult
- Attempt to set a channel value.
- do_toggle(self, args: argparse.Namespace, channel: Union[runtimepy.primitives.field.BitField, runtimepy.channel.Channel[runtimepy.primitives.int.Int8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Int64Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint8Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint16Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint32Primitive], runtimepy.channel.Channel[runtimepy.primitives.int.Uint64Primitive], runtimepy.channel.Channel[runtimepy.primitives.float.FloatPrimitive], runtimepy.channel.Channel[runtimepy.primitives.float.DoublePrimitive], runtimepy.channel.Channel[runtimepy.primitives.bool.BooleanPrimitive]]) -> runtimepy.channel.environment.command.result.CommandResult
- Attempt to toggle a channel.
- get_suggestion(self, value: str) -> Optional[str]
- Get an input suggestion.
- parse(self, value: str) -> Optional[argparse.Namespace]
- Attempt to parse arguments.
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.
Data descriptors inherited from runtimepy.mixins.environment.ChannelEnvironmentMixin:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
| |