dls-dodal 1.33.0__tar.gz → 1.35.0__tar.gz

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.copier-answers.yml

@@ -1,9 +1,11 @@
 # Changes here will be overwritten by Copier
-_commit: 2.2.0
+_commit: 2.5.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: dominic.oram@diamond.ac.uk
 author_name: Dominic Oram
+component_lifecycle: production
 component_owner: group:data-acquisition
+component_type: library
 description: Ophyd devices and other utils that could be used across DLS beamlines
 distribution_name: dls-dodal
 docker: false

{dls_dodal-1.33.0 → dls_dodal-1.35.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.2.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.5.0/how-to.html).

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.github/pages/make_switcher.py

@@ -1,3 +1,5 @@
+"""Make switcher.json to allow docs to switch between different versions."""
+
 import json
 import logging
 from argparse import ArgumentParser
@@ -6,6 +8,7 @@ from subprocess import CalledProcessError, check_output
 
 
 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
@@ -52,14 +55,12 @@ def get_versions(ref: str, add: str | None) -> 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}")
@@ -67,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"
     )

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.github/workflows/_pypi.yml

@@ -15,3 +15,5 @@ jobs:
 
       - name: Publish to PyPI using trusted publishing
         uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: false

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8
+        uses: softprops/action-gh-release@e7a8f85e1c67a31e6ed99a94b41bd0b71bbee6b8 # v2.0.9
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
-        python-version: ["3.10", "3.11"] # add 3.12 when p4p #145 is fixed
+        python-version: ["3.10", "3.11", "3.12"]
         include:
           # Include one that runs in the dev environment
           - runs-on: "ubuntu-latest"

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/.gitignore

@@ -57,6 +57,7 @@ tmp/
 # Sphinx documentation
 docs/_build/
 docs/reference/generated/
+docs/_api
 
 # PyBuilder
 target/

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/Dockerfile

@@ -1,7 +1,7 @@
 # The devcontainer should use the developer target and run as root with podman
 # or docker with user namespaces.
 ARG PYTHON_VERSION=3.11
-FROM python:${PYTHON_VERSION} as developer
+FROM python:${PYTHON_VERSION} AS developer
 
 # Add any system dependencies for the developer/build environment here
 RUN apt-get update && apt-get install -y --no-install-recommends \

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dls-dodal
-Version: 1.33.0
+Version: 1.35.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -216,7 +216,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click
 Requires-Dist: ophyd
-Requires-Dist: ophyd-async<0.7,>=0.6
+Requires-Dist: ophyd-async==0.8.0a4
 Requires-Dist: bluesky
 Requires-Dist: pyepics
 Requires-Dist: dataclasses-json
