refactor: added type hints for optim_trajectory; closes #117

This commit is contained in:
wakonig_k 2023-11-18 11:44:17 +01:00
parent c47a46f049
commit 968960646c

View File

@ -2,12 +2,10 @@ import ast
import enum import enum
import time import time
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from typing import Any, Dict, List from typing import Any, Dict, List, Literal
from bec_lib import messages
import numpy as np import numpy as np
from bec_lib import DeviceManagerBase, MessageEndpoints, bec_logger, messages
from bec_lib import DeviceManagerBase, MessageEndpoints, bec_logger
from .errors import LimitError, ScanAbortion from .errors import LimitError, ScanAbortion
from .path_optimization import PathOptimizerMixin from .path_optimization import PathOptimizerMixin
@ -267,7 +265,8 @@ class RequestBase(ABC):
pos_axis = pos[ii] pos_axis = pos[ii]
if not low_limit <= pos_axis <= high_limit: if not low_limit <= pos_axis <= high_limit:
raise LimitError( raise LimitError(
f"Target position {pos} for motor {dev} is outside of range: [{low_limit}, {high_limit}]" f"Target position {pos} for motor {dev} is outside of range: [{low_limit},"
f" {high_limit}]"
) )
def _get_scan_motors(self): def _get_scan_motors(self):
@ -354,7 +353,7 @@ class ScanBase(RequestBase, PathOptimizerMixin):
relative: bool = False, relative: bool = False,
burst_at_each_point: int = 1, burst_at_each_point: int = 1,
frames_per_trigger: int = 1, frames_per_trigger: int = 1,
optim_trajectory: str = None, optim_trajectory: Literal["corridor", None] = None,
monitored: list = None, monitored: list = None,
metadata: dict = None, metadata: dict = None,
**kwargs, **kwargs,
@ -815,7 +814,7 @@ class FermatSpiralScan(ScanBase):
relative: bool = False, relative: bool = False,
burst_at_each_point: int = 1, burst_at_each_point: int = 1,
spiral_type: float = 0, spiral_type: float = 0,
optim_trajectory: str = None, optim_trajectory: Literal["corridor", None] = None,
**kwargs, **kwargs,
): ):
""" """