ophyd-async 0.5.2__tar.gz → 0.7.0__tar.gz

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.copier-answers.yml

@@ -1,9 +1,8 @@
 # Changes here will be overwritten by Copier
-_commit: 2.1.0
+_commit: 2.3.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: tom.cobb@diamond.ac.uk
 author_name: Tom Cobb
-component_owner: ''
 description: Asynchronous Bluesky hardware abstraction code, compatible with control
     systems like EPICS and Tango
 distribution_name: ophyd-async

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.devcontainer/devcontainer.json

@@ -52,4 +52,4 @@
     "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind",
     // After the container is created, install the python project in editable form
     "postCreateCommand": "pip install $([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e '.[dev]' && pre-commit install"
-}
+}

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.git-blame-ignore-revs

@@ -7,4 +7,4 @@
 # Use isort to sort imports
 881a35b43584103ca572b6f4e472dd8b6fd6ea87
 # Replace flake8 and mypy with ruff and pyrite
-e2f8317e7584e4de788c2b39e5b5edaa98c1bc9e
+e2f8317e7584e4de788c2b39e5b5edaa98c1bc9e

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.github/CONTRIBUTING.md

@@ -24,4 +24,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.1.0/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.3.0/how-to.html).

ophyd_async-0.7.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug Report
+about: The template to use for reporting bugs and usability issues
+title: " "
+labels: 'bug'
+assignees: ''
+
+---
+
+Describe the bug, including a clear and concise description of the expected behavior, the actual behavior and the context in which you encountered it (ideally include details of your environment).
+
+## Steps To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+
+## Acceptance Criteria
+- Specific criteria that will be used to judge if the issue is fixed

ophyd_async-0.7.0/.github/ISSUE_TEMPLATE/issue.md

@@ -0,0 +1,13 @@
+---
+name: Issue
+about: The standard template to use for feature requests, design discussions and tasks
+title: " "
+labels: ''
+assignees: ''
+
+---
+
+A brief description of the issue, including specific stakeholders and the business case where appropriate
+
+## Acceptance Criteria
+- Specific criteria that will be used to judge if the issue is fixed

ophyd_async-0.7.0/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,8 @@
+Fixes #ISSUE
+
+### Instructions to reviewer on how to test:
+1. Do thing x
+2. Confirm thing y happens
+
+### Checks for reviewer
+- [ ] Would the PR title make sense to a user on a set of release notes

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.github/pages/index.html

@@ -8,4 +8,4 @@
     <link rel="canonical" href="main/index.html">
 </head>
 
-</html>
+</html>

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.github/pages/make_switcher.py

@@ -1,30 +1,32 @@
+"""Make switcher.json to allow docs to switch between different versions."""
+
 import json
 import logging
 from argparse import ArgumentParser
 from pathlib import Path
 from subprocess import CalledProcessError, check_output
-from typing import List, Optional
 
 
-def report_output(stdout: bytes, label: str) -> List[str]:
+def report_output(stdout: bytes, label: str) -> list[str]:
+    """Print and return something received frm stdout."""
     ret = stdout.decode().strip().split("\n")
     print(f"{label}: {ret}")
     return ret
 
 
-def get_branch_contents(ref: str) -> List[str]:
+def get_branch_contents(ref: str) -> list[str]:
     """Get the list of directories in a branch."""
     stdout = check_output(["git", "ls-tree", "-d", "--name-only", ref])
     return report_output(stdout, "Branch contents")
 
 
-def get_sorted_tags_list() -> List[str]:
+def get_sorted_tags_list() -> list[str]:
     """Get a list of sorted tags in descending order from the repository."""
     stdout = check_output(["git", "tag", "-l", "--sort=-v:refname"])
     return report_output(stdout, "Tags list")
 
 
-def get_versions(ref: str, add: Optional[str]) -> List[str]:
+def get_versions(ref: str, add: str | None) -> list[str]:
     """Generate the file containing the list of all GitHub Pages builds."""
     # Get the directories (i.e. builds) from the GitHub Pages branch
     try:
@@ -41,7 +43,7 @@ def get_versions(ref: str, add: Optional[str]) -> List[str]:
     tags = get_sorted_tags_list()
 
     # Make the sorted versions list from main branches and tags
