Merge pull request #721 from DHI/ruff

Ruff format

Author: ecomodeller

.devcontainer/devcontainer.json

@@ -1,27 +1,26 @@
 {
-	"name": "Python 3",
-	"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
-	"postCreateCommand": "pip3 install --user -e .'[dev,test,notebooks]'",
-	"customizations": {
+    "name": "Python 3",
+    "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+    "postCreateCommand": "pip3 install --user -e .'[dev,test,notebooks]'",
+    "customizations": {
         "vscode": {
             "extensions": [
                 "ms-python.python",
                 "ms-toolsai.jupyter",
                 "GitHub.vscode-pull-request-github",
                 "charliermarsh.ruff"
-
             ],
             "settings": {
                 "editor.formatOnSave": true,
                 "[python]": {
                     "editor.formatOnSave": true,
                     "editor.codeActionsOnSave": {
-                      "source.fixAll": true,
-                      "source.organizeImports": true
+                        "source.fixAll": true,
+                        "source.organizeImports": true
                     }
-                  },
-                  "python.formatting.provider": "black"
+                },
+                "python.formatting.provider": "charliermarsh.ruff",
             }
         }
     }
-}
+}

.github/workflows/full_test.yml

@@ -23,7 +23,8 @@ jobs:
     - uses: actions/checkout@v3
     - uses: chartboost/ruff-action@v1 # Fail fast if there are any linting errors
       with:
-        version: 0.5.6 # consistent with pyproject.toml ?
+        version: 0.6.2 # consistent with pyproject.toml ?
+        src: mikeio # ignore notebooks
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:

.vscode/settings.json

@@ -13,4 +13,8 @@
     "mypy-type-checker.args": [
         "--disallow-untyped-defs",
     ],
+    "[python]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    }
 }

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 3. If you are fixing a bug, first add a failing test
 4. Make changes
 5. Verify that all tests passes by running `pytest` from the package root directory
