mx-bluesky 1.5.9__tar.gz → 1.5.11__tar.gz

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2.5.0
+_commit: 4.3.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: dominic.oram@diamond.ac.uk
 author_name: Dominic Oram
@@ -9,10 +9,12 @@ component_type: library
 description: Bluesky tools for MX Beamlines at DLS
 distribution_name: mx-bluesky
 docker: true
+docker_debug: true
 docs_type: sphinx
 git_platform: github.com
 github_org: DiamondLightSource
 package_name: mx_bluesky
 pypi: true
 repo_name: mx-bluesky
+strict_typing: true
 type_checker: pyright

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.devcontainer/devcontainer.json

@@ -23,7 +23,8 @@
                 "redhat.vscode-yaml",
                 "ryanluker.vscode-coverage-gutters",
                 "charliermarsh.ruff",
-                "ms-azuretools.vscode-docker"
+                "ms-azuretools.vscode-docker",
+                "streetsidesoftware.code-spell-checker"
             ],
             "python.testing.pytestArgs": [
                 "--cov=mx_bluesky",
@@ -53,7 +54,6 @@
         }
     },
     "features": {
-        // Some default things like git config
         // add in eternal history and other bash features
         "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1": {}
     },

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/CONTRIBUTING.md

@@ -73,4 +73,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.5.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/4.3.0/how-to.html).

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ 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).
+Describe the bug, including a clear and concise description of the expected behaviour, 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:

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/actions/install_requirements/action.yml

@@ -15,7 +15,8 @@ runs:
       run: |
         PYTHON_VERSION="${{ inputs.python-version }}"
         if [ $PYTHON_VERSION == "dev" ]; then
-          PYTHON_VERSION=$(sed -n "s/ARG PYTHON_VERSION=//p" Dockerfile)
+          # python version from Dockerfile, removing potential pinned sha
+          PYTHON_VERSION=$(sed -Ene "s/ARG PYTHON_VERSION=([0-9\.]+).*/\1/p" Dockerfile)
         fi
         echo "PYTHON_VERSION=$PYTHON_VERSION" >> "$GITHUB_ENV"
       shell: bash

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/dependabot.yml

@@ -13,6 +13,8 @@ updates:
       actions:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"
 
   - package-ecosystem: "pip"
     directory: "/"
@@ -22,3 +24,5 @@ updates:
       dev-dependencies:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"

mx_bluesky-1.5.11/.github/release.yml

@@ -0,0 +1,44 @@
+# .github/release.yml
+
+changelog:
+  categories:
+    - title: Hyperion
+      labels:
+        - hyperion
+    - title: Jungfrau
+      labels:
+        - jungfrau
+    - title: Murko
+      labels:
+        - murko
+    - title: I03
+      labels:
+        - i03
+    - title: I04
+      labels:
+        - i04
+    - title: I04-1
+      labels:
+        - i04-1
+    - title: I23
+      labels:
+        - i23
+    - title: I24
+      labels:
+        - i24
+    - title: VMXm
+      labels:
+        - vmxm
+    - title: VMXi
+      labels:
+        - vmxi
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Dev Experience / Refactors
+      labels:
+        - dev experience
+        - refactor
+    - title: Other Changes
+      labels:
+        - "*"

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/workflows/_container.yml

@@ -1,5 +1,9 @@
 on:
   workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
 
 jobs:
   build:
@@ -75,7 +79,7 @@ jobs:
             type=raw,value=latest
 
       - name: Push cached Hyperion image to container registry
-        if: github.ref_type == 'tag'
+        if: inputs.publish && github.ref_type == 'tag'
         uses: docker/build-push-action@v6
         env:
           DOCKER_BUILD_RECORD_UPLOAD: false

mx_bluesky-1.5.11/.github/workflows/_debug_container.yml

@@ -0,0 +1,49 @@
+on:
+  workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Docker Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create tags for publishing debug image
+        id: debug-meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag,suffix=-debug
+            type=raw,value=latest-debug
+
+      - name: Build and publish debug image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          push: true
+          target: debug
+          tags: ${{ steps.debug-meta.outputs.tags }}

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/workflows/_docs.yml

@@ -1,6 +1,7 @@
 on:
   workflow_call:
 
+
 jobs:
   build:
     runs-on: ubuntu-latest

mx_bluesky-1.5.11/.github/workflows/_label.yml

@@ -0,0 +1,19 @@
+on:
+  workflow_call:
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: mheap/github-action-required-labels@v5
+        with:
+          labels: |
+            .*
+          use_regex: true
+          mode: minimum
+          count: 1
+          add_comment: true
+          message: "Please add a label to this PR. This helps with generating helpful release notes."

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.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@e7a8f85e1c67a31e6ed99a94b41bd0b71bbee6b8 # v2.0.9
+        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/workflows/_test.yml

@@ -56,7 +56,7 @@ jobs:
         run: tox -e tests -- -m "not dlstbx" --timeout=2 --cov=mx_bluesky --cov-report term --cov-report xml:cov.xml
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
           files: cov.xml

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.github/workflows/ci.yml

@@ -2,26 +2,32 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
+    tags:
+      - '*'
   pull_request:
 
 jobs:
-  check:
-    uses: ./.github/workflows/_check.yml
+
+  require-label:
+    if: github.event_name == 'pull_request'
+    uses: ./.github/workflows/_label.yml
 
   lint:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_tox.yml
     with:
       tox: pre-commit,type-checking
 
   test:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     strategy:
       matrix:
         runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
+        include:
+          # Include one that runs in the dev environment
+          - runs-on: "ubuntu-latest"
+            python-version: "dev"
       fail-fast: false
     uses: ./.github/workflows/_test.yml
     with:
@@ -31,9 +37,20 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   container:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
+    needs: test
+    if: always()
     uses: ./.github/workflows/_container.yml
+    with:
+      publish: ${{ needs.test.result == 'success' }}
+    permissions:
+      contents: read
+      packages: write
+
+  debug_container:
+    needs: [container, test]
+    uses: ./.github/workflows/_debug_container.yml
+    with:
+      publish: ${{ needs.test.result == 'success' }}
     permissions:
       contents: read
       packages: write
@@ -47,25 +64,22 @@ jobs:
       packages: write
 
   docs:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_docs.yml
 
+
   dist:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_dist.yml
   
   pypi:
+    needs: [dist, test]
     if: github.ref_type == 'tag'
-    needs: dist
     uses: ./.github/workflows/_pypi.yml
     permissions:
       id-token: write
   
   release:
+    needs: [dist, test, docs]
     if: github.ref_type == 'tag'
-    needs: [dist, docs]
     uses: ./.github/workflows/_release.yml
     permissions:
       contents: write

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=500"]
@@ -15,7 +15,7 @@ repos:
       - id: ruff
         name: lint with ruff
         language: system
-        entry: ruff check --force-exclude
+        entry: ruff check --force-exclude --fix
         types: [python]
         require_serial: true
 

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.vscode/extensions.json

@@ -5,6 +5,7 @@
         "tamasfe.even-better-toml",
         "redhat.vscode-yaml",
         "ryanluker.vscode-coverage-gutters",
-        "charliermarsh.Ruff"
+        "charliermarsh.Ruff",
+        "streetsidesoftware.code-spell-checker"
     ]
 }

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.vscode/launch.json

@@ -17,7 +17,7 @@
             "env": {
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
                 "PYTEST_RAISE": "1",
-                "PYTEST_ADDOPTS": "--no-cov"
+                "PYTEST_ADDOPTS": "--no-cov" // Needed for debugger - see https://code.visualstudio.com/docs/python/testing#_pytest-configuration-settings
             },
         }
     ]

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.vscode/mx-bluesky.code-workspace

@@ -18,6 +18,6 @@
         ],
         "python.analysis.autoImportCompletions": true,
         "terminal.integrated.gpuAcceleration": "off",
-        "esbonio.sphinx.confDir": ""
+        "esbonio.sphinx.confDir": "",
     }
 }

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/.vscode/settings.json

@@ -24,4 +24,35 @@
     },
     "terminal.integrated.gpuAcceleration": "off",
     "python.analysis.typeCheckingMode": "basic",
