Merge pull request #181 from bluesky/int-product

Remove `Repeat` in favour of `Product`

Author: coretl

docs/conf.py

@@ -74,6 +74,7 @@
     ("py:class", "scanspec.core.C"),
     ("py:class", "scanspec.core.T"),
     ("py:class", "pydantic.config.ConfigDict"),
+    ("py:class", "numpy.float64"),
 ]
 
 # Both the class’ and the __init__ method’s docstring are concatenated and

docs/explanations/technical-terms.rst

@@ -13,7 +13,7 @@ documentation. Consider a 1D line scan:
 Axis
 ----
 
-A fixed reference that can be scanned, i.e. a motor or the `frame_` `DURATION`.
+A fixed reference that can be scanned, i.e. a motor.
 In the diagram above, the Axis is ``x``. `Spec.axes` will return the Axes that
 should be scanned for a given Spec.
 

docs/how-to/iterate-a-spec.rst

@@ -30,7 +30,7 @@ If you need to do a fly scan
 
 If you are conducting a fly scan then you need the frames that the motor moves
 through. You can get that from the lower and upper bounds of each point. If the
-scan is small enough to fit in memory on the machine you can use the `Fly(spec).frames()`
+scan is small enough to fit in memory on the machine you can use the `Spec.frames`
 method to produce a single `Dimension` object containing the entire scan:
 
 >>> from scanspec.specs import Fly

docs/how-to/serialize-a-spec.rst

@@ -11,7 +11,7 @@ Lets start with an example `Spec`.
 This Spec has a `repr` that shows its parameters it was instantiated with:
 
 >>> spec
-Product(outer=Line(axis='y', start=4.0, stop=5.0, num=6), inner=Line(axis='x', start=1.0, stop=2.0, num=3))
+Product(outer=Line(axis='y', start=4.0, stop=5.0, num=6), inner=Line(axis='x', start=1.0, stop=2.0, num=3), gap=True)
 
 
 How to Serialize
@@ -20,12 +20,12 @@ How to Serialize
 We can recursively serialize it to a dictionary:
 
 >>> spec.serialize()
-{'outer': {'axis': 'y', 'start': 4.0, 'stop': 5.0, 'num': 6, 'type': 'Line'}, 'inner': {'axis': 'x', 'start': 1.0, 'stop': 2.0, 'num': 3, 'type': 'Line'}, 'type': 'Product'}
+{'outer': {'axis': 'y', 'start': 4.0, 'stop': 5.0, 'num': 6, 'type': 'Line'}, 'inner': {'axis': 'x', 'start': 1.0, 'stop': 2.0, 'num': 3, 'type': 'Line'}, 'gap': True, 'type': 'Product'}
 
 How to Deserialize
 ------------------
 
 We can turn this back into a spec using `Spec.deserialize`:
 
 >>> Spec.deserialize({'outer': {'axis': 'y', 'start': 4.0, 'stop': 5.0, 'num': 6, 'type': 'Line'}, 'inner': {'axis': 'x', 'start': 1.0, 'stop': 2.0, 'num': 3, 'type': 'Line'}, 'type': 'Product'})
-Product(outer=Line(axis='y', start=4.0, stop=5.0, num=6), inner=Line(axis='x', start=1.0, stop=2.0, num=3))
+Product(outer=Line(axis='y', start=4.0, stop=5.0, num=6), inner=Line(axis='x', start=1.0, stop=2.0, num=3), gap=True)

pyproject.toml

@@ -105,7 +105,7 @@ commands =
     pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
     type-checking: pyright src tests {posargs}
     tests: pytest --cov=scanspec --cov-report term --cov-report xml:cov.xml {posargs}
-    docs: sphinx-{posargs:build -E --keep-going} -T docs build/html
+    docs: sphinx-{posargs:build -EW --keep-going} -T docs build/html
 """
 
 [tool.ruff]

schema.json

@@ -268,7 +268,9 @@ def _make_schema(
     return {member.__name__: handler(member) for member in members}
 
 
-def if_instance_do(x: C, cls: type[C], func: Callable[[C], T]) -> T:
+def if_instance_do(
+    x: C, cls: type[C] | tuple[type[C], Any], func: Callable[[C], T]
+) -> T:
     """If x is of type cls then return func(x), otherwise return NotImplemented.
 
     Used as a helper when implementing operator overloading.
@@ -311,7 +313,7 @@ def __len__(self) -> int:
     def axes(self) -> list[Axis]:
         """The axes which will move during the scan.
 
-        These will be present in `midpoints`, `lower` and `upper`.
+        These will be present in ``midpoints``, ``lower`` and ``upper``.
         """
         return list(self.midpoints.keys())
 

src/scanspec/core.py

@@ -396,5 +396,6 @@ def scanspec_schema_text() -> str:
             openapi_version=app.openapi_version,
             description=app.description,
             routes=app.routes,
-        )
+        ),
+        indent=4,
     )