Merge pull request #26 from bcdev/forman-ruff

Using ruff

Author: forman

.github/workflows/publish.yml

@@ -26,12 +26,9 @@ jobs:
         python -m pip install --upgrade pip
         pip install .[dev,doc]
 
-    - name: Lint with flake8
+    - name: Lint with ruff
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        ruff check
 
     - name: Run unit tests
       shell: bash -l {0}

.github/workflows/tests.yml

@@ -29,12 +29,9 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install .[dev,doc]
-    - name: Lint with flake8
+    - name: Lint with ruff
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        ruff check
     - name: Test with pytest
       run: |
         pytest --cov=xrlint --cov-branch --cov-report=xml

CHANGES.md

@@ -16,6 +16,9 @@
 
 - Improved overall test coverage.
 
+- Switched to [ruff](https://docs.astral.sh/ruff/) 
+  as default linter and formatter.
+
 
 ## Version 0.2.0 (14.01.2025)
 

CONTRIBUTING.md

@@ -20,8 +20,9 @@ checklist are addressed in your PR.
 
 **PR checklist**
 
-* Format code using [black](https://black.readthedocs.io/) with default settings.
-  Check also section [code style](#code-style) below.
+* Format and check code using [ruff](https://docs.astral.sh/ruff/) with 
+  default settings: `ruff format` and `ruff check`. See also section 
+  [code style](#code-style) below.
 * Your change shall not break existing unit tests.
   `pytest` must run without errors.
 * Add unit tests for any new code not yet covered by tests.
@@ -33,16 +34,18 @@ checklist are addressed in your PR.
 
 ## Code style
 
-The XRLint code complies to [PEP-8](https://pep8.org/) except for a line 
-length of 88 characters as recommended by [black](https://black.readthedocs.io/).
-Since black is un-opinionated regarding the order of imports, 
-we use the following three import blocks separated by an empty 
-line:
+The code style of XRLint equals the default settings 
+of [black](https://black.readthedocs.io/). Since black is 
+un-opinionated regarding the order of imports, we group and 
+sort imports statements according to the default settings of 
+[isort](https://pycqa.github.io/isort/) which boils down to
 
+0. Future imports
 1. Python standard library imports, e.g., `os`, `typing`, etc
 2. 3rd-party imports, e.g., `xarray`, `zarr`, etc
-3. XRLint module imports: 
-   Prefer absolute import paths: `from xrlint.a.b.c import d`. 
+3. 1st-party XRLint module imports using absolute paths, 
+   e.g., `from xrlint.a.b.c import d`. 
+4. 1st-party XRLint module imports from local modules: 
    Relative imports such as `from .c import d` are ok
    while `..c import d` are not ok.
 

README.md

@@ -1,8 +1,7 @@
 [![CI](https://github.com/bcdev/xrlint/actions/workflows/tests.yml/badge.svg)](https://github.com/bcdev/xrlint/actions/workflows/tests.yml)
 [![codecov](https://codecov.io/gh/bcdev/xrlint/graph/badge.svg?token=GVKuJao97t)](https://codecov.io/gh/bcdev/xrlint)
 [![PyPI Version](https://img.shields.io/pypi/v/xrlint)](https://pypi.org/project/xrlint/)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![GitHub License](https://img.shields.io/github/license/bcdev/xrlint)](https://github.com/bcdev/xrlint)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff)[![GitHub License](https://img.shields.io/github/license/bcdev/xrlint)](https://github.com/bcdev/xrlint)
 
 # XRLint - A linter for xarray datasets
 

docs/about.md

@@ -50,12 +50,12 @@ pytest --cov=xrlint --cov-report html
 
 ### Code Style
 
-XRLint source code is formatted using the [black](https://black.readthedocs.io/) tool and 
-quality-controlled using [flake8](https://flake8.pycqa.org/).
+XRLint source code is formatted and quality-controlled using
+using [ruff](https://docs.astral.sh/ruff/):
 
 ```bash
-black .
-flake8 --max-line-length=88 . 
+ruff format
+ruff check
 ```
 
 ### Documentation

environment.yml

@@ -10,8 +10,6 @@ dependencies:
   - tabulate
   - xarray
   # Dev Dependencies
-  - black
-  - flake8
   - mkdocs
   - mkdocs-autorefs
   - mkdocs-material
@@ -20,6 +18,7 @@ dependencies:
   - pytest
   - pytest-cov
   - requests-mock
+  - ruff
   # Testing Datasets
   - pandas
   - netcdf4

examples/plugin_config.py

@@ -6,9 +6,7 @@
 from xrlint.config import Config
 from xrlint.node import DatasetNode
 from xrlint.plugin import new_plugin
-from xrlint.rule import RuleContext
-from xrlint.rule import RuleOp
-
+from xrlint.rule import RuleContext, RuleOp
 
 plugin = new_plugin(
     name="hello-plugin",

examples/rule_testing.py

@@ -5,11 +5,8 @@
 import xarray as xr
 
 from xrlint.node import DatasetNode
-from xrlint.rule import RuleContext
-from xrlint.rule import RuleOp
-from xrlint.rule import define_rule
-from xrlint.testing import RuleTest
-from xrlint.testing import RuleTester
+from xrlint.rule import RuleContext, RuleOp, define_rule
+from xrlint.testing import RuleTest, RuleTester
 
 
 @define_rule("good-title")

examples/virtual_plugin_config.py

@@ -5,9 +5,7 @@
 """
 
 from xrlint.node import DatasetNode
-from xrlint.rule import RuleContext
-from xrlint.rule import RuleOp
-from xrlint.rule import define_rule
+from xrlint.rule import RuleContext, RuleOp, define_rule
 
 
 @define_rule("good-title", description="Dataset title should be 'Hello World!'.")