Replace black with ruff-format

Author: stephanlukasczyk

.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2019–2024 Pynguin Contributors
+#
+# SPDX-License-Identifier: MIT
+
+# Replace black with ruff-format
+0729abe647ddd0ab6a7fc33fbbcec10a16819d07

.pre-commit-config.yaml

@@ -40,17 +40,12 @@ repos:
       - id: isort
         args: [--profile, black]
 
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-        args: [--config, ./pyproject.toml]
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.8.0
     hooks:
       - id: ruff
         args: [ --fix ]
+      - id: ruff-format
 
   - repo: https://github.com/fsfe/reuse-tool
     rev: v5.0.2

Makefile

@@ -10,14 +10,12 @@ ifeq ($(STRICT), 1)
 	POETRY_COMMAND_FLAG =
 	PIP_COMMAND_FLAG =
 	SECRETS_COMMAND_FLAG =
-	BLACK_COMMAND_FLAG =
 	ISORT_COMMAND_FLAG =
 	MYPY_COMMAND_FLAG =
 else
 	POETRY_COMMAND_FLAG = -
 	PIP_COMMAND_FLAG = -
 	SECRETS_COMMAND_FLAG = -
-	BLACK_COMMAND_FLAG = -
 	ISORT_COMMAND_FLAG = -
 	MYPY_COMMAND_FLAG = -
 endif
@@ -40,12 +38,6 @@ else ifeq ($(SECRETS_STRICT), 0)
 	SECRETS_COMMAND_FLAG = -
 endif
 
-ifeq ($(BLACK_STRICT), 1)
-	BLACK_COMMAND_FLAG =
-else ifeq ($(BLACK_STRICT), 0)
-	BLACK_COMMAND_FLAG = -
-endif
-
 ifeq ($(ISORT_STRICT), 1)
 	ISORT_COMMAND_FLAG =
 else ifeq ($(ISORT_STRICT), 0)
@@ -78,7 +70,6 @@ check-safety:
 
 .PHONY: check-style
 check-style:
-	$(BLACK_COMMAND_FLAG)poetry run black --diff --check ./
 	$(ISORT_COMMAND_FLAG)poetry run isort --check-only .
 	$(MYPY_COMMAND_FLAG)poetry run mypy
 
@@ -102,15 +93,15 @@ ruff:
 isort:
 	poetry run isort .
 
-.PHONY: black
-black:
-	poetry run black .
+.PHONY: ruff-format
+ruff-format:
+	poetry run ruff format .
 
 update-docs-requirements:
 	poetry export -o docs/requirements.txt --with docs --without-hashes
 
 .PHONY: check
-check: update-docs-requirements isort black mypy ruff test
+check: update-docs-requirements isort mypy ruff ruff-format test
 
 .PHONY: lint
 lint: test check-safety check-style

pyproject.toml

@@ -83,28 +83,6 @@ pytest-sugar = "^1.0.0"
 [tool.poetry.scripts]
 pynguin = "pynguin.cli:main"
 
-[tool.black]
-line-length = 88
-target_version = ['py310']
-include = '\.pyi?$'
-exclude = '''
-
-(
-  /(
-      \.eggs          # exclude a few common directories in the
-    | \.git           # root of the project
-    | \.pytest_cache
-    | \.mypy_cache
-    | \.venv
-    | venv
-    | _build
-    | build
-    | dist
-    | pynguin.egg-info
-  )/
-)
-'''
-
 [tool.coverage.run]
 branch = true
 source = ["src/pynguin", "tests"]
@@ -168,7 +146,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.ruff]
 # Assume Python 3.10.
 target-version = "py310"