-    versions: List[str] = []
+    versions: list[str] = []
     for version in ["master", "main"] + tags:
         if version in builds:
             versions.append(version)
@@ -53,14 +55,12 @@ def get_versions(ref: str, add: Optional[str]) -> List[str]:
     return versions
 
 
-def write_json(path: Path, repository: str, versions: str):
+def write_json(path: Path, repository: str, versions: list[str]):
+    """Write the JSON switcher to path."""
     org, repo_name = repository.split("/")
-    pages_url = f"https://{org}.github.io"
-    if repo_name != f"{org}.github.io":
-        # Only add the repo name if it isn't the source for the org pages site
-        pages_url += f"/{repo_name}"
     struct = [
-        {"version": version, "url": f"{pages_url}/{version}/"} for version in versions
+        {"version": version, "url": f"https://{org}.github.io/{repo_name}/{version}/"}
+        for version in versions
     ]
     text = json.dumps(struct, indent=2)
     print(f"JSON switcher:\n{text}")
@@ -68,6 +68,7 @@ def write_json(path: Path, repository: str, versions: str):
 
 
 def main(args=None):
+    """Parse args and write switcher."""
     parser = ArgumentParser(
         description="Make a versions.json file from gh-pages directories"
     )

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.github/workflows/_docs.yml

@@ -51,4 +51,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: .github/pages
-          keep_files: true
+          keep_files: true

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.github/workflows/ci.yml

@@ -43,14 +43,14 @@ jobs:
     needs: check
     if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_dist.yml
-  
+
   pypi:
     if: github.ref_type == 'tag'
     needs: dist
     uses: ./.github/workflows/_pypi.yml
     permissions:
       id-token: write
-  
+
   release:
     if: github.ref_type == 'tag'
     needs: [dist, docs]

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.gitignore

@@ -55,6 +55,7 @@ cov.xml
 
 # Sphinx documentation
 docs/_build/
+docs/_api
 
 # PyBuilder
 target/

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/.pre-commit-config.yaml

@@ -5,6 +5,7 @@ repos:
       - id: check-added-large-files
       - id: check-yaml
       - id: check-merge-conflict
+      - id: end-of-file-fixer
 
   - repo: local
     hooks:

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ophyd-async
-Version: 0.5.2
+Version: 0.7.0
 Summary: Asynchronous Bluesky hardware abstraction code, compatible with control systems like EPICS and Tango
 Author-email: Tom Cobb <tom.cobb@diamond.ac.uk>
 License: BSD 3-Clause License
@@ -57,10 +57,13 @@ Provides-Extra: pva
 Requires-Dist: p4p; extra == "pva"
 Provides-Extra: sim
 Requires-Dist: h5py; extra == "sim"
+Provides-Extra: tango
+Requires-Dist: pytango>=10.0.0; extra == "tango"
 Provides-Extra: dev
 Requires-Dist: ophyd_async[pva]; extra == "dev"
 Requires-Dist: ophyd_async[sim]; extra == "dev"
 Requires-Dist: ophyd_async[ca]; extra == "dev"
+Requires-Dist: ophyd_async[tango]; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: flake8-isort; extra == "dev"
@@ -77,11 +80,13 @@ Requires-Dist: pipdeptree; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pydata-sphinx-theme>=0.12; extra == "dev"
 Requires-Dist: pyepics>=3.4.2; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
 Requires-Dist: pyside6==6.7.0; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-faulthandler; extra == "dev"
+Requires-Dist: pytest-forked; extra == "dev"
 Requires-Dist: pytest-rerunfailures; extra == "dev"
 Requires-Dist: pytest-timeout; extra == "dev"
 Requires-Dist: ruff; extra == "dev"

ophyd_async-0.7.0/docs/_api.rst

@@ -0,0 +1,16 @@
+:orphan:
+
+..
+   This page is not included in the TOC tree, but must exist so that the
+   autosummary pages are generated for ophyd_async and all its
+   subpackages
+
+API
+===
+
+.. autosummary::
+    :toctree: _api
+    :template: custom-module-template.rst
+    :recursive:
+
+    ophyd_async

ophyd_async-0.7.0/docs/_templates/custom-module-template.rst

@@ -0,0 +1,42 @@
+.. note::
+
+    Ophyd async is considered experimental until the v1.0 release and
+    may change API on minor release numbers before then
+
+{{ ('``' + fullname + '``') | underline }}
+
+{%- set filtered_members = [] %}
+{%- for item in members %}
+    {%- if item in functions + classes + exceptions + attributes %}
+        {% set _ = filtered_members.append(item) %}
+    {%- endif %}
+{%- endfor %}
+
+.. automodule:: {{ fullname }}
+    :members:
+
+    {% block modules %}
+    {% if modules %}
+    .. rubric:: Submodules
+
+    .. autosummary::
+        :toctree:
+        :template: custom-module-template.rst
+        :recursive:
+    {% for item in modules %}
+        {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block members %}
+    {% if filtered_members %}
+    .. rubric:: Members
+
+    .. autosummary::
+        :nosignatures:
+    {% for item in filtered_members %}
+        {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/conf.py

@@ -1,8 +1,9 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""Configuration file for the Sphinx documentation builder.
+
+This file only contains a selection of the most common options. For a full
+list see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 
 import os
 import sys
@@ -38,7 +39,10 @@ extensions = [
     "sphinxcontrib.autodoc_pydantic",
     # Use this for generating API docs
     "sphinx.ext.autodoc",
+    # Not sure if this is still used?
     "sphinx.ext.doctest",
+    # and making summary tables at the top of API docs
+    "sphinx.ext.autosummary",
     # This can parse google style docstrings
     "sphinx.ext.napoleon",
     # For linking to external sphinx documentation
@@ -51,7 +55,6 @@ extensions = [
     "sphinx_copybutton",
     # For the card element
     "sphinx_design",
-    "sphinx.ext.autosummary",
     "sphinx.ext.mathjax",
     "sphinx.ext.githubpages",
     "IPython.sphinxext.ipython_directive",
@@ -88,16 +91,21 @@ nitpick_ignore = [
     ("py:class", "typing_extensions.Literal"),
 ]
 
-# Both the class’ and the __init__ method’s docstring are concatenated and
-# inserted into the main body of the autoclass directive
-autoclass_content = "both"
-
 # Order the members by the order they appear in the source code
 autodoc_member_order = "bysource"
 
 # Don't inherit docstrings from baseclasses
 autodoc_inherit_docstrings = False
 
+# Add some more modules to the top level autosummary
+ophyd_async.__all__ += ["sim", "epics", "tango", "fastcs", "plan_stubs"]
+
+# Document only what is in __all__
+autosummary_ignore_module_all = False
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
 # Output graphviz directive produced images in a scalable format
 graphviz_output_format = "svg"
 
@@ -241,9 +249,11 @@ autodoc_docstring_signature = True
 # numpydoc config
 numpydoc_show_class_members = False
 
-# pydantic models
-autodoc_pydantic_model_show_json = True
+# Don't show config summary as it's not relevant
 autodoc_pydantic_model_show_config_summary = False
 
+# Show the fields in source order
+autodoc_pydantic_model_summary_list_order = "bysource"
+
 # Where to put Ipython savefigs
 ipython_savefig_dir = "../build/savefig"

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/examples/foo_detector.py

@@ -1,11 +1,10 @@
 import asyncio
-from typing import Optional
 
 from bluesky.protocols import HasHints, Hints
 
 from ophyd_async.core import (
     AsyncStatus,
-    DetectorControl,
+    DetectorController,
     DetectorTrigger,
     PathProvider,
     StandardDetector,
@@ -20,7 +19,7 @@ class FooDriver(adcore.ADBaseIO):
         super().__init__(prefix, name)
 
 
-class FooController(DetectorControl):
+class FooController(DetectorController):
     def __init__(self, driver: FooDriver) -> None:
         self._drv = driver
 
@@ -32,7 +31,7 @@ class FooController(DetectorControl):
         self,
         num: int,
         trigger: DetectorTrigger = DetectorTrigger.internal,
-        exposure: Optional[float] = None,
+        exposure: float | None = None,
     ) -> AsyncStatus:
         await asyncio.gather(
             self._drv.num_images.set(num),

ophyd_async-0.7.0/docs/examples/tango_demo.py

@@ -0,0 +1,54 @@
+import asyncio
+
+import bluesky.plan_stubs as bps
+import bluesky.plans as bp
+from bluesky import RunEngine
+
+from ophyd_async.tango.demo import (
+    DemoCounter,
+    DemoMover,
+    TangoDetector,
+)
+from tango.test_context import MultiDeviceTestContext
+
+content = (
+    {
+        "class": DemoMover,
+        "devices": [{"name": "demo/motor/1"}],
+    },
+    {
+        "class": DemoCounter,
+        "devices": [{"name": "demo/counter/1"}, {"name": "demo/counter/2"}],
+    },
+)
+
+tango_context = MultiDeviceTestContext(content)
+
+
+async def main():
+    with tango_context:
+        detector = TangoDetector(
+            trl="",
+            name="detector",
+            counters_kwargs={"prefix": "demo/counter/", "count": 2},
+            mover_kwargs={"trl": "demo/motor/1"},
+        )
+        await detector.connect()
+
+        RE = RunEngine()
+
+        RE(bps.read(detector))
+        RE(bps.mv(detector, 0))
+        RE(bp.count(list(detector.counters.values())))
+
+        set_status = detector.set(1.0)
+        await asyncio.sleep(0.1)
+        stop_status = detector.stop()
+        await set_status
+        await stop_status
+        assert all([set_status.done, stop_status.done])
+        assert all([set_status.success, stop_status.success])
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/explanations/decisions/0003-ophyd-async-migration.rst

@@ -47,4 +47,4 @@ Consequences
 ------------
 
 This will require changing the repository structure of Ophyd Async; see 
-the decision on repository structure :doc:`0004-repository-structure` for details.
+the decision on repository structure :doc:`0004-repository-structure` for details.

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/explanations/decisions/0005-respect-black-line-length.rst

@@ -26,4 +26,4 @@ Consequences
 ------------
 
 Linting tools for this repository are configured to accept black's line length of 88 characters.
-Any additional linting tools should respect this.
+Any additional linting tools should respect this.

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/explanations/decisions/0007-subpackage-structure.md

@@ -31,7 +31,7 @@ There will be a flat public namespace under core, with contents reimported from
 - `_signal.py` for `Signal`, `SignalBackend`, `observe_signal`, etc.
 - `_mock.py` for `MockSignalBackend`, `get_mock_put`, etc.
 - `_readable.py` for `StandardReadable`, `ConfigSignal`, `HintedSignal`, etc.
-- `_detector.py` for `StandardDetector`, `DetectorWriter`, `DetectorControl`, `TriggerInfo`, etc.
+- `_detector.py` for `StandardDetector`, `DetectorWriter`, `DetectorController`, `TriggerInfo`, etc.
 - `_flyer.py` for `StandardFlyer`, `FlyerControl`, etc.
 
 There are some renames that will be required, e.g. `HardwareTriggeredFlyable` -> `StandardFlyer`

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/explanations/design-goals.rst

@@ -54,4 +54,4 @@ To view and contribute to discussions on outstanding decisions, please see the d
 .. _malcolm: https://github.com/dls-controls/pymalcolm
 .. _scanspec: https://github.com/dls-controls/scanspec
 .. _design: https://github.com/bluesky/ophyd-async/issues?q=is%3Aissue+is%3Aopen+label%3Adesign
-.. _pmac: https://github.com/dls-controls/pmac
+.. _pmac: https://github.com/dls-controls/pmac

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/explanations/event-loop-choice.rst

@@ -48,5 +48,3 @@ they can either:
 
 * Run the :python:`DeviceCollector` first and pass the event-loop into the run-engine.
 * Initialize the run-engine first and run the :python:`DeviceCollector` using the bluesky event-loop.
-
-

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/how-to/contribute.md

@@ -1,2 +1,2 @@
 ```{include} ../../.github/CONTRIBUTING.md
-```
+```

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/how-to/make-a-standard-detector.rst

@@ -10,7 +10,7 @@ Make a StandardDetector
 The `StandardDetector` is a simple compound device, with 2 standard components: 
 
 - `DetectorWriter` to handle data persistence, i/o and pass information about data to the RunEngine (usually an instance of :py:class:`ADHDFWriter`)
-- `DetectorControl` with logic for arming and disarming the detector. This will be unique to the StandardDetector implementation.
+- `DetectorController` with logic for arming and disarming the detector. This will be unique to the StandardDetector implementation.
 
 Writing an AreaDetector StandardDetector
 ----------------------------------------
@@ -28,9 +28,9 @@ Enumeration fields should be named to prevent namespace collision, i.e. for a Si
    :language: python
    :pyobject: FooDriver
 
-Define a :py:class:`FooController` with handling for converting the standard pattern of :py:meth:`ophyd_async.core.DetectorControl.arm` and :py:meth:`ophyd_async.core.DetectorControl.disarm` to required state of :py:class:`FooDriver` e.g. setting a compatible "FooTriggerSource" for a given `DetectorTrigger`, or raising an exception if incompatible with the `DetectorTrigger`.
+Define a :py:class:`FooController` with handling for converting the standard pattern of :py:meth:`ophyd_async.core.DetectorController.arm` and :py:meth:`ophyd_async.core.DetectorController.disarm` to required state of :py:class:`FooDriver` e.g. setting a compatible "FooTriggerSource" for a given `DetectorTrigger`, or raising an exception if incompatible with the `DetectorTrigger`.
 
-The :py:meth:`ophyd_async.core.DetectorControl.get_deadtime` method is used when constructing sequence tables for hardware controlled scanning. Details on how to calculate the deadtime may be only available from technical manuals or otherwise complex. **If it requires fetching from signals, it is recommended to cache the value during the StandardDetector `prepare` method.**
+The :py:meth:`ophyd_async.core.DetectorController.get_deadtime` method is used when constructing sequence tables for hardware controlled scanning. Details on how to calculate the deadtime may be only available from technical manuals or otherwise complex. **If it requires fetching from signals, it is recommended to cache the value during the StandardDetector `prepare` method.**
 
 .. literalinclude:: ../examples/foo_detector.py
    :pyobject: FooController
@@ -47,8 +47,8 @@ If the :py:class:`FooDriver` signals that should be read as configuration, they
 Writing a non-AreaDetector StandardDetector
 -------------------------------------------
 
-A non-AreaDetector `StandardDetector` should implement `DetectorControl` and `DetectorWriter` directly.
-Here we construct a `DetectorControl` that co-ordinates signals on a PandA PositionCapture block - a child device "pcap" of the `StandardDetector` implementation, analogous to the :py:class:`FooDriver`.
+A non-AreaDetector `StandardDetector` should implement `DetectorController` and `DetectorWriter` directly.
+Here we construct a `DetectorController` that co-ordinates signals on a PandA PositionCapture block - a child device "pcap" of the `StandardDetector` implementation, analogous to the :py:class:`FooDriver`.
 
 .. literalinclude:: ../../src/ophyd_async/fastcs/panda/_control.py
    :pyobject: PandaPcapController

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/how-to/write-tests-for-devices.rst

@@ -1,6 +1,6 @@
 .. note::
 
-   Ophyd async is included on a provisional basis until the v1.0 release and 
+   Ophyd async is included on a provisional basis until the v1.0 release and
    may change API on minor release numbers before then
 
 Write Tests for Devices
@@ -35,7 +35,7 @@ Mock Utility Functions
 
 Mock signals behave as simply as possible, holding a sensible default value when initialized and retaining any value (in memory) to which they are set. This model breaks down in the case of read-only signals, which cannot be set because there is an expectation of some external device setting them in the real world. There is a utility function, ``set_mock_value``, to mock-set values for mock signals, including read-only ones.
 
-In addition this example also utilizes helper functions like ``assert_reading`` and ``assert_value`` to ensure the validity of device readings and values. For more information see: :doc:`API.core<../generated/ophyd_async.core>`
+In addition this example also utilizes helper functions like ``assert_reading`` and ``assert_value`` to ensure the validity of device readings and values. For more information see: :doc:`API.core<../_api/ophyd_async.core>`
 
 .. literalinclude:: ../../tests/epics/demo/test_demo.py
    :pyobject: test_sensor_reading_shows_value

{ophyd_async-0.5.2 → ophyd_async-0.7.0}/docs/reference.md

@@ -6,7 +6,7 @@ Technical reference material including APIs and release notes.
 :maxdepth: 1
 :glob:
 
-reference/*
+API <_api/ophyd_async>
 genindex
 Release Notes <https://github.com/bluesky/ophyd-async/releases>
 ```