Replace flake8 and black with ruff (gcovr#1007)

* Replace black and flake8 with ruff, reformat code
* Move pytest and coverage configuration to toml

Author: Spacetown

.vscode/tasks.json

@@ -39,15 +39,9 @@
             "group": "build"
         },
         {
-            "label": "Run black",
+            "label": "Run ruff",
             "type": "shell",
-            "command": "nox --reuse-existing-virtualenvs $(if [ -n \"${env:NOX_ENV_DIR}\" ] ; then echo \"--envdir ${env:NOX_ENV_DIR}\" ; fi) -s black",
-            "group": "build"
-        },
-        {
-            "label": "Run flake8",
-            "type": "shell",
-            "command": "nox --reuse-existing-virtualenvs $(if [ -n \"${env:NOX_ENV_DIR}\" ] ; then echo \"--envdir ${env:NOX_ENV_DIR}\" ; fi) -s flake8",
+            "command": "nox --reuse-existing-virtualenvs $(if [ -n \"${env:NOX_ENV_DIR}\" ] ; then echo \"--envdir ${env:NOX_ENV_DIR}\" ; fi) -s ruff",
             "group": "build"
         },
         {
@@ -77,7 +71,7 @@
         {
             "label": "Format current file",
             "type": "shell",
-            "command": "nox --reuse-existing-virtualenvs $(if [ -n \"${env:NOX_ENV_DIR}\" ] ; then echo \"--envdir ${env:NOX_ENV_DIR}\" ; fi) -s black -- ${file}",
+            "command": "nox --reuse-existing-virtualenvs $(if [ -n \"${env:NOX_ENV_DIR}\" ] ; then echo \"--envdir ${env:NOX_ENV_DIR}\" ; fi) -s ruff -- format ${file}",
             "group": "build"
         },
         {

CHANGELOG.rst

@@ -29,6 +29,7 @@ Internal changes:
 
 - Add MacOs 15 and clang-16 to the GitHub test workflow. (:issue:`1004`)
 - Fix sporadic timestamp mismatch in development build package. (:issue:`1006`)
+- Replace ``black`` and ``flake8`` with ``ruff`` and move configuration of ``pytest`` to ``pyproject.toml``. (:issue:`1007`)
 
 8.2 (13 October 2024)
 ---------------------

CONTRIBUTING.rst

@@ -267,7 +267,7 @@ and a comprehensive corpus of example projects
 that are executed as the ``test_gcovr.py`` integration test.
 Each ``tests/*`` directory is one such example project.
 
-You can format files with ``python3 -m nox --session black``)
+You can format files with ``python3 -m nox --session ruff -- format path/to/file``)
 
 To get a list of all available sessions run ``python3 -m nox -l``.
 
@@ -276,6 +276,9 @@ the :ref:`structure of integration tests <integration tests>`,
 how to :ref:`run and filter tests <run tests>`,
 and how to :ref:`run tests with Docker <docker tests>`.
 
+.. versionchanged:: NEXT
+   black is replaced by ruff.
+
 .. versionchanged:: 5.2
    If black is called without arguments, all files are reformated
    instead of checked. To check the format use the session lint.

admin/Dockerfile.qa

@@ -106,7 +106,7 @@ RUN echo "docker:docker" | chpasswd
 USER docker:docker
 
 # Select language-agnostic "C" locale.
-# Unicode is necessary for some tools like "black" to work.
+# Unicode is necessary for some tools to work.
 ENV LC_ALL=C.UTF-8 LANG=C.UTF-8
 
 WORKDIR /gcovr

admin/bump_version.py

@@ -49,12 +49,21 @@
 
 
 def getLicenseSection(comment_char: str = "#"):
-    yield comment_char + "  ************************** Copyrights and license ***************************"
+    yield (
+        comment_char
+        + "  ************************** Copyrights and license ***************************"
+    )
     yield comment_char
-    yield comment_char + f" This file is part of gcovr {VERSION}, a parsing and reporting tool for gcov."
+    yield (
+        comment_char
+        + f" This file is part of gcovr {VERSION}, a parsing and reporting tool for gcov."
+    )
     yield comment_char + f" https://gcovr.com/en/{READTHEDOCS_VERSION}"
     yield comment_char
-    yield comment_char + " _____________________________________________________________________________"
+    yield (
+        comment_char
+        + " _____________________________________________________________________________"
+    )
     yield comment_char
     for line in COPYRIGHT:
         yield comment_char + " " + line

cspell.json

@@ -72,10 +72,10 @@
         "googletest",
         "gtest",
         "Hashbang",
+        "htmlcov",
         "iostream",
         "jacoco",
         "kcov",
-        "latk",
         "lcov",
         "LDFLAGS",
         "levelname",
@@ -120,6 +120,7 @@
         "stylesheet",
         "Traceback",
         "tracefile",
+        "unfixable",
         "venv",
         "versionadded",
         "versionchanged",
@@ -145,6 +146,7 @@
         "includecss",
         "keil",
         "kMGTPEZY",
+        "latk",
         "levelno",
         "linenos",
         "linkcss",
@@ -158,6 +160,7 @@
         "pydevproject",
         "Sandia",
         "strerror",
+        "subdir",
         "testcase",
         "userdel",
         "userid",

gcovr/configuration.py

@@ -224,7 +224,7 @@ def get_boolean(silent_error: bool = False):
         try:
             value = converter(cfg_entry.value)
         except (ValueError, ArgumentTypeError) as err:
-            raise cfg_entry.error(str(err))
+            raise cfg_entry.error(str(err)) from None
 
     elif option.name == "json_add_tracefile":  # Special case for patterns
         if cfg_entry.filename is None:
@@ -316,7 +316,6 @@ def merge_options_and_set_defaults(
     target: Dict[str, Any] = {}
     for namespace in partial_namespaces:
         for option in all_options:
-
             if option.name not in namespace:
                 continue
 
@@ -794,15 +793,15 @@ def parse_config_file(
     test.cfg: 7: optional = spaces
     """
 
+    def error(pattern: str, *args, **kwargs):
+        # pylint: disable=cell-var-from-loop
+        message = pattern.format(*args, **kwargs)
+        message += f"\non this line: {line}"
+        return SyntaxError(": ".join([filename, str(lineno), message]))
+
     for lineno, line in enumerate(open_file, first_lineno):
         line = line.rstrip()
 
-        def error(pattern: str, *args, **kwargs):
-            # pylint: disable=cell-var-from-loop
-            message = pattern.format(*args, **kwargs)
-            message += "\non this line: " + line
-            return SyntaxError(": ".join([filename, str(lineno), message]))
-
         # strip (trailing) comments
         line = CONFIG_HASH_COMMENT.sub("", line)
 

gcovr/formats/cobertura/read.py

@@ -68,11 +68,9 @@ def read_report(options: Options) -> CovData:
         LOGGER.debug(f"Processing XML file: {filename}")
 
         try:
-            root = etree.parse(
-                filename
-            ).getroot()  # nosec # We parse the file given by the user
+            root = etree.parse(filename).getroot()  # nosec # We parse the file given by the user
         except Exception as e:
-            raise RuntimeError(f"Bad --cobertura-add-tracefile option.\n{e}")
+            raise RuntimeError(f"Bad --cobertura-add-tracefile option.\n{e}") from None
 
         for gcovr_file in root.xpath("./packages//class"):
             if gcovr_file.get("filename") is None:  # pragma: no cover
@@ -106,15 +104,15 @@ def _line_from_xml(filename: str, xml_line) -> LineCoverage:
         raise RuntimeError(
             "Bad --covertura-add-tracefile option.\n"
             f"'number' attribute is required and must be an integer: {etree.tostring(xml_line).decode()}\n"
-        )
+        ) from None
 
     try:
         count = int(xml_line.get("hits"))
     except Exception:  # pragma: no cover
         raise RuntimeError(
             "Bad --covertura-add-tracefile option.\n"
             f"'hits' attribute is required and must be an integer: {etree.tostring(xml_line).decode()}\n"
-        )
+        ) from None
 
     is_branch = xml_line.get("branch") == "true"
     branch_msg = xml_line.get("condition-coverage")

gcovr/formats/coveralls/write.py

@@ -173,7 +173,6 @@ def run_git_log_cmd(arg):
     # Loop through each coverage file collecting details
     json_dict["source_files"] = []
     for file_path in sorted(covdata):
-
         # File data has been compiled
         json_dict["source_files"].append(_make_source_file(covdata[file_path], options))
 

gcovr/formats/gcov/parser.py

@@ -35,7 +35,6 @@
 """
 # pylint: disable=too-many-lines
 
-
 import enum
 import logging
 import re
@@ -315,7 +314,6 @@ def parse_metadata(lines: List[str]) -> Dict[str, Optional[str]]:
     """
     collected = {}
     for line in lines:
-
         # empty lines shouldn't occur in reality, but are common in testing
         if not line:
             continue
@@ -369,7 +367,6 @@ def parse_coverage(
     tokenized_lines: List[Tuple[_Line, str]] = []
     persistent_states: Dict[str, Any] = {}
     for raw_line in lines:
-
         # empty lines shouldn't occur in reality, but are common in testing
         if not raw_line:
             continue
@@ -607,7 +604,9 @@ def _report_lines_with_errors(
 
 
 def _parse_line(
-    line: str, ignore_parse_errors: set = (), persistent_states: dict = {}
+    line: str,
+    ignore_parse_errors: Optional[set] = None,
+    persistent_states: Optional[dict] = None,
 ) -> _Line:
     """
     Categorize/parse individual lines without further processing.
@@ -729,6 +728,10 @@ def _parse_line(
     gcovr.formats.gcov.parser.UnknownLineType: nonexistent_tag foo bar
     """
     # pylint: disable=too-many-branches
+    if ignore_parse_errors is None:
+        ignore_parse_errors = set([])
+    if persistent_states is None:
+        persistent_states = {}
 
     tag = _parse_tag_line(line, ignore_parse_errors, persistent_states)
     if tag is not None:
@@ -838,10 +841,16 @@ def _parse_line(
 
 
 def _parse_tag_line(
-    line: str, ignore_parse_errors: set = (), persistent_states: dict = {}
+    line: str,
+    ignore_parse_errors: Optional[set] = None,
+    persistent_states: Optional[dict] = None,
 ) -> Optional[_Line]:
     """A tag line is any gcov line that starts in the first column."""
     # pylint: disable=too-many-return-statements
+    if ignore_parse_errors is None:
+        ignore_parse_errors = set([])
+    if persistent_states is None:
+        persistent_states = {}
 
     # Tag lines never start with whitespace.
     #

gcovr/formats/html/write.py

@@ -84,7 +84,6 @@ def get_theme_color(html_theme: str) -> str:
 # This speeds up text and XML output.
 @Lazy
 def templates(options):
-
     from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PackageLoader
 
     # As default use the package loader
@@ -129,7 +128,6 @@ def load_user_template(template):
 
 
 class CssRenderer:
-
     THEMES = [
         "green",
         "blue",
@@ -523,7 +521,6 @@ def write_source_pages(
     cdata_sourcefile: Dict[str, str],
     data: Dict[str, Any],
 ) -> bool:
-
     error_no_files_not_found = 0
     all_functions = dict()
     for fname, cdata in covdata.items():
@@ -614,7 +611,6 @@ def write_single_page(
     cdata_sourcefile: Dict[str, str],
     data: Dict[str, Any],
 ) -> bool:
-
     error_no_files_not_found = 0
     files = []
     all_functions = dict()

gcovr/formats/lcov/write.py

@@ -48,6 +48,9 @@ def write_report(covdata: CovData, output_file: str, options: Options) -> None:
         # TN:<test name>
         fh.write(f"TN:{options.lcov_test_name}\n")
 
+        def postfix():
+            return f"_{lineno}" if len(linenos) > 1 else ""
+
         for key in keys:
             filename = force_unix_separator(covdata[key].filename)
 
@@ -68,9 +71,6 @@ def write_report(covdata: CovData, output_file: str, options: Options) -> None:
                 linenos = list(covdata[key].functions[function_name].count)
                 functions += len(linenos)
 
-                def postfix():
-                    return f"_{lineno}" if len(linenos) > 1 else ""
-
                 for lineno in sorted(linenos):
                     # FN:<line number of function start>,[<line number of function end>,]<function name>
                     fh.write(f"FN:{lineno},{function_name}{postfix()}\n")
@@ -92,7 +92,7 @@ def postfix():
             for lineno in sorted_lines:
                 line_coverage = covdata[key].lines[lineno]
                 if line_coverage.excluded:
-                    next
+                    continue
                 branches += len(line_coverage.branches)
                 for branch in sorted(line_coverage.branches):
                     branch_coverage = line_coverage.branches[branch]