diff-cover 10.0.0__tar.gz → 10.2.0__tar.gz

{diff_cover-10.0.0 → diff_cover-10.2.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: diff_cover
-Version: 10.0.0
+Version: 10.2.0
 Summary: Run coverage and linting reports on diffs
 License: Apache-2.0
 Author: See Contributors
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -12,7 +12,6 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -88,7 +87,7 @@ To install the latest release:
 
 .. code:: bash
 
-    pip install diff_cover
+    pip install diff-cover
 
 
 To install the development version:
@@ -252,6 +251,18 @@ You can then run ``diff-cover`` with the diff file as an argument:
 
     diff-cover coverage.xml --diff-file=diff.txt
 
+Total Percent Formatting
+------------------------
+
+By default, ``diff-cover`` and ``diff-quality`` round the total coverage/quality
+percentage to an integer. To keep up to two decimal places, use
+``--total-percent-float``:
+
+.. code:: bash
+
+    diff-cover coverage.xml --total-percent-float
+    diff-quality --violations=pycodestyle --total-percent-float
+
 Fail Under
 ----------
 

{diff_cover-10.0.0 → diff_cover-10.2.0}/README.rst

@@ -55,7 +55,7 @@ To install the latest release:
 
 .. code:: bash
 
-    pip install diff_cover
+    pip install diff-cover
 
 
 To install the development version:
@@ -219,6 +219,18 @@ You can then run ``diff-cover`` with the diff file as an argument:
 
     diff-cover coverage.xml --diff-file=diff.txt
 
+Total Percent Formatting
+------------------------
+
+By default, ``diff-cover`` and ``diff-quality`` round the total coverage/quality
+percentage to an integer. To keep up to two decimal places, use
+``--total-percent-float``:
+
+.. code:: bash
+
+    diff-cover coverage.xml --total-percent-float
+    diff-quality --violations=pycodestyle --total-percent-float
+
 Fail Under
 ----------
 

{diff_cover-10.0.0 → diff_cover-10.2.0}/diff_cover/diff_cover_tool.py

@@ -51,6 +51,9 @@ EXPAND_COVERAGE_REPORT = (
 INCLUDE_UNTRACKED_HELP = "Include untracked files"
 CONFIG_FILE_HELP = "The configuration file to use"
 DIFF_FILE_HELP = "The diff file to use"
+TOTAL_PERCENT_FLOAT_HELP = (
+    "Show total coverage/quality as a float rounded to 2 decimal places"
+)
 
 LOGGER = logging.getLogger(__name__)
 
@@ -181,6 +184,12 @@ def parse_coverage_args(argv):
     )
 
     parser.add_argument("--diff-file", type=str, default=None, help=DIFF_FILE_HELP)
+    parser.add_argument(
+        "--total-percent-float",
+        action="store_true",
+        default=None,
+        help=TOTAL_PERCENT_FLOAT_HELP,
+    )
 
     defaults = {
         "show_uncovered": False,
@@ -194,6 +203,7 @@ def parse_coverage_args(argv):
         "diff_range_notation": "...",
         "quiet": False,
         "expand_coverage_report": False,
+        "total_percent_float": False,
     }
 
     return get_config(parser=parser, argv=argv, defaults=defaults, tool=Tool.DIFF_COVER)
@@ -214,6 +224,7 @@ def generate_coverage_report(
     quiet=False,
     show_uncovered=False,
     expand_coverage_report=False,
+    total_percent_float=False,
 ):
     """
     Generate the diff coverage report, using kwargs from `parse_args()`.
@@ -251,7 +262,9 @@ def generate_coverage_report(
         css_url = css_file
         if css_url is not None:
             css_url = os.path.relpath(css_file, os.path.dirname(html_report))
-        reporter = HtmlReportGenerator(coverage, diff, css_url=css_url)
+        reporter = HtmlReportGenerator(
+            coverage, diff, css_url=css_url, total_percent_float=total_percent_float
+        )
         with open_file(html_report, "wb") as output_file:
             reporter.generate_report(output_file)
         if css_file is not None:
@@ -260,13 +273,17 @@ def generate_coverage_report(
 
     if "json" in report_formats:
         json_report = report_formats["json"] or JSON_REPORT_DEFAULT_PATH
-        reporter = JsonReportGenerator(coverage, diff)
+        reporter = JsonReportGenerator(
+            coverage, diff, total_percent_float=total_percent_float
+        )
         with open_file(json_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
     if "markdown" in report_formats:
         markdown_report = report_formats["markdown"] or MARKDOWN_REPORT_DEFAULT_PATH
-        reporter = MarkdownReportGenerator(coverage, diff)
+        reporter = MarkdownReportGenerator(
+            coverage, diff, total_percent_float=total_percent_float
+        )
         with open_file(markdown_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
@@ -276,11 +293,17 @@ def generate_coverage_report(
             coverage,
             diff,
             report_formats["github-annotations"],
+            total_percent_float=total_percent_float,
         )
         reporter.generate_report(sys.stdout.buffer)
 
     # Generate the report for stdout
-    reporter = StringReportGenerator(coverage, diff, show_uncovered)
+    reporter = StringReportGenerator(
+        coverage,
+        diff,
+        show_uncovered,
+        total_percent_float=total_percent_float,
+    )
     output_file = io.BytesIO() if quiet else sys.stdout.buffer
 
     # Generate the report
@@ -376,6 +399,7 @@ def main(argv=None, directory=None):
         quiet=quiet,
         show_uncovered=arg_dict["show_uncovered"],
         expand_coverage_report=arg_dict["expand_coverage_report"],
+        total_percent_float=arg_dict["total_percent_float"],
     )
 
     if percent_covered >= fail_under:

{diff_cover-10.0.0 → diff_cover-10.2.0}/diff_cover/diff_quality_tool.py

@@ -30,6 +30,7 @@ from diff_cover.diff_cover_tool import (
     JSON_REPORT_DEFAULT_PATH,
     MARKDOWN_REPORT_DEFAULT_PATH,
     QUIET_HELP,
+    TOTAL_PERCENT_FLOAT_HELP,
     format_type,
     handle_old_format,
 )
@@ -200,6 +201,12 @@ def parse_quality_args(argv):
     parser.add_argument(
         "--report-root-path", help=REPORT_ROOT_PATH_HELP, metavar="ROOT_PATH"
     )
+    parser.add_argument(
+        "--total-percent-float",
+        action="store_true",
+        default=None,
+        help=TOTAL_PERCENT_FLOAT_HELP,
+    )
 
     defaults = {
         "ignore_whitespace": False,
@@ -211,6 +218,7 @@ def parse_quality_args(argv):
         "ignore_unstaged": False,
         "ignore_untracked": False,
         "quiet": False,
+        "total_percent_float": False,
     }
 
     return get_config(
@@ -230,6 +238,7 @@ def generate_quality_report(
     exclude=None,
     include=None,
     quiet=False,
+    total_percent_float=False,
 ):
     """
     Generate the quality report, using kwargs from `parse_args()`.
@@ -253,7 +262,9 @@ def generate_quality_report(
         css_url = css_file
         if css_url is not None:
             css_url = os.path.relpath(css_file, os.path.dirname(html_report))
-        reporter = HtmlQualityReportGenerator(tool, diff, css_url=css_url)
+        reporter = HtmlQualityReportGenerator(
+            tool, diff, css_url=css_url, total_percent_float=total_percent_float
+        )
         with open_file(html_report, "wb") as output_file:
             reporter.generate_report(output_file)
         if css_file is not None:
@@ -262,18 +273,24 @@ def generate_quality_report(
 
     if "json" in report_formats:
         json_report = report_formats["json"] or JSON_REPORT_DEFAULT_PATH
-        reporter = JsonReportGenerator(tool, diff)
+        reporter = JsonReportGenerator(
+            tool, diff, total_percent_float=total_percent_float
+        )
         with open_file(json_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
     if "markdown" in report_formats:
         markdown_report = report_formats["markdown"] or MARKDOWN_REPORT_DEFAULT_PATH
-        reporter = MarkdownQualityReportGenerator(tool, diff)
+        reporter = MarkdownQualityReportGenerator(
+            tool, diff, total_percent_float=total_percent_float
+        )
         with open_file(markdown_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
     # Generate the report for stdout
-    reporter = StringQualityReportGenerator(tool, diff)
+    reporter = StringQualityReportGenerator(
+        tool, diff, total_percent_float=total_percent_float
+    )
     output_file = io.BytesIO() if quiet else sys.stdout.buffer
     reporter.generate_report(output_file)
 
@@ -367,6 +384,7 @@ def main(argv=None, directory=None):
                 exclude=arg_dict["exclude"],
                 include=arg_dict["include"],
                 quiet=quiet,
+                total_percent_float=arg_dict["total_percent_float"],
             )
             if percent_passing >= fail_under:
                 return 0

{diff_cover-10.0.0 → diff_cover-10.2.0}/diff_cover/git_path.py

@@ -36,6 +36,10 @@ class GitPathTool:
         """
         Returns git_diff_path relative to cwd.
         """
+        # If GitPathTool hasn't been initialized, return the path unchanged
+        if cls._cwd is None or cls._root is None:
+            return git_diff_path
+
         # Remove git_root from src_path for searching the correct filename
         # If cwd is `/home/user/work/diff-cover/diff_cover`
         # and src_path is `diff_cover/violations_reporter.py`

{diff_cover-10.0.0 → diff_cover-10.2.0}/diff_cover/report_generator.py

@@ -42,7 +42,7 @@ class BaseReportGenerator(ABC):
     Generate a diff coverage report.
     """
 
-    def __init__(self, violations_reporter, diff_reporter):
+    def __init__(self, violations_reporter, diff_reporter, total_percent_float=False):
         """
         Configure the report generator to build a report
         from `violations_reporter` (of type BaseViolationReporter)
@@ -50,6 +50,7 @@ class BaseReportGenerator(ABC):
         """
         self._violations = violations_reporter
         self._diff = diff_reporter
+        self._total_percent_float = total_percent_float
         self._diff_violations_dict = None
 
         self._cache_violations = None
@@ -169,9 +170,12 @@ class BaseReportGenerator(ABC):
 
         if total_lines > 0:
             num_covered = total_lines - self.total_num_violations()
-            return int(float(num_covered) / total_lines * 100)
+            total_percent = float(num_covered) / total_lines * 100
+            if self._total_percent_float:
+                return round(total_percent, 2)
+            return int(total_percent)
 
-        return 100
+        return 100.0 if self._total_percent_float else 100
 
     def num_changed_lines(self):
         """Returns the number of changed lines."""
@@ -285,8 +289,18 @@ class TemplateReportGenerator(BaseReportGenerator):
     # that they want to include source file snippets.
     include_snippets = False
 
-    def __init__(self, violations_reporter, diff_reporter, css_url=None):
-        super().__init__(violations_reporter, diff_reporter)
+    def __init__(
+        self,
+        violations_reporter,
+        diff_reporter,
+        css_url=None,
+        total_percent_float=False,
+    ):
+        super().__init__(
+            violations_reporter,
+            diff_reporter,
+            total_percent_float=total_percent_float,
+        )
         self.css_url = css_url
 
     def generate_report(self, output_file):
@@ -347,7 +361,12 @@ class TemplateReportGenerator(BaseReportGenerator):
             snippet_style = None
 
         context = super().report_dict()
-        context.update({"css_url": self.css_url, "snippet_style": snippet_style})
+        context.update(
+            {
+                "css_url": self.css_url,
+                "snippet_style": snippet_style,
+            }
+        )
 
         return context
 
@@ -413,8 +432,18 @@ class StringReportGenerator(TemplateReportGenerator):
 
     template_path = "console_coverage_report.txt"
 
-    def __init__(self, violations_reporter, diff_reporter, show_uncovered=False):
-        super().__init__(violations_reporter, diff_reporter)
+    def __init__(
+        self,
+        violations_reporter,
+        diff_reporter,
+        show_uncovered=False,
+        total_percent_float=False,
+    ):
+        super().__init__(
+            violations_reporter,
+            diff_reporter,
+            total_percent_float=total_percent_float,
+        )
         self.include_snippets = show_uncovered
 
 
@@ -429,8 +458,18 @@ class GitHubAnnotationsReportGenerator(TemplateReportGenerator):
 
     template_path = "github_coverage_annotations.txt"
 
-    def __init__(self, violations_reporter, diff_reporter, annotations_type):
-        super().__init__(violations_reporter, diff_reporter)
+    def __init__(
+        self,
+        violations_reporter,
+        diff_reporter,
+        annotations_type,
+        total_percent_float=False,
+    ):
+        super().__init__(
+            violations_reporter,
+            diff_reporter,
+            total_percent_float=total_percent_float,
+        )
         self.annotations_type = annotations_type
 
     def _context(self):

{diff_cover-10.0.0 → diff_cover-10.2.0}/diff_cover/violationsreporters/base.py

@@ -6,6 +6,7 @@ from abc import ABC, abstractmethod
 from collections import defaultdict, namedtuple
 
 from diff_cover.command_runner import execute, run_command_for_code
+from diff_cover.git_path import GitPathTool
 from diff_cover.util import to_unix_path
 
 Violation = namedtuple("Violation", "line, message")
@@ -152,14 +153,19 @@ class QualityReporter(BaseViolationReporter):
         if not any(src_path.endswith(ext) for ext in self.driver.supported_extensions):
             return []
 
-        if src_path not in self.violations_dict:
+        # `src_path` is relative to the git root. We convert it to be relative to
+        # the current working directory, since quality tools report paths relative
+        # to the current working directory.
+        relative_src_path = to_unix_path(GitPathTool.relative_path(src_path))
+
+        if relative_src_path not in self.violations_dict:
             if self.reports:
                 self.violations_dict = self.driver.parse_reports(self.reports)
-                return self.violations_dict[src_path]
+                return self.violations_dict[relative_src_path]
 
-            if not os.path.exists(src_path):
-                self.violations_dict[src_path] = []
-                return self.violations_dict[src_path]
+            if not os.path.exists(relative_src_path):
+                self.violations_dict[relative_src_path] = []
+                return self.violations_dict[relative_src_path]
 
             if self.driver_tool_installed is None:
                 self.driver_tool_installed = self.driver.installed()
@@ -170,13 +176,13 @@ class QualityReporter(BaseViolationReporter):
             if self.options:
                 for arg in self.options.split():
                     command.append(arg)
-            command.append(src_path.encode(sys.getfilesystemencoding()))
+            command.append(relative_src_path.encode(sys.getfilesystemencoding()))
 
             stdout, stderr = execute(command, self.driver.exit_codes)
             output = stderr if self.driver.output_stderr else stdout
             self.violations_dict.update(self.driver.parse_reports([output]))
 
-        return self.violations_dict[src_path]
+        return self.violations_dict[relative_src_path]
 
     def measured_lines(self, src_path):
         """

{diff_cover-10.0.0 → diff_cover-10.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "diff_cover"
-version = "10.0.0"
+version = "10.2.0"
 description = "Run coverage and linting reports on diffs"
 authors = ["See Contributors"]
 homepage = "https://github.com/Bachmann1234/diff-cover"
@@ -40,7 +40,7 @@ diff-cover = 'diff_cover.diff_cover_tool:main'
 diff-quality = 'diff_cover.diff_quality_tool:main'
 
 [tool.poetry.dependencies]
-python = ">=3.9"
+python = ">=3.10"
 Pygments = "^2.19.1"
 Jinja2 = ">=2.7.1"
 pluggy = ">=0.13.1,<2"
@@ -55,12 +55,12 @@ pytest-xdist = "^3.6.1"
 pycodestyle = ">=2.9.1"
 flake8-pyproject = "^1.2.3"
 pyflakes = "^3.3.2"
-pylint = "^3.3.4"
+pylint = ">=3.3.4,<5.0.0"
 pylint-pytest = "^1.1.8"
 pydocstyle = "^6.1.1"
 black = "^25.1.0"
 isort = "^6.0.1"
-doc8 = "1.1.2"
+doc8 = "2.0.0"
 ruff = ">=0.11.10,<0.15.0"
 
 [tool.poetry.extras]

diff_cover-10.2.0/tests/conftest.py

@@ -0,0 +1,17 @@
+import pytest
+
+from diff_cover.git_path import GitPathTool
+
+
+@pytest.fixture(autouse=True)
+def reset_git_path_tool():
+    """Reset GitPathTool before each test to ensure test isolation.
+
+    GitPathTool uses class variables (_cwd and _root) that persist across tests.
+    This fixture ensures each test starts with a clean state.
+    """
+    GitPathTool._cwd = None
+    GitPathTool._root = None
+    yield
+    GitPathTool._cwd = None
+    GitPathTool._root = None

diff_cover-10.2.0/tests/fixtures/add_json_report_float.json

@@ -0,0 +1,49 @@
+{
+    "report_name": "XML",
+    "diff_name": "origin/main...HEAD, staged and unstaged changes",
+    "src_stats": {
+        "test_src.txt": {
+            "percent_covered": 50.0,
+            "violation_lines": [
+                2,
+                4,
+                6,
+                8,
+                10
+            ],
+            "covered_lines": [
+                1,
+                3,
+                5,
+                7,
+                9
+            ],
+            "violations": [
+                [
+                    2,
+                    null
+                ],
+                [
+                    4,
+                    null
+                ],
+                [
+                    6,
+                    null
+                ],
+                [
+                    8,
+                    null
+                ],
+                [
+                    10,
+                    null
+                ]
+            ]
+        }
+    },
+    "total_num_lines": 10,
+    "total_num_violations": 5,
+    "total_percent_covered": 50.0,
+    "num_changed_lines": 10
+}

diff_cover-10.2.0/tests/fixtures/pycodestyle_violations_report_float.json

@@ -0,0 +1,40 @@
+{
+    "report_name": "pycodestyle",
+    "diff_name": "origin/main...HEAD, staged and unstaged changes",
+    "src_stats": {
+        "violations_test_file.py": {
+            "percent_covered": 66.66666666666667,
+            "violation_lines": [
+                2,
+                6,
+                11
+            ],
+            "covered_lines": [
+                1,
+                7,
+                8,
+                9,
+                10,
+                12
+            ],
+            "violations": [
+                [
+                    2,
+                    "E225 missing whitespace around operator"
+                ],
+                [
+                    6,
+                    "E302 expected 2 blank lines, found 0"
+                ],
+                [
+                    11,
+                    "E225 missing whitespace around operator"
+                ]
+            ]
+        }
+    },
+    "total_num_lines": 9,
+    "total_num_violations": 3,
+    "total_percent_covered": 66.67,
+    "num_changed_lines": 9
+}

{diff_cover-10.0.0 → diff_cover-10.2.0}/tests/test_integration.py

@@ -186,6 +186,22 @@ class TestDiffCoverIntegration:
         compare_json("add_json_report.json", "dummy/diff_coverage.json")
         compare_markdown("add_markdown_report.md", "dummy/diff_coverage.md")
 
+    def test_json_report_total_percent_float(self, runbin, patch_git_command):
+        patch_git_command.set_stdout("git_diff_add.txt")
+        assert (
+            runbin(
+                [
+                    "coverage.xml",
+                    "--format",
+                    "json:dummy/diff_coverage.json",
+                    "--total-percent-float",
+                    "-q",
+                ]
+            )
+            == 0
+        )
+        compare_json("add_json_report_float.json", "dummy/diff_coverage.json")
+
     def test_all_reports_with_stdout(self, runbin, patch_git_command, capsys):
         patch_git_command.set_stdout("git_diff_add.txt")
         assert (
@@ -610,6 +626,24 @@ class TestDiffQualityIntegration:
         compare_json("pycodestyle_violations_report.json", "dummy/diff_coverage.json")
         compare_markdown("pycodestyle_violations_report.md", "dummy/diff_coverage.md")
 
+    def test_json_report_total_percent_float(self, runbin, patch_git_command):
+        patch_git_command.set_stdout("git_diff_violations.txt")
+        assert (
+            runbin(
+                [
+                    "--violations=pycodestyle",
+                    "--format",
+                    "json:dummy/diff_coverage.json",
+                    "--total-percent-float",
+                    "-q",
+                ]
+            )
+            == 0
+        )
+        compare_json(
+            "pycodestyle_violations_report_float.json", "dummy/diff_coverage.json"
+        )
+
     def test_added_file_pyflakes_html(self, runbin, patch_git_command):
         patch_git_command.set_stdout("git_diff_violations.txt")
         assert (

{diff_cover-10.0.0 → diff_cover-10.2.0}/tests/test_report_generator.py

@@ -212,6 +212,11 @@ class TestSimpleReportGenerator(BaseReportGeneratorTest):
         # individually.
         assert self.report.total_percent_covered() == 66
 
+    @pytest.mark.usefixtures("use_default_values")
+    def test_total_percent_covered_float(self, coverage, diff):
+        report = SimpleReportGenerator(coverage, diff, total_percent_float=True)
+        assert report.total_percent_covered() == pytest.approx(66.67)
+
 
 class TestTemplateReportGenerator(BaseReportGeneratorTest):
 
@@ -334,6 +339,24 @@ class TestJsonReportGenerator(BaseReportGeneratorTest):
 
         self.assert_report(expected)
 
+    @pytest.mark.usefixtures("use_default_values")
+    def test_total_percent_covered_float(self, coverage, diff):
+        output = BytesIO()
+        report = JsonReportGenerator(coverage, diff, total_percent_float=True)
+        report.generate_report(output)
+        report_data = json.loads(output.getvalue().decode("utf-8"))
+        assert isinstance(report_data["total_percent_covered"], float)
+        assert report_data["total_percent_covered"] == pytest.approx(66.67)
+
+    @pytest.mark.usefixtures("use_default_values")
+    def test_total_percent_covered_int(self, coverage, diff):
+        output = BytesIO()
+        report = JsonReportGenerator(coverage, diff)
+        report.generate_report(output)
+        report_data = json.loads(output.getvalue().decode("utf-8"))
+        assert isinstance(report_data["total_percent_covered"], int)
+        assert report_data["total_percent_covered"] == 66
+
 
 class TestStringReportGenerator(BaseReportGeneratorTest):
 
@@ -406,6 +429,14 @@ class TestStringReportGenerator(BaseReportGeneratorTest):
 
         self.assert_report(expected)
 
+    @pytest.mark.usefixtures("use_default_values")
+    def test_total_percent_covered_float(self, coverage, diff):
+        output = BytesIO()
+        report = StringReportGenerator(coverage, diff, total_percent_float=True)
+        report.generate_report(output)
+        report_output = output.getvalue().decode("utf-8")
+        assert "Coverage: 66.67%" in report_output
+
 
 class TestGitHubAnnotationsReportGenerator(BaseReportGeneratorTest):