imfusion.algorithm.typing

Typing module for the imfusion.algorithm 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.algorithm.typing.Algorithm

Bases: Protocol

Runtime-checkable, generic protocol that defines the requirements for a user-defined algorithm that can be registered in the ImFusionSuite.

__call__() → list[Data] | tuple[Data] | Data | None

Call self as a function.

Return type:

list[Data] | tuple[Data] | Data | None

imfusion.algorithm.typing.TAlgorithmBound = ~TAlgorithmBound

typing.TypeVar[TAlgorithmBound, bound = Algorithm]

imfusion.algorithm.typing.TDataBound = ~TDataBound

typing.TypeVar[TDataBound, bound = Data]

imfusion.algorithm.typing.TEnumBound = ~TEnumBound

typing.TypeVar[TEnumBound, bound = Enum]