Module madsci.common.types.workcell_types

Types for MADSci Workcell configuration.

Classes¶

WorkcellManagerDefinition(**data: Any)

Definition of a MADSci Workcell.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)¶

madsci.common.types.base_types.MadsciBaseModel
pydantic.main.BaseModel

Class variables¶

description: str | None :

manager_id: str :

manager_type: Literal[<ManagerType.WORKCELL_MANAGER: 'workcell_manager'>] :

model_config :

name: str :

nodes: dict[str, pydantic.networks.AnyUrl] :

Methods¶

is_ulid(id: str, info: pydantic_core.core_schema.ValidationInfo) ‑> str: Validates that a string field is a valid ULID.

WorkcellManagerHealth(**data: Any)

Health status for Workcell Manager including Redis connectivity.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)¶

madsci.common.types.manager_types.ManagerHealth
madsci.common.types.base_types.MadsciBaseModel
pydantic.main.BaseModel

Class variables¶

model_config :

nodes_reachable: int | None :

redis_connected: bool | None :

total_nodes: int | None :

WorkcellManagerSettings(**values: Any)

Settings for the MADSci Workcell Manager.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)¶

madsci.common.types.manager_types.ManagerSettings
madsci.common.types.base_types.MadsciBaseSettings
pydantic_settings.main.BaseSettings
pydantic.main.BaseModel

Class variables¶

cold_start_delay: int :

collection_name: str :

database_name: str :

get_action_result_retries: int :

manager_definition: str | pathlib.Path :

mongo_db_url: pydantic.networks.AnyUrl | None :

node_info_update_interval: float :

node_update_interval: float :

reconnect_attempt_interval: float :

redis_host: str :

redis_password: str | None :

redis_port: int :

scheduler: str :

scheduler_update_interval: float :

server_url: pydantic.networks.AnyUrl :

workcells_directory: str | pathlib.Path | None :

WorkcellState(**data: Any)

Represents the live state of a MADSci workcell.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)¶

madsci.common.types.base_types.MadsciBaseModel
pydantic.main.BaseModel

Class variables¶

model_config :

nodes: dict[str, madsci.common.types.node_types.Node] :

status: madsci.common.types.workcell_types.WorkcellStatus :

workcell_definition: madsci.common.types.workcell_types.WorkcellManagerDefinition :

workflow_queue: list[madsci.common.types.workflow_types.Workflow] :

WorkcellStatus(**data: Any)

Represents the status of a MADSci workcell.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)¶

madsci.common.types.base_types.MadsciBaseModel
pydantic.main.BaseModel

Class variables¶

errored: bool :

errors: list[madsci.common.types.base_types.Error] :

initializing: bool :

locked: bool :

model_config :

paused: bool :

shutdown: bool :

Static methods¶

ensure_list_of_errors(v: Any) ‑> Any: Ensure that errors is a list of MADSci Errors

Instance variables¶

ok: bool: Whether the workcell is in a good state.