+    "cSpell.words": [
+        "aperturescatterguard",
+        "beamstop",
+        "blueapi",
+        "cryostream",
+        "deadtime",
+        "dodal",
+        "eiger",
+        "Expeye",
+        "fastcs",
+        "flyscan",
+        "gonio",
+        "gridscan",
+        "mrad",
+        "murko",
+        "ophyd",
+        "readback",
+        "scanspec",
+        "scatterguard",
+        "smargon",
+        "topup",
+        "Transfocator",
+        "undulator",
+        "xbpm",
+        "xspress",
+        "pmac",
+        "beamlines",
+        "caget",
+        "thawer",
+        "beamline",
+    ],
 }

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/Dockerfile

@@ -17,10 +17,33 @@ ENV PATH=/venv/bin:$PATH
 
 # The build stage installs the context into the venv
 FROM developer AS build
-COPY . /context
-WORKDIR /context
+# Requires buildkit 0.17.0
+COPY --chmod=o+wrX . /workspaces/mx-bluesky
+WORKDIR /workspaces/mx-bluesky
 RUN touch dev-requirements.txt && pip install -c dev-requirements.txt .
 
+
+FROM build AS debug
+
+
+# Set origin to use ssh
+RUN git remote set-url origin git@github.com:DiamondLightSource/mx-bluesky.git
+
+
+# For this pod to understand finding user information from LDAP
+RUN apt update
+RUN DEBIAN_FRONTEND=noninteractive apt install libnss-ldapd -y
+RUN sed -i 's/files/ldap files/g' /etc/nsswitch.conf
+
+# Make editable and debuggable
+RUN pip install debugpy
+RUN pip install -e .
+
+# Alternate entrypoint to allow devcontainer to attach
+ENTRYPOINT [ "/bin/bash", "-c", "--" ]
+CMD [ "while true; do sleep 30; done;" ]
+
+
 # The runtime stage copies the built venv into a slim runtime container
 FROM python:${PYTHON_VERSION}-slim AS runtime
 # Add apt-get system dependecies for runtime here if needed

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.9
+Version: 1.5.11
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -210,6 +210,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -237,11 +238,11 @@ Requires-Dist: deepdiff
 Requires-Dist: matplotlib
 Requires-Dist: cachetools
 Requires-Dist: daq-config-server>=v1.0.0-rc.2
-Requires-Dist: blueapi>=0.15.0
+Requires-Dist: blueapi>=1.6.3
 Requires-Dist: ophyd>=1.10.5
-Requires-Dist: ophyd-async>=0.10.0a2
-Requires-Dist: bluesky>=1.13.1
-Requires-Dist: dls-dodal==1.62.0
+Requires-Dist: ophyd-async>=0.13.5
+Requires-Dist: bluesky>=1.14.6
+Requires-Dist: dls-dodal==1.65.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"
@@ -255,7 +256,7 @@ Requires-Dist: pipdeptree; extra == "dev"
 Requires-Dist: plantweb; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pydata-sphinx-theme>=0.12; extra == "dev"
-Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pyright==1.1.406; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-random-order; extra == "dev"

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/docs/developer/serial-crystallography-on-i24/how-to/pmac-docs.rst

@@ -108,7 +108,7 @@ Theory for this computation
 
    Skew:
    Skew is the difference between the Sz1 and Sz2 after rotation is taken out.
-   This should be measured in situ prior to expriment, ie. measure by hand using
+   This should be measured in situ prior to experiment, ie. measure by hand using
    opposite and adjacent RBV after calibration of scale factors.
 
 The plan needs information stored in a few files:

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/pyproject.toml