-6. Format the code by running [black (`pip install black==22.3.0`)](https://black.readthedocs.io/en/stable/) e.g. `black nameofthefiletoformat.py`
+6. Format the code by running [`ruff format`](https://docs.astral.sh/ruff/formatter/)
 6. Make a pull request with a summary of the changes
 
 Tests can also be run with tools like VS Code

Makefile

@@ -8,7 +8,10 @@ build: typecheck test
 	python -m build
 
 lint:
-	ruff check .
+	ruff check mikeio
+
+format:
+	ruff format $(LIB)/
 
 pylint:
 	pylint --disable=all --enable=attribute-defined-outside-init mikeio/

mikeio/_track.py

@@ -28,7 +28,6 @@ def _extract_track(
     dtype: Any,  # TODO DTypeLike?
     data_read_func: Callable[[int, int], Tuple[np.ndarray, float]],
 ) -> Dataset:
-
     if not isinstance(geometry, GeometryFM2D):
         raise NotImplementedError("Only implemented for 2d flexible mesh geometries")
 
@@ -65,9 +64,7 @@ def _extract_track(
     assert isinstance(
         times, pd.DatetimeIndex
     ), "The index must be a pandas.DatetimeIndex"
-    assert (
-        times.is_monotonic_increasing
-    ), "The time index must be monotonic increasing. Consider df.sort_index() before passing to extract_track()."
+    assert times.is_monotonic_increasing, "The time index must be monotonic increasing. Consider df.sort_index() before passing to extract_track()."
 
     data_list = [coords[:, 0], coords[:, 1]]  # lon,lat
     for item in range(n_items):

mikeio/dataset/_data_plot.py

@@ -59,7 +59,6 @@ def __call__(
     def _get_ax(
         ax: Axes | None = None, figsize: Tuple[float, float] | None = None
     ) -> Axes:
-
         if ax is None:
             _, ax = plt.subplots(figsize=figsize)
         return ax
@@ -68,7 +67,6 @@ def _get_ax(
     def _get_fig_ax(
         ax: Axes | None = None, figsize: Tuple[float, float] | None = None
     ) -> Tuple[Figure, Axes]:
-
         if ax is None:
             fig, ax = plt.subplots(figsize=figsize)
         else:

mikeio/dataset/_dataarray.py

@@ -220,7 +220,6 @@ def _guess_dims(
         ndim_no_time = ndim if (len(dims) == 0) else ndim - 1
 
         if isinstance(geometry, GeometryUndefined):
-
             DIMS_MAPPING: Mapping[int, Sequence[Any]] = {
                 0: [],
                 1: ["x"],
@@ -965,7 +964,9 @@ def interp(
 
                 if interpolant is None:
                     interpolant = self.geometry.get_2d_interpolant(
-                        coords, n_nearest=n_nearest, **kwargs  # type: ignore
+                        coords,  # type: ignore
+                        n_nearest=n_nearest,
+                        **kwargs,  # type: ignore
                     )
                 dai = self.geometry.interp2d(self, *interpolant).flatten()  # type: ignore
                 if z is None:

mikeio/dataset/_dataset.py

@@ -99,9 +99,18 @@ def __init__(
     ):
         if not self._is_DataArrays(data):
             data = self._create_dataarrays(
-                data=data, time=time, items=items, geometry=geometry, zn=zn, dims=dims, dt=dt  # type: ignore
+                data=data,
+                time=time,
+                items=items,
+                geometry=geometry,
+                zn=zn,
+                dims=dims,
+                dt=dt,
             )
-        self._data_vars: MutableMapping[str, DataArray] = self._init_from_DataArrays(data, validate=validate)  # type: ignore
+        self._data_vars: MutableMapping[str, DataArray] = self._init_from_DataArrays(
+            data,  # type: ignore
+            validate=validate,
+        )  # type: ignore
         self.plot = _DatasetPlotter(self)
 
     @staticmethod
@@ -124,12 +133,12 @@ def _is_DataArrays(data: Any) -> bool:
 
     @staticmethod
     def _create_dataarrays(
-        data: Sequence[NDArray[np.floating]] | NDArray[np.floating],
+        data: Any,
         time: pd.DatetimeIndex,
-        items: Sequence[ItemInfo],
+        items: Any,
         geometry: Any,
-        zn: NDArray[np.floating],
-        dims: Tuple[str, ...],
+        zn: Any,
+        dims: Any,
         dt: float,
     ) -> Mapping[str, DataArray]:
         if not isinstance(data, Iterable):
@@ -220,7 +229,7 @@ def _parse_items(
 
     @staticmethod
     def _DataArrays_as_mapping(
-        data: DataArray | Sequence[DataArray] | Mapping[str, DataArray]
+        data: DataArray | Sequence[DataArray] | Mapping[str, DataArray],
     ) -> MutableMapping[str, DataArray]:
         """Create dict of DataArrays if necessary"""
         if isinstance(data, MutableMapping):
@@ -238,7 +247,7 @@ def _DataArrays_as_mapping(
 
     @staticmethod
     def _validate_item_names_and_keys(
-        data_map: MutableMapping[str, DataArray]
+        data_map: MutableMapping[str, DataArray],
     ) -> MutableMapping[str, DataArray]:
         for key, da in data_map.items():
             if da.name == "NoName":
@@ -489,7 +498,12 @@ def create_data_array(
 
     # TODO: delete this?
     @staticmethod
-    def create_empty_data(n_items: int = 1, n_timesteps: int = 1, n_elements: int | None = None, shape: Tuple[int, ...] | None = None):  # type: ignore
+    def create_empty_data(
+        n_items: int = 1,
+        n_timesteps: int = 1,
+        n_elements: int | None = None,
+        shape: Tuple[int, ...] | None = None,
+    ) -> list:
         data = []
         if shape is None:
             if n_elements is None:
@@ -948,7 +962,9 @@ def interp(
                 self.geometry, GeometryFM2D
             ):  # TODO remove this when all geometries implements the same method
                 interpolant = self.geometry.get_2d_interpolant(
-                    xy, n_nearest=n_nearest, **kwargs  # type: ignore
+                    xy,  # type: ignore
+                    n_nearest=n_nearest,
+                    **kwargs,  # type: ignore
                 )
                 das = [da.interp(x=x, y=y, interpolant=interpolant) for da in self]
             else:

mikeio/dfs/__init__.py

@@ -3,4 +3,4 @@
 from ._dfs2 import Dfs2
 from ._dfs3 import Dfs3
 
-__all__ = ["Dfs0", "Dfs1", "Dfs2", "Dfs3"]
+__all__ = ["Dfs0", "Dfs1", "Dfs2", "Dfs3"]