Use forward slashes in relative paths on Windows #991
Labels
Comments
|
Have you tried using "--parallel=True", and then "coverage combine" with a "[paths]" setting to rewrite the paths as you need? |
|
I've been manually renaming the coverage files in their respective CI jobs which I think covers the I've updated the description to include an example report generated on Windows from 4 test runs (2 Linux, 2 Windows). This doesn't work at all trying to report on Linux because it can't find any files with backslashes in, while Windows happily deals with the forward slashes used in the Linux results. |
|
I can confirm that the following [tool.coverage.paths]
source = ["src", "*/site-packages"]
tests = ["tests", "*/tests"]
[tool.coverage.run]
source = ["yourpackage", "tests"]This assumes a project where the package under test is located under As for the original issue, I can confirm that as well. Since Note the mixed forward and backward slashes in the path. This was run on macOS using both the latest release and master of Coverage.py. I have attached the coverage data from the GitHub Action runners. Use these commands to reproduce: git clone https://github.com/cjolowicz/cookiecutter-hypermodern-python-instance
cd cookiecutter-hypermodern-python-instance
git switch --detach 11b803bd73c6f702aeaa477f2eba78f4b101950f
unzip coverage-data.zip
coverage combine
coverage reportBelow is a full traceback for the Full traceback╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/venv-py39/bin/coverage:33 in <module> │
│ │
│ 30 │
│ 31 if __name__ == '__main__': │
│ 32 │ sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0]) │
│ ❱ 33 │ sys.exit(load_entry_point('coverage', 'console_scripts', 'coverage')()) │
│ 34 │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ __annotations__ = {} │ │
│ │ __builtins__ = <module 'builtins' (built-in)> │ │
│ │ __cached__ = None │ │
│ │ __doc__ = None │ │
│ │ __file__ = '/Users/cjolowicz/Code/github.com/nedbat/coveragepy/venv-py39/… │ │
│ │ __loader__ = <_frozen_importlib_external.SourceFileLoader object at │ │
│ │ 0x108f6fca0> │ │
│ │ __name__ = '__main__' │ │
│ │ __package__ = None │ │
│ │ __requires__ = 'coverage' │ │
│ │ __spec__ = None │ │
│ │ distribution = <function distribution at 0x109190160> │ │
│ │ importlib_load_entry_point = <function importlib_load_entry_point at 0x108fbb0d0> │ │
│ │ load_entry_point = <function importlib_load_entry_point at 0x108fbb0d0> │ │
│ │ re = <module 're' from │ │
│ │ '/usr/local/Cellar/python@3.9/3.9.7_1/Frameworks/Python.framew… │ │
│ │ sys = <module 'sys' (built-in)> │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/cmdline.py:879 in main │
│ │
│ 876 │ if argv is None: │
│ 877 │ │ argv = sys.argv[1:] │
│ 878 │ try: │
│ ❱ 879 │ │ status = CoverageScript().command_line(argv) │
│ 880 │ except _ExceptionDuringRun as err: │
│ 881 │ │ # An exception was caught while running the product code. The │
│ 882 │ │ # sys.exc_info() return tuple is packed into an _ExceptionDuringRun │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ argv = ['report'] │ │
│ │ install = <function install at 0x109e68a60> │ │
│ │ msg = "No source for code: │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hyp"+44 │ │
│ │ status = 1 │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/cmdline.py:625 in command_line │
│ │
│ 622 │ │ │
│ 623 │ │ total = None │
│ 624 │ │ if options.action == "report": │
│ ❱ 625 │ │ │ total = self.coverage.report( │
│ 626 │ │ │ │ show_missing=options.show_missing, │
│ 627 │ │ │ │ skip_covered=options.skip_covered, │
│ 628 │ │ │ │ skip_empty=options.skip_empty, │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ args = [] │ │
│ │ argv = [] │ │
│ │ contexts = None │ │
│ │ debug = None │ │
│ │ include = None │ │
│ │ ok = True │ │
│ │ omit = None │ │
│ │ options = <Values at 0x10918bd30: {'action': 'report', 'append': None, 'branch': None, │ │
│ │ 'concurrency': None, 'context': None, 'contexts': None, 'debug': None, │ │
│ │ 'directory': None, 'fail_under': None, 'help': None, 'ignore_errors': None, │ │
│ │ 'include': None, 'keep': None, 'module': None, 'omit': None, 'parallel_mode': │ │
│ │ None, 'precision': None, 'pylib': None, 'quiet': None, 'rcfile': True, │ │
│ │ 'show_contexts': None, 'show_missing': None, 'skip_covered': None, │ │
│ │ 'skip_empty': None, 'sort': None, 'source': None, 'timid': None, 'title': │ │
│ │ None, 'version': None}> │ │
│ │ parser = <coverage.cmdline.CmdOptionParser object at 0x109e603d0> │ │
│ │ report_args = { │ │
│ │ │ 'morfs': [], │ │
│ │ │ 'ignore_errors': None, │ │
│ │ │ 'omit': None, │ │
│ │ │ 'include': None, │ │
│ │ │ 'contexts': None │ │
│ │ } │ │
│ │ self = <coverage.cmdline.CoverageScript object at 0x10918abe0> │ │
│ │ source = None │ │
│ │ total = None │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/control.py:934 in report │
│ │
│ 931 │ │ │ sort=sort │
│ 932 │ │ ): │
│ 933 │ │ │ reporter = SummaryReporter(self) │
│ ❱ 934 │ │ │ return reporter.report(morfs, outfile=file) │
│ 935 │ │
│ 936 │ def annotate( │
│ 937 │ │ self, morfs=None, directory=None, ignore_errors=None, │
│ │
│ ╭───────────────────────────────── locals ─────────────────────────────────╮ │
│ │ contexts = None │ │
│ │ file = None │ │
│ │ ignore_errors = None │ │
│ │ include = None │ │
│ │ morfs = [] │ │
│ │ omit = None │ │
│ │ precision = None │ │
│ │ reporter = <coverage.summary.SummaryReporter object at 0x109e606a0> │ │
│ │ self = <coverage.control.Coverage object at 0x10918bd90> │ │
│ │ show_missing = None │ │
│ │ skip_covered = None │ │
│ │ skip_empty = None │ │
│ │ sort = None │ │
│ ╰──────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/summary.py:43 in report │
│ │
│ 40 │ │ self.outfile = outfile or sys.stdout │
│ 41 │ │ │
│ 42 │ │ self.coverage.get_data().set_query_contexts(self.config.report_contexts) │
│ ❱ 43 │ │ for fr, analysis in get_analysis_to_report(self.coverage, morfs): │
│ 44 │ │ │ self.report_one_file(fr, analysis) │
│ 45 │ │ │
│ 46 │ │ # Prepare the formatting strings, header, and column sorting. │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ analysis = <coverage.results.Analysis object at 0x109e60640> │ │
│ │ fr = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-inst… │ │
│ │ morfs = [] │ │
│ │ outfile = None │ │
│ │ self = <coverage.summary.SummaryReporter object at 0x109e606a0> │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/report.py:72 in │
│ get_analysis_to_report │
│ │
│ 69 │ │
│ 70 │ for fr in sorted(file_reporters): │
│ 71 │ │ try: │
│ ❱ 72 │ │ │ analysis = coverage._analyze(fr) │
│ 73 │ │ except NotPython: │
│ 74 │ │ │ # Only report errors for .py files, and only if we didn't │
│ 75 │ │ │ # explicitly suppress those errors. │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ analysis = <coverage.results.Analysis object at 0x109e60640> │ │
│ │ config = <coverage.config.CoverageConfig object at 0x109e60790> │ │
│ │ coverage = <coverage.control.Coverage object at 0x10918bd90> │ │
│ │ file_reporters = [ │ │
│ │ │ <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ │ <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ │ <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ │ <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ ] │ │
│ │ fr = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ morfs = [] │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/control.py:829 in _analyze │
│ │
│ 826 │ │ if not isinstance(it, FileReporter): │
│ 827 │ │ │ it = self._get_file_reporter(it) │
│ 828 │ │ │
│ ❱ 829 │ │ return Analysis(data, self.config.precision, it, self._file_mapper) │
│ 830 │ │
│ 831 │ def _get_file_reporter(self, morf): │
│ 832 │ │ """Get a FileReporter for a module or file name.""" │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ data = <CoverageData @0x1096df310 _no_disk=False │ │
│ │ _basename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ _suffix=None │ │
│ │ _filename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-pytho… │ │
│ │ _file_map={'tests\\__init__.py': 1, 'tests\\test_main.py': 2, │ │
│ │ 'src/cookiecutter_hypermodern_python_instance/__init__.py': 3, │ │
│ │ 'src/cookiecutter_hypermodern_python_instance/__main__.py': 4} _dbs={4553778688: │ │
│ │ <SqliteDb @0x1096df670 debug=None │ │
│ │ filename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python… │ │
│ │ nest=0 con=None>} _pid=2200 _lock=<unlocked _thread.lock object at 0x1096df330> │ │
│ │ _have_used=True _has_lines=False _has_arcs=True _current_context=None │ │
│ │ _current_context_id=None _query_context_ids=None> │ │
│ │ it = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-instance… │ │
│ │ self = <coverage.control.Coverage object at 0x10918bd90> │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/results.py:20 in __init__ │
│ │
│ 17 │ │ self.data = data │
│ 18 │ │ self.file_reporter = file_reporter │
│ 19 │ │ self.filename = file_mapper(self.file_reporter.filename) │
│ ❱ 20 │ │ self.statements = self.file_reporter.lines() │
│ 21 │ │ self.excluded = self.file_reporter.excluded_lines() │
│ 22 │ │ │
│ 23 │ │ # Identify missing statements. │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ data = <CoverageData @0x1096df310 _no_disk=False │ │
│ │ _basename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermod… │ │
│ │ _suffix=None │ │
│ │ _filename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermod… │ │
│ │ _file_map={'tests\\__init__.py': 1, 'tests\\test_main.py': 2, │ │
│ │ 'src/cookiecutter_hypermodern_python_instance/__init__.py': 3, │ │
│ │ 'src/cookiecutter_hypermodern_python_instance/__main__.py': 4} │ │
│ │ _dbs={4553778688: <SqliteDb @0x1096df670 debug=None │ │
│ │ filename='/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermode… │ │
│ │ nest=0 con=None>} _pid=2200 _lock=<unlocked _thread.lock object at │ │
│ │ 0x1096df330> _have_used=True _has_lines=False _has_arcs=True │ │
│ │ _current_context=None _current_context_id=None _query_context_ids=None> │ │
│ │ file_mapper = <function relative_filename at 0x1099229d0> │ │
│ │ file_reporter = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python… │ │
│ │ precision = 0 │ │
│ │ self = <coverage.results.Analysis object at 0x109e60940> │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/python.py:189 in lines │
│ │
│ 186 │ │
│ 187 │ def lines(self): │
│ 188 │ │ """Return the line numbers of statements in the file.""" │
│ ❱ 189 │ │ return self.parser.statements │
│ 190 │ │
│ 191 │ def excluded_lines(self): │
│ 192 │ │ """Return the line numbers of statements in the file.""" │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ self = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-instance… │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/python.py:180 in parser │
│ │
│ 177 │ def parser(self): │
│ 178 │ │ """Lazily create a :class:`PythonParser`.""" │
│ 179 │ │ if self._parser is None: │
│ ❱ 180 │ │ │ self._parser = PythonParser( │
│ 181 │ │ │ │ filename=self.filename, │
│ 182 │ │ │ │ exclude=self.coverage._exclude_regex('exclude'), │
│ 183 │ │ │ ) │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ self = <PythonFileReporter │ │
│ │ '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-instance… │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/parser.py:42 in __init__ │
│ │
│ 39 │ │ if not self.text: │
│ 40 │ │ │ from coverage.python import get_python_source │
│ 41 │ │ │ try: │
│ ❱ 42 │ │ │ │ self.text = get_python_source(self.filename) │
│ 43 │ │ │ except OSError as err: │
│ 44 │ │ │ │ raise NoSource(f"No source for code: '{self.filename}': {err}") from err │
│ 45 │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ exclude = '(?:#\\s*(pragma|PRAGMA)[:\\s]?\\s*(no|NO)\\s*(cover|COVER))' │ │
│ │ filename = '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-py… │ │
│ │ get_python_source = <function get_python_source at 0x109b19c10> │ │
│ │ self = <coverage.parser.PythonParser object at 0x109e60a30> │ │
│ │ text = None │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ │
│ /Users/cjolowicz/Code/github.com/nedbat/coveragepy/coverage/python.py:60 in get_python_source │
│ │
│ 57 │ │ │ break │
│ 58 │ else: │
│ 59 │ │ # Couldn't find source. │
│ ❱ 60 │ │ raise NoSource(f"No source for code: '{filename}'.") │
│ 61 │ │
│ 62 │ # Replace \f because of http://bugs.python.org/issue19035 │
│ 63 │ source = source.replace(b'\f', b' ') │
│ │
│ ╭─────────────────────────────────────────── locals ───────────────────────────────────────────╮ │
│ │ base = '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-… │ │
│ │ ext = '.py' │ │
│ │ exts = ['.py'] │ │
│ │ filename = '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-… │ │
│ │ source = None │ │
│ │ try_filename = '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-… │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────╯ │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
NoSource: No source for code: '/Users/cjolowicz/Code/github.com/cjolowicz/cookiecutter-hypermodern-python-instance/tests\__init__.py'. |
|
FWIW the paths in the combined coverage look like this: |
|
I'm running into a similar problem. I have coverage data generated in a Linux container, but want to generate the report on the Windows host. Since the Linux container wrote |
1 task
|
In case it helps anyone else: I've been able to work around this by re-writing the Windows coverage file prior to If you aren't using |
|
Thanks for bring this to back to my attention, and sorry for letting it languish. Definitely one thing is needed to fix this: if --- a/coverage/files.py
+++ b/coverage/files.py
@@ -363,8 +363,9 @@ def add(self, pattern, result):
# The pattern is meant to match a filepath. Let's make it absolute
# unless it already is, or is meant to match any prefix.
- if not pattern.startswith('*') and not isabs_anywhere(pattern + pattern_sep):
- pattern = abs_file(pattern)
+ if not self.relative:
+ if not pattern.startswith('*') and not isabs_anywhere(pattern + pattern_sep):
+ pattern = abs_file(pattern)
if not pattern.endswith(pattern_sep):
pattern += pattern_sepThen if you had an entry like |
|
Actually, we don't even need the change in my diff if |
|
@nedbat That may be a bug, but I don't think it's related to the problem being described here (or, if it is, I'm not seeing the connection). The issue I addressed with that SQLite hack isn't anything to do with the prefix; If you have a coverage file generated on macOS/Unix, the coverage data will refer to files as This problem still exists if you use The naïve fix is to make all path separators "unix" style when they're persisted in the coverage file - which is what the SQLite hack does. There might be other problems with taking that approach (especially if you're running the report on Windows) - but it's been enough to get me unstuck. |
|
@freakboy3742 are you using the What's the best way for me to see the failing case when the separators aren't adjusted? |
|
@nedbat I'm not; I'm using As for the failing case - the coverage files I've uploaded contain the generated data; that data is from commit 0cd2ca0, CI run https://github.com/beeware/briefcase/actions/runs/3155776011. |
nedbat
added a commit
that referenced
this issue
Oct 3, 2022
|
I've made some changes on a branch: @cjolowicz This should make your code combine and report correctly as-is. |
|
Perhaps this should be more automatic, since |
|
@nedbat Can confirm the branch plus that config change fixes the problem I'm seeing without the need for the SQLite fix. |
|
Thanks for taking a look at this again nedbat. I tried out the branch and also added a trivial path section to the config and I still get errors around the Here is the [paths]
chia = ["chia", "*/chia"]
tests = ["tests", "*/tests"]I added some diagnostics as reference against the error message. |
|
@altendky thanks for looking into it. Can you add |
|
Sure thing. |
|
@altendky I see what happened. The earlier discussion was about a pyproject.toml file, and you put that snippet into your .coveragerc file. The syntax you need is different: |
|
And here I thought I was being a good little dev and exactly following the example. |
|
Yep, that works. Thanks for identifying my error. It is apparently not obvious that this would be needed to trigger platform compatibility. But anyways, looks like we'll be turning on Windows coverage inclusion 'soon' and I very much appreciate that. Now, to take the next step and get this data well reported and require coverage for PRs... |
nedbat
added a commit
that referenced
this issue
Oct 9, 2022
|
Hi, I've added more to the nedbat/bug991 branch (commit 285ca25). Now relative paths will be combined implicitly, so you shouldn't need "obvious" |
|
@nedbat No luck, sorry - commit 285ca25 without a pyproject.tomlCombine and report:I get the same result if I disable |
|
@freakboy3742 hmm, i've been running your project as a test, that's odd. Can you try these commands? |
|
Seems ok here without the Also looks ok in the next run where I removed the coverage debug, other debug, and CI minimization. Thanks for cleaning this up here. |
|
@nedbat Log output below. Test suite is running on an x86 Mac mini running Monterey (12.5.1), and a Parallels virtual machine on the same physical machine running Windows 10. The Parallels machine is accessing the source folder over a network drive (hence the Setuppython -m coverage debug datapython -m coverage combine --debug=pathmappython -m coverage debug data |
|
@freakboy3742 thanks for sticking with me on this. I don't understand why the debug output isn't appearing in the combine step. Can you make it |
python -m coverage combine --debug=sys,config,pathmap |
|
@freakboy3742 I don't understand why there's no output from the combine step. I've added a more distinctive version marker to the branch. Can you try running with nedbat/bug991 again? |
|
Ok - that seems to have worked. Running on Briefcase hash 385a4aa1: Coverage installpython -m coverage combine --debug=sys,config,pathmappython -m coverage report |
nedbat
added a commit
that referenced
this issue
Oct 15, 2022
nedbat
added a commit
that referenced
this issue
Oct 15, 2022
|
I'm marking this as fixed as of commit 7df8609. |
|
But I think because of #1407, there will be larger changes to how file wildcards are interpreted. |
|
This is now released as part of coverage 6.6.0b1. |
|
This is now released as part of coverage 7.0.0b1. |
2 tasks
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this issue
May 5, 2023
Version 7.2.5 — 2023-04-30 -------------------------- - Fix: ``html_report()`` could fail with an AttributeError on ``isatty`` if run in an unusual environment where sys.stdout had been replaced. This is now fixed. Version 7.2.4 — 2023-04-28 -------------------------- PyCon 2023 sprint fixes! - Fix: with ``relative_files = true``, specifying a specific file to include or omit wouldn't work correctly (`issue 1604`_). This is now fixed, with testing help by `Marc Gibbons <pull 1608_>`_. - Fix: the XML report would have an incorrect ``<source>`` element when using relative files and the source option ended with a slash (`issue 1541`_). This is now fixed, thanks to `Kevin Brown-Silva <pull 1608_>`_. - When the HTML report location is printed to the terminal, it's now a terminal-compatible URL, so that you can click the location to open the HTML file in your browser. Finishes `issue 1523`_ thanks to `Ricardo Newbery <pull 1613_>`_. - Docs: a new :ref:`Migrating page <migrating>` with details about how to migrate between major versions of coverage.py. It currently covers the wildcard changes in 7.x. Thanks, `Brian Grohe <pull 1610_>`_. .. _issue 1523: nedbat/coveragepy#1523 .. _issue 1541: nedbat/coveragepy#1541 .. _issue 1604: nedbat/coveragepy#1604 .. _pull 1608: nedbat/coveragepy#1608 .. _pull 1609: nedbat/coveragepy#1609 .. _pull 1610: nedbat/coveragepy#1610 .. _pull 1613: nedbat/coveragepy#1613 Version 7.2.3 — 2023-04-06 -------------------------- - Fix: the :ref:`config_run_sigterm` setting was meant to capture data if a process was terminated with a SIGTERM signal, but it didn't always. This was fixed thanks to `Lewis Gaul <pull 1600_>`_, closing `issue 1599`_. - Performance: HTML reports with context information are now much more compact. File sizes are typically as small as one-third the previous size, but can be dramatically smaller. This closes `issue 1584`_ thanks to `Oleh Krehel <pull 1587_>`_. - Development dependencies no longer use hashed pins, closing `issue 1592`_. .. _issue 1584: nedbat/coveragepy#1584 .. _pull 1587: nedbat/coveragepy#1587 .. _issue 1592: nedbat/coveragepy#1592 .. _issue 1599: nedbat/coveragepy#1599 .. _pull 1600: nedbat/coveragepy#1600 Version 7.2.2 — 2023-03-16 -------------------------- - Fix: if a virtualenv was created inside a source directory, and a sourced package was installed inside the virtualenv, then all of the third-party packages inside the virtualenv would be measured. This was incorrect, but has now been fixed: only the specified packages will be measured, thanks to `Manuel Jacob <pull 1560_>`_. - Fix: the ``coverage lcov`` command could create a .lcov file with incorrect LF (lines found) and LH (lines hit) totals. This is now fixed, thanks to `Ian Moore <pull 1583_>`_. - Fix: the ``coverage xml`` command on Windows could create a .xml file with duplicate ``<package>`` elements. This is now fixed, thanks to `Benjamin Parzella <pull 1574_>`_, closing `issue 1573`_. .. _pull 1560: nedbat/coveragepy#1560 .. _issue 1573: nedbat/coveragepy#1573 .. _pull 1574: nedbat/coveragepy#1574 .. _pull 1583: nedbat/coveragepy#1583 Version 7.2.1 — 2023-02-26 -------------------------- - Fix: the PyPI page had broken links to documentation pages, but no longer does, closing `issue 1566`_. - Fix: public members of the coverage module are now properly indicated so that mypy will find them, fixing `issue 1564`_. .. _issue 1564: nedbat/coveragepy#1564 .. _issue 1566: nedbat/coveragepy#1566 Version 7.2.0 — 2023-02-22 -------------------------- - Added a new setting ``[report] exclude_also`` to let you add more exclusions without overwriting the defaults. Thanks, `Alpha Chen <pull 1557_>`_, closing `issue 1391`_. - Added a :meth:`.CoverageData.purge_files` method to remove recorded data for a particular file. Contributed by `Stephan Deibel <pull 1547_>`_. - Fix: when reporting commands fail, they will no longer congratulate themselves with messages like "Wrote XML report to file.xml" before spewing a traceback about their failure. - Fix: arguments in the public API that name file paths now accept pathlib.Path objects. This includes the ``data_file`` and ``config_file`` arguments to the Coverage constructor and the ``basename`` argument to CoverageData. Closes `issue 1552`_. - Fix: In some embedded environments, an IndexError could occur on stop() when the originating thread exits before completion. This is now fixed, thanks to `Russell Keith-Magee <pull 1543_>`_, closing `issue 1542`_. - Added a ``py.typed`` file to announce our type-hintedness. Thanks, `KotlinIsland <pull 1550_>`_. .. _issue 1391: nedbat/coveragepy#1391 .. _issue 1542: nedbat/coveragepy#1542 .. _pull 1543: nedbat/coveragepy#1543 .. _pull 1547: nedbat/coveragepy#1547 .. _pull 1550: nedbat/coveragepy#1550 .. _issue 1552: nedbat/coveragepy#1552 .. _pull 1557: nedbat/coveragepy#1557 Version 7.1.0 — 2023-01-24 -------------------------- - Added: the debug output file can now be specified with ``[run] debug_file`` in the configuration file. Closes `issue 1319`_. - Performance: fixed a slowdown with dynamic contexts that's been around since 6.4.3. The fix closes `issue 1538`_. Thankfully this doesn't break the `Cython change`_ that fixed `issue 972`_. Thanks to Mathieu Kniewallner for the deep investigative work and comprehensive issue report. - Typing: all product and test code has type annotations. .. _Cython change: nedbat/coveragepy#1347 .. _issue 972: nedbat/coveragepy#972 .. _issue 1319: nedbat/coveragepy#1319 .. _issue 1538: nedbat/coveragepy#1538 Version 7.0.5 — 2023-01-10 -------------------------- - Fix: On Python 3.7, a file with type annotations but no ``from __future__ import annotations`` would be missing statements in the coverage report. This is now fixed, closing `issue 1524`_. .. _issue 1524: nedbat/coveragepy#1524 Version 7.0.4 — 2023-01-07 -------------------------- - Performance: an internal cache of file names was accidentally disabled, resulting in sometimes drastic reductions in performance. This is now fixed, closing `issue 1527`_. Thanks to Ivan Ciuvalschii for the reproducible test case. .. _issue 1527: nedbat/coveragepy#1527 Version 7.0.3 — 2023-01-03 -------------------------- - Fix: when using pytest-cov or pytest-xdist, or perhaps both, the combining step could fail with ``assert row is not None`` using 7.0.2. This was due to a race condition that has always been possible and is still possible. In 7.0.1 and before, the error was silently swallowed by the combining code. Now it will produce a message "Couldn't combine data file" and ignore the data file as it used to do before 7.0.2. Closes `issue 1522`_. .. _issue 1522: nedbat/coveragepy#1522 Version 7.0.2 — 2023-01-02 -------------------------- - Fix: when using the ``[run] relative_files = True`` setting, a relative ``[paths]`` pattern was still being made absolute. This is now fixed, closing `issue 1519`_. - Fix: if Python doesn't provide tomllib, then TOML configuration files can only be read if coverage.py is installed with the ``[toml]`` extra. Coverage.py will raise an error if TOML support is not installed when it sees your settings are in a .toml file. But it didn't understand that ``[tools.coverage]`` was a valid section header, so the error wasn't reported if you used that header, and settings were silently ignored. This is now fixed, closing `issue 1516`_. - Fix: adjusted how decorators are traced on PyPy 7.3.10, fixing `issue 1515`_. - Fix: the ``coverage lcov`` report did not properly implement the ``--fail-under=MIN`` option. This has been fixed. - Refactor: added many type annotations, including a number of refactorings. This should not affect outward behavior, but they were a bit invasive in some places, so keep your eyes peeled for oddities. - Refactor: removed the vestigial and long untested support for Jython and IronPython. .. _issue 1515: nedbat/coveragepy#1515 .. _issue 1516: nedbat/coveragepy#1516 .. _issue 1519: nedbat/coveragepy#1519 Version 7.0.1 — 2022-12-23 -------------------------- - When checking if a file mapping resolved to a file that exists, we weren't considering files in .whl files. This is now fixed, closing `issue 1511`_. - File pattern rules were too strict, forbidding plus signs and curly braces in directory and file names. This is now fixed, closing `issue 1513`_. - Unusual Unicode or control characters in source files could prevent reporting. This is now fixed, closing `issue 1512`_. - The PyPy wheel now installs on PyPy 3.7, 3.8, and 3.9, closing `issue 1510`_. .. _issue 1510: nedbat/coveragepy#1510 .. _issue 1511: nedbat/coveragepy#1511 .. _issue 1512: nedbat/coveragepy#1512 .. _issue 1513: nedbat/coveragepy#1513 Version 7.0.0 — 2022-12-18 -------------------------- Nothing new beyond 7.0.0b1. Version 7.0.0b1 — 2022-12-03 ---------------------------- A number of changes have been made to file path handling, including pattern matching and path remapping with the ``[paths]`` setting (see :ref:`config_paths`). These changes might affect you, and require you to update your settings. (This release includes the changes from `6.6.0b1 <changes_6-6-0b1_>`_, since 6.6.0 was never released.) - Changes to file pattern matching, which might require updating your configuration: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing `issue 1407`_. - Now ``**`` matches any number of nested directories, including none. - Improvements to combining data files when using the :ref:`config_run_relative_files` setting, which might require updating your configuration: - During ``coverage combine``, relative file paths are implicitly combined without needing a ``[paths]`` configuration setting. This also fixed `issue 991`_. - A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that relative file paths can be combined more easily. - The :ref:`config_run_relative_files` setting is properly interpreted in more places, fixing `issue 1280`_. - When remapping file paths with ``[paths]``, a path will be remapped only if the resulting path exists. The documentation has long said the prefix had to exist, but it was never enforced. This fixes `issue 608`_, improves `issue 649`_, and closes `issue 757`_. - Reporting operations now implicitly use the ``[paths]`` setting to remap file paths within a single data file. Combining multiple files still requires the ``coverage combine`` step, but this simplifies some single-file situations. Closes `issue 1212`_ and `issue 713`_. - The ``coverage report`` command now has a ``--format=`` option. The original style is now ``--format=text``, and is the default. - Using ``--format=markdown`` will write the table in Markdown format, thanks to `Steve Oswald <pull 1479_>`_, closing `issue 1418`_. - Using ``--format=total`` will write a single total number to the output. This can be useful for making badges or writing status updates. - Combining data files with ``coverage combine`` now hashes the data files to skip files that add no new information. This can reduce the time needed. Many details affect the speed-up, but for coverage.py's own test suite, combining is about 40% faster. Closes `issue 1483`_. - When searching for completely un-executed files, coverage.py uses the presence of ``__init__.py`` files to determine which directories have source that could have been imported. However, `implicit namespace packages`_ don't require ``__init__.py``. A new setting ``[report] include_namespace_packages`` tells coverage.py to consider these directories during reporting. Thanks to `Felix Horvat <pull 1387_>`_ for the contribution. Closes `issue 1383`_ and `issue 1024`_. - Fixed environment variable expansion in pyproject.toml files. It was overly broad, causing errors outside of coverage.py settings, as described in `issue 1481`_ and `issue 1345`_. This is now fixed, but in rare cases will require changing your pyproject.toml to quote non-string values that use environment substitution. - An empty file has a coverage total of 100%, but used to fail with ``--fail-under``. This has been fixed, closing `issue 1470`_. - The text report table no longer writes out two separator lines if there are no files listed in the table. One is plenty. - Fixed a mis-measurement of a strange use of wildcard alternatives in match/case statements, closing `issue 1421`_. - Fixed internal logic that prevented coverage.py from running on implementations other than CPython or PyPy (`issue 1474`_). - The deprecated ``[run] note`` setting has been completely removed. .. _implicit namespace packages: https://peps.python.org/pep-0420/ .. _issue 608: nedbat/coveragepy#608 .. _issue 649: nedbat/coveragepy#649 .. _issue 713: nedbat/coveragepy#713 .. _issue 757: nedbat/coveragepy#757 .. _issue 991: nedbat/coveragepy#991 .. _issue 1024: nedbat/coveragepy#1024 .. _issue 1212: nedbat/coveragepy#1212 .. _issue 1280: nedbat/coveragepy#1280 .. _issue 1345: nedbat/coveragepy#1345 .. _issue 1383: nedbat/coveragepy#1383 .. _issue 1407: nedbat/coveragepy#1407 .. _issue 1418: nedbat/coveragepy#1418 .. _issue 1421: nedbat/coveragepy#1421 .. _issue 1470: nedbat/coveragepy#1470 .. _issue 1474: nedbat/coveragepy#1474 .. _issue 1481: nedbat/coveragepy#1481 .. _issue 1483: nedbat/coveragepy#1483 .. _pull 1387: nedbat/coveragepy#1387 .. _pull 1479: nedbat/coveragepy#1479 Version 6.6.0b1 — 2022-10-31 ---------------------------- (Note: 6.6.0 final was never released. These changes are part of `7.0.0b1 <changes_7-0-0b1_>`_.) - Changes to file pattern matching, which might require updating your configuration: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing `issue 1407`_. - Now ``**`` matches any number of nested directories, including none. - Improvements to combining data files when using the :ref:`config_run_relative_files` setting: - During ``coverage combine``, relative file paths are implicitly combined without needing a ``[paths]`` configuration setting. This also fixed `issue 991`_. - A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that relative file paths can be combined more easily. - The setting is properly interpreted in more places, fixing `issue 1280`_. - Fixed environment variable expansion in pyproject.toml files. It was overly broad, causing errors outside of coverage.py settings, as described in `issue 1481`_ and `issue 1345`_. This is now fixed, but in rare cases will require changing your pyproject.toml to quote non-string values that use environment substitution. - Fixed internal logic that prevented coverage.py from running on implementations other than CPython or PyPy (`issue 1474`_). .. _issue 991: nedbat/coveragepy#991 .. _issue 1280: nedbat/coveragepy#1280 .. _issue 1345: nedbat/coveragepy#1345 .. _issue 1407: nedbat/coveragepy#1407 .. _issue 1474: nedbat/coveragepy#1474 .. _issue 1481: nedbat/coveragepy#1481
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current Problem
I'm running coverage for multiple Python versions on both Linux and Windows. They are all run on Gitlab, with the Windows tests using Python install on the host, and with the Linux tests using Docker. The paths of the build directories are not deterministic (may be picked up by multiple runners, existing or yet to exist) so I have
relative_files = True.The Windows paths use
\instead of/which, if the coverage combination and reporting is done on Windows, results in a report with every source file twice, one for each separator, although the end result appears to be correct. If this is done on Linux, it fails entirely when trying to resolve the paths containing backslashes.Example Report
Describe the solution you'd like
Source paths on Windows should use forward slashes in relative paths to allow result combination and final reporting to be done on Linux, and to clean up the report output when done on Windows.
Describe alternatives you've considered
Manually modifying the coverage results generated from
coverage run.The text was updated successfully, but these errors were encountered: