Merge pull request NSLS-II#95 from thomashopkins32/ruff-linter

Ruff linter support; Removal of black, flake8, and isort
thomaswmorris · Feb 20, 2025 · d736bda · d736bda
2 parents c0eb914 + fe06de0
commit d736bda
Show file tree

Hide file tree

Showing 30 changed files with 223 additions and 267 deletions.
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -14,6 +14,8 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
+      - name: Install pre-commit dependencies
+        run: pip install .[pre-commit]
       - uses: pre-commit/action@v3.0.0
         with:
           extra_args: --all-files
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,28 +1,36 @@
-default_language_version:
-    python: python3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
+      - id: check-added-large-files
       - id: check-yaml
+      - id: check-merge-conflict
       - id: end-of-file-fixer
-      - id: trailing-whitespace
-  - repo: https://github.com/ambv/black
-    rev: 24.10.0
+
+  - repo: local
     hooks:
-      - id: black
-        language_version: python3
-      - id: black-jupyter
-        language_version: python3
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
-    hooks:
-      - id: flake8
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        args: ["--profile", "black"]
+      - id: ruff
+        name: lint with ruff
+        language: system
+        entry: ruff check --force-exclude
+        types: [python]
+        require_serial: true
+
+      - id: ruff-format
+        name: format with ruff
+        language: system
+        entry: ruff format --force-exclude
+        types: [python]
+        require_serial: true
+
+      - id: import-linter
+        name: ensure import directionality 
+        pass_filenames: false
+        language: system
+        entry: lint-imports
+        types: [python]
+        require_serial: false
+
   - repo: https://github.com/kynan/nbstripout
     rev: 0.8.1
     hooks:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # blop documentation build configuration file, created by
 # sphinx-quickstart on Thu Jun 28 12:35:56 2018.
@@ -21,6 +20,11 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+import blop
 
 # -- General configuration ------------------------------------------------
 
@@ -72,12 +76,6 @@
 copyright = "2020, Brookhaven National Laboratory"
 author = "Brookhaven National Laboratory"
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-import blop
-
 # The short X.Y version.
 version = blop.__version__
 # The full version, including alpha/beta/rc tags.

diff --git a/docs/source/tutorials/hyperparameters.ipynb b/docs/source/tutorials/hyperparameters.ipynb
@@ -18,9 +18,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import numpy as np\n",
     "import matplotlib as mpl\n",
+    "import numpy as np\n",
     "from matplotlib import pyplot as plt\n",
+    "\n",
     "from blop.utils import functions\n",
     "\n",
     "x1 = x2 = np.linspace(-10, 10, 256)\n",
@@ -66,11 +67,11 @@
    },
    "outputs": [],
    "source": [
-    "from blop.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env  # noqa: F401\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp\n",
     "\n",
-    "from blop import DOF, Objective, Agent\n",
+    "from blop import DOF, Agent, Objective\n",
     "\n",
     "dofs = [\n",
     "    DOF(name=\"x1\", search_domain=(-6, 6)),\n",
@@ -139,7 +140,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "blop-dev",
    "language": "python",
    "name": "python3"
   },
@@ -153,12 +154,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.20"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
-   }
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/tutorials/introduction.ipynb b/docs/source/tutorials/introduction.ipynb
@@ -26,7 +26,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env  # noqa: F401\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp"
    ]
@@ -38,9 +38,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import numpy as np\n",
     "import matplotlib as mpl\n",
+    "import numpy as np\n",
     "from matplotlib import pyplot as plt\n",
+    "\n",
     "from blop.utils import functions\n",
     "\n",
     "x1 = x2 = np.linspace(-6, 6, 256)\n",
@@ -289,7 +290,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "blop-dev",
    "language": "python",
    "name": "python3"
   },
@@ -303,12 +304,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.20"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
-   }
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/tutorials/kb-mirrors.ipynb b/docs/source/tutorials/kb-mirrors.ipynb
@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env  # noqa: F401\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp\n",
     "bec.disable_plots()"
@@ -42,7 +42,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop import DOF, Objective, Agent\n",
+    "from blop import DOF, Agent, Objective\n",
     "from blop.digestion import beam_stats_digestion\n",
     "\n",
     "dofs = [\n",
@@ -103,19 +103,11 @@
    "source": [
     "agent.plot_objectives(axes=(2, 3))"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "blop-dev",
    "language": "python",
    "name": "python3"
   },
@@ -129,12 +121,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.20"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
-   }
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/tutorials/pareto-fronts.ipynb b/docs/source/tutorials/pareto-fronts.ipynb
@@ -18,7 +18,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env  # noqa: F401\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp"
    ]
@@ -30,12 +30,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop import DOF, Objective, Agent\n",
-    "from blop.utils import functions\n",
-    "from blop.dofs import BrownianMotion\n",
-    "\n",
     "import numpy as np\n",
     "\n",
+    "from blop import DOF, Agent, Objective\n",
+    "\n",
     "\n",
     "def digestion(df):\n",
     "    for index, entry in df.iterrows():\n",
@@ -130,7 +128,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "blop-dev",
    "language": "python",
    "name": "python3"
   },
@@ -144,12 +142,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.20"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
-   }
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,

diff --git a/docs/source/tutorials/passive-dofs.ipynb b/docs/source/tutorials/passive-dofs.ipynb
@@ -26,7 +26,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop.utils import prepare_re_env\n",
+    "from blop.utils import prepare_re_env  # noqa: F401\n",
     "\n",
     "%run -i $prepare_re_env.__file__ --db-type=temp"
    ]
@@ -38,11 +38,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from blop.digestion.tests import constrained_himmelblau_digestion\n",
     "from blop import DOF, Agent, Objective\n",
+    "from blop.digestion.tests import constrained_himmelblau_digestion\n",
     "from blop.dofs import BrownianMotion\n",
     "\n",
-    "\n",
     "dofs = [\n",
     "    DOF(name=\"x1\", search_domain=(-5.0, 5.0)),\n",
     "    DOF(name=\"x2\", search_domain=(-5.0, 5.0)),\n",
@@ -80,7 +79,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "blop-dev",
    "language": "python",
    "name": "python3"
   },
@@ -94,12 +93,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.20"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
-   }
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,