runtimepy.primitives.field.manager package

runtimepy.primitives.field.manager package#

Submodules#

runtimepy.primitives.field.manager.base module#

A base management entity for bit-fields.

class runtimepy.primitives.field.manager.base.BitFieldsManagerBase(registry: NameRegistry, enums: EnumRegistry, fields: Iterable[BitFields] = None)[source]#

Bases: object

A class for managing multiple bit-fields objects.

add(fields: BitFields) → int[source]#: Add new bit-fields to manage.

add_field(field: BitField) → BitFields | None[source]#: Add a bit field to the environment.

asdict() → Dict[str, str | int | float | bool | None | Dict[str, str | int | float | bool | None] | List[str | int | float | bool | None]][source]#: Get this bit-fields manager as a JSON object.

encode(path: Path | str | None, **kwargs) → Tuple[bool, int][source]#: Encode this bit-fields manager to a file.

get(key: str | int, resolve_enum: bool = True) → int | bool | str[source]#: Get the value of a field.

get_field(key: str | int) → BitField | None[source]#: Attempt to get a bit-field.

get_fields(key: str | int) → BitFields | None[source]#: Attempt to get a bit-fields object from a registry key.

get_flag(key: str | int) → BitFlag[source]#: Attempt to lookup a bit-flag.

has_field(key: str | int) → bool[source]#: Determine if this manager has a field with this key.

set(key: str | int, value: int | bool | str) → None[source]#: Set a value of a field.

values(resolve_enum: bool = True) → dict[str, str | int][source]#: Get a new dictionary of current field values.

runtimepy.primitives.field.manager.base.fields_to_dict(fields: Iterable[BitFields]) → Dict[str, str | int | float | bool | None | Dict[str, str | int | float | bool | None] | List[str | int | float | bool | None]][source]#: Organize a bit-fields iterable into a JSON object.

runtimepy.primitives.field.manager.base.fields_to_file(path: Path | str | None, fields: Iterable[BitFields], **kwargs) → Tuple[bool, int][source]#: Write bit-fields to a file.

Module contents#

A management entity for bit-fields.

class runtimepy.primitives.field.manager.BitFieldsManager(registry: NameRegistry, enums: EnumRegistry, fields: Iterable[BitFields] = None)[source]#

Bases: BitFieldsManagerBase

A class for managing multiple bit-fields objects.

export_json(resolve_enum: bool = True) → dict[str, Dict[str, str | int | float | bool | None | Dict[str, str | int | float | bool | None] | List[str | int | float | bool | None]]][source]#: Export this manager’s data to JSON.

classmethod import_json(data: dict[str, Dict[str, str | int | float | bool | None | Dict[str, str | int | float | bool | None] | List[str | int | float | bool | None]]]) → BitFieldsManager[source]#: Create a bit-fields manager from JSON data.

runtimepy.primitives.field.manager.fields_from_dict(data: Dict[str, str | int | float | bool | None | Dict[str, str | int | float | bool | None] | List[str | int | float | bool | None]]) → Iterable[BitFields][source]#: Load bit-fields from JSON data.

runtimepy.primitives.field.manager.fields_from_file(path: Path | str | None) → Iterable[BitFields][source]#: Load bit-fields from a file.