Plugin

Operator

Base operator class for LightlyStudio plugins.

BaseOperator

Bases: ABC

Base class for all operators.

description abstractmethod property

description: str

Return the description of the operator.

name abstractmethod property

name: str

Return the operator name.

parameters abstractmethod property

parameters: list[BaseParameter]

Return the list of parameters this operator expects.

execute abstractmethod

execute(*, session: Session, dataset_id: UUID, parameters: dict[str, Any]) -> OperatorResult

Execute the operator with the given parameters.

Parameters:

Name	Type	Description	Default
session	Session	Database session.	required
dataset_id	UUID	ID of the dataset to operate on.	required
parameters	dict[str, Any]	Parameters passed to the operator.	required

Returns:

Type	Description
OperatorResult	Dictionary with 'success' (bool) and 'message' (str) keys.

Parameter

Parameter for operators for LightlyStudio plugins.

BaseParameter dataclass

BaseParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: ABC

Base parameter definition shared across operator parameters.

__post_init__

__post_init__() -> None

Run value validation once the dataclass is initialized.

BoolParameter dataclass

BoolParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: BuiltinParameter[bool]

Represents a boolean operator parameter.

__post_init__

__post_init__() -> None

Set up type information and validate default value.

BuiltinParameter dataclass

BuiltinParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: BaseParameter, Generic[T]

Represents a built-in operator parameter.

__post_init__

__post_init__() -> None

Set up type information and validate default value.

FloatParameter dataclass

FloatParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: BuiltinParameter[float]

Represents a float operator parameter.

__post_init__

__post_init__() -> None

Set up type information and validate default value.

IntParameter dataclass

IntParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: BuiltinParameter[int]

Represents an integer operator parameter.

__post_init__

__post_init__() -> None

Set up type information and validate default value.

StringParameter dataclass

StringParameter(
    name: str,
    description: str = "",
    default: Any = None,
    required: bool = True,
    param_type: str | None = None,
)

Bases: BuiltinParameter[str]

Represents a string operator parameter.

__post_init__

__post_init__() -> None

Set up type information and validate default value.