Add Long name to OphydObj

.github/workflows/code.yml

@@ -13,7 +13,7 @@ jobs:
     if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Lint
         run: pip install --user .[dev] && tox -e pre-commit
@@ -22,7 +22,7 @@ jobs:
     if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # So we get history for version numbers
 
@@ -32,7 +32,7 @@ jobs:
         run: SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) pipx run build --sdist --wheel
 
       - name: Upload Wheel and Sdist as artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: dist
           path: dist
@@ -46,30 +46,39 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        prerelease: [false]
+        # Add one more job that runs on prereleases
+        include:
+          - python-version: "3.12"
+            prerelease: true
     runs-on: ubuntu-latest
     env:
       TEST_CL: pyepics
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # So we get history for version number
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: pip install --upgrade setuptools && pip install -e .[dev] && pipdeptree
 
+      - name: Install prereleases of certain dependencies.
+        run: pip install --upgrade --pre bluesky event-model
+        if: ${{ matrix.prerelease }}
+
       - name: Start IOCs in containers.
         run: |
           source ${GITHUB_WORKSPACE}/scripts/epics_exports.sh
           source ${GITHUB_WORKSPACE}/scripts/epics_docker.sh
 
       - name: Test with pytest
-        run: pytest -k "${TEST_CL}"
+        run: pytest -k "${TEST_CL}" -m "not motorsim" --strict-markers
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
@@ -80,10 +89,15 @@ jobs:
   release:
     needs: [build]
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
     # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
 
       - name: Github Release
         # We pin to the SHA, not the tag, for security reasons.
@@ -96,9 +110,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish to PyPI
-        env:
-          TWINE_USERNAME: __token__
-          # The PYPI_PASSWORD must be a pypi token with the "pypi-" prefix with sufficient permissions to upload this package
-          # https://pypi.org/help/#apitoken
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: pipx run twine upload dist/*
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./dist/

.github/workflows/docs.yml

@@ -16,15 +16,15 @@ jobs:
       TOX_DIRECT: 1
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # So we get history for version numbers
 
       - name: Install Packages
         run: sudo apt-get install graphviz
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -35,7 +35,7 @@ jobs:
         run: tox -e docs
 
       - name: Upload built docs as artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: docs
           path: build
@@ -44,7 +44,7 @@ jobs:
         run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV
 
       - name: Deploy documentation to blueskyproject.io.
-        if: github.repository_owner == 'bluesky' && github.ref_name == 'master'
+        if: github.repository_owner == 'bluesky' && github.ref_name == 'main'
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
         uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501 # v3.7.3

.gitignore

@@ -22,6 +22,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.eggs/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-yaml
@@ -10,14 +10,14 @@ repos:
     hooks:
       - id: black
         name: Run black
-        stages: [commit]
+        stages: [pre-commit]
         language: system
         entry: black --check --diff
         types: [python]
 
       - id: flake8
         name: Run flake8
-        stages: [commit]
+        stages: [pre-commit]
         language: system
         entry: flake8
         types: [python]

docs/user/reference/release_notes.rst

@@ -2,6 +2,36 @@
  Release History
 =================
 
+1.10.1 (2024-12-04)
+===================
+
+Fixes
+-----
+
+* Fix CI to release the package on PyPI
+
+
+1.10.0 (2024-12-03)
+===================
+
+Added
+-----
+
+* ``count`` parameter to Signal.get (same as pv.get)
+* ``.locate()`` method to EpicsMotor, returning setpoint and readback
+* ``dtype`` and ``shape`` keywords can be specified in Signal constructor to avoid type inference
+* ``describe()`` returns ``dtype_numpy``, if available
+
+Fixes
+-----
+
+* Allow write path template on FileStoreBase to include ``.``
+* Enforce FileStoreBase root path to be absolute
+* Fixed fraction in ADTriggerStatus to match docs
+* Status objects do not create threads when timeout is None
+* Enforce configured Component.trigger_value is used for acquisition signal
+
+
 1.9.0 (2023-09-15)
 ==================
 

ophyd/_dummy_shim.py

@@ -40,19 +40,27 @@ def setup(logger):
 
 
 def caget(*args, **kwargs):
-    raise NotImplementedError
+    raise NotImplementedError(
+        "Dummy control layer in-use. Try installing either pyepics or caproto."
+    )
 
 
 def caput(*args, **kwargs):
-    raise NotImplementedError
+    raise NotImplementedError(
+        "Dummy control layer in-use. Try installing either pyepics or caproto."
+    )
 
 
 def get_pv(*args, **kwargs):
-    raise NotImplementedError
+    raise NotImplementedError(
+        "Dummy control layer in-use. Try installing either pyepics or caproto."
+    )
 
 
 def release_pvs(*args, **kwargs):
-    raise NotImplementedError
+    raise NotImplementedError(
+        "Dummy control layer in-use. Try installing either pyepics or caproto."
+    )
 
 
 def get_dispatcher():

ophyd/_pyepics_shim.py

@@ -7,6 +7,10 @@
 
 from ._dispatch import EventDispatcher, _CallbackThread, wrap_callback
 
+# suspect attempt to monkey-patch printf is causing segfaults
+if hasattr(ca, "WITH_CA_MESSAGES"):
+    ca.WITH_CA_MESSAGES = True
+
 _min_pyepics = "3.4.2"
 
 if parse(epics.__version__) < parse(_min_pyepics):

ophyd/areadetector/base.py

@@ -24,7 +24,13 @@
 
 from ..device import Component, Device, DynamicDeviceComponent
 from ..ophydobj import Kind, OphydObject
-from ..signal import ArrayAttributeSignal, DerivedSignal, EpicsSignal, EpicsSignalRO
+from ..signal import (
+    UNSET_VALUE,
+    ArrayAttributeSignal,
+    DerivedSignal,
+    EpicsSignal,
+    EpicsSignalRO,
+)
 from . import docs
 
 
@@ -92,6 +98,9 @@ def __init__(
         if isinstance(num_dimensions, str):
             num_dimensions = getattr(parent, num_dimensions)
         self._num_dimensions = num_dimensions
+        kwargs.setdefault("value", UNSET_VALUE)
+        kwargs.setdefault("dtype", None)
+        kwargs.setdefault("shape", shape)
         super().__init__(derived_from=derived_from, parent=parent, **kwargs)
 
     @property

ophyd/device.py

@@ -234,7 +234,7 @@ def maybe_add_prefix(self, instance, kw, suffix):
             suffix from.
 
         kw : str
-            The key of associated with the suffix.  If this key is
+            The key of associated with the suffix.  If this key is in
             self.add_prefix than prepend the prefix to the suffix and
             return, else just return the suffix.
 
@@ -253,10 +253,16 @@ def create_component(self, instance):
         "Instantiate the object described by this Component for a Device"
         kwargs = self.kwargs.copy()
         kwargs.update(
-            name=f"{instance.name}_{self.attr}",
+            name=f"{instance.name}{instance._child_name_separator}{self.attr}",
             kind=instance._component_kinds[self.attr],
             attr_name=self.attr,
         )
+        if issubclass(self.cls, Device):
+            kwargs.setdefault("child_name_separator", instance._child_name_separator)
+
+        _long_name = kwargs.get("long_name", self.attr)
+        _parent_long_name = getattr(instance, "long_name", instance.name)
+        kwargs["long_name"] = f"{_parent_long_name} {_long_name}"
 
         for kw, val in list(kwargs.items()):
             kwargs[kw] = self.maybe_add_prefix(instance, kw, val)
@@ -839,10 +845,11 @@ def __init__(
         read_attrs=None,
         configuration_attrs=None,
         parent=None,
+        child_name_separator="_",
         **kwargs,
     ):
         self._destroyed = False
-
+        self._child_name_separator = child_name_separator
         # Store EpicsSignal objects (only created once they are accessed)
         self._signals = {}
 
@@ -1457,7 +1464,8 @@ def done_acquisition(**ignored_kwargs):
             # has finished
             self._done_acquiring()
 
-        acq_signal.put(1, wait=False, callback=done_acquisition)
+        trigger_value = self._sig_attrs[acq_signal.attr_name].trigger_value
+        acq_signal.put(trigger_value, wait=False, callback=done_acquisition)
         return status
 
     def stop(self, *, success=False):
@@ -1785,7 +1793,6 @@ def wrapped(self, *args, **kwargs):
 def _wait_for_connection_context(value, doc):
     @contextlib.contextmanager
     def wrapped(dev):
-
         orig = dev.lazy_wait_for_connection
         dev.lazy_wait_for_connection = value
         try:

ophyd/ophydobj.py

@@ -36,7 +36,6 @@ class IFBase(IntFlag, boundary=KEEP):
         ...
 
 except ImportError:
-
     IFBase = IntFlag
 
 
@@ -148,7 +147,16 @@ class OphydObject:
     __any_instantiated = False
     subscriptions: ClassVar[FrozenSet[str]] = frozenset()
 
-    def __init__(self, *, name=None, attr_name="", parent=None, labels=None, kind=None):
+    def __init__(
+        self,
+        *,
+        name=None,
+        attr_name="",
+        parent=None,
+        labels=None,
+        kind=None,
+        long_name=None,
+    ):
         if labels is None:
             labels = set()
         self._ophyd_labels_ = set(labels)
@@ -166,7 +174,7 @@ def __init__(self, *, name=None, attr_name="", parent=None, labels=None, kind=No
             raise ValueError("name must be a string.")
         self._name = name
         self._parent = parent
-
+        self._long_name = long_name
         # dictionary of wrapped callbacks
         self._callbacks = {k: {} for k in self.subscriptions}
         # this is to maintain api on clear_sub
@@ -331,6 +339,18 @@ def name(self):
     def name(self, name):
         self._name = name
 
+    @property
+    def long_name(self):
+        """name of the device"""
+        if self._long_name is not None:
+            return self._long_name
+        else:
+            return self._name
+
+    @long_name.setter
+    def long_name(self, name):
+        self._long_name = name
+
     @property
     def attr_name(self):
         return self._attr_name

ophyd/quadem.py

@@ -98,7 +98,7 @@ class QuadEM(SingleTrigger, DetectorBase):
     position_offset_calc_y = Cpt(EpicsSignal, "ComputePosOffsetY")
 
     position_scale_x = Cpt(EpicsSignal, "PositionScaleX")
-    position_scale_Y = Cpt(EpicsSignal, "PositionScaleY")
+    position_scale_y = Cpt(EpicsSignal, "PositionScaleY")
 
     image = Cpt(ImagePlugin, "image1:")
     current1 = Cpt(StatsPlugin, "Current1:")