| |
- Method resolution order:
- GlobalEnvironment
- collections.UserDict
- collections.abc.MutableMapping
- collections.abc.Mapping
- collections.abc.Collection
- collections.abc.Sized
- collections.abc.Iterable
- collections.abc.Container
- vcorelib.logging.LoggerMixin
- builtins.object
Methods defined here:
- __init__(self, root: pathlib.Path = None) -> None
- Initialize this instance.
- clear(self) -> None
- Log environments that get cleared when clearing.
- event_telemetry_output(self, env_pattern: str = '.*', env_exact: bool = False, channel_pattern: str = '.*', channel_exact: bool = False, event_path: str = 'event_stream.bin', text_log: bool = True) -> Iterator[list[tuple[str, list[str]]]]
- Register file-output streams for environments based on a pattern.
- export(self, env: str) -> pathlib.Path
- Export an environment to a sub-directory of the root directory.
- file_event_stream(self, env: str, pattern: str = '.*', path: str = 'event_stream.bin', exact: bool = False) -> Iterator[list[str]]
- Enable event streaming to a file for an environment by name.
- log_file(self, path: str = 'log.txt') -> Iterator[logging.FileHandler]
- Register a logging file handler as a managed context.
- read_event_stream(self, env: str, path: str = 'event_stream.bin') -> Iterator[runtimepy.channel.registry.ParsedEvent]
- Reade events from a specific environment.
- register(self, name: str, env: runtimepy.channel.environment.command.processor.ChannelCommandProcessor) -> None
- Register an environment.
- write_meta(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
- Write metadata to the output directory.
Static methods defined here:
- from_root(root: pathlib.Path) -> 'GlobalEnvironment'
- Load a global environment from a directory.
- meta_path(root: pathlib.Path) -> pathlib.Path
- Get the path to the metadata file.
- temporary() -> Iterator[ForwardRef('GlobalEnvironment')]
- Create a temporary global environment.
Readonly properties defined here:
- valid_root
- Get the validated root directory.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {}
- __orig_bases__ = (collections.UserDict[str, runtimepy.channel.environment.command.processor.ChannelCommandProcessor], <class 'vcorelib.logging.LoggerMixin'>)
Methods inherited from collections.UserDict:
- __contains__(self, key)
- # Modify __contains__ and get() to work like dict
# does when __missing__ is present.
- __copy__(self)
- __delitem__(self, key)
- __getitem__(self, key)
- __ior__(self, other)
- __iter__(self)
- __len__(self)
- __or__(self, other)
- Return self|value.
- __repr__(self)
- Return repr(self).
- __ror__(self, other)
- Return value|self.
- __setitem__(self, key, item)
- copy(self)
- get(self, key, default=None)
- D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
Class methods inherited from collections.UserDict:
- fromkeys(iterable, value=None) from abc.ABCMeta
Data descriptors inherited from collections.UserDict:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from collections.abc.MutableMapping:
- pop(self, key, default=<object object at 0x7fc9149c81c0>)
- D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised.
- popitem(self)
- D.popitem() -> (k, v), remove and return some (key, value) pair
as a 2-tuple; but raise KeyError if D is empty.
- setdefault(self, key, default=None)
- D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
- update(self, other=(), /, **kwds)
- D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
If E present and has a .keys() method, does: for k in E: D[k] = E[k]
If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
In either case, this is followed by: for k, v in F.items(): D[k] = v
Methods inherited from collections.abc.Mapping:
- __eq__(self, other)
- Return self==value.
- items(self)
- D.items() -> a set-like object providing a view on D's items
- keys(self)
- D.keys() -> a set-like object providing a view on D's keys
- values(self)
- D.values() -> an object providing a view on D's values
Data and other attributes inherited from collections.abc.Mapping:
- __hash__ = None
- __reversed__ = None
Class methods inherited from collections.abc.Collection:
- __subclasshook__(C) from abc.ABCMeta
- Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented. If it returns
NotImplemented, the normal algorithm is used. Otherwise, it
overrides the normal algorithm (and the outcome is cached).
Class methods inherited from collections.abc.Iterable:
- __class_getitem__ = GenericAlias(...) from abc.ABCMeta
- Represent a PEP 585 generic type
E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
Methods inherited from vcorelib.logging.LoggerMixin:
- log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]
- A simple wrapper.
|