Switch CI to use 'ruff' package for linting (#273)

* DOC #258

* CI #258

* STY #258 changes to comply with 'ruff check'

* CFG #258 ruff configuration

* MNT #258 restore these two imports, they start the instrument

* MNT #258 per 'ruff check'

.github/workflows/code.yml

@@ -31,19 +31,11 @@ jobs:
         run: |
           set -vxeuo pipefail
           python -m pip install --upgrade pip
-          pip install ruff flake8
-
-      - name: Run flake8
-        run: flake8
   
-      # # TODO: will replace flake8
-      # - name: Run ruff
-      #   uses: davidslusser/actions_python_ruff@v1.0.0
-      #   with:
-      #     # src: "."
-      #     # options: "--cov=src"
-      #     pip_install_command: "pip install -e .[dev]"
-      #     python_version: "3.11"
+      - name: Run ruff
+        uses: davidslusser/actions_python_ruff@v1.0.0
+        with:
+          python_version: "3.11"
 
   tests:
     name: CI py${{ matrix.python-version }}

.ruff.toml

@@ -0,0 +1,86 @@
+# 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", "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" = ["F403"]
+"bluesky/console/__start_bluesky_instrument__.py" = ["F403"]
+"bluesky/instrument/collection.py" = ["F403"]
+"bluesky/instrument/qstarter.py" = ["F401", "F403"]
+"bluesky/instrument/queueserver.py" = ["F401", "F403"]
+"bluesky/qstarter.py" = ["F401"]
+"**/{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"

.wip/pack_unpack/export_db.py

@@ -6,10 +6,12 @@
 see: https://github.com/APS-3ID-IXN/ipython-s3blue/issues/2
 """
 
-from databroker import Broker
-import datetime, os, shutil, time
+import datetime
+import os
+import shutil
+
 import pyRestTable
-from dask.bag import text
+from databroker import Broker
 
 
 def main():
@@ -101,6 +103,7 @@ def main():
 
 
 import re
+
 ACCEPTABLE_PATTERN = r"[A-Za-z_][\w_]*"
 
 
@@ -127,9 +130,7 @@ def tester():
     'mca_elapsed_real_time', 'mca_preset_real_time', 'mca_spectrum',
     'neat_stage_x', 'neat_stage_x_user_setpoint', 'neat_stage_y',
     'neat_stage_y_user_setpoint', 'scaler_time']
-    safe_keys = make_safe(keys)
-    keymap = {k:v for k, v in zip(keys, safe_keys)}
-    for old_key, new_key in zip(keys, safe_keys):
+    for old_key, new_key in zip(keys, make_safe(keys)):
         tbl.addRow((old_key, new_key))
     print(tbl)
 

CHANGES.rst

@@ -51,10 +51,10 @@ Maintenance
 * Add 'Hello, World!' test to installation checklist.
 * Drop the (unused now) *stdlogpj* package for configuring Python's *logging*.
 * Environment for bluesky_2024_1.
+* Lint the code (for style and syntax errors) using the 'ruff' package.
 * Updates (learned from 2-ID) for new installations.
 * Various documentation updates.
 
-
 v1.0.1
 ******
 

bluesky/instrument/__init__.py

@@ -1,2 +1,2 @@
 # instrument configuration
-from ._iconfig import iconfig
+from ._iconfig import iconfig  # noqa

bluesky/instrument/collection.py

@@ -24,7 +24,7 @@
     logger.info("xmode exception level: '%s'", _xmode_level)
     del _ip
 
-from . import mpl
+from . import mpl  # noqa
 
 logger.info("#### Bluesky Framework ####")
 from .framework import *

bluesky/instrument/framework/initialize.py

@@ -26,21 +26,21 @@
 from bluesky import SupplementalData
 from bluesky.callbacks.best_effort import BestEffortCallback
 from bluesky.magics import BlueskyMagics
-from bluesky.simulators import summarize_plan
+from bluesky.simulators import summarize_plan  # noqa
 from bluesky.utils import PersistentDict
 from bluesky.utils import ProgressBarManager
-from bluesky.utils import ts_msg_hook
+from bluesky.utils import ts_msg_hook  # noqa
 from IPython import get_ipython
 from ophydregistry import Registry
 import databroker
 import ophyd
-import warnings
+import warnings  # noqa
 
 # convenience imports
-import bluesky.plans as bp
-import bluesky.plan_stubs as bps
-import bluesky.preprocessors as bpp
-import numpy as np
+import bluesky.plans as bp  # noqa
+import bluesky.plan_stubs as bps  # noqa
+import bluesky.preprocessors as bpp  # noqa
+import numpy as np  # noqa
 
 
 def get_md_path():

bluesky/instrument/framework/metadata.py

@@ -15,7 +15,6 @@
 import getpass
 import os
 import socket
-from datetime import datetime
 
 import apstools
 import databroker

bluesky/instrument/utils/image_analysis.py

@@ -17,7 +17,6 @@
 import numpy as np
 import pyRestTable
 from scipy.ndimage import center_of_mass
-from scipy.integrate import trapz
 
 
 def analyze_peak(y_arr, x_arr=None):

bluesky/qstarter.py

@@ -22,7 +22,7 @@
 )
 
 from instrument import iconfig
-from instrument.queueserver import *
+from instrument.queueserver import *  # noqa
 
 
 print_instrument_configuration()

bluesky/tests/test_ipython_startup.py

@@ -6,7 +6,8 @@
 
 
 def test_startup(capsys):
-    from instrument.collection import iconfig
+    # start the instrument package for IPython console session
+    from instrument.collection import iconfig  # noqa
 
     out, err = capsys.readouterr()
 

bluesky/tests/test_queueserver_startup.py

@@ -6,7 +6,8 @@
 
 
 def test_startup(capsys):
-    from qstarter import iconfig
+    # start the instrument package for queueserver session
+    from qstarter import iconfig  # noqa
 
     out, err = capsys.readouterr()
 

bluesky/user/quick_hello.py

@@ -16,12 +16,15 @@
 
 import logging
 
+from ophyd import Component
+from ophyd import Device
+from ophyd import Signal
+
+from bluesky import plans as bp
+
 logger = logging.getLogger(__name__)
 logger.info(__file__)
 
-from ophyd import Component, Device, Signal
-
-from bluesky import plans as bp
 
 print("Loading 'Hello, World!' example.")