runtimepy.primitives.field package

Subpackages

• runtimepy.primitives.field.manager package
  • Submodules
  • runtimepy.primitives.field.manager.base module
    • BitFieldsManagerBase
      • BitFieldsManagerBase.add()
      • BitFieldsManagerBase.add_field()
      • BitFieldsManagerBase.asdict()
      • BitFieldsManagerBase.encode()
      • BitFieldsManagerBase.get()
      • BitFieldsManagerBase.get_field()
      • BitFieldsManagerBase.get_fields()
      • BitFieldsManagerBase.get_flag()
      • BitFieldsManagerBase.has_field()
      • BitFieldsManagerBase.set()
      • BitFieldsManagerBase.values()
    • fields_to_dict()
    • fields_to_file()
  • Module contents
    • BitFieldsManager
      • BitFieldsManager.export_json()
      • BitFieldsManager.import_json()
    • fields_from_dict()
    • fields_from_file()

Submodules

runtimepy.primitives.field.fields module

A module implementing a data structure for managing multiple bit fields.

class runtimepy.primitives.field.fields.BitFields(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None, schemas: SchemaMap = None, dest_attr: str = 'data', verify: bool = True)

Bases: RuntimepyDictCodec

A class for managing bit fields and flags from dictionary data.

asdict() → dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]

Get these bit fields as a dictionary.

claim_field(field: BitField) → BitField

Claim a bit field.

curr_index: int

field(name: str, width: int, index: int = None, enum: str | int = None, description: str = None, **kwargs) → BitField

Create a new bit field.

finalize() → None

Finalize the fields so that new fields can’t be added.

flag(name: str, index: int = None, enum: str | int = None, description: str = None, **kwargs) → BitFlag

Create a new bit flag.

get_field(key: str | int) → BitField | None

Attempt to get a bit-field from this entity.

init(data: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]) → None

Perform implementation-specific initialization.

property names: Iterator[str]

Iterate over names mapping to individual fields.

classmethod new(value: type[Int8Primitive | Int16Primitive | Int32Primitive | Int64Primitive | Uint8Primitive | Uint16Primitive | Uint32Primitive | Uint64Primitive | HalfPrimitive | FloatPrimitive | DoublePrimitive | BooleanPrimitive] | str | Int8Primitive | Int16Primitive | Int32Primitive | Int64Primitive | Uint8Primitive | Uint16Primitive | Uint32Primitive | Uint64Primitive | HalfPrimitive | FloatPrimitive | DoublePrimitive | BooleanPrimitive = 'uint8') → T

Create a new bit-field storage entity.

pad(width: int = 1, index: int = None, val: int = 0) → int

Pad bits in this primitive so they can’t be allocated.

Module contents

A module implementing bit flags and fields.

class runtimepy.primitives.field.BitField(name: str, raw: Uint8Primitive | Uint16Primitive | Uint32Primitive | Uint64Primitive, index: int, width: int, enum: str | int = None, commandable: bool = False, description: str = None)

Bases: BitFieldBase, RegexMixin, EnumMixin

A class managing a portion of an unsigned-integer primitive.

asdict() → dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]]

Get this field as a dictionary.

name_regex: _Pattern | None = re.compile('^[a-zA-Z0-9_.-]+$')

class runtimepy.primitives.field.BitFieldBase(raw: Uint8Primitive | Uint16Primitive | Uint32Primitive | Uint64Primitive, index: int, width: int, commandable: bool = False, description: str = None)

Bases: object

A simple bit-field implementation.

invert() → int

Invert the value of this field and return the result.

where_str() → str

Get a simple string representing the bit locations this field occupies.

class runtimepy.primitives.field.BitFlag(name: str, raw: Uint8Primitive | Uint16Primitive | Uint32Primitive | Uint64Primitive, index: int, enum: str | int = None, commandable: bool = False, description: str = None)

Bases: BitField

A bit field that is always a single bit.

clear() → None

Clear this field.

get() → bool

Get the value of this flag.

set(val: bool = True) → None

Set this flag.