Switch from black to ruff-format. (#478)

tobiasraabe · web-flow · commit 1c76085d2a35 · 2023-11-07T00:21:10.000Z
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,15 +44,12 @@ repos:
     rev: v1.2.0
     hooks:
     -   id: sort-all
--   repo: https://github.com/psf/black
-    rev: 23.10.1
-    hooks:
-    -   id: black
 -   repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.1.4
     hooks:
       - id: ruff
         args: [--unsafe-fixes]
+      - id: ruff-format
 -   repo: https://github.com/dosisod/refurb
     rev: v1.22.1
     hooks:
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ ______________________________________________________________________
 [![image](https://img.shields.io/github/actions/workflow/status/pytask-dev/pytask/main.yml?branch=main)](https://github.com/pytask-dev/pytask/actions?query=branch%3Amain)
 [![image](https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pytask-dev/pytask)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/pytask/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/pytask/main)
-[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 <!-- Keep in sync with docs/source/index.md -->
 
diff --git a/docs/source/changes.md b/docs/source/changes.md
@@ -24,6 +24,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`472` adds `is_product` to {meth}`PNode.load`.
 - {pull}`473` adds signatures to nodes which decouples an identifier from a name.
 - {pull}`477` updates the PyPI action.
+- {pull}`478` replaces black with ruff-format.
 
 ## 0.4.1 - 2023-10-11
 
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -11,7 +11,7 @@
 [![image](https://img.shields.io/github/actions/workflow/status/pytask-dev/pytask/main.yml?branch=main)](https://github.com/pytask-dev/pytask/actions?query=branch%3Amain)
 [![image](https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg)](https://app.codecov.io/gh/pytask-dev/pytask)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pytask-dev/pytask/main.svg)](https://results.pre-commit.ci/latest/github/pytask-dev/pytask/main)
-[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ## Features
 
diff --git a/environment.yml b/environment.yml
@@ -23,7 +23,6 @@ dependencies:
   - typing_extensions
 
   # Misc
-  - black
   - deepdiff
   - ipywidgets
   - jupyterlab
@@ -35,6 +34,7 @@ dependencies:
   - pytest-cov
   - pytest-env
   - pytest-xdist
+  - ruff
   - syrupy
   - tabulate
   - tox
diff --git a/pyproject.toml b/pyproject.toml
@@ -110,6 +110,7 @@ ignore = [
     "D416",
     "D417",
     # Others.
+    "ISC001",
     "S101",  # raise errors for asserts.
     "ANN101",  # type annotating self
     "ANN102",  # type annotating cls
diff --git a/src/_pytask/click.py b/src/_pytask/click.py
@@ -67,7 +67,9 @@ class ColoredGroup(DefaultGroup):
     """A command group with colored help pages."""
 
     def format_help(
-        self: DefaultGroup, ctx: click.Context, formatter: Any  # noqa: ARG002
+        self: DefaultGroup,
+        ctx: click.Context,
+        formatter: Any,  # noqa: ARG002
     ) -> None:
         """Format the help text."""
         highlighter = _OptionHighlighter()
@@ -116,7 +118,9 @@ class ColoredCommand(click.Command):
     """A command with colored help pages."""
 
     def format_help(
-        self: click.Command, ctx: click.Context, formatter: Any  # noqa: ARG002
+        self: click.Command,
+        ctx: click.Context,
+        formatter: Any,  # noqa: ARG002
     ) -> None:
         """Format the help text."""
         console.print(
diff --git a/src/_pytask/config_utils.py b/src/_pytask/config_utils.py
@@ -20,7 +20,9 @@
 
 
 def set_defaults_from_config(
-    context: click.Context, param: click.Parameter, value: Any  # noqa: ARG001
+    context: click.Context,
+    param: click.Parameter,  # noqa: ARG001
+    value: Any,
 ) -> Path | None:
     """Set the defaults for the command-line interface from the configuration."""
     # pytask will later walk through all configuration hooks, even the ones not related
diff --git a/src/_pytask/debugging.py b/src/_pytask/debugging.py
@@ -59,7 +59,9 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
 
 
 def _pdbcls_callback(
-    ctx: click.Context, name: str, value: str | None  # noqa: ARG001
+    ctx: click.Context,  # noqa: ARG001
+    name: str,  # noqa: ARG001
+    value: str | None,
 ) -> tuple[str, str] | None:
     """Validate the debugger class string passed to pdbcls."""
     message = "'pdbcls' must be like IPython.terminal.debugger:TerminalPdb"
@@ -259,7 +261,10 @@ def get_stack(self, f: FrameType, t: TracebackType) -> tuple[str, int]:
 
     @classmethod
     def _init_pdb(
-        cls, method: str, *args: Any, **kwargs: Any  # noqa: ARG003
+        cls,
+        method: str,
+        *args: Any,  # noqa: ARG003
+        **kwargs: Any,
     ) -> pdb.Pdb:
         """Initialize PDB debugging, dropping any IO capturing."""
         if cls._pluginmanager is None:
diff --git a/src/_pytask/parameters.py b/src/_pytask/parameters.py
@@ -72,7 +72,9 @@
 
 
 def _database_url_callback(
-    ctx: Context, name: str, value: str | None  # noqa: ARG001
+    ctx: Context,  # noqa: ARG001
+    name: str,  # noqa: ARG001
+    value: str | None,
 ) -> URL | None:
     """Check the url for the database."""
     # Since sqlalchemy v2.0.19, we need to shortcircuit here.
diff --git a/src/_pytask/path.py b/src/_pytask/path.py
@@ -217,7 +217,9 @@ def shorten_path(path: Path, paths: Sequence[Path]) -> str:
 
 @HashPathCache.memoize
 def hash_path(
-    path: Path, modification_time: float, digest: str = "sha256"  # noqa: ARG001
+    path: Path,
+    modification_time: float,  # noqa: ARG001
+    digest: str = "sha256",
 ) -> str:
     """Compute the hash of a file.
 
diff --git a/tests/test_clean.py b/tests/test_clean.py
@@ -283,7 +283,8 @@ def test_dont_remove_files_tracked_by_git(runner, git_project):
 @pytest.mark.end_to_end()
 def test_clean_git_files_if_git_is_not_installed(monkeypatch, runner, git_project):
     monkeypatch.setattr(
-        "_pytask.clean.is_git_installed", lambda *x: False  # noqa: ARG005
+        "_pytask.clean.is_git_installed",
+        lambda *x: False,  # noqa: ARG005
     )
 
     result = runner.invoke(cli, ["clean", git_project.as_posix()])
diff --git a/tests/test_collect_utils.py b/tests/test_collect_utils.py
@@ -72,9 +72,7 @@ def _convert_placeholders_to_tuples(x):
     return {
         (next(counter), k.scalar)
         if isinstance(k, _Placeholder)
-        else k: _convert_placeholders_to_tuples(v)
-        if isinstance(v, dict)
-        else v
+        else k: _convert_placeholders_to_tuples(v) if isinstance(v, dict) else v
         for k, v in x.items()
     }
 
diff --git a/tests/test_dag_command.py b/tests/test_dag_command.py
@@ -177,7 +177,8 @@ def test_raise_error_with_graph_via_cli_missing_optional_program(
     monkeypatch, tmp_path, runner
 ):
     monkeypatch.setattr(
-        "_pytask.compat.importlib.import_module", lambda x: None  # noqa: ARG005
+        "_pytask.compat.importlib.import_module",
+        lambda x: None,  # noqa: ARG005
     )
     monkeypatch.setattr("_pytask.compat.shutil.which", lambda x: None)  # noqa: ARG005
 
@@ -207,7 +208,8 @@ def test_raise_error_with_graph_via_task_missing_optional_program(
     monkeypatch, tmp_path, runner
 ):
     monkeypatch.setattr(
-        "_pytask.compat.importlib.import_module", lambda x: None  # noqa: ARG005
+        "_pytask.compat.importlib.import_module",
+        lambda x: None,  # noqa: ARG005
     )
     monkeypatch.setattr("_pytask.compat.shutil.which", lambda x: None)  # noqa: ARG005
 
diff --git a/tests/test_git.py b/tests/test_git.py
@@ -8,7 +8,8 @@
 @pytest.mark.parametrize(("mock_return", "expected"), [(True, True), (None, False)])
 def test_is_git_installed(monkeypatch, mock_return, expected):
     monkeypatch.setattr(
-        "_pytask.git.shutil.which", lambda *x: mock_return  # noqa: ARG005
+        "_pytask.git.shutil.which",
+        lambda *x: mock_return,  # noqa: ARG005
     )
     result = is_git_installed()
     assert result is expected
diff --git a/tests/test_path.py b/tests/test_path.py
@@ -170,7 +170,9 @@ def test_no_meta_path_found(
     del sys.modules[module.__name__]
 
     monkeypatch.setattr(
-        importlib.util, "spec_from_file_location", lambda *args: None  # noqa: ARG005
+        importlib.util,
+        "spec_from_file_location",
+        lambda *args: None,  # noqa: ARG005
     )
     with pytest.raises(ImportError):
         import_path(simple_module, root=tmp_path)
diff --git a/tests/test_persist.py b/tests/test_persist.py
@@ -123,7 +123,8 @@ def task_dummy(depends_on, produces):
 )
 def test_pytask_execute_task_process_report(monkeypatch, exc_info, expected):
     monkeypatch.setattr(
-        "_pytask.persist.update_states_in_database", lambda *x: None  # noqa: ARG005
+        "_pytask.persist.update_states_in_database",
+        lambda *x: None,  # noqa: ARG005
     )
 
     task = DummyClass()
