Refactor wrapped scan plans so they more user friendly

src/dodal/plan_stubs/__init__.py

@@ -1,4 +1,4 @@
-from .wrapped import (
+from .blueapi_wrapped import (
     move,
     move_relative,
     rd,

src/dodal/plan_stubs/wrapped.py → src/dodal/plan_stubs/blueapi_wrapped.py

@@ -6,7 +6,7 @@
 from bluesky.protocols import Movable, Readable, Stoppable
 from bluesky.utils import MsgGenerator
 
-"""Wrappers for Bluesky built-in plan stubs with type hinting."""
+"""Wrappers for Bluesky built-in plan stubs with type hinting to be comptable with blueapi."""
 
 Group = Annotated[str, "String identifier used by 'wait' or stubs that await"]
 

src/dodal/plans/__init__.py

@@ -1,33 +0,0 @@
-from .spec_path import spec_scan
-from .wrapped import (
-    count,
-    list_grid_rscan,
-    list_grid_scan,
-    list_rscan,
-    list_scan,
-    num_grid_rscan,
-    num_grid_scan,
-    num_rscan,
-    num_scan,
-    step_grid_rscan,
-    step_grid_scan,
-    step_rscan,
-    step_scan,
-)
-
-__all__ = [
-    "count",
-    "list_grid_rscan",
-    "list_grid_scan",
-    "list_rscan",
-    "list_scan",
-    "num_grid_rscan",
-    "num_grid_scan",
-    "num_rscan",
-    "num_scan",
-    "spec_scan",
-    "step_grid_rscan",
-    "step_grid_scan",
-    "step_rscan",
-    "step_scan",
-]

src/dodal/plans/scans/__init__.py

@@ -0,0 +1,33 @@
+from .blueapi_wrapped import (
+    count,
+    list_grid_rscan,
+    list_grid_scan,
+    list_rscan,
+    list_scan,
+    num_grid_rscan,
+    num_grid_scan,
+    num_rscan,
+    num_scan,
+    step_grid_rscan,
+    step_grid_scan,
+    step_rscan,
+    step_scan,
+)
+from .spec_path import spec_scan
+
+__all__ = [
+    "count",
+    "list_grid_rscan",
+    "list_grid_scan",
+    "list_rscan",
+    "list_scan",
+    "num_grid_rscan",
+    "num_grid_scan",
+    "num_rscan",
+    "num_scan",
+    "step_grid_rscan",
+    "step_grid_scan",
+    "step_rscan",
+    "step_scan",
+    "spec_scan",
+]

src/dodal/plans/scans/annotations.py

@@ -0,0 +1,92 @@
+from typing import Annotated as A
+
+from pydantic import BeforeValidator, Field
+
+from dodal.plans.scans.types import (
+    Detectors,
+    MovableListOfPositions,
+    MovableStartStep,
+    MovableStartStop,
+    MovableStartStopNum,
+    MovableStartStopStep,
+)
+from dodal.plans.scans.validators import trajectory_validator
+
+DetectorsA = A[
+    Detectors,
+    Field(
+        description="Set of readable devices, will take a reading at each point",
+    ),
+]
+
+MovableStartStepA = A[
+    MovableStartStep,
+    Field(
+        description="Trajectory defined by a movable, start position, and step size."
+    ),
+    BeforeValidator(
+        trajectory_validator(
+            length=3,
+            template="(movable, start, step)",
+            expected_type=MovableStartStep,
+        )
+    ),
+]
+
+MovableStartStopA = A[
+    MovableStartStop,
+    Field(
+        description="Trajectory defined by a movable, start position, and stop position.",
+    ),
+    BeforeValidator(
+        trajectory_validator(
+            length=3,
+            template="(movable, start, stop)",
+            expected_type=MovableStartStop,
+        )
+    ),
+]
+
+MovableStartStopNumA = A[
+    MovableStartStopNum,
+    Field(
+        description="Trajectory defined by a movable, start position, stop position, "
+        "and number of points."
+    ),
+    BeforeValidator(
+        trajectory_validator(
+            length=4,
+            template="(movable, start, stop, num)",
+            expected_type=MovableStartStopNum,
+        )
+    ),
+]
+
+MovableListOfPositionsA = A[
+    MovableListOfPositions,
+    Field(
+        description="Trajectory defined by a movable and a list of positions to move to."
+    ),
+    BeforeValidator(
+        trajectory_validator(
+            length=2,
+            template="(movable, [point1, point2, ...])",
+            expected_type=MovableListOfPositions,
+        )
+    ),
+]
+
+MovableStartStopStepA = A[
+    MovableStartStopStep,
+    Field(
+        description="Trajectory defined by a movable, start position, stop position, "
+        "and step size."
+    ),
+    BeforeValidator(
+        trajectory_validator(
+            length=4,
+            template="(movable, start, stop, step)",
+            expected_type=MovableStartStopStep,
+        )
+    ),
+]