-
-
Notifications
You must be signed in to change notification settings - Fork 436
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add purge_files method to CoverageData unit tests for it #1547
Conversation
Hmm, well, checks all passed (in [14b7a78]) until I merged from master which seems to have an issue under Python 3.9 :-/ |
…l and update of coverage data.
…st unless it fails and then it would have failed to fail.
Thanks! I'm going to do a little refactoring after merging. |
file_id = self._file_id(filename, add=False) | ||
if file_id is None: | ||
continue | ||
self._file_map.pop(filename, None) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After I merged, I noticed this line: if you are only removing one context for the file, then we don't want to remove the file from the file_map, correct? Why is it important to remove it from the map, and what should we do if it's only a single context being removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. It looks like in Wing i'm only calling this with context==None and in all cases I immediately set updated data with set_context and add_lines so all the contexts are restored, but on the right new line numbers. Should I go ahead and just remove the context arg? I think it was a mistake that came from trying to follow what other API calls support for arguments. Now I can't really think of a reason to have that argument.
I do remember popping from _file_map was needed or some aspect of the update did not work because measured_files was called. I'm going to investigate that further since popping here may indeed be the wrong way to solve that part of it.
Another option would be to replace this with a call that purges/replaces data with a new set of lines all in one operation. My initial idea was the low-level approach was a better match for this API, but I could have been wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the original cur.execute
call didn't actually remove data because the cursor wasn't iterated. I replaced it with cur.execute_void
and it had a better effect.
If you don't need the per-context operation, then let's definitely simplify it to only remove the entire file. I think I'd have it remove the data for the file, but leave the file in the set of measured files, and state that it's possible for a "measured file" to have no data. Would that work for you?
If we find a need for per-context purging later, we could add it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've implemented this in #1551 - wasn't sure how to add to this pull request so ended up with a new one. Hope that is OK...
This is now released as part of coverage 7.2.0. |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [coverage](https://togithub.com/nedbat/coveragepy) | `==7.1.0` -> `==7.2.1` | [![age](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/compatibility-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/confidence-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>nedbat/coveragepy</summary> ### [`v7.2.1`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-721--2023-02-26) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.2.0...7.2.1) - 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:[https://github.com/nedbat/coveragepy/issues/1564](https://togithub.com/nedbat/coveragepy/issues/1564)4 .. \_issue 1566[https://github.com/nedbat/coveragepy/issues/1566](https://togithub.com/nedbat/coveragepy/issues/1566)66 .. \_changes\_7-2-0: ### [`v7.2.0`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-720--2023-02-22) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.1.0...7.2.0) - 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:[https://github.com/nedbat/coveragepy/issues/1391](https://togithub.com/nedbat/coveragepy/issues/1391)1 .. \_issue 1542[https://github.com/nedbat/coveragepy/issues/1542](https://togithub.com/nedbat/coveragepy/issues/1542)42 .. \_pull 154[https://github.com/nedbat/coveragepy/pull/1543](https://togithub.com/nedbat/coveragepy/pull/1543)543 .. \_pull 15[https://github.com/nedbat/coveragepy/pull/1547](https://togithub.com/nedbat/coveragepy/pull/1547)1547 .. \_pull 1[https://github.com/nedbat/coveragepy/pull/1550](https://togithub.com/nedbat/coveragepy/pull/1550)/1550 .. \_issue [https://github.com/nedbat/coveragepy/issues/1552](https://togithub.com/nedbat/coveragepy/issues/1552)s/1552 .. \_pull[https://github.com/nedbat/coveragepy/pull/1557](https://togithub.com/nedbat/coveragepy/pull/1557)ll/1557 .. \_changes\_7-1-0: </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTQuNyIsInVwZGF0ZWRJblZlciI6IjM0LjE1NC43In0=--> Co-authored-by: renovate[bot] <29139614 renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [coverage](https://togithub.com/nedbat/coveragepy) | `==7.1.0` -> `==7.2.1` | [![age](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/compatibility-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/coverage/7.2.1/confidence-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | | [mkdocs-material](https://togithub.com/squidfunk/mkdocs-material) | `==9.0.9` -> `==9.1.2` | [![age](https://badges.renovateapi.com/packages/pypi/mkdocs-material/9.1.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/mkdocs-material/9.1.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/mkdocs-material/9.1.2/compatibility-slim/9.0.9)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/mkdocs-material/9.1.2/confidence-slim/9.0.9)](https://docs.renovatebot.com/merge-confidence/) | | [pyright](https://togithub.com/RobertCraigie/pyright-python) | `==1.1.291` -> `==1.1.298` | [![age](https://badges.renovateapi.com/packages/pypi/pyright/1.1.298/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/pyright/1.1.298/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/pyright/1.1.298/compatibility-slim/1.1.291)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/pyright/1.1.298/confidence-slim/1.1.291)](https://docs.renovatebot.com/merge-confidence/) | | [pytest](https://docs.pytest.org/en/latest/) ([source](https://togithub.com/pytest-dev/pytest), [changelog](https://docs.pytest.org/en/stable/changelog.html)) | `==7.2.1` -> `==7.2.2` | [![age](https://badges.renovateapi.com/packages/pypi/pytest/7.2.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/pytest/7.2.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/pytest/7.2.2/compatibility-slim/7.2.1)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/pytest/7.2.2/confidence-slim/7.2.1)](https://docs.renovatebot.com/merge-confidence/) | | [slotscheck](https://togithub.com/ariebovenberg/slotscheck) | `==0.16.4` -> `==0.16.5` | [![age](https://badges.renovateapi.com/packages/pypi/slotscheck/0.16.5/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/slotscheck/0.16.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/slotscheck/0.16.5/compatibility-slim/0.16.4)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/slotscheck/0.16.5/confidence-slim/0.16.4)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>nedbat/coveragepy</summary> ### [`v7.2.1`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-721--2023-02-26) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.2.0...7.2.1) - 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:[https://github.com/nedbat/coveragepy/issues/1564](https://togithub.com/nedbat/coveragepy/issues/1564)4 .. \_issue 1566[https://github.com/nedbat/coveragepy/issues/1566](https://togithub.com/nedbat/coveragepy/issues/1566)66 .. \_changes\_7-2-0: ### [`v7.2.0`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-720--2023-02-22) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.1.0...7.2.0) - 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:[https://github.com/nedbat/coveragepy/issues/1391](https://togithub.com/nedbat/coveragepy/issues/1391)1 .. \_issue 1542[https://github.com/nedbat/coveragepy/issues/1542](https://togithub.com/nedbat/coveragepy/issues/1542)42 .. \_pull 154[https://github.com/nedbat/coveragepy/pull/1543](https://togithub.com/nedbat/coveragepy/pull/1543)543 .. \_pull 15[https://github.com/nedbat/coveragepy/pull/1547](https://togithub.com/nedbat/coveragepy/pull/1547)1547 .. \_pull 1[https://github.com/nedbat/coveragepy/pull/1550](https://togithub.com/nedbat/coveragepy/pull/1550)/1550 .. \_issue [https://github.com/nedbat/coveragepy/issues/1552](https://togithub.com/nedbat/coveragepy/issues/1552)s/1552 .. \_pull[https://github.com/nedbat/coveragepy/pull/1557](https://togithub.com/nedbat/coveragepy/pull/1557)ll/1557 .. \_changes\_7-1-0: </details> <details> <summary>squidfunk/mkdocs-material</summary> ### [`v9.1.2`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.1.2): mkdocs-material-9.1.2 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.1.1...9.1.2) - Updated Icelandic, Korean and Swedish translations - Fixed [#​5168](https://togithub.com/squidfunk/mkdocs-material/issues/5168): Mermaid text boxes overflow (9.0.13 regression) - Fixed [#​5155](https://togithub.com/squidfunk/mkdocs-material/issues/5155): table of contents not highlighting percent-encoded URLs ### [`v9.1.1`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.1.1): mkdocs-material-9.1.1 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.1.0...9.1.1) - Updated Czech and Thai translations - Improved instant loading (scroll restoration, slow connections) - Fixed [#​5023](https://togithub.com/squidfunk/mkdocs-material/issues/5023): Instant loading not allowing to go back to initial page - Fixed [#​3797](https://togithub.com/squidfunk/mkdocs-material/issues/3797): Instant loading does not work with section anchors in Safari ### [`v9.1.0`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.1.0): mkdocs-material-9.1.0 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.15...9.1.0) - Docker image now available for `amd64`, `arm64` and `arm/v7` - Updated Chinese (Taiwanese) translations - Generalized tag identifier implementation - Fixed flickering of header shadow on load - Fixed occasional flickering of announcement bar ### [`v9.0.15`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.15): mkdocs-material-9.0.15 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.14...9.0.15) - Updated Chinese (Traditional) translations - Updated Hebrew translations ### [`v9.0.14`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.14): mkdocs-material-9.0.14 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.13...9.0.14) - Fixed [#​5072](https://togithub.com/squidfunk/mkdocs-material/issues/5072): Rendering bug on navigation expand button in Firefox ### [`v9.0.13`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.13): mkdocs-material-9.0.13 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.12...9.0.13) - Updated Uzbek translations - Switched back to pre-9.0.0 headline detection in `content` partial - Fixed [#​5062](https://togithub.com/squidfunk/mkdocs-material/issues/5062): Version warning not readable when using slate scheme - Fixed [#​5061](https://togithub.com/squidfunk/mkdocs-material/issues/5061): Improved discernibility of table row hover color - Fixed [#​5034](https://togithub.com/squidfunk/mkdocs-material/issues/5034): Sequence actors in Mermaid diagrams not color-abiding - Fixed [#​4919](https://togithub.com/squidfunk/mkdocs-material/issues/4919): Allow to hide version warning in multiple versions ### [`v9.0.12`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.12): mkdocs-material-9.0.12 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.11...9.0.12) - Updated Catalan translations - Fixed [#​4975](https://togithub.com/squidfunk/mkdocs-material/issues/4975): Mermaid entity relationship rendering diagrams bug - Fixed [#​4924](https://togithub.com/squidfunk/mkdocs-material/issues/4924): Header title not reset when using instant loading ### [`v9.0.11`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.11): mkdocs-material-9.0.11 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.10...9.0.11) - Added Mastodon verification for social links (`rel=me`) - Updated Italian translations ### [`v9.0.10`](https://togithub.com/squidfunk/mkdocs-material/releases/tag/9.0.10): mkdocs-material-9.0.10 [Compare Source](https://togithub.com/squidfunk/mkdocs-material/compare/9.0.9...9.0.10) - Updated Arabic translations - Updated Korean translations - Updated Hungarian translations - Updated Russian translations - Fixed [#​4977](https://togithub.com/squidfunk/mkdocs-material/issues/4977): Improved accessibility for content tabs - Fixed [#​4960](https://togithub.com/squidfunk/mkdocs-material/issues/4960): Sometimes anchor following doesn't bring last item into view </details> <details> <summary>RobertCraigie/pyright-python</summary> ### [`v1.1.298`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.297...v1.1.298) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.297...v1.1.298) ### [`v1.1.297`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.296...v1.1.297) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.296...v1.1.297) ### [`v1.1.296`](https://togithub.com/RobertCraigie/pyright-python/releases/tag/v1.1.296) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.295...v1.1.296) This release adds support for offline usage after the first initial run to cache the installed package. This release also changes how the root cache directory is resolved, it now follows this pattern: - Checks the `PYRIGHT_PYTHON_CACHE_DIR` environment variable - Checks the `XDG_CACHE_HOME` environment variable - Then if neither of the above are set, it defaults to `~/.cache` ### [`v1.1.295`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.294...v1.1.295) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.294...v1.1.295) ### [`v1.1.294`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.293...v1.1.294) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.293...v1.1.294) ### [`v1.1.293`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.292...v1.1.293) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.292...v1.1.293) ### [`v1.1.292`](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.291...v1.1.292) [Compare Source](https://togithub.com/RobertCraigie/pyright-python/compare/v1.1.291...v1.1.292) </details> <details> <summary>pytest-dev/pytest</summary> ### [`v7.2.2`](https://togithub.com/pytest-dev/pytest/releases/tag/7.2.2) [Compare Source](https://togithub.com/pytest-dev/pytest/compare/7.2.1...7.2.2) # pytest 7.2.2 (2023-03-03) ## Bug Fixes - [#​10533](https://togithub.com/pytest-dev/pytest/issues/10533): Fixed `pytest.approx`{.interpreted-text role="func"} handling of dictionaries containing one or more values of \[0.0]{.title-ref}. - [#​10592](https://togithub.com/pytest-dev/pytest/issues/10592): Fixed crash if \[--cache-show]{.title-ref} and \[--help]{.title-ref} are passed at the same time. - [#​10597](https://togithub.com/pytest-dev/pytest/issues/10597): Fixed bug where a fixture method named `teardown` would be called as part of `nose` teardown stage. - [#​10626](https://togithub.com/pytest-dev/pytest/issues/10626): Fixed crash if `--fixtures` and `--help` are passed at the same time. - [#​10660](https://togithub.com/pytest-dev/pytest/issues/10660): Fixed :py`pytest.raises`{.interpreted-text role="func"} to return a 'ContextManager' so that type-checkers could narrow `pytest.raises(...) if ... else nullcontext()` down to 'ContextManager' rather than 'object'. ## Improved Documentation - [#​10690](https://togithub.com/pytest-dev/pytest/issues/10690): Added \[CI]{.title-ref} and \[BUILD_NUMBER]{.title-ref} environment variables to the documentation. - [#​10721](https://togithub.com/pytest-dev/pytest/issues/10721): Fixed entry-points declaration in the documentation example using Hatch. - [#​10753](https://togithub.com/pytest-dev/pytest/issues/10753): Changed wording of the module level skip to be very explicit about not collecting tests and not executing the rest of the module. </details> <details> <summary>ariebovenberg/slotscheck</summary> ### [`v0.16.5`](https://togithub.com/ariebovenberg/slotscheck/blob/HEAD/CHANGELOG.rst#​0165-2023-03-01) [Compare Source](https://togithub.com/ariebovenberg/slotscheck/compare/v0.16.4...v0.16.5) - Don't flag `TypedDict` from `typing_extensions` in Python versions where `typing` has `TypedDict` itself. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/RobertCraigie/prisma-client-py). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTkuMCIsInVwZGF0ZWRJblZlciI6IjM0LjE2MC4wIn0=--> --------- Co-authored-by: renovate[bot] <29139614 renovate[bot]@users.noreply.github.com> Co-authored-by: Robert Craigie <[email protected]>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [coverage](https://togithub.com/nedbat/coveragepy) | `==7.1.0` -> `==7.2.2` | [![age](https://badges.renovateapi.com/packages/pypi/coverage/7.2.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/coverage/7.2.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/coverage/7.2.2/compatibility-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/coverage/7.2.2/confidence-slim/7.1.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>nedbat/coveragepy</summary> ### [`v7.2.2`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-722--2023-03-16) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.2.1...7.2.2) - 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:[https://github.com/nedbat/coveragepy/pull/1560](https://togithub.com/nedbat/coveragepy/pull/1560)0 .. \_issue 1573[https://github.com/nedbat/coveragepy/issues/1573](https://togithub.com/nedbat/coveragepy/issues/1573)73 .. \_pull 157[https://github.com/nedbat/coveragepy/pull/1574](https://togithub.com/nedbat/coveragepy/pull/1574)574 .. \_pull 15[https://github.com/nedbat/coveragepy/pull/1583](https://togithub.com/nedbat/coveragepy/pull/1583)1583 .. \_changes\_7-2-1: ### [`v7.2.1`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-721--2023-02-26) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.2.0...7.2.1) - 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:[https://github.com/nedbat/coveragepy/issues/1564](https://togithub.com/nedbat/coveragepy/issues/1564)4 .. \_issue 1566[https://github.com/nedbat/coveragepy/issues/1566](https://togithub.com/nedbat/coveragepy/issues/1566)66 .. \_changes\_7-2-0: ### [`v7.2.0`](https://togithub.com/nedbat/coveragepy/blob/HEAD/CHANGES.rst#Version-720--2023-02-22) [Compare Source](https://togithub.com/nedbat/coveragepy/compare/7.1.0...7.2.0) - 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:[https://github.com/nedbat/coveragepy/issues/1391](https://togithub.com/nedbat/coveragepy/issues/1391)1 .. \_issue 1542[https://github.com/nedbat/coveragepy/issues/1542](https://togithub.com/nedbat/coveragepy/issues/1542)42 .. \_pull 154[https://github.com/nedbat/coveragepy/pull/1543](https://togithub.com/nedbat/coveragepy/pull/1543)543 .. \_pull 15[https://github.com/nedbat/coveragepy/pull/1547](https://togithub.com/nedbat/coveragepy/pull/1547)1547 .. \_pull 1[https://github.com/nedbat/coveragepy/pull/1550](https://togithub.com/nedbat/coveragepy/pull/1550)/1550 .. \_issue [https://github.com/nedbat/coveragepy/issues/1552](https://togithub.com/nedbat/coveragepy/issues/1552)s/1552 .. \_pull[https://github.com/nedbat/coveragepy/pull/1557](https://togithub.com/nedbat/coveragepy/pull/1557)ll/1557 .. \_changes\_7-1-0: </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - "after 1 am and before 7 am" in timezone Etc/UTC. 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/canonical/charmcraft). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTQuNyIsInVwZGF0ZWRJblZlciI6IjM1LjExLjAifQ==--> Co-authored-by: renovate[bot] <29139614 renovate[bot]@users.noreply.github.com>
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
This new method makes it possible for users to selectively remove coverage data, and then optionally update it via the existing add_lines and add_arcs methods.
My motivation for this change: I'm using it in an IDE to track coverage data across edits, in order to invalidate unit test results based on which code was edited. It produces a pretty good approximation of tests that need to be re-run, useful in applications with massive test suites that take days or longer to run. Eventually you have to rerun all tests, of course, but this helps catch errors earlier in the development process. Obviously, there is way more to the implementation of that feature in an IDE, but this method is needed to make it possible. I'm currently monkey-patching it in, but would prefer it to be part of the CoverageData API.
Of course this new method may also have other uses I'm not thinking of.