diff-cover 10.5.0__tar.gz → 10.6.0__tar.gz

diff_cover-10.6.0/.gitignore

@@ -0,0 +1,50 @@
+*.py[cod]
+.DS_Store
+
+.idea
+venv
+27venv
+.venv
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+.pytest_cache
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage*
+.tox
+/coverage.xml
+/report.html
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+.python-version
+
+# VS Code
+.vscode/*
+*.code-workspaces
+.history/

{diff_cover-10.5.0 → diff_cover-10.6.0}/PKG-INFO

@@ -1,14 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.5
 Name: diff_cover
-Version: 10.5.0
+Version: 10.6.0
 Summary: Run coverage and linting reports on diffs
-License: Apache-2.0
+Project-URL: Homepage, https://github.com/Bachmann1234/diff-cover
+Project-URL: Repository, https://github.com/Bachmann1234/diff-cover
 Author: See Contributors
-Requires-Python: >=3.10
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -20,14 +22,13 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: chardet>=3.0.0
+Requires-Dist: jinja2>=2.7.1
+Requires-Dist: pluggy<2,>=0.13.1
+Requires-Dist: pygments<3,>=2.19.1
 Provides-Extra: toml
-Requires-Dist: Jinja2 (>=2.7.1)
-Requires-Dist: Pygments (>=2.19.1,<3.0.0)
-Requires-Dist: chardet (>=3.0.0)
-Requires-Dist: pluggy (>=0.13.1,<2)
-Requires-Dist: tomli (>=1.2.1) ; extra == "toml"
-Project-URL: Homepage, https://github.com/Bachmann1234/diff-cover
-Project-URL: Repository, https://github.com/Bachmann1234/diff-cover
+Requires-Dist: tomli>=1.2.1; extra == 'toml'
 Description-Content-Type: text/x-rst
 
 diff-cover |pypi-version| |conda-version| |build-status|
@@ -96,8 +97,11 @@ To install the development version:
 
     git clone https://github.com/Bachmann1234/diff-cover.git
     cd diff-cover
-    poetry install
-    poetry shell
+    uv sync
+
+This creates a ``.venv`` with the project installed. Run commands through it with
+``uv run``, for example ``uv run diff-cover --help``, or activate it the usual way
+with ``source .venv/bin/activate``.
 
 
 Getting Started
@@ -508,17 +512,21 @@ Support for a New Quality Checker".
 Setting Up For Development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This project is managed with `poetry` this can be installed with `pip`
-poetry manages a python virtual environment and organizes dependencies. It also
-packages this project.
+This project is managed with `uv <https://docs.astral.sh/uv/>`_. uv provisions the
+Python toolchain and a project virtual environment, resolves and locks dependencies,
+and packages this project. Install it by following the
+`uv installation guide <https://docs.astral.sh/uv/getting-started/installation/>`_.
 
 .. code:: bash
 
-    pip install poetry
+    uv sync
+
+This creates ``.venv`` with all runtime and development dependencies. Run project
+commands through ``uv run``, for example the full verification suite:
 
 .. code:: bash
 
-    poetry install
+    uv run ./verify.sh
 
 I would also suggest running this command after. This will make it so git blame ignores the commit
 that formatted the entire codebase.
@@ -649,4 +657,3 @@ Originally created with the support of `edX
 .. |build-status| image:: https://github.com/bachmann1234/diff_cover/actions/workflows/verify.yaml/badge.svg?branch=main
     :target: https://github.com/Bachmann1234/diff_cover/actions/workflows/verify.yaml
     :alt: Build Status
-

{diff_cover-10.5.0 → diff_cover-10.6.0}/README.rst

@@ -64,8 +64,11 @@ To install the development version:
 
     git clone https://github.com/Bachmann1234/diff-cover.git
     cd diff-cover
-    poetry install
-    poetry shell
+    uv sync
+
+This creates a ``.venv`` with the project installed. Run commands through it with
+``uv run``, for example ``uv run diff-cover --help``, or activate it the usual way
+with ``source .venv/bin/activate``.
 
 
 Getting Started
@@ -476,17 +479,21 @@ Support for a New Quality Checker".
 Setting Up For Development
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This project is managed with `poetry` this can be installed with `pip`
-poetry manages a python virtual environment and organizes dependencies. It also
-packages this project.
+This project is managed with `uv <https://docs.astral.sh/uv/>`_. uv provisions the
+Python toolchain and a project virtual environment, resolves and locks dependencies,
+and packages this project. Install it by following the
+`uv installation guide <https://docs.astral.sh/uv/getting-started/installation/>`_.
 
 .. code:: bash
 
-    pip install poetry
+    uv sync
+
+This creates ``.venv`` with all runtime and development dependencies. Run project
+commands through ``uv run``, for example the full verification suite:
 
 .. code:: bash
 
-    poetry install
+    uv run ./verify.sh
 
 I would also suggest running this command after. This will make it so git blame ignores the commit
 that formatted the entire codebase.

{diff_cover-10.5.0 → diff_cover-10.6.0}/diff_cover/command_runner.py

@@ -1,6 +1,8 @@
 import subprocess
 import sys
 
+GIT_INSTALL_URL = "https://git-scm.com/book/en/v2/Getting-Started-Installing-Git"
+
 
 class CommandError(Exception):
     """
@@ -8,6 +10,16 @@ class CommandError(Exception):
     """
 
 
+class ExecutableNotFoundError(CommandError):
+    """
+    Error raised when the executable of a command cannot be found at all.
+
+    This is a `CommandError` so that existing handling keeps working, but a
+    distinct type so the command line tools can tell "your tooling is not
+    installed" apart from "the command ran and failed".
+    """
+
+
 def execute(command, exit_codes=None):
     """Execute provided command returning the stdout
     Args:
@@ -24,7 +36,12 @@ def execute(command, exit_codes=None):
         exit_codes = [0]
 
     stdout_pipe = subprocess.PIPE
-    with subprocess.Popen(command, stdout=stdout_pipe, stderr=stdout_pipe) as process:
+    try:
+        popen = subprocess.Popen(command, stdout=stdout_pipe, stderr=stdout_pipe)
+    except FileNotFoundError as exc:
+        raise ExecutableNotFoundError(_executable_not_found_message(command)) from exc
+
+    with popen as process:
         try:
             stdout, stderr = process.communicate()
         except OSError:
@@ -52,6 +69,20 @@ def run_command_for_code(command):
     return process.returncode
 
 
+def _executable_not_found_message(command):
+    """
+    Explain that the executable of `command` is not installed or not on PATH.
+    """
+    executable = _ensure_unicode(command[0]) if command else ""
+    message = (
+        f"'{executable}' was not found. diff-cover needs '{executable}' to be "
+        "installed and on your PATH in order to run."
+    )
+    if executable == "git":
+        message += f" See {GIT_INSTALL_URL} for installation instructions."
+    return message
+
+
 def _ensure_unicode(text):
     """
     Ensures the text passed in becomes unicode

{diff_cover-10.5.0 → diff_cover-10.6.0}/diff_cover/diff_cover_tool.py

@@ -7,6 +7,7 @@ import warnings
 import xml.etree.ElementTree as etree
 
 from diff_cover import DESCRIPTION, VERSION
+from diff_cover.command_runner import ExecutableNotFoundError
 from diff_cover.config_parser import Tool, get_config
 from diff_cover.diff_reporter import GitDiffReporter
 from diff_cover.git_diff import GitDiffFileTool, GitDiffTool
@@ -33,6 +34,7 @@ CSS_FILE_HELP = "Write CSS into an external file"
 FAIL_UNDER_HELP = (
     "Returns an error code if coverage or quality score is below this value"
 )
+MINIMUM_CHANGE_HELP = "Always pass if total lines of change is below this value"
 IGNORE_STAGED_HELP = "Ignores staged changes"
 IGNORE_UNSTAGED_HELP = "Ignores unstaged changes"
 IGNORE_WHITESPACE = "When getting a diff ignore any and all whitespace"
@@ -155,6 +157,13 @@ def parse_coverage_args(argv):
     parser.add_argument(
         "--fail-under", metavar="SCORE", type=float, default=None, help=FAIL_UNDER_HELP
     )
+    parser.add_argument(
+        "--minimum-change",
+        metavar="LINES",
+        type=int,
+        default=None,
+        help=MINIMUM_CHANGE_HELP,
+    )
 
     parser.add_argument(
         "--ignore-staged", action="store_true", default=None, help=IGNORE_STAGED_HELP
@@ -229,6 +238,7 @@ def parse_coverage_args(argv):
         "compare_branch": "origin/main",
         "format": {},
         "fail_under": 0,
+        "minimum_change": 0,
         "ignore_staged": False,
         "ignore_unstaged": False,
         "ignore_untracked": False,
@@ -353,7 +363,7 @@ def generate_coverage_report(
 
     # Generate the report
     reporter.generate_report(output_file)
-    return reporter.total_percent_covered()
+    return reporter.total_percent_covered(), reporter.total_num_lines()
 
 
 def handle_old_format(description, argv):
@@ -418,8 +428,13 @@ def main(argv=None, directory=None):
     level = logging.ERROR if quiet else logging.WARNING
     logging.basicConfig(format="%(message)s", level=level)
 
-    GitPathTool.set_cwd(directory)
+    try:
+        GitPathTool.set_cwd(directory)
+    except ExecutableNotFoundError as exc:
+        LOGGER.error("%s", exc)
+        return 1
     fail_under = arg_dict.get("fail_under")
+    minimum_change = arg_dict.get("minimum_change") or 0
     diff_tool = None
 
     if not arg_dict["diff_file"]:
@@ -429,7 +444,7 @@ def main(argv=None, directory=None):
     else:
         diff_tool = GitDiffFileTool(arg_dict["diff_file"])
 
-    percent_covered = generate_coverage_report(
+    percent_covered, num_changed_lines = generate_coverage_report(
         arg_dict["coverage_files"],
         arg_dict["compare_branch"],
         diff_tool,
@@ -449,7 +464,9 @@ def main(argv=None, directory=None):
         total_percent_float=arg_dict["total_percent_float"],
     )
 
-    if percent_covered >= fail_under:
+    if percent_covered >= fail_under or (
+        minimum_change and num_changed_lines < minimum_change
+    ):
         return 0
     LOGGER.error("Failure. Coverage is below %i%%.", fail_under)
     return 1

{diff_cover-10.5.0 → diff_cover-10.6.0}/diff_cover/diff_quality_tool.py

@@ -14,6 +14,7 @@ import pluggy
 
 import diff_cover
 from diff_cover import hookspecs
+from diff_cover.command_runner import ExecutableNotFoundError
 from diff_cover.config_parser import Tool, get_config
 from diff_cover.diff_cover_tool import (
     COMPARE_BRANCH_HELP,
@@ -30,6 +31,7 @@ from diff_cover.diff_cover_tool import (
     INCLUDE_UNTRACKED_HELP,
     JSON_REPORT_DEFAULT_PATH,
     MARKDOWN_REPORT_DEFAULT_PATH,
+    MINIMUM_CHANGE_HELP,
     QUIET_HELP,
     TOTAL_PERCENT_FLOAT_HELP,
     format_type,
@@ -146,6 +148,12 @@ def parse_quality_args(argv):
     parser.add_argument(
         "--fail-under", metavar="SCORE", type=float, help=FAIL_UNDER_HELP
     )
+    parser.add_argument(
+        "--minimum-change",
+        metavar="LINES",
+        type=int,
+        help=MINIMUM_CHANGE_HELP,
+    )
 
     parser.add_argument(
         "--ignore-staged", action="store_true", default=None, help=IGNORE_STAGED_HELP
@@ -217,6 +225,7 @@ def parse_quality_args(argv):
         "diff_range_notation": "...",
         "input_reports": [],
         "fail_under": 0,
+        "minimum_change": 0,
         "ignore_staged": False,
         "ignore_unstaged": False,
         "ignore_untracked": False,
@@ -297,7 +306,7 @@ def generate_quality_report(
     output_file = io.BytesIO() if quiet else sys.stdout.buffer
     reporter.generate_report(output_file)
 
-    return reporter.total_percent_covered()
+    return reporter.total_percent_covered(), reporter.total_num_lines()
 
 
 def _call_reporter_factory(factory_fn, reports, options):
@@ -339,8 +348,13 @@ def main(argv=None, directory=None):
     level = logging.ERROR if quiet else logging.WARNING
     logging.basicConfig(format="%(message)s", level=level)
 
-    GitPathTool.set_cwd(directory)
+    try:
+        GitPathTool.set_cwd(directory)
+    except ExecutableNotFoundError as exc:
+        LOGGER.error("%s", exc)
+        return 1
     fail_under = arg_dict.get("fail_under")
+    minimum_change = arg_dict.get("minimum_change") or 0
     tool = arg_dict["violations"]
     user_options = arg_dict.get("options")
     if user_options:
@@ -394,7 +408,7 @@ def main(argv=None, directory=None):
                     reporter_factory_fn, input_reports, user_options
                 )
 
-            percent_passing = generate_quality_report(
+            percent_passing, num_changed_lines = generate_quality_report(
                 reporter,
                 arg_dict["compare_branch"],
                 GitDiffTool(
@@ -410,7 +424,10 @@ def main(argv=None, directory=None):
                 quiet=quiet,
                 total_percent_float=arg_dict["total_percent_float"],
             )
-            if percent_passing >= fail_under:
+
+            if percent_passing >= fail_under or (
+                minimum_change and num_changed_lines < minimum_change
+            ):
                 return 0
 
             LOGGER.error("Failure. Quality is below %i.", fail_under)

{diff_cover-10.5.0 → diff_cover-10.6.0}/diff_cover/git_diff.py

@@ -72,10 +72,12 @@ class GitDiffTool:
             )[0]
         except CommandError as e:
             if "unknown revision" in str(e):
-                raise ValueError(dedent(f"""
+                raise ValueError(
+                    dedent(f"""
                         Could not find the branch to compare to. Does '{compare_branch}' exist?
                         the `--compare-branch` argument allows you to set a different branch.
-                    """)) from e
+                    """)
+                ) from e
             raise
 
     def diff_unstaged(self):
@@ -115,7 +117,6 @@ class GitDiffTool:
 
 
 class GitDiffFileTool(GitDiffTool):
-
     def __init__(self, diff_file_path):
 
         self.diff_file_path = diff_file_path

diff_cover-10.6.0/diff_cover/violationsreporters/clover.py

@@ -0,0 +1,84 @@
+"""
+Reading the ``<file>`` elements of a Clover XML coverage report.
+"""
+
+import itertools
+from collections import defaultdict
+
+from diff_cover import util
+from diff_cover.git_path import GitPathTool
+
+
+class CloverFileIndex:
+    """
+    The ``<file>`` elements of one Clover report, indexed for lookup by path.
+
+    Building the index costs one walk of the document. Looking a source path up
+    by walking the document instead costs that walk once per source path, which
+    is quadratic in a report with many files.
+    """
+
+    def __init__(self, xml_document):
+        """
+        Index every ``<file>`` element of `xml_document`.
+
+        A file is matched either by its path relative to the repository root
+        or, when the report carries absolute paths, by a suffix test. The
+        suffix can only match when the last path segment does, so candidates
+        for it are grouped by that segment and the test is applied to the few
+        that share it.
+
+        Both tables store the document position of each element so that
+        lookups can return matches in document order, as a direct walk would.
+        """
+        self._by_relative_path = defaultdict(list)
+        self._by_last_segment = defaultdict(list)
+        for position, file_tree in enumerate(xml_document.findall(".//file")):
+            file_path = file_tree.get("path") or file_tree.get("name")
+            if not file_path:
+                continue
+
+            normalized_file_path = util.to_unix_path(file_path)
+            relative_file_path = util.to_unix_path(GitPathTool.relative_path(file_path))
+            self._by_relative_path[relative_file_path].append((position, file_tree))
+            self._by_last_segment[normalized_file_path.rsplit("/", 1)[-1]].append(
+                (position, normalized_file_path, file_tree)
+            )
+
+    def _files(self, src_path):
+        """
+        Return the ``<file>`` elements for `src_path`, in document order.
+        """
+        normalized_src_path = util.to_unix_path(src_path)
+
+        matches = {}
+        for position, file_tree in self._by_relative_path.get(normalized_src_path, ()):
+            matches[position] = file_tree
+        suffix = f"/{normalized_src_path}"
+        for position, normalized_file_path, file_tree in self._by_last_segment.get(
+            normalized_src_path.rsplit("/", 1)[-1], ()
+        ):
+            if normalized_file_path.endswith(suffix):
+                matches[position] = file_tree
+
+        return [matches[position] for position in sorted(matches)]
+
+    def line_nodes(self, src_path):
+        """
+        Return a list of nodes containing line information for `src_path`.
+
+        If the file is not present in the report, return None
+        """
+        files = self._files(src_path)
+        if not files:
+            return None
+        lines = []
+        for file_tree in files:
+            # Clover marks an executable line as one of these three types. PHPUnit's
+            # writer emits `method` for the declaration line of every function it
+            # measured; leaving it out reported those lines as unmeasured.
+            # https://github.com/sebastianbergmann/php-code-coverage/blob/main/src/Report/Clover.php
+            lines.append(file_tree.findall('./line[@type="method"]'))
+            lines.append(file_tree.findall('./line[@type="stmt"]'))
+            lines.append(file_tree.findall('./line[@type="cond"]'))
+        return list(itertools.chain(*lines))

{diff_cover-10.5.0 → diff_cover-10.6.0}/diff_cover/violationsreporters/violations_reporter.py

@@ -17,6 +17,7 @@ from diff_cover.violationsreporters.base import (
     RegexBasedDriver,
     Violation,
 )
+from diff_cover.violationsreporters.clover import CloverFileIndex
 
 
 class XmlCoverageReporter(BaseViolationReporter):
@@ -51,6 +52,9 @@ class XmlCoverageReporter(BaseViolationReporter):
         # once per source file in `_cache_file`.
         self._report_formats = [self._detect_report_format(root) for root in xml_roots]
 
+        # A `CloverFileIndex` for each Clover report, built on first use.
+        self._clover_file_index = [None] * len(xml_roots)
+
         self._src_roots = src_roots or [""]
         self._expand_coverage_report = expand_coverage_report
         self._branch_coverage = branch_coverage
@@ -125,41 +129,16 @@ class XmlCoverageReporter(BaseViolationReporter):
         lines = [clazz.findall("./lines/line") for clazz in classes]
         return list(itertools.chain(*lines))
 
-    @staticmethod
-    def get_src_path_line_nodes_clover(xml_document, src_path):
+    def get_src_path_line_nodes_clover(self, index, xml_document, src_path):
         """
         Return a list of nodes containing line information for `src_path`
         in `xml_document`.
 
         If file is not present in `xml_document`, return None
         """
-
-        files = []
-        normalized_src_path = util.to_unix_path(src_path)
-        for file_tree in xml_document.findall(".//file"):
-            file_path = file_tree.get("path") or file_tree.get("name")
-            if not file_path:
-                continue
-
-            normalized_file_path = util.to_unix_path(file_path)
-            relative_file_path = util.to_unix_path(GitPathTool.relative_path(file_path))
-            if (
-                relative_file_path == normalized_src_path
-                or normalized_file_path.endswith(f"/{normalized_src_path}")
-            ):
-                files.append(file_tree)
-        if not files:
-            return None
-        lines = []
-        for file_tree in files:
-            # Clover marks an executable line as one of these three types. PHPUnit's
-            # writer emits `method` for the declaration line of every function it
-            # measured; leaving it out reported those lines as unmeasured.
-            # https://github.com/sebastianbergmann/php-code-coverage/blob/main/src/Report/Clover.php
-            lines.append(file_tree.findall('./line[@type="method"]'))
-            lines.append(file_tree.findall('./line[@type="stmt"]'))
-            lines.append(file_tree.findall('./line[@type="cond"]'))
-        return list(itertools.chain(*lines))
+        if self._clover_file_index[index] is None:
+            self._clover_file_index[index] = CloverFileIndex(xml_document)
+        return self._clover_file_index[index].line_nodes(src_path)
 
     @staticmethod
     def _detect_report_format(xml_document):
@@ -246,7 +225,7 @@ class XmlCoverageReporter(BaseViolationReporter):
                 report_format = self._report_formats[i]
                 if report_format == "clover":
                     line_nodes = self.get_src_path_line_nodes_clover(
-                        xml_document, src_path
+                        i, xml_document, src_path
                     )
                     _number = "num"
                     _hits = "count"
@@ -475,9 +454,9 @@ class LcovCoverageReporter(BaseViolationReporter):
                         if not has_da_directive:
                             # No line execution data, use branch coverage
                             if info["total"] > 0 and info["hit"] < info["total"]:
-                                lcov_report[source_file][
-                                    line_no
-                                ] = 0  # Partial branch coverage
+                                lcov_report[source_file][line_no] = (
+                                    0  # Partial branch coverage
+                                )
                             else:
                                 lcov_report[source_file][line_no] = info["executions"]
                             continue
@@ -955,7 +934,6 @@ class ClangFormatDriver(QualityDriver):
         """
         violations_dict = defaultdict(list)
         for report in reports:
-
             matches = list(re.finditer(self.clang_expression, report))
             for match in matches:
                 if match is not None: