Merge pull request #391 from GeoStat-Framework/pylint-to-ruff

Replace pylint with ruff

Author: LSchueler

.github/workflows/main.yml

@@ -33,21 +33,17 @@ jobs:
           pip install -v --editable '.[lint,test]'
           pip install "coveralls>=3.0.0"
 
-      - name: black check
+      - name: ruff linter
         run: |
-          python -m black --check --diff --color .
+          python -m ruff check src/gstools/
 
-      - name: black preview
+      - name: ruff import check
         run: |
-          python -m black --preview --diff --color .
+          python -m ruff check --select I --diff src/gstools/
 
-      - name: isort check
+      - name: ruff format check
         run: |
-          python -m isort --check --diff --color .
-
-      - name: pylint check
-        run: |
-          python -m pylint src/gstools/
+          python -m ruff format --diff src/gstools/
 
       - name: coveralls check
         run: |

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to **GSTools** will be documented in this file.
 
+## [Unreleased] - ?
+
+### Changes
+
+- replace pylint, black, and isort with ruff [#391](https://github.com/GeoStat-Framework/GSTools/pull/391)
+
 ## [1.7.0] - Morphic Mint - 2025-04
 
 ### Enhancements

CONTRIBUTING.md

@@ -29,8 +29,10 @@ with your idea or suggestion and we'd love to discuss about it.
 
 - Fork the repo on [GitHub](https://github.com/GeoStat-Framework/GSTools)
 - Add yourself to AUTHORS.md (if you want to).
-- We use [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort) to format our code.
-  Please use the scripts `black .` and `isort .` after you have written your code.
+- We use [Ruff](https://github.com/psf/black) to check and format the code.
+  Please use the scripts `ruff check src/gstools`,
+  `ruff check --select I --fix src/gstools/`, and
+  `ruff format --diff src/gstools/` after you have written your code.
 - Add some tests if possible.
 - Add an example showing your new feature in one of the examples sub-folders if possible.
   Follow this [Sphinx-Gallary guide](https://sphinx-gallery.github.io/stable/syntax.html#embed-rst-in-your-example-python-files).

pyproject.toml

@@ -73,11 +73,7 @@ plotting = [
 ]
 rust = ["gstools_core>=1.0.0"]
 test = ["pytest-cov>=3"]
-lint = [
-    "black>=24",
-    "pylint",
-    "isort[colors]",
-]
+lint = ["ruff"]
 
 [project.urls]
 Changelog = "https://github.com/GeoStat-Framework/GSTools/blob/main/CHANGELOG.md"
@@ -107,21 +103,9 @@ include = [
 [tool.hatch.build.targets.wheel]
 packages = ["src/gstools"]
 
-[tool.isort]
-profile = "black"
-multi_line_output = 3
-line_length = 79
-
-[tool.black]
+[tool.ruff]
 line-length = 79
-target-version = [
-    "py38",
-    "py39",
-    "py310",
-    "py311",
-    "py312",
-    "py313",
-]
+target-version = "py38"
 
 [tool.coverage]
     [tool.coverage.run]
@@ -140,32 +124,3 @@ target-version = [
         "def __repr__",
         "def __str__",
     ]
-
-[tool.pylint]
-    [tool.pylint.main]
-    extension-pkg-whitelist = [
-        "numpy",
-        "scipy",
-        "gstools_core",
-    ]
-    ignore = "_version.py"
-    load-plugins = [
-        "pylint.extensions.no_self_use",
-    ]
-
-    [tool.pylint.message_control]
-    disable = [
-        "R0801",
-    ]
-
-    [tool.pylint.reports]
-    output-format = "colorized"
-
-    [tool.pylint.design]
-    max-args = 20
-    max-locals = 50
-    max-branches = 30
-    max-statements = 85
-    max-attributes = 30
-    max-public-methods = 80
-    max-positional-arguments=20

src/gstools/__init__.py

@@ -236,6 +236,7 @@
     "Krige",
     "SRF",
     "CondSRF",
+    "PGS",
     "rotated_main_axes",
     "generate_grid",
     "generate_st_grid",

src/gstools/config.py

@@ -7,9 +7,8 @@
 
 NUM_THREADS = None
 
-# pylint: disable=W0611
 try:  # pragma: no cover
-    import gstools_core
+    import gstools_core  # noqa: F401
 
     _GSTOOLS_CORE_AVAIL = True
     USE_GSTOOLS_CORE = True

src/gstools/covmodel/base.py

@@ -10,7 +10,6 @@
    SumModel
 """
 
-# pylint: disable=C0103, R0201, E1101, C0302, W0613, W0231
 import copy
 
 import numpy as np

src/gstools/covmodel/fit.py

@@ -9,7 +9,6 @@
    fit_variogram
 """
 
-# pylint: disable=C0103, W0632
 import numpy as np
 from scipy.optimize import curve_fit
 

src/gstools/covmodel/models.py

@@ -22,7 +22,6 @@
    JBessel
 """
 
-# pylint: disable=C0103, C0302, E1101, R0201
 import warnings
 
 import numpy as np

src/gstools/covmodel/plot.py

@@ -25,7 +25,6 @@
    plot_spectral_rad_pdf
 """
 
-# pylint: disable=C0103, C0415, E1130
 import numpy as np
 
 from gstools.tools.geometric import generate_grid