docket-client 0.3.2__py3-none-any.whl

docket/models/run_response.py

@@ -0,0 +1,181 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..models.run_origin import RunOrigin
+from ..models.run_status import RunStatus
+from typing import cast
+from uuid import UUID
+import datetime
+
+if TYPE_CHECKING:
+    from ..models.run_settings_snapshot import RunSettingsSnapshot
+
+
+T = TypeVar("T", bound="RunResponse")
+
+
+@_attrs_define
+class RunResponse:
+    """One attempt at a scheduled acquisition.
+
+    Attributes:
+        id (int):
+        scheduled_acquisition_id (int):
+        token (UUID):
+        origin (RunOrigin): Who started a run: the rig software, or a person recording it by hand.
+        status (RunStatus):
+        started_at (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+        ended_at (datetime.datetime | None):
+        error_detail (None | str):
+        started_by (str):
+        resolved_settings (list[RunSettingsSnapshot]):
+    """
+
+    id: int
+    scheduled_acquisition_id: int
+    token: UUID
+    origin: RunOrigin
+    status: RunStatus
+    started_at: datetime.datetime
+    ended_at: datetime.datetime | None
+    error_detail: None | str
+    started_by: str
+    resolved_settings: list[RunSettingsSnapshot]
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.run_settings_snapshot import RunSettingsSnapshot
+
+        id = self.id
+
+        scheduled_acquisition_id = self.scheduled_acquisition_id
+
+        token = str(self.token)
+
+        origin = self.origin.value
+
+        status = self.status.value
+
+        started_at = self.started_at.isoformat()
+
+        ended_at: None | str
+        if isinstance(self.ended_at, datetime.datetime):
+            ended_at = self.ended_at.isoformat()
+        else:
+            ended_at = self.ended_at
+
+        error_detail: None | str
+        error_detail = self.error_detail
+
+        started_by = self.started_by
+
+        resolved_settings = []
+        for resolved_settings_item_data in self.resolved_settings:
+            resolved_settings_item = resolved_settings_item_data.to_dict()
+            resolved_settings.append(resolved_settings_item)
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "id": id,
+                "scheduled_acquisition_id": scheduled_acquisition_id,
+                "token": token,
+                "origin": origin,
+                "status": status,
+                "started_at": started_at,
+                "ended_at": ended_at,
+                "error_detail": error_detail,
+                "started_by": started_by,
+                "resolved_settings": resolved_settings,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.run_settings_snapshot import RunSettingsSnapshot
+
+        d = dict(src_dict)
+        id = d.pop("id")
+
+        scheduled_acquisition_id = d.pop("scheduled_acquisition_id")
+
+        token = UUID(d.pop("token"))
+
+        origin = RunOrigin(d.pop("origin"))
+
+        status = RunStatus(d.pop("status"))
+
+        started_at = datetime.datetime.fromisoformat(d.pop("started_at"))
+
+        def _parse_ended_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                componentsschemas_instant_nullable_type_1 = datetime.datetime.fromisoformat(data)
+
+                return componentsschemas_instant_nullable_type_1
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        ended_at = _parse_ended_at(d.pop("ended_at"))
+
+        def _parse_error_detail(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        error_detail = _parse_error_detail(d.pop("error_detail"))
+
+        started_by = d.pop("started_by")
+
+        resolved_settings = []
+        _resolved_settings = d.pop("resolved_settings")
+        for resolved_settings_item_data in _resolved_settings:
+            resolved_settings_item = RunSettingsSnapshot.from_dict(resolved_settings_item_data)
+
+            resolved_settings.append(resolved_settings_item)
+
+        run_response = cls(
+            id=id,
+            scheduled_acquisition_id=scheduled_acquisition_id,
+            token=token,
+            origin=origin,
+            status=status,
+            started_at=started_at,
+            ended_at=ended_at,
+            error_detail=error_detail,
+            started_by=started_by,
+            resolved_settings=resolved_settings,
+        )
+
+        run_response.additional_properties = d
+        return run_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/run_settings_snapshot.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+T = TypeVar("T", bound="RunSettingsSnapshot")
+
+
+@_attrs_define
+class RunSettingsSnapshot:
+    """
+    Attributes:
+        acquisition_type (str): Acquisition type key.
+        settings_id (int): The settings version the run used.
+    """
+
+    acquisition_type: str
+    settings_id: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        acquisition_type = self.acquisition_type
+
+        settings_id = self.settings_id
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "acquisition_type": acquisition_type,
+                "settings_id": settings_id,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        acquisition_type = d.pop("acquisition_type")
+
+        settings_id = d.pop("settings_id")
+
+        run_settings_snapshot = cls(
+            acquisition_type=acquisition_type,
+            settings_id=settings_id,
+        )
+
+        run_settings_snapshot.additional_properties = d
+        return run_settings_snapshot
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/run_start_response.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+from uuid import UUID
+
+if TYPE_CHECKING:
+    from ..models.run_start_response_settings import RunStartResponseSettings
+
+
+T = TypeVar("T", bound="RunStartResponse")
+
+
+@_attrs_define
+class RunStartResponse:
+    """A started run and the settings it must use.
+
+    Attributes:
+        run_id (int): Run id.
+        token (UUID): Identifier to report the outcome with. Not a credential.
+        settings (RunStartResponseSettings): Resolved settings per acquisition type, exactly as snapshotted.
+    """
+
+    run_id: int
+    token: UUID
+    settings: RunStartResponseSettings
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.run_start_response_settings import RunStartResponseSettings
+
+        run_id = self.run_id
+
+        token = str(self.token)
+
+        settings = self.settings.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "run_id": run_id,
+                "token": token,
+                "settings": settings,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.run_start_response_settings import RunStartResponseSettings
+
+        d = dict(src_dict)
+        run_id = d.pop("run_id")
+
+        token = UUID(d.pop("token"))
+
+        settings = RunStartResponseSettings.from_dict(d.pop("settings"))
+
+        run_start_response = cls(
+            run_id=run_id,
+            token=token,
+            settings=settings,
+        )
+
+        run_start_response.additional_properties = d
+        return run_start_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/run_start_response_settings.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+
+if TYPE_CHECKING:
+    from ..models.resolved_settings import ResolvedSettings
+
+
+T = TypeVar("T", bound="RunStartResponseSettings")
+
+
+@_attrs_define
+class RunStartResponseSettings:
+    """Resolved settings per acquisition type, exactly as snapshotted."""
+
+    additional_properties: dict[str, ResolvedSettings] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.resolved_settings import ResolvedSettings
+
+        field_dict: dict[str, Any] = {}
+        for prop_name, prop in self.additional_properties.items():
+            field_dict[prop_name] = prop.to_dict()
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.resolved_settings import ResolvedSettings
+
+        d = dict(src_dict)
+        run_start_response_settings = cls()
+
+        additional_properties = {}
+        for prop_name, prop_dict in d.items():
+            additional_property = ResolvedSettings.from_dict(prop_dict)
+
+            additional_properties[prop_name] = additional_property
+
+        run_start_response_settings.additional_properties = additional_properties
+        return run_start_response_settings
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> ResolvedSettings:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: ResolvedSettings) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

docket/models/run_status.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class RunStatus(str, Enum):
+    COMPLETED = "completed"
+    ERRORED = "errored"
+    STARTED = "started"
+    TIMED_OUT = "timed_out"
+
+    def __str__(self) -> str:
+        return str(self.value)

docket/models/scheduled_acquisition_edit_preview_response.py

@@ -0,0 +1,150 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+import datetime
+
+if TYPE_CHECKING:
+    from ..models.acquisition_warning import AcquisitionWarning
+
+
+T = TypeVar("T", bound="ScheduledAcquisitionEditPreviewResponse")
+
+
+@_attrs_define
+class ScheduledAcquisitionEditPreviewResponse:
+    """What an edit would produce. Nothing is written to scheduling data, audit or exceptions; the one exception is that
+    looking up a person never seen before may add them to the vocabulary cache.
+
+        Attributes:
+            scheduled_start (datetime.datetime): UTC instant, ISO 8601 with offset, e.g. 2026-10-15T16:00:00Z.
+            scheduled_end (datetime.datetime | None):
+            instrument_id (str): Instrument after the edit.
+            warnings (list[AcquisitionWarning]): Overlap warnings for the edited window, as the real edit would return them.
+            in_series (bool): True when the acquisition is an occurrence of a series; the real edit would then record an
+                `edited` exception for it.
+            recurring_acquisition_id (int | None): The series, when `in_series`.
+    """
+
+    scheduled_start: datetime.datetime
+    scheduled_end: datetime.datetime | None
+    instrument_id: str
+    warnings: list[AcquisitionWarning]
+    in_series: bool
+    recurring_acquisition_id: int | None
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.acquisition_warning import AcquisitionWarning
+
+        scheduled_start = self.scheduled_start.isoformat()
+
+        scheduled_end: None | str
+        if isinstance(self.scheduled_end, datetime.datetime):
+            scheduled_end = self.scheduled_end.isoformat()
+        else:
+            scheduled_end = self.scheduled_end
+
+        instrument_id = self.instrument_id
+
+        warnings = []
+        for warnings_item_data in self.warnings:
+            warnings_item = warnings_item_data.to_dict()
+            warnings.append(warnings_item)
+
+        in_series = self.in_series
+
+        recurring_acquisition_id: int | None
+        recurring_acquisition_id = self.recurring_acquisition_id
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "scheduled_start": scheduled_start,
+                "scheduled_end": scheduled_end,
+                "instrument_id": instrument_id,
+                "warnings": warnings,
+                "in_series": in_series,
+                "recurring_acquisition_id": recurring_acquisition_id,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.acquisition_warning import AcquisitionWarning
+
+        d = dict(src_dict)
+        scheduled_start = datetime.datetime.fromisoformat(d.pop("scheduled_start"))
+
+        def _parse_scheduled_end(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                componentsschemas_instant_nullable_type_1 = datetime.datetime.fromisoformat(data)
+
+                return componentsschemas_instant_nullable_type_1
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        scheduled_end = _parse_scheduled_end(d.pop("scheduled_end"))
+
+        instrument_id = d.pop("instrument_id")
+
+        warnings = []
+        _warnings = d.pop("warnings")
+        for warnings_item_data in _warnings:
+            warnings_item = AcquisitionWarning.from_dict(warnings_item_data)
+
+            warnings.append(warnings_item)
+
+        in_series = d.pop("in_series")
+
+        def _parse_recurring_acquisition_id(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        recurring_acquisition_id = _parse_recurring_acquisition_id(
+            d.pop("recurring_acquisition_id")
+        )
+
+        scheduled_acquisition_edit_preview_response = cls(
+            scheduled_start=scheduled_start,
+            scheduled_end=scheduled_end,
+            instrument_id=instrument_id,
+            warnings=warnings,
+            in_series=in_series,
+            recurring_acquisition_id=recurring_acquisition_id,
+        )
+
+        scheduled_acquisition_edit_preview_response.additional_properties = d
+        return scheduled_acquisition_edit_preview_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties