Use ruff for all linting

Author: jzuhone

.github/workflows/python-formatting.yml

@@ -0,0 +1,10 @@
+name: check format using ruff
+on: [push]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: format --check

.github/workflows/python-linting.yml

@@ -1,11 +1,8 @@
-name: Check Python formatting using Black and Ruff
-
+name: lint code using ruff
 on: [push]
-
 jobs:
-  lint:
+  ruff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: psf/black@stable
+      - uses: actions/checkout@v4
       - uses: chartboost/ruff-action@v1

.pre-commit-config.yaml

@@ -3,14 +3,11 @@ ci:
 
 
 repos:
--   repo: https://github.com/psf/black
-    rev: 23.7.0
-    hooks:
-    - id: black
-      language_version: python3.11
-
--   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
-    hooks:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.13.3
+  hooks:
+    # Run the linter.
     - id: ruff
-    - id: ruff-format      
+    # Run the formatter.
+    - id: ruff-format

acis_thermal_check/apps/acisfp_check.py

@@ -152,7 +152,7 @@ def make_prediction_plots(
         textypos = [-108.0, -119.3, -115.7]
         fontsize = [12, 9, 9]
         for i in range(3):
-            name = f"{self.name}_{i+1}"
+            name = f"{self.name}_{i + 1}"
             plots[name] = PredictPlot(
                 fig_id=i + 1,
                 x=times,
@@ -379,7 +379,7 @@ def draw_obsids(
         if obsid > 60000:
             # ECS observations during the science orbit are colored blue
             color = "blue"
-        else:
+        else:  # noqa: PLR5501
             # Color all ACIS-S observations green; all ACIS-I
             # observations red
             if in_fp == "ACIS-I":

acis_thermal_check/apps/copy_model_outputs.py

@@ -80,10 +80,10 @@ def main():
         prefix = "Copied"
         try:
             shutil.copytree(location, copy_path, dirs_exist_ok=args.overwrite)
-        except FileExistsError:
+        except FileExistsError as exc:
             raise IOError(
                 f"Files already exist in {copy_path} and --overwrite is not specified!"
-            )
+            ) from exc
     print(f"{prefix} contents of {location} to {copy_path}.")
 
 

acis_thermal_check/state_builder.py

@@ -187,9 +187,9 @@ def get_prediction_states(self, tbegin):
         ok = bs_cmds["event_type"] == "RUNNING_LOAD_TERMINATION_TIME"
         if np.any(ok):
             rltt = CxoTime(bs_dates[ok][0])
-        else:
+        else:  # noqa: PLR5501
             # Handle the case of old loads (prior to backstop 6.9) where there
-            # is no RLTT.  If the first command is AOACRSTD this indicates the
+            # is no RLTT. If the first command is AOACRSTD this indicates the
             # beginning of a maneuver ATS which may overlap by 3 mins with the
             # previous loads because of the AOACRSTD command. So move the RLTT
             # forward by 3 minutes (exactly 180.0 sec). If the first command is

acis_thermal_check/tests/regression_testing.py

@@ -156,8 +156,8 @@ def exception_catcher(test, old, new, data_type, **kwargs):
         old = old.astype("U")
     try:
         test(old, new, **kwargs)
-    except AssertionError:
-        raise AssertionError(f"{data_type} are not the same!")
+    except AssertionError as exc:
+        raise AssertionError(f"{data_type} are not the same!") from exc
 
 
 class RegressionTester:
@@ -512,7 +512,7 @@ def check_violation_reporting(
                 viol_data["limit"] = []
                 viol_data["obsids"] = []
         load_year = "20%s" % load_week[-3:-1]
-        next_year = f"{int(load_year)+1}"
+        next_year = f"{int(load_year) + 1}"
         self.run_model(
             load_week,
             run_start=viol_data["run_start"],
@@ -547,18 +547,18 @@ def check_violation_reporting(
                             viol_data["obsids"].append(obsid)
                     else:
                         try:
-                            assert viol_data["datestarts"][i] in line
+                            assert viol_data["datestarts"][i] in line  # noqa: S101
                             assert viol_data["datestops"][i] in line
                             assert viol_data["duration"][i] in line
                             assert viol_data["temps"][i] in line
                             if self.msid == "fptemp":
                                 assert viol_data["obsids"][i] in line
                                 assert viol_data["exposure"][i] in line
                                 assert viol_data["limit"][i] in line
-                        except AssertionError:
+                        except AssertionError as exc:
                             raise AssertionError(
                                 "Comparison failed. Check file at %s." % index_rst,
-                            )
+                            ) from exc
                     i += 1
         if answer_store:
             with open(viol_json, "w") as f:
@@ -590,9 +590,9 @@ def check_acis_obsids(self, load_week, obsid_json, answer_store=False):
                 obsid_data_stored = json.load(f)
                 try:
                     assert_array_equal(obsid_data, obsid_data_stored)
-                except AssertionError:
+                except AssertionError as exc:
                     outlines = "Some entries did not match:\n"
                     for o1, o2 in zip(obsid_data, obsid_data_stored):
                         if not np.all(o1 == o2):
                             outlines += f"Ref:  {o1}\nTest: {o2}\n\n"
-                    raise AssertionError(outlines)
+                    raise AssertionError(outlines) from exc

pyproject.toml

@@ -0,0 +1,63 @@
+target-version = "py312"
+
+# fix = true
+lint.unfixable = []
+
+lint.select = [
+  "I", # isort
+  "F", # pyflakes
+  "E", "W", # pycodestyle
+  "YTT", # flake8-2020
+  "B", # flake8-bugbear
+  "Q", # flake8-quotes
+  "T10", # flake8-debugger
+  "INT", # flake8-gettext
+  "PLC", "PLE", "PLR", "PLW", # pylint
+  "PIE", # misc lints
+  "PYI", # flake8-pyi
+  "TID", # tidy imports
+  "ISC", # implicit string concatenation
+  "TCH", # type-checking imports
+  "C4", # comprehensions
+  "PGH" # pygrep-hooks
+]
+
+# Some additional rules that are useful
+lint.extend-select = [
+"UP009",  # UTF-8 encoding declaration is unnecessary
+"SIM118",  # Use `key in dict` instead of `key in dict.keys()`
+"D205",  # One blank line required between summary line and description
+"ARG001",  # Unused function argument
+"RSE102",  # Unnecessary parentheses on raised exception
+"PERF401",  # Use a list comprehension to create a transformed list
+"S101",  # Use of `assert` detected
+]
+
+lint.ignore = [
+  "ISC001", # Disable this for compatibility with ruff format
+  "E402", # module level import not at top of file
+  "E731", # do not assign a lambda expression, use a def
+  "PLR2004", # Magic number
+  "B028", # No explicit `stacklevel` keyword argument found
+  "PLR0913", # Too many arguments to function call
+  "PLR1730", # Checks for if statements that can be replaced with min() or max() calls
+  "PLC0415", # `import` should be at the top-level of a file
+  "PLW1641", # Class implements `__hash__` if `__eq__` is implemented,
+]
+
+extend-exclude = [
+  "doc",
+  "build",
+]
+
+[lint.pycodestyle]
+max-line-length = 100 # E501 reports lines that exceed the length of 100.
+
+[lint.extend-per-file-ignores]
+"__init__.py" = ["E402", "F401", "F403"]
+# For tests:
+# - D205: Don't worry about test docstrings
+# - ARG001: Unused function argument false positives for some fixtures
+# - E501: Line-too-long
+# - S101: Do not use assert
+"**/tests/*test*.py" = ["D205", "ARG001", "E501", "S101"]

ruff-base.toml

@@ -0,0 +1,26 @@
+extend = "ruff-base.toml"
+
+# These are files to exclude for this project.
+extend-exclude = [
+  # "**/*.ipynb",  # commonly not ruff-compliant
+]
+
+# These are rules that commonly cause many ruff warnings. Code will be improved by
+# incrementally fixing code to adhere to these rules, but for practical purposes they
+# can be ignored by uncommenting each one. You can also add to this list as needed.
+lint.extend-ignore = [
+  "D205", # 1 blank line required between summary line and description
+  "B905", # `zip()` without an explicit `strict=` parameter
+  # "PLC1901", # compare-to-empty-string
+  # "PLR0911", # Too many returns
+  "PLR0912", # Too many branches
+  "PLR0915", # Too many statements
+  # "PGH004", # Use specific rule codes when using `noqa`
+  # "C401", # Unnecessary generator (rewrite as a `set` comprehension)
+  # "C402", # Unnecessary generator (rewrite as a dict comprehension)
+  # "C405", # Unnecessary `list` literal (rewrite as a `set` literal)
+  # "C408", # Unnecessary `dict` call (rewrite as a literal)
+  # "C416", # Unnecessary `dict` comprehension (rewrite using `dict()`)
+  # "G010", # warn is deprecated in favor of warning
+  # "PYI056", # Calling `.append()` on `__all__` may not be supported by all type checkers
+]