runtimepy.primitives.field.manager
index
/home/vkottler/src/vkottler/workspace/runtimepy/runtimepy/primitives/field/manager/__init__.py

A management entity for bit-fields.

 
Package Contents
       
base

 
Classes
       
runtimepy.primitives.field.manager.base.BitFieldsManagerBase(builtins.object)
BitFieldsManager

 
class BitFieldsManager(runtimepy.primitives.field.manager.base.BitFieldsManagerBase)
    BitFieldsManager(registry: runtimepy.registry.name.NameRegistry, enums: runtimepy.enum.registry.EnumRegistry, fields: Iterable[runtimepy.primitives.field.fields.BitFields] = None) -> None
 
A class for managing multiple bit-fields objects.
 
 
Method resolution order:
BitFieldsManager
runtimepy.primitives.field.manager.base.BitFieldsManagerBase
builtins.object

Methods defined here:
export_json(self, resolve_enum: bool = True) -> dict[str, typing.Dict[str, typing.Union[str, int, float, bool, NoneType, typing.Dict[str, typing.Union[str, int, float, bool, NoneType]], typing.List[typing.Union[str, int, float, bool, NoneType]]]]]
Export this manager's data to JSON.

Class methods defined here:
import_json(data: dict[str, typing.Dict[str, typing.Union[str, int, float, bool, NoneType, typing.Dict[str, typing.Union[str, int, float, bool, NoneType]], typing.List[typing.Union[str, int, float, bool, NoneType]]]]]) -> 'BitFieldsManager' from builtins.type
Create a bit-fields manager from JSON data.

Methods inherited from runtimepy.primitives.field.manager.base.BitFieldsManagerBase:
__copy__(self: ~T) -> ~T
Create a copy of the manager with fields that use distinct underlying
primitives.
__getitem__(self, key: Union[str, int]) -> runtimepy.primitives.field.BitField
Attempt to get a bit-field.
__init__(self, registry: runtimepy.registry.name.NameRegistry, enums: runtimepy.enum.registry.EnumRegistry, fields: Iterable[runtimepy.primitives.field.fields.BitFields] = None) -> None
Initialize this bit-fields manager.
add(self, fields: runtimepy.primitives.field.fields.BitFields) -> int
Add new bit-fields to manage.
add_field(self, field: runtimepy.primitives.field.BitField) -> Optional[runtimepy.primitives.field.fields.BitFields]
Add a bit field to the environment.
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]]]]
Get this bit-fields manager as a JSON object.
encode(self, path: Union[pathlib.Path, str, NoneType], **kwargs) -> Tuple[bool, int]
Encode this bit-fields manager to a file.
get(self, key: Union[str, int], resolve_enum: bool = True) -> Union[int, bool, str]
Get the value of a field.
get_field(self, key: Union[str, int]) -> Optional[runtimepy.primitives.field.BitField]
Attempt to get a bit-field.
get_fields(self, key: Union[str, int]) -> Optional[runtimepy.primitives.field.fields.BitFields]
Attempt to get a bit-fields object from a registry key.
get_flag(self, key: Union[str, int]) -> runtimepy.primitives.field.BitFlag
Attempt to lookup a bit-flag.
has_field(self, key: Union[str, int]) -> bool
Determine if this manager has a field with this key.
set(self, key: Union[str, int], value: Union[int, bool, str]) -> None
Set a value of a field.
values(self, resolve_enum: bool = True) -> dict[str, typing.Union[str, int]]
Get a new dictionary of current field values.

Data descriptors inherited from runtimepy.primitives.field.manager.base.BitFieldsManagerBase:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
Functions
       
fields_from_dict(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]) -> Iterable[runtimepy.primitives.field.fields.BitFields]
Load bit-fields from JSON data.
fields_from_file(path: Union[pathlib.Path, str, NoneType]) -> Iterable[runtimepy.primitives.field.fields.BitFields]
Load bit-fields from a file.

 
Data
        ENUMS_KEY = 'enums'
FIELDS_KEY = 'fields'
NAMES_KEY = 'names'
VALUES_KEY = 'values'