-line-length = 88
+line-length = 100
 preview = true
 src = ["src", "tests"]
 exclude = [
@@ -249,6 +227,7 @@ ignore = [
     "CPY001",   # missing copyright notice at top of file
     "D105",     # missing docstrings in magic methods
     "FIX002",   # valid TODO comments
+    "ISC001",   # conflicts with ruff-format
     "PLR0911",  # do not complain about too many return statements
     "PLR0912",  # do not complain about too many branches
     "PLR0913",  # do not complain about too many arguments to function call

src/pynguin/analyses/constants.py

@@ -154,9 +154,7 @@ def get_constant_for(self, tp_: type[T]) -> T | None:  # noqa: D102
 class DelegatingConstantProvider(ConstantProvider, ABC):
     """Either provides values from its own pool or delegates to another provider."""
 
-    def __init__(
-        self, pool: ConstantPool, delegate: ConstantProvider, probability: float
-    ):
+    def __init__(self, pool: ConstantPool, delegate: ConstantProvider, probability: float):
         """Create a new provider.
 
         Args:
@@ -170,10 +168,7 @@ def __init__(
         self._probability = probability
 
     def get_constant_for(self, tp_: type[T]) -> T | None:  # noqa: D102
-        if (
-            self._pool.has_constant_for(tp_)
-            and randomness.next_float() < self._probability
-        ):
+        if self._pool.has_constant_for(tp_) and randomness.next_float() < self._probability:
             return self._pool.get_constant_for(tp_)
         return self._delegate.get_constant_for(tp_)
 
@@ -198,9 +193,7 @@ def __init__(
             max_constant_length: The maximum length of strings to store.
         """
         super().__init__(pool, delegate, probability)
-        assert (
-            max_constant_length > 0
-        ), "Length limit for constant pool elements must be positive."
+        assert max_constant_length > 0, "Length limit for constant pool elements must be positive."
         self._max_constant_length = max_constant_length
 
     # A map containing the names of all string functions which are instrumented.
@@ -210,14 +203,10 @@ def __init__(
         "isalnum": lambda value: f"{value}!" if value.isalnum() else "isalnum",
         "islower": lambda value: value.upper() if value.islower() else value.lower(),
         "isupper": lambda value: value.lower() if value.isupper() else value.upper(),
-        "isdecimal": lambda value: (
-            "non_decimal" if value.isdecimal() else string.digits
-        ),
+        "isdecimal": lambda value: ("non_decimal" if value.isdecimal() else string.digits),
         "isalpha": lambda value: f"{value}1" if value.isalpha() else "isalpha",
         "isdigit": lambda value: f"{value}_" if value.isdigit() else "0",
-        "isidentifier": lambda value: (
-            f"{value}!" if value.isidentifier() else "is_Identifier"
-        ),
+        "isidentifier": lambda value: (f"{value}!" if value.isidentifier() else "is_Identifier"),
         "isnumeric": lambda value: f"{value}A" if value.isnumeric() else "012345",
         "isprintable": lambda value: (
             f"{value}{os.linesep}" if value.isprintable() else "is_printable"
@@ -235,10 +224,7 @@ def add_value(self, value: ConstantTypes) -> None:
         # Might be a proxy.
         value = unwrap(value)
         if type(value) in typing.get_args(ConstantTypes):
-            if (
-                isinstance(value, str | bytes)
-                and len(value) > self._max_constant_length
-            ):
+            if isinstance(value, str | bytes) and len(value) > self._max_constant_length:
                 return
             self._pool.add_constant(value)
 

src/pynguin/analyses/controlflow.py

@@ -442,9 +442,7 @@ def copy_graph(cfg: CFG) -> CFG:
         Returns:
             The copied graph
         """
-        copy = CFG(
-            ControlFlowGraph()
-        )  # TODO(fk) Cloning the bytecode cfg is complicated.
+        copy = CFG(ControlFlowGraph())  # TODO(fk) Cloning the bytecode cfg is complicated.
 
         copy._graph = cfg._graph.copy()  # noqa: SLF001
         return copy
@@ -498,21 +496,18 @@ def _create_nodes_and_edges(
                     false_branch = target_block
                 else:
                     raise RuntimeError(
-                        "Unknown conditional Jump instruction in bytecode "
-                        + last_instr.name
+                        "Unknown conditional Jump instruction in bytecode " + last_instr.name
                     )
                 for next_branch, value in [(true_branch, True), (false_branch, False)]:
                     next_index = blocks.get_block_index(
                         next_branch  # type: ignore[arg-type]
                     )
                     # 'label' is also set to value, to get a nicer DOT representation,
                     # because 'label' is a keyword for labelling edges.
-                    edges[node_index].append(
-                        (
-                            next_index,
-                            {EDGE_DATA_BRANCH_VALUE: value, "label": value},
-                        )
-                    )
+                    edges[node_index].append((
+                        next_index,
+                        {EDGE_DATA_BRANCH_VALUE: value, "label": value},
+                    ))
             else:
                 if next_block:
                     next_index = blocks.get_block_index(next_block)
@@ -557,9 +552,7 @@ def _insert_dummy_entry_node(cfg: CFG) -> CFG:
         # Search node with index 0. This block contains the instruction where
         # the execution of a code object begins.
         node_zero = [n for n in cfg.nodes if n.index == 0]
-        assert (
-            len(node_zero) == 1
-        ), "Execution has to start at exactly one node that has index 0."
+        assert len(node_zero) == 1, "Execution has to start at exactly one node that has index 0."
         entry_node = node_zero[0]
         cfg.add_node(dummy_entry_node)
         cfg.add_edge(dummy_entry_node, entry_node)
@@ -692,9 +685,7 @@ def _calculate_dominance(
                 if node == entry:
                     continue
                 current_dominators = dominance_map.get(node)
-                new_dominators = DominatorTree._calculate_dominators(
-                    graph, dominance_map, node
-                )
+                new_dominators = DominatorTree._calculate_dominators(graph, dominance_map, node)
 
                 if current_dominators != new_dominators:
                     changed = True
@@ -756,14 +747,8 @@ def compute(graph: CFG) -> ControlDependenceGraph:
                 if source not in post_dominator_tree.get_transitive_successors(target):
                     # Store branching data from edge, i.e., which outcome of the
                     # branching node leads to this node.
-                    data = frozenset(
-                        augmented_cfg.graph.get_edge_data(source, target).items()
-                    )
-                    edges.add(
-                        ControlDependenceGraph._Edge(
-                            source=source, target=target, data=data
-                        )
-                    )
+                    data = frozenset(augmented_cfg.graph.get_edge_data(source, target).items())
+                    edges.add(ControlDependenceGraph._Edge(source=source, target=target, data=data))
 
         # Mark nodes in the PDT and construct edges for them.
         for edge in edges:
@@ -787,9 +772,7 @@ def compute(graph: CFG) -> ControlDependenceGraph:
 
         return filter_dead_code_nodes(cdg, entry_node_index=-sys.maxsize)
 
-    def get_control_dependencies(
-        self, node: ProgramGraphNode
-    ) -> OrderedSet[ControlDependency]:
+    def get_control_dependencies(self, node: ProgramGraphNode) -> OrderedSet[ControlDependency]:
         """Get the immediate control dependencies of this node.
 
         Args: