imfusion.data.components.typing

Typing module for the imfusion.data.components module.

Most parts of the ImFusion Python SDK provide PEP 484-style type annotations. This module adds extra types and protocols for type hints and improved type safety.

class imfusion.data.components.typing.PyDataComponent

Optional base class for static type checking.

Inheriting from this class is not required at runtime. It exists solely to inform static type checkers about the methods and attributes that the register`() decorator injects into every registered data component class.

configuration() → Properties

Return the current field values as a Properties object.

Return type:

Properties

configure(properties: Properties) → None

Apply field values from properties into this component.

Only fields whose keys are present in properties are written; absent fields retain their current value.

Parameters:

properties (Properties)

Return type:

None

id: str

name: str

imfusion.data.components.typing.TDataComponentBound = ~TDataComponentBound

typing.TypeVar[TDataComponentBound, bound = object | imfusion.data.components.typing.PyDataComponent]

imfusion.data.components.typing.TPyDataComponent = ~TPyDataComponent

typing.TypeVar[TPyDataComponent]

imfusion.data.components.typing.TValueType = ~TValueType

typing.TypeVar[TValueType]