| | |
- runtimepy.mixins.enum.EnumMixin(builtins.object)
-
- Channel(runtimepy.registry.item.RegistryItem, runtimepy.mixins.enum.EnumMixin, typing.Generic)
- runtimepy.registry.item.RegistryItem(runtimepy.schemas.RuntimepyDictCodec)
-
- Channel(runtimepy.registry.item.RegistryItem, runtimepy.mixins.enum.EnumMixin, typing.Generic)
- typing.Generic(builtins.object)
-
- Channel(runtimepy.registry.item.RegistryItem, runtimepy.mixins.enum.EnumMixin, typing.Generic)
class Channel(runtimepy.registry.item.RegistryItem, runtimepy.mixins.enum.EnumMixin, typing.Generic) |
| |
Channel(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None
An interface for an individual channel.
|
| |
- Method resolution order:
- Channel
- runtimepy.registry.item.RegistryItem
- runtimepy.schemas.RuntimepyDictCodec
- vcorelib.dict.codec.DictCodec
- vcorelib.dict.codec.JsonCodec
- abc.ABC
- vcorelib.schemas.mixins.SchemaMixin
- runtimepy.mixins.enum.EnumMixin
- typing.Generic
- builtins.object
Methods defined here:
- __bool__(self) -> bool
- Get this channel as a boolean.
- __str__(self) -> str
- Get this channel as a string.
- asdict(self) -> Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]
- Obtain a dictionary representing this instance.
- init(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]) -> None
- Perform implementation-specific initialization.
Readonly properties defined here:
- type
- Get the underlying primitive type of this channel.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {}
- __orig_bases__ = (<class 'runtimepy.registry.item.RegistryItem'>, <class 'runtimepy.mixins.enum.EnumMixin'>, typing.Generic[~T])
- __parameters__ = (~T,)
Methods inherited from runtimepy.registry.item.RegistryItem:
- __eq__(self, other) -> bool
- Use the integer identifier to determine equivalence.
- __hash__(self) -> int
- Get a suitable hash for this registry item.
Data and other attributes inherited from runtimepy.schemas.RuntimepyDictCodec:
- default_schemas = {'StructConfig': <vcorelib.schemas.json.JsonSche...chemas.json.JsonSchema object at 0x7fcfd9601640>}
Methods inherited from vcorelib.dict.codec.DictCodec:
- __init__(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None
- Initialize this instance.
Class methods inherited from vcorelib.dict.codec.DictCodec:
- create(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> ~V from abc.ABCMeta
- A factory method to create an instance.
Methods inherited from vcorelib.dict.codec.JsonCodec:
- __copy__(self: ~T) -> ~T
- Create another instance based on this instance's data.
- encode(self, pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7fcfda137f20>, **kwargs) -> Tuple[bool, int]
- Encode this object instance to a file.
Class methods inherited from vcorelib.dict.codec.JsonCodec:
- decode(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7fcfda137f20>, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True, require_success: bool = True, default_data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, **kwargs) -> ~T from abc.ABCMeta
- Decode an object instance from data loaded from a file.
- file_cache(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7fcfda137f20>, encode_kwargs: Dict[str, Any] = None, require_success: bool = False, **kwargs) -> Iterator[~T] from abc.ABCMeta
- Manage an instance of this class as a disk-backed file.
- normalize(data: Union[Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]], ~T]) -> ~T from abc.ABCMeta
- Ensure that some object is an instance of this class.
Data descriptors inherited from vcorelib.dict.codec.JsonCodec:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from vcorelib.schemas.mixins.SchemaMixin:
- validate(self, valid_attr: str = 'data') -> None
- Validate an instance attribute based on this instance's schema.
Class methods inherited from vcorelib.schemas.mixins.SchemaMixin:
- schema_name() -> str from abc.ABCMeta
- A default name for this class's schema.
Readonly properties inherited from runtimepy.mixins.enum.EnumMixin:
- enum
- Get the enum-registry key for this channel.
- is_enum
- Determine if this channel has an associated enumeration.
Class methods inherited from typing.Generic:
- __class_getitem__(...) from abc.ABCMeta
- 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 abc.ABCMeta
- Function to initialize subclasses.
| |