Merge pull request #445 from DHI/ruff

Use ruff for formatting instead of black

Author: jsmariegaard

.devcontainer/devcontainer.json

@@ -20,7 +20,7 @@
                       "source.organizeImports": true
                     }
                   },
-                  "python.formatting.provider": "black"
+                  "python.formatting.provider": "charliermarsh.ruff",
             }
         }
     }

.github/workflows/full_test.yml

@@ -21,6 +21,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: chartboost/ruff-action@v1 # Fail fast if there are any linting errors
       with:
+        version: 0.6.2
         src: "modelskill"
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnSave": true
     },
     "python.testing.pytestArgs": [

CONTRIBUTING.md

@@ -4,5 +4,5 @@
 2. Install package in editable mode `pip install -e .[dev]`, including development dependencies
 3. Make changes
 4. Verify that all tests passes by running `pytest` from the package root directory
-5. Format the code by running [black](https://black.readthedocs.io/en/stable/) e.g. `black nameofthefiletoformat.py`
+5. Format the code by running [`ruff format`](https://docs.astral.sh/ruff/formatter/)
 6. Make a pull request with a summary of the changes

Makefile

@@ -8,6 +8,9 @@ build: typecheck test
 lint:
 	ruff check $(LIB)
 
+format:
+	ruff format $(LIB)
+
 test:
 	pytest --disable-warnings
 

modelskill/comparison/__init__.py

@@ -1,6 +1,7 @@
-"""The `comparison` module contains different types of classes for single 
+"""The `comparison` module contains different types of classes for single
 observation comparison (Comparer), and collections of Comparers (ComparerCollection).
 """
+
 from ._comparison import Comparer
 from ._collection import ComparerCollection
 

modelskill/comparison/_comparison.py

@@ -233,6 +233,7 @@ def _validate_metrics(metrics: Iterable[Any]) -> None:
 @dataclass
 class ItemSelection:
     "Utility class to keep track of observation, model and auxiliary items"
+
     obs: str
     model: Sequence[str]
     aux: Sequence[str]
@@ -793,7 +794,8 @@ def __iadd__(self, other: Comparer):  # type: ignore
         else:
             self.raw_mod_data.update(other.raw_mod_data)
             matched = match_space_time(
-                observation=self._to_observation(), raw_mod_data=self.raw_mod_data  # type: ignore
+                observation=self._to_observation(),
+                raw_mod_data=self.raw_mod_data,  # type: ignore
             )
             self.data = matched
 
@@ -821,7 +823,8 @@ def __add__(
                 raw_mod_data = self.raw_mod_data.copy()
                 raw_mod_data.update(other.raw_mod_data)  # TODO!
                 matched = match_space_time(
-                    observation=self._to_observation(), raw_mod_data=raw_mod_data  # type: ignore
+                    observation=self._to_observation(),
+                    raw_mod_data=raw_mod_data,  # type: ignore
                 )
                 cmp = Comparer(matched_data=matched, raw_mod_data=raw_mod_data)
 
@@ -879,7 +882,9 @@ def sel(
             d = d.sel(time=d.time.to_index().to_frame().loc[start:end].index)  # type: ignore
 
             # Note: if user asks for a specific time, we also filter raw
-            raw_mod_data = {k: v.sel(time=slice(start, end)) for k, v in raw_mod_data.items()}  # type: ignore
+            raw_mod_data = {
+                k: v.sel(time=slice(start, end)) for k, v in raw_mod_data.items()
+            }  # type: ignore
         if time is not None:
             d = d.sel(time=time)
 

modelskill/matching.py

@@ -258,7 +258,9 @@ def match(
     if isinstance(obs, Collection):
         assert all(isinstance(o, get_args(ObsInputType)) for o in obs)
     else:
-        raise TypeError(f"Obs is not the correct type: it is {type(obs)}. Check the order of the arguments (obs, mod).")
+        raise TypeError(
+            f"Obs is not the correct type: it is {type(obs)}. Check the order of the arguments (obs, mod)."
+        )
 
     if len(obs) > 1 and isinstance(mod, Collection) and len(mod) > 1:
         if not all(isinstance(m, (DfsuModelResult, GridModelResult)) for m in mod):

modelskill/metrics.py

@@ -1,9 +1,9 @@
-"""The `metrics` module contains different skill metrics for evaluating the 
-difference between a model and an observation. 
+"""The `metrics` module contains different skill metrics for evaluating the
+difference between a model and an observation.
 
 * [bias][modelskill.metrics.bias]
 * [max_error][modelskill.metrics.max_error]
-* [root_mean_squared_error (rmse)][modelskill.metrics.root_mean_squared_error]    
+* [root_mean_squared_error (rmse)][modelskill.metrics.root_mean_squared_error]
 * [urmse][modelskill.metrics.urmse]
 * [mean_absolute_error (mae)][modelskill.metrics.mean_absolute_error]
 * [mean_absolute_percentage_error (mape)][modelskill.metrics.mean_absolute_percentage_error]

modelskill/model/_base.py

@@ -89,7 +89,6 @@ def _extract_track(
 
 
 class Alignable(Protocol):
-
     @property
     def time(self) -> pd.DatetimeIndex: ...