Replace black and blackdoc with ruff-format

Armavica · Armavica · commit 33b4576e0e49 · 2024-09-26T19:07:37.000-04:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -15,20 +15,9 @@ repos:
     # Ruff version.
     rev: 'v0.6.3'
     hooks:
+      - id: ruff-format
       - id: ruff
         args: ["--fix", "--show-fixes"]
-  # https://github.com/python/black#version-control-integration
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.8.0
-    hooks:
-      - id: black-jupyter
-  - repo: https://github.com/keewis/blackdoc
-    rev: v0.3.9
-    hooks:
-      - id: blackdoc
-        exclude: "generate_aggregations.py"
-        additional_dependencies: ["black==24.8.0"]
-      - id: blackdoc-autoupdate-black
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.11.2
     hooks:
diff --git a/asv_bench/benchmarks/__init__.py b/asv_bench/benchmarks/__init__.py
@@ -67,7 +67,6 @@ def _skip_slow():
     >>> from . import _skip_slow
     >>> def time_something_slow():
     ...     pass
-    ...
     >>> time_something.setup = _skip_slow
     """
     if os.environ.get("ASV_SKIP_SLOW", "0") == "1":
diff --git a/ci/min_deps_check.py b/ci/min_deps_check.py
@@ -3,6 +3,7 @@
 publication date. Compare it against requirements/min-all-deps.yml to verify the
 policy on obsolete dependencies is being followed. Print a pretty report :)
 """
+
 from __future__ import annotations
 
 import itertools
diff --git a/pyproject.toml b/pyproject.toml
@@ -239,6 +239,9 @@ extend-exclude = [
   "_typed_ops.pyi",
 ]
 
+[tool.ruff.format]
+docstring-code-format = true
+
 [tool.ruff.lint]
 # E402: module level import not at top of file
 # E501: line too long - let black worry about that
diff --git a/xarray/backends/common.py b/xarray/backends/common.py
@@ -206,13 +206,10 @@ def load(self):
         For example::
 
             class SuffixAppendingDataStore(AbstractDataStore):
-
                 def load(self):
                     variables, attributes = AbstractDataStore.load(self)
-                    variables = {'%s_suffix' % k: v
-                                 for k, v in variables.items()}
-                    attributes = {'%s_suffix' % k: v
-                                  for k, v in attributes.items()}
+                    variables = {"%s_suffix" % k: v for k, v in variables.items()}
+                    attributes = {"%s_suffix" % k: v for k, v in attributes.items()}
                     return variables, attributes
 
         This function will be called anytime variables or attributes
diff --git a/xarray/backends/file_manager.py b/xarray/backends/file_manager.py
@@ -65,7 +65,7 @@ class CachingFileManager(FileManager):
 
     Example usage::
 
-        manager = FileManager(open, 'example.txt', mode='w')
+        manager = FileManager(open, "example.txt", mode="w")
         f = manager.acquire()
         f.write(...)
         manager.close()  # ensures file is closed
diff --git a/xarray/backends/h5netcdf_.py b/xarray/backends/h5netcdf_.py
@@ -450,7 +450,6 @@ def open_datatree(
         driver_kwds=None,
         **kwargs,
     ) -> DataTree:
-
         from xarray.core.datatree import DataTree
 
         groups_dict = self.open_groups_as_dict(filename_or_obj, **kwargs)
@@ -478,7 +477,6 @@ def open_groups_as_dict(
         driver_kwds=None,
         **kwargs,
     ) -> dict[str, Dataset]:
-
         from xarray.backends.common import _iter_nc_groups
         from xarray.core.treenode import NodePath
         from xarray.core.utils import close_on_error
diff --git a/xarray/backends/netCDF4_.py b/xarray/backends/netCDF4_.py
@@ -692,7 +692,6 @@ def open_datatree(
         autoclose=False,
         **kwargs,
     ) -> DataTree:
-
         from xarray.core.datatree import DataTree
 
         groups_dict = self.open_groups_as_dict(filename_or_obj, **kwargs)
diff --git a/xarray/backends/plugins.py b/xarray/backends/plugins.py
@@ -80,7 +80,7 @@ def backends_dict_from_pkg(
 
 
 def set_missing_parameters(
-    backend_entrypoints: dict[str, type[BackendEntrypoint]]
+    backend_entrypoints: dict[str, type[BackendEntrypoint]],
 ) -> None:
     for _, backend in backend_entrypoints.items():
         if backend.open_dataset_parameters is None:
@@ -89,7 +89,7 @@ def set_missing_parameters(
 
 
 def sort_backends(
-    backend_entrypoints: dict[str, type[BackendEntrypoint]]
+    backend_entrypoints: dict[str, type[BackendEntrypoint]],
 ) -> dict[str, type[BackendEntrypoint]]:
     ordered_backends_entrypoints = {}
     for be_name in STANDARD_BACKENDS_ORDER:
diff --git a/xarray/backends/zarr.py b/xarray/backends/zarr.py
@@ -499,7 +499,6 @@ def open_store(
         zarr_version=None,
         write_empty: bool | None = None,
     ):
-
         zarr_group, consolidate_on_close, close_store_on_close = _get_open_params(
             store=store,
             mode=mode,
@@ -545,7 +544,6 @@ def open_group(
         zarr_version=None,
         write_empty: bool | None = None,
     ):
-
         zarr_group, consolidate_on_close, close_store_on_close = _get_open_params(
             store=store,
             mode=mode,
@@ -1323,7 +1321,6 @@ def open_groups_as_dict(
         zarr_version=None,
         **kwargs,
     ) -> dict[str, Dataset]:
-
         from xarray.core.treenode import NodePath
 
         filename_or_obj = _normalize_path(filename_or_obj)
@@ -1370,7 +1367,6 @@ def open_groups_as_dict(
 
 
 def _iter_zarr_groups(root: ZarrGroup, parent: str = "/") -> Iterable[str]:
-
     parent_nodepath = NodePath(parent)
     yield str(parent_nodepath)
     for path, group in root.groups():
diff --git a/xarray/convert.py b/xarray/convert.py
@@ -1,5 +1,4 @@
-"""Functions for converting to and from xarray objects
-"""
+"""Functions for converting to and from xarray objects"""
 
 from collections import Counter
 
diff --git a/xarray/core/common.py b/xarray/core/common.py
@@ -792,13 +792,10 @@ def pipe(
 
         >>> def adder(data, arg):
         ...     return data + arg
-        ...
         >>> def div(data, arg):
         ...     return data / arg
-        ...
         >>> def sub_mult(data, sub_arg, mult_arg):
         ...     return (data * mult_arg) - sub_arg
-        ...
         >>> x.pipe(adder, 2)
         <xarray.Dataset> Size: 96B
         Dimensions:        (lat: 2, lon: 2)
diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py
@@ -1583,7 +1583,7 @@ def sel(
           Do not try to assign values when using any of the indexing methods
           ``isel`` or ``sel``::
 
-            da = xr.DataArray([0, 1, 2, 3], dims=['x'])
+            da = xr.DataArray([0, 1, 2, 3], dims=["x"])
             # DO NOT do this
             da.isel(x=[0, 1, 2])[1] = -1
 
@@ -5578,7 +5578,6 @@ def map_blocks(
         ...     gb = da.groupby(groupby_type)
         ...     clim = gb.mean(dim="time")
         ...     return gb - clim
-        ...
         >>> time = xr.cftime_range("1990-01", "1992-01", freq="ME")
         >>> month = xr.DataArray(time.month, coords={"time": time}, dims=["time"])
         >>> np.random.seed(123)
@@ -6404,7 +6403,6 @@ def curvefit(
         >>> rng = np.random.default_rng(seed=0)
         >>> def exp_decay(t, time_constant, amplitude):
         ...     return np.exp(-t / time_constant) * amplitude
-        ...
         >>> t = np.arange(11)
         >>> da = xr.DataArray(
         ...     np.stack(
diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -8936,7 +8936,6 @@ def map_blocks(
         ...     gb = da.groupby(groupby_type)
         ...     clim = gb.mean(dim="time")
         ...     return gb - clim
-        ...
         >>> time = xr.cftime_range("1990-01", "1992-01", freq="ME")
         >>> month = xr.DataArray(time.month, coords={"time": time}, dims=["time"])
         >>> np.random.seed(123)
diff --git a/xarray/core/datatree.py b/xarray/core/datatree.py
@@ -794,7 +794,6 @@ def _replace_node(
         data: Dataset | Default = _default,
         children: dict[str, DataTree] | Default = _default,
     ) -> None:
-
         ds = self.to_dataset(inherited=False) if data is _default else data
 
         if children is _default:
diff --git a/xarray/core/datatree_render.py b/xarray/core/datatree_render.py
@@ -118,7 +118,6 @@ def __init__(
 
         >>> for pre, _, node in RenderDataTree(root):
         ...     print(f"{pre}{node.name}")
-        ...
         root
         ├── sub0
         │   ├── sub0B
@@ -131,7 +130,6 @@ def __init__(
         ...     print(f"{pre}{node.name}")
         ...     for variable in node.variables:
         ...         print(f"{fill}{variable}")
-        ...
         root
         a
         b
diff --git a/xarray/core/extensions.py b/xarray/core/extensions.py
@@ -106,7 +106,6 @@ def register_dataset_accessor(name):
     ...     def plot(self):
     ...         # plot this array's data on a map, e.g., using Cartopy
     ...         pass
-    ...
 
     Back in an interactive IPython session:
 
diff --git a/xarray/core/formatting.py b/xarray/core/formatting.py
@@ -1,5 +1,4 @@
-"""String formatting routines for __repr__.
-"""
+"""String formatting routines for __repr__."""
 
 from __future__ import annotations
 
diff --git a/xarray/core/groupby.py b/xarray/core/groupby.py
@@ -235,7 +235,9 @@ def to_array(self) -> DataArray:
 T_Group = Union["T_DataArray", _DummyGroup]
 
 
-def _ensure_1d(group: T_Group, obj: T_DataWithCoords) -> tuple[
+def _ensure_1d(
+    group: T_Group, obj: T_DataWithCoords
+) -> tuple[
     T_Group,
     T_DataWithCoords,
     Hashable | None,
@@ -462,7 +464,9 @@ def factorize(self) -> EncodedGroups:
         )
         # NaNs; as well as values outside the bins are coded by -1
         # Restore these after the raveling
-        mask = functools.reduce(np.logical_or, [(code == -1) for code in broadcasted_codes])  # type: ignore[arg-type]
+        mask = functools.reduce(
+            np.logical_or, [(code == -1) for code in broadcasted_codes]
+        )  # type: ignore[arg-type]
         _flatcodes[mask] = -1
 
         midx = pd.MultiIndex.from_product(
@@ -1288,7 +1292,6 @@ def _concat_shortcut(self, applied, dim, positions=None):
         return self._obj._replace_maybe_drop_dims(reordered)
 
     def _restore_dim_order(self, stacked: DataArray) -> DataArray:
-
         def lookup_order(dimension):
             for grouper in self.groupers:
                 if dimension == grouper.name and grouper.group.ndim == 1:
diff --git a/xarray/core/indexes.py b/xarray/core/indexes.py
@@ -1768,7 +1768,7 @@ def indexes_equal(
 
 
 def indexes_all_equal(
-    elements: Sequence[tuple[Index, dict[Hashable, Variable]]]
+    elements: Sequence[tuple[Index, dict[Hashable, Variable]]],
 ) -> bool:
     """Check if indexes are all equal.
 
diff --git a/xarray/core/options.py b/xarray/core/options.py
@@ -266,7 +266,6 @@ class set_options:
     >>> ds = xr.Dataset({"x": np.arange(1000)})
     >>> with xr.set_options(display_width=40):
     ...     print(ds)
-    ...
     <xarray.Dataset> Size: 8kB
     Dimensions:  (x: 1000)
     Coordinates:
diff --git a/xarray/core/parallel.py b/xarray/core/parallel.py
@@ -296,7 +296,6 @@ def map_blocks(
     ...     gb = da.groupby(groupby_type)
     ...     clim = gb.mean(dim="time")
     ...     return gb - clim
-    ...
     >>> time = xr.cftime_range("1990-01", "1992-01", freq="ME")
     >>> month = xr.DataArray(time.month, coords={"time": time}, dims=["time"])
     >>> np.random.seed(123)
@@ -372,7 +371,8 @@ def _wrapper(
 
             # ChainMap wants MutableMapping, but xindexes is Mapping
             merged_indexes = collections.ChainMap(
-                expected["indexes"], merged_coordinates.xindexes  # type: ignore[arg-type]
+                expected["indexes"],
+                merged_coordinates.xindexes,  # type: ignore[arg-type]
             )
             expected_index = merged_indexes.get(name, None)
             if expected_index is not None and not index.equals(expected_index):
diff --git a/xarray/core/resample.py b/xarray/core/resample.py
@@ -188,7 +188,9 @@ def _interpolate(self, kind="linear", **kwargs) -> T_Xarray:
 
 
 # https://github.com/python/mypy/issues/9031
-class DataArrayResample(Resample["DataArray"], DataArrayGroupByBase, DataArrayResampleAggregations):  # type: ignore[misc]
+class DataArrayResample(
+    Resample["DataArray"], DataArrayGroupByBase, DataArrayResampleAggregations
+):  # type: ignore[misc]
     """DataArrayGroupBy object specialized to time resampling operations over a
     specified dimension
     """
@@ -329,7 +331,9 @@ def asfreq(self) -> DataArray:
 
 
 # https://github.com/python/mypy/issues/9031
-class DatasetResample(Resample["Dataset"], DatasetGroupByBase, DatasetResampleAggregations):  # type: ignore[misc]
+class DatasetResample(
+    Resample["Dataset"], DatasetGroupByBase, DatasetResampleAggregations
+):  # type: ignore[misc]
     """DatasetGroupBy object specialized to resampling a specified dimension"""
 
     def map(
diff --git a/xarray/core/variable.py b/xarray/core/variable.py
@@ -839,7 +839,6 @@ def _getitem_with_mask(self, key, fill_value=dtypes.NA):
         dims, indexer, new_order = self._broadcast_indexes(key)
 
         if self.size:
-
             if is_duck_dask_array(self._data):
                 # dask's indexing is faster this way; also vindex does not
                 # support negative indices yet:
diff --git a/xarray/namedarray/_array_api.py b/xarray/namedarray/_array_api.py
@@ -79,7 +79,8 @@ def astype(
 
 
 def imag(
-    x: NamedArray[_ShapeType, np.dtype[_SupportsImag[_ScalarType]]], /  # type: ignore[type-var]
+    x: NamedArray[_ShapeType, np.dtype[_SupportsImag[_ScalarType]]],
+    /,  # type: ignore[type-var]
 ) -> NamedArray[_ShapeType, np.dtype[_ScalarType]]:
     """
     Returns the imaginary component of a complex number for each element x_i of the
@@ -111,7 +112,8 @@ def imag(
 
 
 def real(
-    x: NamedArray[_ShapeType, np.dtype[_SupportsReal[_ScalarType]]], /  # type: ignore[type-var]
+    x: NamedArray[_ShapeType, np.dtype[_SupportsReal[_ScalarType]]],
+    /,  # type: ignore[type-var]
 ) -> NamedArray[_ShapeType, np.dtype[_ScalarType]]:
     """
     Returns the real component of a complex number for each element x_i of the
diff --git a/xarray/plot/utils.py b/xarray/plot/utils.py
@@ -986,7 +986,7 @@ def legend_elements(
     This is useful for obtaining a legend for a `~.Axes.scatter` plot;
     e.g.::
 
-        scatter = plt.scatter([1, 2, 3],  [4, 5, 6],  c=[7, 2, 3])
+        scatter = plt.scatter([1, 2, 3], [4, 5, 6], c=[7, 2, 3])
         plt.legend(*scatter.legend_elements())
 
     creates three legend elements, one for each color with the numerical
diff --git a/xarray/tests/test_cftime_offsets.py b/xarray/tests/test_cftime_offsets.py
@@ -1673,7 +1673,6 @@ def test_new_to_legacy_freq_anchored(year_alias, n):
     ),
 )
 def test_legacy_to_new_freq_pd_freq_passthrough(freq, expected):
-
     result = _legacy_to_new_freq(freq)
     assert result == expected
 
@@ -1699,7 +1698,6 @@ def test_legacy_to_new_freq_pd_freq_passthrough(freq, expected):
     ),
 )
 def test_new_to_legacy_freq_pd_freq_passthrough(freq, expected):
-
     result = _new_to_legacy_freq(freq)
     assert result == expected
 
@@ -1786,7 +1784,6 @@ def test_date_range_no_freq(start, end, periods):
 )
 @pytest.mark.parametrize("has_year_zero", [False, True])
 def test_offset_addition_preserves_has_year_zero(offset, has_year_zero):
-
     with warnings.catch_warnings():
         warnings.filterwarnings("ignore", message="this date/calendar/year zero")
         datetime = cftime.DatetimeGregorian(-1, 12, 31, has_year_zero=has_year_zero)
diff --git a/xarray/tests/test_coordinates.py b/xarray/tests/test_coordinates.py
@@ -64,7 +64,9 @@ def test_init_index_error(self) -> None:
             Coordinates(indexes={"x": idx})
 
         with pytest.raises(TypeError, match=".* is not an `xarray.indexes.Index`"):
-            Coordinates(coords={"x": ("x", [1, 2, 3])}, indexes={"x": "not_an_xarray_index"})  # type: ignore[dict-item]
+            Coordinates(
+                coords={"x": ("x", [1, 2, 3])}, indexes={"x": "not_an_xarray_index"}
+            )  # type: ignore[dict-item]
 
     def test_init_dim_sizes_conflict(self) -> None:
         with pytest.raises(ValueError):
diff --git a/xarray/tests/test_dataset.py b/xarray/tests/test_dataset.py
diff --git a/xarray/tests/test_datatree.py b/xarray/tests/test_datatree.py
diff --git a/xarray/tests/test_distributed.py b/xarray/tests/test_distributed.py
diff --git a/xarray/tests/test_formatting.py b/xarray/tests/test_formatting.py
diff --git a/xarray/tests/test_indexing.py b/xarray/tests/test_indexing.py
diff --git a/xarray/tests/test_interp.py b/xarray/tests/test_interp.py
diff --git a/xarray/tests/test_namedarray.py b/xarray/tests/test_namedarray.py
diff --git a/xarray/tests/test_treenode.py b/xarray/tests/test_treenode.py

Original file line number	Diff line number	Diff line change
`@@ -239,6 +239,9 @@ extend-exclude = [`
`239`	`239`	`"_typed_ops.pyi",`
`240`	`240`	`]`
`241`	`241`
	`242`	`+[tool.ruff.format]`
	`243`	`+docstring-code-format = true`
	`244`	`+`
`242`	`245`	`[tool.ruff.lint]`
`243`	`246`	`# E402: module level import not at top of file`
`244`	`247`	`# E501: line too long - let black worry about that`