@@ -9,6 +9,7 @@ classifiers = [
     "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 description = "Bluesky tools for MX Beamlines at DLS"
 dependencies = [
@@ -44,11 +45,11 @@ dependencies = [
     # as by default pip-install will not upgrade to a pre-release.
     #
     "daq-config-server>=v1.0.0-rc.2",
-    "blueapi >= 0.15.0",
+    "blueapi >= 1.6.3",
     "ophyd >= 1.10.5",
-    "ophyd-async >= 0.10.0a2",
-    "bluesky >= 1.13.1",
-    "dls-dodal == 1.62.0",
+    "ophyd-async >= 0.13.5",
+    "bluesky >= 1.14.6",
+    "dls-dodal == 1.65.0",
 ]
 
 
@@ -73,7 +74,8 @@ dev = [
     "plantweb",
     "pre-commit",
     "pydata-sphinx-theme>=0.12",
-    "pyright",
+    # Pin to previous pyright until https://github.com/microsoft/pyright/issues/11060 is fixed
+    "pyright==1.1.406", 
     "pytest-asyncio",
     "pytest-cov",
     "pytest-random-order",
@@ -109,7 +111,25 @@ name = "Dominic Oram"
 version_file = "src/mx_bluesky/_version.py"
 
 [tool.pyright]
-typeCheckingMode = "standard"
+typeCheckingMode = "strict"
+# Issue to remove some of these exceptions: https://github.com/DiamondLightSource/mx-bluesky/issues/1403
+reportMissingTypeStubs = false
+reportUnknownMemberType = false
+reportUnknownLambdaType = false
+reportUnknownParameterType = false
+reportUnknownArgumentType = false
+reportMissingParameterType = false
+reportMissingTypeArgument = false
+reportPrivateUsage = false
+reportUnknownVariableType = false
+reportUnusedVariable = false
+reportUnusedFunction = false
+reportArgumentType = false
+reportUnnecessaryComparison = false
+reportUnnecessaryCast = false
+reportMatchNotExhaustive = false
+reportUnnecessaryIsInstance = false
+
 
 [tool.pytest.ini_options]
 # Run pytest with all our checkers, and don't spam us with massive tracebacks on error
@@ -131,7 +151,7 @@ filterwarnings = [
     "error",
     # Ophyd status objects in tests
     "ignore:.*The 'done' and 'success' parameters will be removed.*:DeprecationWarning",
-    # Ignore nondeterministic closing of log, RE, etc. before test end
+    # Ignore nondeterministic closing of log, run_engine, etc. before test end
     "ignore:(.*)unclosed file(.*)name='(.*)dodal.log'(.*):ResourceWarning",
     "ignore:(.*)unclosed <socket(.*):ResourceWarning",
     "ignore:(.*)unclosed event loop(.*):ResourceWarning",
@@ -151,6 +171,7 @@ filterwarnings = [
 testpaths = "docs src tests/unit_tests"
 
 [tool.coverage.run]
+patch = ["subprocess"]
 data_file = "/tmp/mx_bluesky.coverage"
 
 [tool.coverage.paths]
@@ -211,6 +232,7 @@ lint.select = [
     "C4",     # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
     "E",      # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
     "F",      # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "N",      # pep8-naming - https://docs.astral.sh/ruff/rules/#pep8-naming-n
     "W",      # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
     "I",      # isort - https://docs.astral.sh/ruff/rules/#isort-i
     "UP",     # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/src/mx_bluesky/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.5.9'
-__version_tuple__ = version_tuple = (1, 5, 9)
+__version__ = version = '1.5.11'
+__version_tuple__ = version_tuple = (1, 5, 11)
 
-__commit_id__ = commit_id = 'g65ec4a831'
+__commit_id__ = commit_id = 'ge95f07917'

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/src/mx_bluesky/beamlines/aithre_lasershaping/goniometer_controls.py

@@ -53,9 +53,9 @@ def go_to_furthest_maximum(
 ) -> MsgGenerator:
     """Rotate to positive or negative maximum, whichever is further away"""
 
-    LIMIT_OF_TRAVEL = 3600
+    limit_of_travel = 3600
     current_value: float = yield from bps.rd(goniometer.omega.user_readback)
 
     yield from bps.mv(
-        goniometer.omega, -LIMIT_OF_TRAVEL if current_value > 0 else LIMIT_OF_TRAVEL
+        goniometer.omega, -limit_of_travel if current_value > 0 else limit_of_travel
     )

{mx_bluesky-1.5.9 → mx_bluesky-1.5.11}/src/mx_bluesky/beamlines/i02_1/parameters/gridscan.py

@@ -20,7 +20,7 @@ class SpecifiedTwoDGridScan(
         return self.grid_1_spec
 
     @property
-    def FGS_params(self) -> ZebraGridScanParamsTwoD:
+    def fast_gridscan_params(self) -> ZebraGridScanParamsTwoD:
         return ZebraGridScanParamsTwoD(
             x_steps=self.x_steps,
             y_steps=self.y_steps,