diff-cover 9.2.3__tar.gz → 9.3.0__tar.gz

{diff_cover-9.2.3 → diff_cover-9.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: diff_cover
-Version: 9.2.3
+Version: 9.3.0
 Summary: Run coverage and linting reports on diffs
 License: Apache-2.0
 Author: See Contributors
@@ -25,7 +25,6 @@ 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: setuptools (>=17.0.0) ; python_version < "3.8"
 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
@@ -134,9 +133,10 @@ You can also generate an HTML, JSON or Markdown version of the report:
 
 .. code:: bash
 
-    diff-cover coverage.xml --html-report report.html
-    diff-cover coverage.xml --json-report report.json
-    diff-cover coverage.xml --markdown-report report.md
+    diff-cover coverage.xml --format html:report.html
+    diff-cover coverage.xml --format json:report.json
+    diff-cover coverage.xml --format markdown:report.md
+    diff-cover coverage.xml --format html:report.html,markdown:report.md
 
 Multiple XML Coverage Reports
 -------------------------------
@@ -161,7 +161,7 @@ You can use diff-cover to see quality reports on the diff as well by running
     diff-quality --violations=<tool>
 
 Where ``tool`` is the quality checker to use. Currently ``pycodestyle``, ``pyflakes``,
-``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml`` are supported, but more
+``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check`` are supported, but more
 checkers can (and should!) be supported. See the section "Adding `diff-quality``
 Support for a New Quality Checker".
 
@@ -173,9 +173,10 @@ Like ``diff-cover``, HTML, JSON or Markdown reports can be generated with
 
 .. code:: bash
 
-    diff-quality --violations=<tool> --html-report report.html
-    diff-quality --violations=<tool> --json-report report.json
-    diff-quality --violations=<tool> --markdown-report report.md
+    diff-quality --violations=<tool> --format html:report.html
+    diff-quality --violations=<tool> --format json:report.json
+    diff-quality --violations=<tool> --format markdown:report.md
+    diff-quality --violations=<tool> --format html:report.html,markdown:report.md
 
 If you have already generated a report using ``pycodestyle``, ``pyflakes``, ``flake8``,
 ``pylint``, ``checkstyle``, ``checkstylexml``, or ``findbugs`` you can pass the report

{diff_cover-9.2.3 → diff_cover-9.3.0}/README.rst

@@ -101,9 +101,10 @@ You can also generate an HTML, JSON or Markdown version of the report:
 
 .. code:: bash
 
-    diff-cover coverage.xml --html-report report.html
-    diff-cover coverage.xml --json-report report.json
-    diff-cover coverage.xml --markdown-report report.md
+    diff-cover coverage.xml --format html:report.html
+    diff-cover coverage.xml --format json:report.json
+    diff-cover coverage.xml --format markdown:report.md
+    diff-cover coverage.xml --format html:report.html,markdown:report.md
 
 Multiple XML Coverage Reports
 -------------------------------
@@ -128,7 +129,7 @@ You can use diff-cover to see quality reports on the diff as well by running
     diff-quality --violations=<tool>
 
 Where ``tool`` is the quality checker to use. Currently ``pycodestyle``, ``pyflakes``,
-``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml`` are supported, but more
+``flake8``, ``pylint``, ``checkstyle``, ``checkstylexml``, ``ruff check`` are supported, but more
 checkers can (and should!) be supported. See the section "Adding `diff-quality``
 Support for a New Quality Checker".
 
@@ -140,9 +141,10 @@ Like ``diff-cover``, HTML, JSON or Markdown reports can be generated with
 
 .. code:: bash
 
-    diff-quality --violations=<tool> --html-report report.html
-    diff-quality --violations=<tool> --json-report report.json
-    diff-quality --violations=<tool> --markdown-report report.md
+    diff-quality --violations=<tool> --format html:report.html
+    diff-quality --violations=<tool> --format json:report.json
+    diff-quality --violations=<tool> --format markdown:report.md
+    diff-quality --violations=<tool> --format html:report.html,markdown:report.md
 
 If you have already generated a report using ``pycodestyle``, ``pyflakes``, ``flake8``,
 ``pylint``, ``checkstyle``, ``checkstylexml``, or ``findbugs`` you can pass the report

diff_cover-9.3.0/diff_cover/__init__.py

@@ -0,0 +1,5 @@
+from importlib.metadata import version
+
+VERSION = version("diff_cover")
+DESCRIPTION = "Automatically find diff lines that need test coverage."
+QUALITY_DESCRIPTION = "Automatically find diff lines with quality violations."

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/command_runner.py

@@ -28,18 +28,7 @@ def execute(command, exit_codes=None):
     try:
         stdout, stderr = process.communicate()
     except OSError:
-        sys.stderr.write(
-            " ".join(
-                [
-                    (
-                        cmd.decode(sys.getfilesystemencoding())
-                        if isinstance(cmd, bytes)
-                        else cmd
-                    )
-                    for cmd in command
-                ]
-            )
-        )
+        sys.stderr.write(" ".join(_ensure_unicode(cmd) for cmd in command))
         raise
 
     stderr = _ensure_unicode(stderr)

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/diff_cover_tool.py

@@ -3,6 +3,7 @@ import io
 import logging
 import os
 import sys
+import warnings
 import xml.etree.ElementTree as etree
 
 from diff_cover import DESCRIPTION, VERSION
@@ -21,9 +22,10 @@ from diff_cover.violationsreporters.violations_reporter import (
     XmlCoverageReporter,
 )
 
-HTML_REPORT_HELP = "Diff coverage HTML output"
-JSON_REPORT_HELP = "Diff coverage JSON output"
-MARKDOWN_REPORT_HELP = "Diff coverage Markdown output"
+FORMAT_HELP = "Format to use"
+HTML_REPORT_DEFAULT_PATH = "diff-cover.html"
+JSON_REPORT_DEFAULT_PATH = "diff-cover.json"
+MARKDOWN_REPORT_DEFAULT_PATH = "diff-cover.md"
 COMPARE_BRANCH_HELP = "Branch to compare"
 CSS_FILE_HELP = "Write CSS into an external file"
 FAIL_UNDER_HELP = (
@@ -51,6 +53,19 @@ DIFF_FILE_HELP = "The diff file to use"
 LOGGER = logging.getLogger(__name__)
 
 
+def format_type(value):
+    """
+    Accepts:
+        --format html
+        --format json
+        --format json,html
+        --format html,json:path/to/file.json
+
+        return: dict of strings to paths
+    """
+    return dict((item.split(":") for item in value.split(",")) if value else {})
+
+
 def parse_coverage_args(argv):
     """
     Parse command line arguments, returning a dict of
@@ -72,24 +87,10 @@ def parse_coverage_args(argv):
     parser.add_argument("coverage_file", type=str, help=COVERAGE_FILE_HELP, nargs="+")
 
     parser.add_argument(
-        "--html-report",
-        metavar="FILENAME",
-        type=str,
-        help=HTML_REPORT_HELP,
-    )
-
-    parser.add_argument(
-        "--json-report",
-        metavar="FILENAME",
-        type=str,
-        help=JSON_REPORT_HELP,
-    )
-
-    parser.add_argument(
-        "--markdown-report",
-        metavar="FILENAME",
-        type=str,
-        help=MARKDOWN_REPORT_HELP,
+        "--format",
+        type=format_type,
+        default="",
+        help=FORMAT_HELP,
     )
 
     parser.add_argument(
@@ -203,10 +204,8 @@ def generate_coverage_report(
     coverage_files,
     compare_branch,
     diff_tool,
-    html_report=None,
+    report_formats=None,
     css_file=None,
-    json_report=None,
-    markdown_report=None,
     ignore_staged=False,
     ignore_unstaged=False,
     include_untracked=False,
@@ -248,7 +247,8 @@ def generate_coverage_report(
         coverage = LcovCoverageReporter(lcov_roots, src_roots)
 
     # Build a report generator
-    if html_report is not None:
+    if "html" in report_formats:
+        html_report = report_formats["html"] or HTML_REPORT_DEFAULT_PATH
         css_url = css_file
         if css_url is not None:
             css_url = os.path.relpath(css_file, os.path.dirname(html_report))
@@ -259,12 +259,14 @@ def generate_coverage_report(
             with open(css_file, "wb") as output_file:
                 reporter.generate_css(output_file)
 
-    if json_report is not None:
+    if "json" in report_formats:
+        json_report = report_formats["json"] or JSON_REPORT_DEFAULT_PATH
         reporter = JsonReportGenerator(coverage, diff)
         with open(json_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
-    if markdown_report is not None:
+    if "markdown" in report_formats:
+        markdown_report = report_formats["markdown"] or MARKDOWN_REPORT_DEFAULT_PATH
         reporter = MarkdownReportGenerator(coverage, diff)
         with open(markdown_report, "wb") as output_file:
             reporter.generate_report(output_file)
@@ -278,6 +280,53 @@ def generate_coverage_report(
     return reporter.total_percent_covered()
 
 
+def handle_old_format(description, argv):
+    parser = argparse.ArgumentParser(description=description)
+    arg_html = parser.add_argument("--html-report", type=str)
+    arg_json = parser.add_argument("--json-report", type=str)
+    arg_markdown = parser.add_argument("--markdown-report", type=str)
+    parser.add_argument("--format", type=str)
+
+    known_args, unknown_args = parser.parse_known_args(argv)
+    format_ = format_type(known_args.format)
+    if known_args.html_report:
+        if "html" in format_:
+            raise argparse.ArgumentError(
+                arg_html, "Cannot use along with --format html."
+            )
+        warnings.warn(
+            "The --html-report option is deprecated. "
+            f"Use --format html:{known_args.html_report} instead."
+        )
+        format_["html"] = known_args.html_report
+    if known_args.json_report:
+        if "json" in format_:
+            raise argparse.ArgumentError(
+                arg_json, "Cannot use along with --format json."
+            )
+        warnings.warn(
+            "The --json-report option is deprecated. "
+            f"Use --format json:{known_args.json_report} instead."
+        )
+        format_["json"] = known_args.json_report
+    if known_args.markdown_report:
+        if "markdown" in format_:
+            raise argparse.ArgumentError(
+                arg_markdown, "Cannot use along with --format markdown."
+            )
+        warnings.warn(
+            "The --markdown-report option is deprecated. "
+            f"Use --format markdown:{known_args.markdown_report} instead."
+        )
+        format_["markdown"] = known_args.markdown_report
+    if format_:
+        unknown_args += [
+            "--format",
+            ",".join(f"{k}:{v}" for k, v in format_.items()),  # noqa: E231
+        ]
+    return unknown_args
+
+
 def main(argv=None, directory=None):
     """
     Main entry point for the tool, script installed via pyproject.toml
@@ -287,7 +336,7 @@ def main(argv=None, directory=None):
     0 is successful run
     """
     argv = argv or sys.argv
-    arg_dict = parse_coverage_args(argv[1:])
+    arg_dict = parse_coverage_args(handle_old_format(DESCRIPTION, argv[1:]))
 
     quiet = arg_dict["quiet"]
     level = logging.ERROR if quiet else logging.WARNING
@@ -308,9 +357,7 @@ def main(argv=None, directory=None):
         arg_dict["coverage_file"],
         arg_dict["compare_branch"],
         diff_tool,
-        html_report=arg_dict["html_report"],
-        json_report=arg_dict["json_report"],
-        markdown_report=arg_dict["markdown_report"],
+        report_formats=arg_dict["format"],
         css_file=arg_dict["external_css_file"],
         ignore_staged=arg_dict["ignore_staged"],
         ignore_unstaged=arg_dict["ignore_unstaged"],

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/diff_quality_tool.py

@@ -20,14 +20,17 @@ from diff_cover.diff_cover_tool import (
     DIFF_RANGE_NOTATION_HELP,
     EXCLUDE_HELP,
     FAIL_UNDER_HELP,
-    HTML_REPORT_HELP,
+    FORMAT_HELP,
+    HTML_REPORT_DEFAULT_PATH,
     IGNORE_STAGED_HELP,
     IGNORE_UNSTAGED_HELP,
     IGNORE_WHITESPACE,
     INCLUDE_UNTRACKED_HELP,
-    JSON_REPORT_HELP,
-    MARKDOWN_REPORT_HELP,
+    JSON_REPORT_DEFAULT_PATH,
+    MARKDOWN_REPORT_DEFAULT_PATH,
     QUIET_HELP,
+    format_type,
+    handle_old_format,
 )
 from diff_cover.diff_reporter import GitDiffReporter
 from diff_cover.git_diff import GitDiffTool
@@ -54,6 +57,7 @@ from diff_cover.violationsreporters.violations_reporter import (
     pycodestyle_driver,
     pydocstyle_driver,
     pyflakes_driver,
+    ruff_check_driver,
     shellcheck_driver,
 )
 
@@ -62,6 +66,7 @@ QUALITY_DRIVERS = {
     "pycodestyle": pycodestyle_driver,
     "pyflakes": pyflakes_driver,
     "pylint": PylintDriver(),
+    "ruff.check": ruff_check_driver,
     "flake8": flake8_driver,
     "jshint": jshint_driver,
     "eslint": EslintDriver(),
@@ -105,24 +110,10 @@ def parse_quality_args(argv):
     )
 
     parser.add_argument(
-        "--html-report",
-        metavar="FILENAME",
-        type=str,
-        help=HTML_REPORT_HELP,
-    )
-
-    parser.add_argument(
-        "--json-report",
-        metavar="FILENAME",
-        type=str,
-        help=JSON_REPORT_HELP,
-    )
-
-    parser.add_argument(
-        "--markdown-report",
-        metavar="FILENAME",
-        type=str,
-        help=MARKDOWN_REPORT_HELP,
+        "--format",
+        type=format_type,
+        default="",
+        help=FORMAT_HELP,
     )
 
     parser.add_argument(
@@ -224,17 +215,14 @@ def parse_quality_args(argv):
 def generate_quality_report(
     tool,
     compare_branch,
-    html_report=None,
-    json_report=None,
-    markdown_report=None,
+    diff_tool,
+    report_formats=None,
     css_file=None,
     ignore_staged=False,
     ignore_unstaged=False,
     include_untracked=False,
     exclude=None,
     include=None,
-    diff_range_notation=None,
-    ignore_whitespace=False,
     quiet=False,
 ):
     """
@@ -245,7 +233,7 @@ def generate_quality_report(
     )
     diff = GitDiffReporter(
         compare_branch,
-        git_diff=GitDiffTool(diff_range_notation, ignore_whitespace),
+        git_diff=diff_tool,
         ignore_staged=ignore_staged,
         ignore_unstaged=ignore_unstaged,
         include_untracked=include_untracked,
@@ -254,7 +242,8 @@ def generate_quality_report(
         include=include,
     )
 
-    if html_report is not None:
+    if "html" in report_formats:
+        html_report = report_formats["html"] or HTML_REPORT_DEFAULT_PATH
         css_url = css_file
         if css_url is not None:
             css_url = os.path.relpath(css_file, os.path.dirname(html_report))
@@ -265,12 +254,14 @@ def generate_quality_report(
             with open(css_file, "wb") as output_file:
                 reporter.generate_css(output_file)
 
-    if json_report is not None:
+    if "json" in report_formats:
+        json_report = report_formats["json"] or JSON_REPORT_DEFAULT_PATH
         reporter = JsonReportGenerator(tool, diff)
         with open(json_report, "wb") as output_file:
             reporter.generate_report(output_file)
 
-    if markdown_report is not None:
+    if "markdown" in report_formats:
+        markdown_report = report_formats["markdown"] or MARKDOWN_REPORT_DEFAULT_PATH
         reporter = MarkdownQualityReportGenerator(tool, diff)
         with open(markdown_report, "wb") as output_file:
             reporter.generate_report(output_file)
@@ -293,7 +284,9 @@ def main(argv=None, directory=None):
     """
 
     argv = argv or sys.argv
-    arg_dict = parse_quality_args(argv[1:])
+    arg_dict = parse_quality_args(
+        handle_old_format(diff_cover.QUALITY_DESCRIPTION, argv[1:])
+    )
 
     quiet = arg_dict["quiet"]
     level = logging.ERROR if quiet else logging.WARNING
@@ -353,17 +346,16 @@ def main(argv=None, directory=None):
             percent_passing = generate_quality_report(
                 reporter,
                 arg_dict["compare_branch"],
-                html_report=arg_dict["html_report"],
-                json_report=arg_dict["json_report"],
-                markdown_report=arg_dict["markdown_report"],
+                GitDiffTool(
+                    arg_dict["diff_range_notation"], arg_dict["ignore_whitespace"]
+                ),
+                report_formats=arg_dict["format"],
                 css_file=arg_dict["external_css_file"],
                 ignore_staged=arg_dict["ignore_staged"],
                 ignore_unstaged=arg_dict["ignore_unstaged"],
                 include_untracked=arg_dict["include_untracked"],
                 exclude=arg_dict["exclude"],
                 include=arg_dict["include"],
-                diff_range_notation=arg_dict["diff_range_notation"],
-                ignore_whitespace=arg_dict["ignore_whitespace"],
                 quiet=quiet,
             )
             if percent_passing >= fail_under:

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/diff_reporter.py

@@ -484,9 +484,9 @@ class GitDiffReporter(BaseDiffReporter):
                 try:
                     return int(groups[0])
 
-                except ValueError:
+                except ValueError as e:
                     msg = f"Could not parse '{groups[0]}' as a line number"
-                    raise GitDiffError(msg)
+                    raise GitDiffError(msg) from e
 
             else:
                 msg = f"Could not find start of hunk in line '{line}'"

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/git_diff.py

@@ -5,6 +5,7 @@ Wrapper for `git diff` command.
 from textwrap import dedent
 
 from diff_cover.command_runner import CommandError, execute
+from diff_cover.util import to_unescaped_filename
 
 
 class GitDiffError(Exception):
@@ -40,6 +41,7 @@ class GitDiffTool:
          :param bool ignore_whitespace:
             Perform a diff but ignore any and all whitespace.
         """
+        self._untracked_cache = None
         self.range_notation = range_notation
         self._default_git_args = [
             "git",
@@ -79,7 +81,7 @@ class GitDiffTool:
                         the `--compare-branch` argument allows you to set a different branch.
                     """
                     )
-                )
+                ) from e
             raise
 
     def diff_unstaged(self):
@@ -106,10 +108,16 @@ class GitDiffTool:
 
     def untracked(self):
         """Return the untracked files."""
+        if self._untracked_cache is not None:
+            return self._untracked_cache
+
         output = execute(["git", "ls-files", "--exclude-standard", "--others"])[0]
-        if not output:
-            return []
-        return [line for line in output.splitlines() if line]
+        self._untracked_cache = []
+        if output:
+            self._untracked_cache = [
+                to_unescaped_filename(line) for line in output.splitlines() if line
+            ]
+        return self._untracked_cache
 
 
 class GitDiffFileTool(GitDiffTool):
@@ -128,14 +136,12 @@ class GitDiffFileTool(GitDiffTool):
         try:
             with open(self.diff_file_path, "r") as file:
                 return file.read()
-        except IOError as e:
-            raise ValueError(
-                dedent(
-                    f"""
-                    Could not read the diff file. Make sure '{self.diff_file_path}' exists?
-                    """
-                )
+        except OSError as e:
+            error_message = (
+                "Could not read the diff file. "
+                f"Make sure '{self.diff_file_path}' exists?"
             )
+            raise ValueError(error_message) from e
 
     def diff_unstaged(self):
         return ""

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/git_path.py

@@ -24,10 +24,7 @@ class GitPathTool:
         Set the cwd that is used to manipulate paths.
         """
         if not cwd:
-            try:
-                cwd = os.getcwdu()
-            except AttributeError:
-                cwd = os.getcwd()
+            cwd = os.getcwd()
         if isinstance(cwd, bytes):
             cwd = cwd.decode(sys.getdefaultencoding())
         cls._cwd = cwd

diff_cover-9.3.0/diff_cover/util.py

@@ -0,0 +1,56 @@
+import os.path
+import posixpath
+
+
+def to_unix_path(path):
+    """
+    Tries to ensure tha the path is a normalized unix path.
+    This seems to be the solution cobertura used....
+    https://github.com/cobertura/cobertura/blob/642a46eb17e14f51272c6962e64e56e0960918af/cobertura/src/main/java/net/sourceforge/cobertura/instrument/ClassPattern.java#L84
+
+    I know of at least one case where this will fail (\\) is allowed in unix paths.
+    But I am taking the bet that this is not common. We deal with source code.
+
+    :param path: string of the path to convert
+    :return: the unix version of that path
+    """
+    return posixpath.normpath(os.path.normcase(path).replace("\\", "/"))
+
+
+def to_unescaped_filename(filename: str) -> str:
+    """Try to unescape the given filename.
+
+    Some filenames given by git might be escaped with C-style escape sequences
+    and surrounded by double quotes.
+    """
+    if not (filename.startswith('"') and filename.endswith('"')):
+        return filename
+
+    # Remove surrounding quotes
+    unquoted = filename[1:-1]
+
+    # Handle C-style escape sequences
+    result = []
+    i = 0
+    while i < len(unquoted):
+        if unquoted[i] == "\\" and i + 1 < len(unquoted):
+            # Handle common C escape sequences
+            next_char = unquoted[i + 1]
+            result.append(
+                {
+                    "\\": "\\",
+                    '"': '"',
+                    "a": "a",
+                    "n": "\n",
+                    "t": "\t",
+                    "r": "\r",
+                    "b": "\b",
+                    "f": "\f",
+                }.get(next_char, next_char)
+            )
+            i += 2
+        else:
+            result.append(unquoted[i])
+            i += 1
+
+    return "".join(result)

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/violationsreporters/java_violations_reporter.py

@@ -3,15 +3,9 @@ Classes for querying the information in a test coverage report.
 """
 
 import os
+import xml.etree.ElementTree as etree
 from collections import defaultdict
 
-try:
-    # Needed for Python < 3.3, works up to 3.8
-    import xml.etree.ElementTree as etree
-except ImportError:
-    # Python 3.9 onwards
-    import xml.etree.ElementTree as etree
-
 from diff_cover.command_runner import run_command_for_code
 from diff_cover.git_path import GitPathTool
 from diff_cover.violationsreporters.base import (

{diff_cover-9.2.3 → diff_cover-9.3.0}/diff_cover/violationsreporters/violations_reporter.py

@@ -476,6 +476,20 @@ pyflakes_driver = RegexBasedDriver(
     exit_codes=[0, 1],
 )
 
+ruff_check_driver = RegexBasedDriver(
+    name="ruff.check",
+    supported_extensions=["py"],
+    command=["ruff", "check"],
+    # Match lines of the form:
+    # path/to/file.py:328:27 F541 [*] f-string without any placeholders
+    # path/to/file.py:418:26 F841 [*] Local variable `e` is assigned to but never used
+    expression=r"^([^:]+):(\d+):\d*:? (.*)$",
+    command_to_check_install=["ruff", "--version"],
+    # ruff exit code is 1 if there are violations
+    # https://docs.astral.sh/ruff/linter/#exit-codes
+    exit_codes=[0, 1],
+)
+
 """
     Report Flake8 violations.
 """