Merge pull request #930 from BCDA-APS/909-ruff-linting

Switch linting to use ruff

.github/workflows/code.yml

@@ -26,20 +26,15 @@ jobs:
         with:
           python-version: "3.11"
 
-      - name: Install Dependencies
+      - name: Install package
         run: |
           set -vxeuo pipefail
           python -m pip install --upgrade pip
-          pip install flake8
-
-      - name: Run flake8
-        run: |
-          flake8
-
-      - name: Run black
-        uses: rickstaa/action-black@v1
+  
+      - name: Run ruff
+        uses: davidslusser/[email protected]
         with:
-          black_args: ". --check"
+          python_version: "3.11"
 
   install-catalogs:
     name: Install & cache databroker catalogs
@@ -91,7 +86,7 @@ jobs:
           mv /tmp/*_test ~/databroker_catalogs/
 
       - name: Archive catalog artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: databroker_catalogs
           path: ~/databroker_catalogs
@@ -181,7 +176,7 @@ jobs:
           python -c "${CMD}"
 
       - name: Download catalog artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: databroker_catalogs
           path: ~/databroker_catalogs

.ruff.toml

@@ -0,0 +1,81 @@
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 115
+indent-width = 4
+
+# Assume Python 3.8
+target-version = "py38"
+
+[lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+select = ["E4", "E7", "E9", "F"]
+ignore = ["E402", "E741", "F405"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[lint.per-file-ignores]
+"__init__.py" = ["F401", "F403"]
+"**/{tests,docs,tools}/*" = ["E402"]
+
+[format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"

CHANGES.rst

@@ -28,14 +28,19 @@ describe future plans.
 1.6.19
 ******
 
-release expected by 2024-03-31
+release expected by 2024-04-02
 
 Fixes
 -----
 
 * lineup2() should work with low intensity peaks.
 * lineup2() would raise ZeroDivideError in some cases.
 
+Maintenance
+-----------
+
+* Code format conforms to 'ruff'.
+
 1.6.18
 ******
 

apstools/devices/tests/test_SingleTrigger_V34.py

@@ -3,7 +3,6 @@
 import bluesky
 import bluesky.plans as bp
 import databroker
-from ophyd import EpicsSignalWithRBV
 from ophyd import SingleTrigger
 from ophyd.areadetector import ADComponent
 from ophyd.areadetector import DetectorBase

apstools/devices/tests/test_aps_data_management.py

@@ -21,7 +21,8 @@ def test_object(wf_name):
     assert wf.owner.get() == DM_STATION_NAME
 
     try:
-        import dm
+        # Force a test that dm package can be imported.
+        import dm  # noqa
 
         assert wf.api is not None
 

apstools/devices/tests/test_mc_tc32.py

@@ -1,5 +1,3 @@
-import pytest
-
 from ..measComp_tc32_support import BI_CHANNEL_LIST
 from ..measComp_tc32_support import BO_CHANNEL_LIST
 from ..measComp_tc32_support import TC_CHANNEL_LIST

apstools/plans/tests/test_issue606.py

@@ -12,7 +12,6 @@
 
 import dataclasses
 
-import bluesky.plan_stubs as bps
 import bluesky.preprocessors as bpp
 import databroker
 from bluesky import RunEngine

apstools/plans/tests/test_run_blocking_function_plan.py

@@ -10,7 +10,6 @@
 from ophyd import EpicsSignal
 
 from ...tests import IOC_GP
-from ...utils import run_in_thread
 from .. import run_blocking_function
 
 PV = f"{IOC_GP}gp:float1"

apstools/plans/tests/test_sscan_support.py

@@ -5,9 +5,8 @@
 from ophyd import EpicsMotor
 from ophyd.scaler import ScalerCH
 
-from apstools.plans import sscan_1D
-from apstools.synApps import SscanDevice
-from apstools.tests import IOC_GP
+from ...synApps import SscanDevice
+from ...tests import IOC_GP
 
 from ..sscan_support import _get_sscan_data_objects
 from ..sscan_support import sscan_1D

apstools/utils/apsu_controls_subnet.py

@@ -34,32 +34,3 @@ def warn_if_not_aps_controls_subnet():
                 " consider switching to a workstation on the controls subnet"
                 f" which has an IP starting with {APSU_CONTROLS_SUBNET!r}"
             )
-
-
-def warn_if_not_aps_controls_subnet():
-    """
-    APS-U controls are on private subnets.  Check and advise as applicable.
-
-    Call this function early in the startup procedure. It could explain easily
-    the reason for subsequent EPICS PV connection failures.
-
-    For workstations on subnets that do not match the criteria, this function
-    should not post any warnings.
-    """
-
-    import socket
-    import warnings
-
-    xray_subnet = ".xray.aps.anl.gov"
-    controls_subnet = "10.54."
-
-    host_name = socket.gethostname()
-    if host_name.endswith(xray_subnet):
-        host_ip_addr = socket.gethostbyname(host_name)
-        if not host_ip_addr.startswith(controls_subnet):
-            warnings.warn(
-                f"Your APS workstation ({host_name}) has IP {host_ip_addr!r}."
-                "  If you experience EPICS connection timeouts,"
-                " consider switching to a workstation on the controls subnet"
-                f" which has an IP starting with {controls_subnet!r}"
-            )

apstools/utils/tests/test_listdevice.py

@@ -13,7 +13,6 @@
 from ...devices import SwaitRecord
 from ...tests import IOC_GP
 from .._core import TableStyle
-from ..device_info import DEFAULT_COLUMN_WIDTH
 from ..device_info import NOT_CONNECTED_VALUE
 from ..device_info import _list_epics_signals
 from ..device_info import listdevice

apstools/utils/tests/test_listplans.py

@@ -2,7 +2,6 @@
 test issue listplans() command
 """
 
-import pandas as pd
 import pyRestTable
 import pytest
 from bluesky import Msg
@@ -17,7 +16,6 @@ def ns():
     try:
         from IPython import get_ipython
 
-        # ns_dict = get_ipython().user_global_ns
         ns_dict = getattr(get_ipython(), "user_global_ns")
     except (ModuleNotFoundError, AttributeError):
         ns_dict = globals()