@@ -263,7 +263,7 @@ Requires-Dist: types-aiofiles; extra == "dev"
 [![CI](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/DiamondLightSource/dodal/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/dodal)
 [![PyPI](https://img.shields.io/pypi/v/dls-dodal.svg)](https://pypi.org/project/dls-dodal)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # dodal
 

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/README.md

@@ -1,7 +1,7 @@
 [![CI](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/DiamondLightSource/dodal/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/dodal)
 [![PyPI](https://img.shields.io/pypi/v/dls-dodal.svg)](https://pypi.org/project/dls-dodal)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # dodal
 

{dls_dodal-1.33.0/tests → dls_dodal-1.35.0}/conftest.py

@@ -7,6 +7,7 @@ import time
 from collections.abc import Mapping
 from os import environ, getenv
 from pathlib import Path
+from typing import Any
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -17,8 +18,7 @@ from ophyd_async.core import (
     PathProvider,
 )
 
-from dodal.beamlines import i03
-from dodal.common.beamlines import beamline_utils
+from dodal.common.beamlines import beamline_parameters, beamline_utils
 from dodal.common.visit import (
     DirectoryServiceClient,
     LocalDirectoryServiceClient,
@@ -32,30 +32,62 @@ mock_paths = [
     ("DAQ_CONFIGURATION_PATH", MOCK_DAQ_CONFIG_PATH),
     ("ZOOM_PARAMS_FILE", "tests/devices/unit_tests/test_jCameraManZoomLevels.xml"),
     ("DISPLAY_CONFIG", "tests/devices/unit_tests/test_display.configuration"),
+    ("LOOK_UPTABLE_DIR", "tests/devices/i10/lookupTables/"),
 ]
 mock_attributes_table = {
     "i03": mock_paths,
+    "i10": mock_paths,
     "s03": mock_paths,
     "i04": mock_paths,
     "s04": mock_paths,
+    "i24": mock_paths,
 }
 
+BANNED_PATHS = [Path("/dls"), Path("/dls_sw")]
+environ["DODAL_TEST_MODE"] = "true"
+
+
+@pytest.fixture(autouse=True)
+def patch_open_to_prevent_dls_reads_in_tests():
+    unpatched_open = open
+
+    def patched_open(*args, **kwargs):
+        requested_path = Path(args[0])
+        if requested_path.is_absolute():
+            for p in BANNED_PATHS:
+                assert not requested_path.is_relative_to(
+                    p
+                ), f"Attempt to open {requested_path} from inside a unit test"
+        return unpatched_open(*args, **kwargs)
+
+    with patch("builtins.open", side_effect=patched_open):
+        yield []
+
+
 # Prevent pytest from catching exceptions when debugging in vscode so that break on
 # exception works correctly (see: https://github.com/pytest-dev/pytest/issues/7409)
 if os.getenv("PYTEST_RAISE", "0") == "1":
 
     @pytest.hookimpl(tryfirst=True)
-    def pytest_exception_interact(call):
-        raise call.excinfo.value
+    def pytest_exception_interact(call: pytest.CallInfo[Any]):
+        if call.excinfo is not None:
+            raise call.excinfo.value
+        else:
+            raise RuntimeError(
+                f"{call} has no exception data, an unknown error has occurred"
+            )
 
     @pytest.hookimpl(tryfirst=True)
-    def pytest_internalerror(excinfo):
+    def pytest_internalerror(excinfo: pytest.ExceptionInfo[Any]):
         raise excinfo.value
 
 
 def mock_beamline_module_filepaths(bl_name, bl_module):
     if mock_attributes := mock_attributes_table.get(bl_name):
         [bl_module.__setattr__(attr[0], attr[1]) for attr in mock_attributes]
+        beamline_parameters.BEAMLINE_PARAMETER_PATHS[bl_name] = (
+            "tests/test_data/i04_beamlineParameters"
+        )
 
 
 @pytest.fixture(scope="function")
@@ -65,12 +97,12 @@ def module_and_devices_for_beamline(request):
         bl_mod = importlib.import_module("dodal.beamlines." + beamline)
         importlib.reload(bl_mod)
         mock_beamline_module_filepaths(beamline, bl_mod)
-        devices, _ = make_all_devices(
+        devices, exceptions = make_all_devices(
             bl_mod,
             include_skipped=True,
             fake_with_ophyd_sim=True,
         )
-        yield (bl_mod, devices)
+        yield (bl_mod, devices, exceptions)
         beamline_utils.clear_devices()
         del bl_mod
 
@@ -92,14 +124,6 @@ def pytest_runtest_teardown():
         sys.modules["dodal.beamlines.beamline_utils"].clear_devices()
 
 
-@pytest.fixture
-def vfm_mirror_voltages(RE: RunEngine):
-    voltages = i03.vfm_mirror_voltages(fake_with_ophyd_sim=True)
-    voltages.voltage_lookup_table_path = "tests/test_data/test_mirror_focus.json"
-    yield voltages
-    beamline_utils.clear_devices()
-
-
 s03_epics_server_port = getenv("S03_EPICS_CA_SERVER_PORT")
 s03_epics_repeater_port = getenv("S03_EPICS_CA_REPEATER_PORT")
 
@@ -132,19 +156,6 @@ async def static_path_provider(
     return svpp
 
 
-@pytest.fixture
-async def RE():
-    RE = RunEngine()
-    # make sure the event loop is thoroughly up and running before we try to create
-    # any ophyd_async devices which might need it
-    timeout = time.monotonic() + 1
-    while not RE.loop.is_running():
-        await asyncio.sleep(0)
-        if time.monotonic() > timeout:
-            raise TimeoutError("This really shouldn't happen but just in case...")
-    yield RE
-
-
 @pytest.fixture
 def run_engine_documents(RE: RunEngine) -> Mapping[str, list[dict]]:
     docs: dict[str, list[dict]] = {}
@@ -162,3 +173,16 @@ def failed_status(failure: Exception) -> Status:
     status = Status()
     status.set_exception(failure)
     return status
+
+
+@pytest.fixture
+async def RE():
+    RE = RunEngine()
+    # make sure the event loop is thoroughly up and running before we try to create
+    # any ophyd_async devices which might need it
+    timeout = time.monotonic() + 1
+    while not RE.loop.is_running():
+        await asyncio.sleep(0)
+        if time.monotonic() > timeout:
+            raise TimeoutError("This really shouldn't happen but just in case...")
+    yield RE

dls_dodal-1.35.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 dodal and all its
+   subpackages
+
+API
+===
+
+.. autosummary::
+    :toctree: _api
+    :template: custom-module-template.rst
+    :recursive:
+
+    dodal

dls_dodal-1.35.0/docs/_templates/custom-module-template.rst

@@ -0,0 +1,37 @@
+{{ ('``' + 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 %}

{dls_dodal-1.33.0 → dls_dodal-1.35.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 sys
 from inspect import isclass
@@ -33,6 +34,7 @@ else:
 extensions = [
     # Use this for generating API docs
     "sphinx.ext.autodoc",
+    # and making summary tables at the top of API docs
     "sphinx.ext.autosummary",
     # This can parse google style docstrings
     "sphinx.ext.napoleon",
@@ -91,6 +93,12 @@ autodoc_preserve_defaults = True
 autosummary_generate = True
 autosummary_imported_members = False
 
+# 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"
 

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/docs/how-to/create-beamline.rst

@@ -11,7 +11,7 @@ Each beamline should have its own file in the ``doodal.beamlines`` folder, in wh
 beamline are instantiated. The file should be named after the colloquial name for the beamline. For example:
 
 * ``i03.py``
-* ``i04_1.py``
+* ``i20_1.py``
 * ``vmxi.py``
 
 Beamline modules (in ``dodal.beamlines``) are code-as-configuration. They define the set of devices and common device

dls_dodal-1.35.0/docs/how-to/write-tests.md

@@ -0,0 +1,8 @@
+# Writing Tests in This Python Project
+
+Testing is essential to maintain the integrity and reliability of the codebase. Follow the guidelines below to write tests for this project effectively.
+
+## Test Organization
+
+- **Unit Tests**: Place unit tests for individual components in the `tests` directory, but take care to mirror the file structure of the `src` folder with the corresponding code files. Use the `test_*.py` naming convention for test files.
+- **System Tests**: Tests that interact with DLS infrastructure, network, and filesystem should be placed in the top-level `systems_test` folder. This separation ensures that these tests are easily identifiable and can be run independently from unit tests.

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/docs/reference/standards.rst

@@ -29,7 +29,7 @@ Supported Python Versions
 As a standard for the python versions to support, we should be matching the deprecation policy at 
 https://numpy.org/neps/nep-0029-deprecation_policy.html.
 
-Currently supported versions are: 3.10, 3.11.
+Currently supported versions are: 3.10, 3.11, 3.12. (As of the last edit of this document.)
 
 .. _documentation_standards:
 

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/docs/reference.md

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

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/pyproject.toml

@@ -15,7 +15,7 @@ description = "Ophyd devices and other utils that could be used across DLS beaml
 dependencies = [
     "click",
     "ophyd",
-    "ophyd-async>=0.6,<0.7",
+    "ophyd-async==0.8.0a4",
     "bluesky",
     "pyepics",
     "dataclasses-json",
@@ -91,7 +91,8 @@ dodal = ["*.txt"]
 version_file = "src/dodal/_version.py"
 
 [tool.pyright]
-reportMissingImports = false # Ignore missing stubs in imported modules
+typeCheckingMode = "standard"
+reportMissingImports = false  # Ignore missing stubs in imported modules
 
 [tool.pytest.ini_options]
 # Run pytest with all our checkers, and don't spam us with massive tracebacks on error
@@ -115,7 +116,7 @@ filterwarnings = [
     "ignore::DeprecationWarning:wheel",
 ]
 # Doctest python code in docs, python code in src docstrings, test functions in tests
-testpaths = "docs src tests"
+testpaths = "docs src tests system_tests"
 
 [tool.coverage.report]
 exclude_also = [
@@ -176,3 +177,4 @@ lint.select = [
 # See https://github.com/DiamondLightSource/python-copier-template/issues/154
 # Remove this line to forbid private member access in tests
 "tests/**/*" = ["SLF001"]
+"system_tests/**/*" = ["SLF001"]

{dls_dodal-1.33.0 → dls_dodal-1.35.0}/src/dls_dodal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dls-dodal
-Version: 1.33.0
+Version: 1.35.0
 Summary: Ophyd devices and other utils that could be used across DLS beamlines
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -216,7 +216,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click
 Requires-Dist: ophyd
-Requires-Dist: ophyd-async<0.7,>=0.6
+Requires-Dist: ophyd-async==0.8.0a4
 Requires-Dist: bluesky
 Requires-Dist: pyepics
 Requires-Dist: dataclasses-json
@@ -263,7 +263,7 @@ Requires-Dist: types-aiofiles; extra == "dev"
 [![CI](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/dodal/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/DiamondLightSource/dodal/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/dodal)
 [![PyPI](https://img.shields.io/pypi/v/dls-dodal.svg)](https://pypi.org/project/dls-dodal)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # dodal