chore(deps): update all dependencies
This MR contains the following updates:
Package | Type | Update | Change |
---|---|---|---|
AleksaC/hadolint-py | repository | minor |
v2.10.0 -> v2.12.0
|
adrienverge/yamllint | repository | minor |
v1.28.0 -> v1.35.1
|
docker | service-image | major |
20.10.22-dind -> 26.1.1-dind
|
docker | image | major |
20.10.22 -> 26.1.1
|
markdownlint/markdownlint | repository | minor |
v0.12.0 -> v0.13.0
|
pre-commit | precommit | major |
2.20.0 -> 3.7.0
|
pre-commit/pre-commit-hooks | repository | minor |
v4.4.0 -> v4.6.0
|
psf/black | repository | major |
22.12.0 -> 24.4.2
|
pycqa/flake8 | repository | major |
6.0.0 -> 7.0.0
|
pycqa/isort | repository | minor |
5.11.4 -> 5.13.2
|
pytest (changelog) | test | major |
7.2.0 -> 8.2.0
|
pytest-cov (changelog) | test | major |
4.0.0 -> 5.0.0
|
python | image | minor |
3.11.1 -> 3.12.3
|
Note: The pre-commit
manager in Renovate is not supported by the pre-commit
maintainers or community. Please do not report any problems there, instead create a Discussion in the Renovate repository if you have any questions.
Release Notes
adrienverge/yamllint (adrienverge/yamllint)
v1.35.1
v1.35.0
v1.34.0
v1.33.0
v1.32.0
v1.31.0
v1.30.0
v1.29.0
markdownlint/markdownlint (markdownlint/markdownlint)
v0.13.0
Rules Added
- MD055 - Tables: Each row must start and end with a
|
#464 - MD056 - Tables: Number of columns is the same for all rows #464
- MD057 - Tables: In the second row every column must have at least
---
, possibly surrounded with alignment:
chars #464
Added
Changed
- MD009 - Allow exactly 2 trailing spaces by default #452
- MD033 - Add
allowed_elements
parameter #450 - Updated build instructions #431
Fixed
pre-commit/pre-commit (pre-commit)
v3.7.0
==================
Features
- Use a tty for
docker
anddocker_image
hooks when--color
is specified.- #3122 MR by @glehmann.
Fixes
- Fix
fail_fast
for individual hooks stopping when previous hooks had failed.- #3167 issue by @tp832944.
- #3168 MR by @asottile.
Updating
- The per-hook behaviour of
fail_fast
was fixed. If you want the pre-3.7.0 behaviour, addfail_fast: true
to all hooks before the lastfail_fast
hook.
v3.6.2
==================
Fixes
- Fix building golang hooks during
git commit --all
.- #3130 MR by @asottile.
- #2722 issue by @pestanko and @matthewhughes934.
v3.6.1
==================
Fixes
- Remove
PYTHONEXECUTABLE
from environment when running.- #3110 MR by @untitaker.
- Handle staged-files-only with only a crlf diff.
- #3126 MR by @asottile.
- issue by @tyyrok.
v3.6.0
==================
Features
- Check
minimum_pre_commit_version
first when parsing configs.- #3092 MR by @asottile.
Fixes
- Fix deprecation warnings for
importlib.resources
.- #3043 MR by @asottile.
- Fix deprecation warnings for rmtree.
- #3079 MR by @edgarrmondragon.
Updating
- Drop support for python<3.9.
- #3042 MR by @asottile.
- #3093 MR by @asottile.
v3.5.0
==================
Features
- Improve performance of
check-hooks-apply
andcheck-useless-excludes
.
Fixes
- Use
time.monotonic()
for more accurate hook timing.- #3024 MR by @adamchainz.
Migrating
- Require npm 6.x+ for
language: node
hooks.- #2996 MR by @RoelAdriaans.
- #1983 issue by @henryiii.
v3.4.0
==================
Features
- Add
language: haskell
.- #2932 by @alunduil.
- Improve cpu count detection when run under cgroups.
Fixes
- Handle negative exit codes from hooks receiving posix signals.
- #2971 MR by @chriskuehl.
- #2970 issue by @chriskuehl.
v3.3.3
==================
Fixes
- Work around OS packagers setting
--install-dir
/--bin-dir
in gem settings.- #2905 MR by @jaysoffian.
- #2799 issue by @lmilbaum.
v3.3.2
==================
Fixes
- Work around
r
on windows sometimes double-un-quoting arguments.- #2885 MR by @lorenzwalthert.
- #2870 issue by @lorenzwalthert.
v3.3.1
==================
Fixes
- Work around
git
partial clone bug forautoupdate
on windows.- #2866 MR by @asottile.
- #2865 issue by @adehad.
v3.3.0
==================
Features
- Upgrade ruby-build.
- #2846 MR by @jalessio.
- Use blobless clone for faster autoupdate.
- #2859 MR by @asottile.
- Add
-j
/--jobs
argument toautoupdate
for parallel execution.- #2863 MR by @asottile.
- issue by @gaborbernat.
v3.2.2
==================
Fixes
- Fix support for swift >= 5.8.
- #2836 MR by @edelabar.
- #2835 issue by @kgrobelny-intive.
v3.2.1
==================
Fixes
- Fix
language_version
forlanguage: rust
without globalrustup
.- #2823 issue by @daschuer.
- #2827 MR by @asottile.
v3.2.0
==================
Features
- Allow
pre-commit
,pre-push
, andpre-merge-commit
asstages
.- #2732 issue by @asottile.
- #2808 MR by @asottile.
- Add
pre-rebase
hook support.- #2582 issue by @BrutalSimplicity.
- #2725 MR by @mgaligniana.
Fixes
- Remove bulky cargo cache from
language: rust
installs.- #2820 MR by @asottile.
v3.1.1
==================
Fixes
- Fix
rust
withlanguage_version
and a non-writable hostRUSTUP_HOME
.
v3.1.0
==================
Fixes
- Fix
dotnet
for.sln
-based hooks for dotnet>=7.0.200. - Prevent stashing when
diff
fails to execute.- #2774 MR by @asottile.
- #2773 issue by @strubbly.
- Dependencies are no longer sorted in repository key.
- #2776 MR by @asottile.
Updating
- Deprecate
language: python_venv
. Uselanguage: python
instead.- #2746 MR by @asottile.
- #2734 issue by @asottile.
v3.0.4
==================
Fixes
- Fix hook diff detection for files affected by
--textconv
.- #2743 MR by @adamchainz.
- #2743 issue by @adamchainz.
v3.0.3
==================
Fixes
- Revert "Prevent local
Gemfile
from interfering with hook execution.".- #2739 issue by @Roguelazer.
- #2740 MR by @asottile.
v3.0.2
==================
Fixes
- Prevent local
Gemfile
from interfering with hook execution.- #2727 MR by @asottile.
- Fix
language: r
,repo: local
hooks- pre-commit-ci/issues#107 by @lorenzwalthert.
- #2728 MR by @asottile.
v3.0.1
==================
Fixes
- Ensure coursier hooks are available offline after install.
- #2723 MR by @asottile.
v3.0.0
==================
Features
- Make
language: golang
bootstrapgo
if not present.- #2651 MR by @taoufik07.
- #2649 issue by @taoufik07.
-
language: coursier
now supportsadditional_dependencies
andrepo: local
- #2702 MR by @asottile.
- Upgrade
ruby-build
to20221225
.- #2718 MR by @jalessio.
Fixes
- Improve error message for invalid yaml for
pre-commit autoupdate
.- #2686 MR by @asottile.
- #2685 issue by @CarstenGrohmann.
-
repo: local
no longer provisions an emptygit
repo.- #2699 MR by @asottile.
Updating
- Drop support for python<3.8
- #2655 MR by @asottile.
- Drop support for top-level list, use
pre-commit migrate-config
to update.- #2656 MR by @asottile.
- Drop support for
sha
to specify revision, usepre-commit migrate-config
to update.- #2657 MR by @asottile.
- Remove
pre-commit-validate-config
andpre-commit-validate-manifest
, usepre-commit validate-config
andpre-commit validate-manifest
instead.- #2658 MR by @asottile.
-
language: golang
hooks must usego.mod
to specify dependencies- #2672 MR by @taoufik07.
v2.21.0
===================
Features
- Require new-enough virtualenv to prevent 3.10 breakage
- #2467 MR by @asottile.
- Respect aliases with
SKIP
for environment install. - Allow
pre-commit run --files
against unmerged paths.- #2484 MR by @asottile.
- Also apply regex warnings to
repo: local
hooks.- #2524 MR by @chrisRedwine.
- #2521 issue by @asottile.
-
rust
is now a "first class" language -- supportinglanguage_version
and installation when not present.- #2534 MR by @Holzhaus.
-
r
now uses more-reliable binary installation.- #2460 MR by @lorenzwalthert.
-
GIT_ALLOW_PROTOCOL
is now passed through for git operations.- #2555 MR by @asottile.
-
GIT_ASKPASS
is now passed through for git operations. - Remove
toml
dependency by usingcargo add
directly. - Support
dotnet
hooks which have dotted prefixes.
Fixes
- Properly adjust
--commit-msg-filename
if run from a sub directory.- #2459 MR by @asottile.
- Simplify
--intent-to-add
detection by usinggit diff
. - Fix
R.exe
selection on windows.- #2605 MR by @lorenzwalthert.
- #2599 issue by @SInginc.
- Skip default
nuget
source when installingdotnet
packages.
pre-commit/pre-commit-hooks (pre-commit/pre-commit-hooks)
v4.6.0
: pre-commit-hooks v4.6.0
Features
-
requirements-txt-fixer
: remove duplicate packages.- #1014 MR by @vhoulbreque-withings.
- #960 issue @csibe17.
Migrating
-
fix-encoding-pragma
: deprecated -- will be removed in 5.0.0. use pyupgrade or some other tool.
v4.5.0
: pre-commit-hooks v4.5.0
Features
-
requirements-txt-fixer
: also sortconstraints.txt
by default.- #857 MR by @lev-blit.
- #830 issue by @PLPeeters.
-
debug-statements
: addbpdb
debugger.
Fixes
-
file-contents-sorter
: fix sorting an empty file.- #944 MR by @RoelAdriaans.
- #935 issue by @paduszyk.
-
double-quote-string-fixer
: don't rewrite inside f-strings in 3.12+.- #973 MR by @asottile.
- #971 issue by @XuehaiPan.
Migrating
- now requires python >= 3.8.
- #926 MR by @asottile.
- #927 MR by @asottile.
psf/black (psf/black)
v24.4.2
This is a bugfix release to fix two regressions in the new f-string parser introduced in 24.4.1.
Parser
- Fix regression where certain complex f-strings failed to parse (#4332)
Performance
- Fix bad performance on certain complex string literals (#4331)
v24.4.1
Highlights
- Add support for the new Python 3.12 f-string syntax introduced by PEP 701 (#3822)
Stable style
- Fix crash involving indented dummy functions containing newlines (#4318)
Parser
- Add support for type parameter defaults, a new syntactic feature added to Python 3.13 by PEP 696 (#4327)
Integrations
- Github Action now works even when
git archive
is skipped (#4313)
v24.4.0
Stable style
- Fix unwanted crashes caused by AST equivalency check (#4290)
Preview style
-
if
guards incase
blocks are now wrapped in parentheses when the line is too long. (#4269) - Stop moving multiline strings to a new line unless inside brackets (#4289)
Integrations
- Add a new option
use_pyproject
to the GitHub Actionpsf/black
. This will read the Black version frompyproject.toml
. (#4294)
v24.3.0
Highlights
This release is a milestone: it fixes Black's first CVE security vulnerability. If you run Black on untrusted input, or if you habitually put thousands of leading tab characters in your docstrings, you are strongly encouraged to upgrade immediately to fix CVE-2024-21503.
This release also fixes a bug in Black's AST safety check that allowed Black to make incorrect changes to certain f-strings that are valid in Python 3.12 and higher.
Stable style
- Don't move comments along with delimiters, which could cause crashes (#4248)
- Strengthen AST safety check to catch more unsafe changes to strings. Previous versions of Black would incorrectly format the contents of certain unusual f-strings containing nested strings with the same quote type. Now, Black will crash on such strings until support for the new f-string syntax is implemented. (#4270)
- Fix a bug where line-ranges exceeding the last code line would not work as expected (#4273)
Performance
- Fix catastrophic performance on docstrings that contain large numbers of leading tab characters. This fixes CVE-2024-21503. (#4278)
Documentation
- Note what happens when
--check
is used with--quiet
(#4236)
v24.2.0
Stable style
- Fixed a bug where comments where mistakenly removed along with redundant parentheses (#4218)
Preview style
- Move the
hug_parens_with_braces_and_square_brackets
feature to the unstable style due to an outstanding crash and proposed formatting tweaks (#4198) - Fixed a bug where base expressions caused inconsistent formatting of ** in tenary expression (#4154)
- Checking for newline before adding one on docstring that is almost at the line limit (#4185)
- Remove redundant parentheses in
case
statementif
guards (#4214).
Configuration
- Fix issue where Black would ignore input files in the presence of symlinks (#4222)
-
Black now ignores
pyproject.toml
that is missing atool.black
section when discovering project root and configuration. Since Black continues to use version control as an indicator of project root, this is expected to primarily change behavior for users in a monorepo setup (desirably). If you wish to preserve previous behavior, simply add an empty[tool.black]
to the previously discoveredpyproject.toml
(#4204)
Output
- Black will swallow any
SyntaxWarning
s orDeprecationWarning
s produced by theast
module when performing equivalence checks (#4189)
Integrations
- Add a JSONSchema and provide a validate-pyproject entry-point (#4181)
v24.1.1
Bugfix release to fix a bug that made Black unusable on certain file systems with strict limits on path length.
Preview style
- Consistently add trailing comma on typed parameters (#4164)
Configuration
- Shorten the length of the name of the cache file to fix crashes on file systems that do not support long paths (#4176)
v24.1.0
Highlights
This release introduces the new 2024 stable style (#4106), stabilizing the following changes:
- Add parentheses around
if
-else
expressions (#2278) - Dummy class and function implementations consisting only of
...
are formatted more compactly (#3796) - If an assignment statement is too long, we now prefer splitting on the right-hand side (#3368)
- Hex codes in Unicode escape sequences are now standardized to lowercase (#2916)
- Allow empty first lines at the beginning of most blocks (#3967, #4061)
- Add parentheses around long type annotations (#3899)
- Enforce newline after module docstrings (#3932, #4028)
- Fix incorrect magic trailing comma handling in return types (#3916)
- Remove blank lines before class docstrings (#3692)
- Wrap multiple context managers in parentheses if combined in a single
with
statement (#3489) - Fix bug in line length calculations for power operations (#3942)
- Add trailing commas to collection literals even if there's a comment after the last entry (#3393)
- When using
--skip-magic-trailing-comma
or-C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209) - Add extra blank lines in stubs in a few cases (#3564, #3862)
- Accept raw strings as docstrings (#3947)
- Split long lines in case blocks (#4024)
- Stop removing spaces from walrus operators within subscripts (#3823)
- Fix incorrect formatting of certain async statements (#3609)
- Allow combining
# fmt: skip
with other comments (#3959)
There are already a few improvements in the --preview
style, which are slated for the
2025 stable style. Try them out and
share your feedback. In the past, the preview
style has included some features that we were not able to stabilize. This year, we're
adding a separate --unstable
style for features with known problems. Now, the
--preview
style only includes features that we actually expect to make it into next
year's stable style.
Stable style
Several bug fixes were made in features that are moved to the stable style in this release:
- Fix comment handling when parenthesising conditional expressions (#4134)
- Fix bug where spaces were not added around parenthesized walruses in subscripts, unlike other binary operators (#4109)
- Remove empty lines before docstrings in async functions (#4132)
- Address a missing case in the change to allow empty lines at the beginning of all blocks, except immediately before a docstring (#4130)
- For stubs, fix logic to enforce empty line after nested classes with bodies (#4141)
Preview style
- Add
--unstable
style, covering preview features that have known problems that would block them from going into the stable style. Also add the--enable-unstable-feature
flag; for example, use--enable-unstable-feature hug_parens_with_braces_and_square_brackets
to apply this preview feature throughout 2024, even if a later Black release downgrades the feature to unstable (#4096) - Format module docstrings the same as class and function docstrings (#4095)
- Fix crash when using a walrus in a dictionary (#4155)
- Fix unnecessary parentheses when wrapping long dicts (#4135)
- Stop normalizing spaces before
# fmt: skip
comments (#4146)
Configuration
- Print warning when configuration in
pyproject.toml
contains an invalid key (#4165) - Fix symlink handling, properly ignoring symlinks that point outside of root (#4161)
- Fix cache mtime logic that resulted in false positive cache hits (#4128)
- Remove the long-deprecated
--experimental-string-processing
flag. This feature can currently be enabled with--preview --enable-unstable-feature string_processing
. (#4096)
Integrations
- Revert the change to run Black's pre-commit integration only on specific git hooks (#3940) for better compatibility with older versions of pre-commit (#4137)
v23.12.1
Packaging
- Fixed a bug that included dependencies from the
d
extra by default (#4108)
v23.12.0
Highlights
It's almost 2024, which means it's time for a new edition of Black's stable style! Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft 2024 stable style, which we'll finalize in the January release. Please try it out and share your feedback.
This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in --preview
mode will be in the 2024 stable style.
Stable style
- Fix bug where
# fmt: off
automatically dedents when used with the--line-ranges
option, even when it is not within the specified line range. (#4084) - Fix feature detection for parenthesized context managers (#4104)
Preview style
- Prefer more equal signs before a break when splitting chained assignments (#4010)
- Standalone form feed characters at the module level are no longer removed (#4021)
- Additional cases of immediately nested tuples, lists, and dictionaries are now indented less (#4012)
- Allow empty lines at the beginning of all blocks, except immediately before a docstring (#4060)
- Fix crash in preview mode when using a short
--line-length
(#4086) - Keep suites consisting of only an ellipsis on their own lines if they are not functions or class definitions (#4066) (#4103)
Configuration
-
--line-ranges
now skips Black's internal stability check in--safe
mode. This avoids a crash on rare inputs that have many unformatted same-content lines. (#4034)
Packaging
- Upgrade to mypy 1.7.1 (#4049) (#4069)
- Faster compiled wheels are now available for CPython 3.12 (#4070)
Integrations
- Enable 3.12 CI (#4035)
- Build docker images in parallel (#4054)
- Build docker images with 3.12 (#4055)
v23.11.0
Highlights
- Support formatting ranges of lines with the new
--line-ranges
command-line option (#4020)
Stable style
- Fix crash on formatting bytes strings that look like docstrings (#4003)
- Fix crash when whitespace followed a backslash before newline in a docstring (#4008)
- Fix standalone comments inside complex blocks crashing Black (#4016)
- Fix crash on formatting code like
await (a ** b)
(#3994) - No longer treat leading f-strings as docstrings. This matches Python's behaviour and fixes a crash (#4019)
Preview style
- Multiline dicts and lists that are the sole argument to a function are now indented less (#3964)
- Multiline unpacked dicts and lists as the sole argument to a function are now also indented less (#3992)
- In f-string debug expressions, quote types that are visible in the final string are now preserved (#4005)
- Fix a bug where long
case
blocks were not split into multiple lines. Also enable general trailing comma rules oncase
blocks (#4024) - Keep requiring two empty lines between module-level docstring and first function or class definition (#4028)
- Add support for single-line format skip with other comments on the same line (#3959)
Configuration
- Consistently apply force exclusion logic before resolving symlinks (#4015)
- Fix a bug in the matching of absolute path names in
--include
(#3976)
Performance
- Fix mypyc builds on arm64 on macOS (#4017)
Integrations
- Black's pre-commit integration will now run only on git hooks appropriate for a code formatter (#3940)
v23.10.1
Highlights
- Maintenance release to get a fix out for GitHub Action edge case (#3957)
Preview style
- Fix merging implicit multiline strings that have inline comments (#3956)
- Allow empty first line after block open before a comment or compound statement (#3967)
Packaging
- Change Dockerfile to hatch + compile black (#3965)
Integrations
- The summary output for GitHub workflows is now suppressible using the
summary
parameter. (#3958) - Fix the action failing when Black check doesn't pass (#3957)
Documentation
- It is known Windows documentation CI is broken https://github.com/psf/black/issues/3968
v23.10.0
Stable style
- Fix comments getting removed from inside parenthesized strings (#3909)
Preview style
- Fix long lines with power operators getting split before the line length (#3942)
- Long type hints are now wrapped in parentheses and properly indented when split across multiple lines (#3899)
- Magic trailing commas are now respected in return types. (#3916)
- Require one empty line after module-level docstrings. (#3932)
- Treat raw triple-quoted strings as docstrings (#3947)
Configuration
- Fix cache versioning logic when
BLACK_CACHE_DIR
is set (#3937)
Parser
- Fix bug where attributes named
type
were not accepted insidematch
statements (#3950) - Add support for PEP 695 type aliases containing lambdas and other unusual expressions (#3949)
Output
- Black no longer attempts to provide special errors for attempting to format Python 2 code (#3933)
- Black will more consistently print stacktraces on internal errors in verbose mode (#3938)
Integrations
- The action output displayed in the job summary is now wrapped in Markdown (#3914)
v23.9.1
Due to various issues, the previous release (23.9.0) did not include compiled mypyc wheels, which make Black significantly faster. These issues have now been fixed, and this release should come with compiled wheels once again.
There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12 wheels in a future release as soon as the mypyc bug is fixed.
Packaging
- Upgrade to mypy 1.5.1 (#3864)
Performance
- Store raw tuples instead of NamedTuples in Black's cache, improving performance and decreasing the size of the cache (#3877)
v23.9.0
Preview style
- More concise formatting for dummy implementations (#3796)
- In stub files, add a blank line between a statement with a body (e.g an
if sys.version_info > (3, x):
) and a function definition on the same level (#3862) - Fix a bug whereby spaces were removed from walrus operators within subscript(#3823)
Configuration
- Black now applies exclusion and ignore logic before resolving symlinks (#3846)
Performance
- Avoid importing
IPython
if notebook cells do not contain magics (#3782) - Improve caching by comparing file hashes as fallback for mtime and size (#3821)
Blackd
- Fix an issue in
blackd
with single character input (#3558)
Integrations
- Black now has an
official pre-commit mirror. Swapping
https://github.com/psf/black
tohttps://github.com/psf/black-pre-commit-mirror
in your.pre-commit-config.yaml
will make Black about 2x faster (#3828) - The
.black.env
folder specified byENV_PATH
will now be removed on the completion of the GitHub Action (#3759)
v23.7.0
Highlights
- Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be supported until further notice (#3765)
Stable style
- Fix a bug where an illegal trailing comma was added to return type annotations using PEP 604 unions (#3735)
- Fix several bugs and crashes where comments in stub files were removed or mishandled under some circumstances (#3745)
- Fix a crash with multi-line magic comments like
type: ignore
within parentheses (#3740) - Fix error in AST validation when Black removes trailing whitespace in a type comment (#3773)
Preview style
- Implicitly concatenated strings used as function args are no longer wrapped inside parentheses (#3640)
- Remove blank lines between a class definition and its docstring (#3692)
Configuration
- The
--workers
argument to Black can now be specified via theBLACK_NUM_WORKERS
environment variable (#3743) -
.pytest_cache
,.ruff_cache
and.vscode
are now excluded by default (#3691) - Fix Black not honouring
pyproject.toml
settings when running--stdin-filename
and thepyproject.toml
found isn't in the current working directory (#3719) -
Black will now error if
exclude
andextend-exclude
have invalid data types inpyproject.toml
, instead of silently doing the wrong thing (#3764)
Packaging
- Upgrade mypyc from 0.991 to 1.3 (#3697)
- Remove patching of Click that mitigated errors on Python 3.6 with
LANG=C
(#3768)
Parser
- Add support for the new PEP 695 syntax in Python 3.12 (#3703)
Performance
- Speed up Black significantly when the cache is full (#3751)
- Avoid importing
IPython
in a case where we wouldn't need it (#3748)
Output
- Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
- Change verbose logging to exactly mirror Black's logic for source discovery (#3749)
Blackd
- The
blackd
argument parser now shows the default values for options in their help text (#3712)
Integrations
- Black is now tested with
PYTHONWARNDEFAULTENCODING = 1
(#3763) - Update GitHub Action to display black output in the job summary (#3688)
Documentation
- Add a CITATION.cff file to the root of the repository, containing metadata on how to cite this software (#3723)
- Update the classes and exceptions documentation in Developer reference to match the latest code base (#3755)
v23.3.0
Highlights
This release fixes a longstanding confusing behavior in Black's GitHub action, where the version of the action did not determine the version of Black being run (issue #3382). In addition, there is a small bug fix around imports and a number of improvements to the preview style.
Please try out the
preview style
with black --preview
and tell us your feedback. All changes in the preview style are
expected to become part of Black's stable style in January 2024.
Stable style
- Import lines with
# fmt: skip
and# fmt: off
no longer have an extra blank line added when they are right after another import line (#3610)
Preview style
- Add trailing commas to collection literals even if there's a comment after the last entry (#3393)
-
async def
,async for
, andasync with
statements are now formatted consistently compared to their non-async version. (#3609) -
with
statements that contain two context managers will be consistently wrapped in parentheses (#3589) - Let string splitters respect East Asian Width (#3445)
- Now long string literals can be split after East Asian commas and periods (
、
U+3001 IDEOGRAPHIC COMMA,。
U+3002 IDEOGRAPHIC FULL STOP, &,
U+FF0C FULLWIDTH COMMA) besides before spaces (#3445) - For stubs, enforce one blank line after a nested class with a body other than just
...
(#3564) - Improve handling of multiline strings by changing line split behavior (#1879)
Parser
- Added support for formatting files with invalid type comments (#3594)
Integrations
- Update GitHub Action to use the version of Black equivalent to action's version if version input is not specified (#3543)
- Fix missing Python binary path in autoload script for vim (#3508)
Documentation
- Document that only the most recent release is supported for security issues; vulnerabilities should be reported through Tidelift (#3612)
v23.1.0
Highlights
This is the first release of 2023, and following our stability policy, it comes with a number of improvements to our stable style, including improvements to empty line handling, removal of redundant parentheses in several contexts, and output that highlights implicitly concatenated strings better.
There are also many changes to the preview style; try out black --preview
and give us
feedback to help us set the stable style for next year.
In addition to style changes, Black now automatically infers the supported Python
versions from your pyproject.toml
file, removing the need to set Black's target
versions separately.
Stable style
- Introduce the 2023 stable style, which incorporates most aspects of last year's
preview style (#3418). Specific changes:
- Enforce empty lines before classes and functions with sticky leading comments (#3302) (22.12.0)
- Reformat empty and whitespace-only files as either an empty file (if no newline is present) or as a single newline character (if a newline is present) (#3348) (22.12.0)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307) (22.12.0)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370) (22.12.0)
-
--skip-string-normalization
/-S
now prevents docstring prefixes from being normalized as expected (#3168) (since 22.8.0) - When using
--skip-magic-trailing-comma
or-C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209) (22.8.0) - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162) (22.8.0)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227) (22.8.0)
- Docstring quotes are no longer moved if it would violate the line length limit (#3044, #3430) (22.6.0)
- Parentheses around return annotations are now managed (#2990) (22.6.0)
- Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
- Remove unnecessary parentheses in
with
statements (#2926) (22.6.0) - Remove trailing newlines after code block open (#3035) (22.6.0)
- Code cell separators
#%%
are now standardised to# %%
(#2919) (22.3.0) - Remove unnecessary parentheses from
except
statements (#2939) (22.3.0) - Remove unnecessary parentheses from tuple unpacking in
for
loops (#2945) (22.3.0) - Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
- Fix a crash when a colon line is marked between
# fmt: off
and# fmt: on
(#3439)
Preview style
- Format hex codes in unicode escape sequences in string literals (#2916)
- Add parentheses around
if
-else
expressions (#2278) - Improve performance on large expressions that contain many strings (#3467)
- Fix a crash in preview style with assert + parenthesized string (#3415)
- Fix crashes in preview style with walrus operators used in function return annotations and except clauses (#3423)
- Fix a crash in preview advanced string processing where mixed implicitly concatenated regular and f-strings start with an empty span (#3463)
- Fix a crash in preview advanced string processing where a standalone comment is placed before a dict's value (#3469)
- Fix an issue where extra empty lines are added when a decorator has
# fmt: skip
applied or there is a standalone comment between decorators (#3470) - Do not put the closing quotes in a docstring on a separate line, even if the line is too long (#3430)
- Long values in dict literals are now wrapped in parentheses; correspondingly unnecessary parentheses around short values in dict literals are now removed; long string lambda values are now wrapped in parentheses (#3440)
- Fix two crashes in preview style involving edge cases with docstrings (#3451)
- Exclude string type annotations from improved string processing; fix crash when the return type annotation is stringified and spans across multiple lines (#3462)
- Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
- Fix several crashes in preview style with walrus operators used in
with
statements or tuples (#3473) - Fix an invalid quote escaping bug in f-string expressions where it produced invalid code. Implicitly concatenated f-strings with different quotes can now be merged or quote-normalized by changing the quotes used in expressions. (#3509)
- Fix crash on
await (yield)
when Black is compiled with mypyc (#3533)
Configuration
- Black now tries to infer its
--target-version
from the project metadata specified inpyproject.toml
(#3219)
Packaging
- Upgrade mypyc from
0.971
to0.991
so mypycified Black can be built on armv7 (#3380)- This also fixes some crashes while using compiled Black with a debug build of CPython
- Drop specific support for the
tomli
requirement on 3.11 alpha releases, working around a bug that would cause the requirement not to be installed on any non-final Python releases (#3448) - Black now depends on
packaging
version22.0
or later. This is required for new functionality that needs to parse part of the project metadata (#3219)
Output
- Calling
black --help
multiple times will return the same help contents each time (#3516) - Verbose logging now shows the values of
pyproject.toml
configuration variables (#3392) - Fix false symlink detection messages in verbose output due to using an incorrect relative path to the project root (#3385)
Integrations
- Move 3.11 CI to normal flow now that all dependencies support 3.11 (#3446)
- Docker: Add new
latest_prerelease
tag automation to follow latest black alpha release on docker images (#3465)
Documentation
- Expand
vim-plug
installation instructions to offer more explicit options (#3468)
pycqa/isort (pycqa/isort)
v5.13.2
- Apply the bracket fix from issue #471 only for use_parentheses=True (#2184) @bp72
- Confine pre-commit to stages (#2213) @davidculley
- Fixed colors extras (#2212) @staticdev
v5.13.1
- Fixed integration tests (#2208) @bp72
- Fixed normalizing imports from more than one level of parent modules (issue/2152) (#2191) @bp72
- Remove optional dependencies without extras (#2207) @staticdev
v5.13.0
- Cleanup deprecated extras (#2089) @staticdev
- Fixed #1989: settings lookup when working in stream based mode
- Fixed 80 line length for wemake linter (#2183) @skatromb
- Add support for Python 3.12 (#2175) @hugovk
- Fixed: add newest version to pre-commit docs (#2190) @AzulGarza
- Fixed assertions in test_git_hook (#2196) @mgorny
- Removed check for include_trailing_comma for the Hanging Indent wrap mode (#2192) @bp72
- Use the standard library tomllib on sufficiently new python (#2202) @eli-schwartz
- Update pre-commit.md version number (#2197) @nicobako
- doc: Update black_compatibility.md (#2177) @JSS95
- Fixed safety sept 2023 (#2178) @staticdev
- docs: fix black profile documentation (#2163) @nijel
- Fixed typo: indended -> indented (#2161) @vadimkerr
- Docs(configuration/options.md): fix missing trailing spaces for hard linebreak (#2157) @JoeyTeng
- Update pre-commit.md (#2148) @godiard
- chore: move configurations to pyproject.toml (#2115) @SauravMaheshkar
- Fixed typo in README (#2112) @stefmolin
- Update version in pre-commit setup to avoid installation issue with poetry (#2103) @stefmolin
- Skip .pytype directory by default. (#2098) @manueljacob
- Fixed a tip block styling in the Config Files section (#2097) @Klavionik
- Do not cache configuration files (#1995) @kaste
- Derive settings_path from --filename (#1992) @kaste
- Fixed year of version 5.12.0 in CHANGELOG.md (#2082) @DjLegolas
v5.12.0
- Removed support for Python 3.7
- Fixed incompatiblity with latest poetry version
- Added support for directory limitations within built in git hook
v5.11.5
- Fixed incompatiblity with latest poetry version
pytest-dev/pytest (pytest)
v8.2.0
pytest 8.2.0 (2024-04-27)
Deprecations
-
#12069: A deprecation warning is now raised when implementations of one of the following hooks request a deprecated
py.path.local
parameter instead of thepathlib.Path
parameter which replaced it:-
pytest_ignore_collect
{.interpreted-text role="hook"} - thepath
parameter - usecollection_path
instead. -
pytest_collect_file
{.interpreted-text role="hook"} - thepath
parameter - usefile_path
instead. -
pytest_pycollect_makemodule
{.interpreted-text role="hook"} - thepath
parameter - usemodule_path
instead. -
pytest_report_header
{.interpreted-text role="hook"} - thestartdir
parameter - usestart_path
instead. -
pytest_report_collectionfinish
{.interpreted-text role="hook"} - thestartdir
parameter - usestart_path
instead.
The replacement parameters are available since pytest 7.0.0. The old parameters will be removed in pytest 9.0.0.
See
legacy-path-hooks-deprecated
{.interpreted-text role="ref"} for more details. -
Features
-
#11871: Added support for reading command line arguments from a file using the prefix character
@
, like e.g.:pytest @​tests.txt
. The file must have one argument per line.See
Read arguments from file <args-from-file>
{.interpreted-text role="ref"} for details.
Improvements
-
#11523:
pytest.importorskip
{.interpreted-text role="func"} will now issue a warning if the module could be found, but raisedImportError
{.interpreted-text role="class"} instead ofModuleNotFoundError
{.interpreted-text role="class"}.The warning can be suppressed by passing
exc_type=ImportError
topytest.importorskip
{.interpreted-text role="func"}.See
import-or-skip-import-error
{.interpreted-text role="ref"} for details. -
#11728: For
unittest
-based tests, exceptions during class cleanup (as raised by functions registered withTestCase.addClassCleanup <unittest.TestCase.addClassCleanup>
{.interpreted-text role="meth"}) are now reported instead of silently failing. -
#11777: Text is no longer truncated in the
short test summary info
section when-vv
is given. -
#12112: Improved namespace packages detection when
consider_namespace_packages
{.interpreted-text role="confval"} is enabled, covering more situations (like editable installs). -
#9502: Added
PYTEST_VERSION
{.interpreted-text role="envvar"} environment variable which is defined at the start of the pytest session and undefined afterwards. It contains the value ofpytest.__version__
, and among other things can be used to easily check if code is running from within a pytest run.
Bug Fixes
-
#12065: Fixed a regression in pytest 8.0.0 where test classes containing
setup_method
and tests using@staticmethod
or@classmethod
would crash withAttributeError: 'NoneType' object has no attribute 'setup_method'
.Now the
request.instance <pytest.FixtureRequest.instance>
{.interpreted-text role="attr"} attribute of tests using@staticmethod
and@classmethod
is no longerNone
, but a fresh instance of the class, like in non-static methods. Previously it wasNone
, and all fixtures of such tests would share a singleself
. -
#12135: Fixed issue where fixtures adding their finalizer multiple times to fixtures they request would cause unreliable and non-intuitive teardown ordering in some instances.
-
#12194: Fixed a bug with
--importmode=importlib
and--doctest-modules
where child modules did not appear as attributes in parent modules. -
#1489: Fixed some instances where teardown of higher-scoped fixtures was not happening in the reverse order they were initialized in.
Trivial/Internal Changes
-
#12069:
pluggy>=1.5.0
is now required. -
#12167:
cache <cache>
{.interpreted-text role="ref"}: create supporting files (CACHEDIR.TAG
,.gitignore
, etc.) in a temporary directory to provide atomic semantics.
v8.1.2
pytest 8.1.2 (2024-04-26)
Bug Fixes
-
#12114: Fixed error in
pytest.approx
{.interpreted-text role="func"} when used with [numpy]{.title-ref} arrays and comparing with other types.
v8.1.1
pytest 8.1.1 (2024-03-08)
::: {.note} ::: {.title} Note :::
This release is not a usual bug fix release -- it contains features and improvements, being a follow up
to 8.1.0
, which has been yanked from PyPI.
:::
Features
-
#11475: Added the new
consider_namespace_packages
{.interpreted-text role="confval"} configuration option, defaulting toFalse
.If set to
True
, pytest will attempt to identify modules that are part of namespace packages when importing modules. -
#11653: Added the new
verbosity_test_cases
{.interpreted-text role="confval"} configuration option for fine-grained control of test execution verbosity. SeeFine-grained verbosity <pytest.fine_grained_verbosity>
{.interpreted-text role="ref"} for more details.
Improvements
-
#10865:
pytest.warns
{.interpreted-text role="func"} now validates thatwarnings.warn
{.interpreted-text role="func"} was called with a [str]{.title-ref} or a [Warning]{.title-ref}. Currently in Python it is possible to use other types, however this causes an exception whenwarnings.filterwarnings
{.interpreted-text role="func"} is used to filter those warnings (see CPython #103577 for a discussion). While this can be considered a bug in CPython, we decided to put guards in pytest as the error message produced without this check in place is confusing. -
#11311: When using
--override-ini
for paths in invocations without a configuration file defined, the current working directory is used as the relative directory.Previoulsy this would raise an
AssertionError
{.interpreted-text role="class"}. -
#11475:
--import-mode=importlib <import-mode-importlib>
{.interpreted-text role="ref"} now tries to import modules using the standard import mechanism (but still without changing :pysys.path
{.interpreted-text role="data"}), falling back to importing modules directly only if that fails.This means that installed packages will be imported under their canonical name if possible first, for example
app.core.models
, instead of having the module name always be derived from their path (for example.env310.lib.site_packages.app.core.models
). -
#11801: Added the
iter_parents() <_pytest.nodes.Node.iter_parents>
{.interpreted-text role="func"} helper method on nodes. It is similar tolistchain <_pytest.nodes.Node.listchain>
{.interpreted-text role="func"}, but goes from bottom to top, and returns an iterator, not a list. -
#11850: Added support for
sys.last_exc
{.interpreted-text role="data"} for post-mortem debugging on Python>=3.12. -
#11962: In case no other suitable candidates for configuration file are found, a
pyproject.toml
(even without a[tool.pytest.ini_options]
table) will be considered as the configuration file and define therootdir
. -
#11978: Add
--log-file-mode
option to the logging plugin, enabling appending to log-files. This option accepts either"w"
or"a"
and defaults to"w"
.Previously, the mode was hard-coded to be
"w"
which truncates the file before logging. -
#12047: When multiple finalizers of a fixture raise an exception, now all exceptions are reported as an exception group. Previously, only the first exception was reported.
Bug Fixes
-
#11475: Fixed regression where
--importmode=importlib
would import non-test modules more than once. -
#11904: Fixed a regression in pytest 8.0.0 that would cause test collection to fail due to permission errors when using
--pyargs
.This change improves the collection tree for tests specified using
--pyargs
, see12043
{.interpreted-text role="pull"} for a comparison with pytest 8.0 and <8. -
#12011: Fixed a regression in 8.0.1 whereby
setup_module
xunit-style fixtures are not executed when--doctest-modules
is passed. -
#12014: Fix the
stacklevel
used when warning about marks used on fixtures. -
#12039: Fixed a regression in
8.0.2
where tests created usingtmp_path
{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.
Improved Documentation
-
#11790: Documented the retention of temporary directories created using the
tmp_path
fixture in more detail.
Trivial/Internal Changes
-
#11785: Some changes were made to private functions which may affect plugins which access them:
-
FixtureManager._getautousenames()
now takes aNode
itself instead of the nodeid. -
FixtureManager.getfixturedefs()
now takes theNode
itself instead of the nodeid. - The
_pytest.nodes.iterparentnodeids()
function is removed without replacement. Prefer to traverse the node hierarchy itself instead. If you really need to, copy the function from the previous pytest release.
-
-
#12069: Delayed the deprecation of the following features to
9.0.0
:-
node-ctor-fspath-deprecation
{.interpreted-text role="ref"}. -
legacy-path-hooks-deprecated
{.interpreted-text role="ref"}.
It was discovered after
8.1.0
was released that the warnings about the impeding removal were not being displayed, so the team decided to revert the removal.This is the reason for
8.1.0
being yanked. -
pytest 8.1.0 (YANKED)
::: {.note} ::: {.title} Note :::
This release has been yanked: it broke some plugins without the proper warning period, due to some warnings not showing up as expected.
See #12069. :::
v8.1.0
pytest 8.1.0 (YANKED)
[!IMPORTANT]
This release has been yanked: it broke some plugins without the proper warning period, due to some warnings not showing up as expected. See #12069.
Features
-
#11475: Added the new
consider_namespace_packages
{.interpreted-text role="confval"} configuration option, defaulting toFalse
.If set to
True
, pytest will attempt to identify modules that are part of namespace packages when importing modules. -
#11653: Added the new
verbosity_test_cases
{.interpreted-text role="confval"} configuration option for fine-grained control of test execution verbosity. SeeFine-grained verbosity <pytest.fine_grained_verbosity>
{.interpreted-text role="ref"} for more details.
Improvements
-
#10865:
pytest.warns
{.interpreted-text role="func"} now validates thatwarnings.warn
{.interpreted-text role="func"} was called with a [str]{.title-ref} or a [Warning]{.title-ref}. Currently in Python it is possible to use other types, however this causes an exception whenwarnings.filterwarnings
{.interpreted-text role="func"} is used to filter those warnings (see CPython #103577 for a discussion). While this can be considered a bug in CPython, we decided to put guards in pytest as the error message produced without this check in place is confusing. -
#11311: When using
--override-ini
for paths in invocations without a configuration file defined, the current working directory is used as the relative directory.Previoulsy this would raise an
AssertionError
{.interpreted-text role="class"}. -
#11475:
--import-mode=importlib <import-mode-importlib>
{.interpreted-text role="ref"} now tries to import modules using the standard import mechanism (but still without changing :pysys.path
{.interpreted-text role="data"}), falling back to importing modules directly only if that fails.This means that installed packages will be imported under their canonical name if possible first, for example
app.core.models
, instead of having the module name always be derived from their path (for example.env310.lib.site_packages.app.core.models
). -
#11801: Added the
iter_parents() <_pytest.nodes.Node.iter_parents>
{.interpreted-text role="func"} helper method on nodes. It is similar tolistchain <_pytest.nodes.Node.listchain>
{.interpreted-text role="func"}, but goes from bottom to top, and returns an iterator, not a list. -
#11850: Added support for
sys.last_exc
{.interpreted-text role="data"} for post-mortem debugging on Python>=3.12. -
#11962: In case no other suitable candidates for configuration file are found, a
pyproject.toml
(even without a[tool.pytest.ini_options]
table) will be considered as the configuration file and define therootdir
. -
#11978: Add
--log-file-mode
option to the logging plugin, enabling appending to log-files. This option accepts either"w"
or"a"
and defaults to"w"
.Previously, the mode was hard-coded to be
"w"
which truncates the file before logging. -
#12047: When multiple finalizers of a fixture raise an exception, now all exceptions are reported as an exception group. Previously, only the first exception was reported.
Bug Fixes
-
#11904: Fixed a regression in pytest 8.0.0 that would cause test collection to fail due to permission errors when using
--pyargs
.This change improves the collection tree for tests specified using
--pyargs
, see12043
{.interpreted-text role="pull"} for a comparison with pytest 8.0 and <8. -
#12011: Fixed a regression in 8.0.1 whereby
setup_module
xunit-style fixtures are not executed when--doctest-modules
is passed. -
#12014: Fix the
stacklevel
used when warning about marks used on fixtures. -
#12039: Fixed a regression in
8.0.2
where tests created usingtmp_path
{.interpreted-text role="fixture"} have been collected multiple times in CI under Windows.
Improved Documentation
-
#11790: Documented the retention of temporary directories created using the
tmp_path
fixture in more detail.
Trivial/Internal Changes
-
#11785: Some changes were made to private functions which may affect plugins which access them:
-
FixtureManager._getautousenames()
now takes aNode
itself instead of the nodeid. -
FixtureManager.getfixturedefs()
now takes theNode
itself instead of the nodeid. - The
_pytest.nodes.iterparentnodeids()
function is removed without replacement. Prefer to traverse the node hierarchy itself instead. If you really need to, copy the function from the previous pytest release.
-
v8.0.2
pytest 8.0.2 (2024-02-24)
Bug Fixes
-
#11895: Fix collection on Windows where initial paths contain the short version of a path (for example
c:\PROGRA~1\tests
). -
#11953: Fix an
IndexError
crash raising fromgetstatementrange_ast
. - #12021: Reverted a fix to [--maxfail]{.title-ref} handling in pytest 8.0.0 because it caused a regression in pytest-xdist whereby session fixture teardowns may get executed multiple times when the max-fails is reached.
v8.0.1
pytest 8.0.1 (2024-02-16)
Bug Fixes
-
#11875: Correctly handle errors from
getpass.getuser
{.interpreted-text role="func"} in Python 3.13. -
#11879: Fix an edge case where
ExceptionInfo._stringify_exception
could crashpytest.raises
{.interpreted-text role="func"}. -
#11906: Fix regression with
pytest.warns
{.interpreted-text role="func"} using custom warning subclasses which have more than one parameter in their [__init__]{.title-ref}. -
#11907: Fix a regression in pytest 8.0.0 whereby calling
pytest.skip
{.interpreted-text role="func"} and similar control-flow exceptions within apytest.warns()
{.interpreted-text role="func"} block would get suppressed instead of propagating. - #11929: Fix a regression in pytest 8.0.0 whereby autouse fixtures defined in a module get ignored by the doctests in the module.
- #11937: Fix a regression in pytest 8.0.0 whereby items would be collected in reverse order in some circumstances.
v8.0.0
: pytest 8.0.0 (2024-01-27)
See 8.0.0rc1 and 8.0.0rc2 for the full changes since pytest 7.4!
Bug Fixes
-
#11842: Properly escape the
reason
of askip <pytest.mark.skip ref>
{.interpreted-text role="ref"} mark when writing JUnit XML files. -
#11861: Avoid microsecond exceeds
1_000_000
when usinglog-date-format
with%f
specifier, which might cause the test suite to crash.
v7.4.4
: pytest 7.4.4 (2023-12-31)
Bug Fixes
- #11140: Fix non-string constants at the top of file being detected as docstrings on Python>=3.8.
-
#11572: Handle an edge case where
sys.stderr
{.interpreted-text role="data"} andsys.__stderr__
{.interpreted-text role="data"} might already be closed whenfaulthandler
{.interpreted-text role="ref"} is tearing down. - #11710: Fixed tracebacks from collection errors not getting pruned.
-
#7966: Removed unhelpful error message from assertion rewrite mechanism when exceptions are raised in
__iter__
methods. Now they are treated un-iterable instead.
Improved Documentation
-
#11091: Updated documentation to refer to hyphenated options: replaced
--junitxml
with--junit-xml
and--collectonly
with--collect-only
.
v7.4.3
: pytest 7.4.3 (2023-10-24)
Bug Fixes
-
#10447: Markers are now considered in the reverse mro order to ensure base class markers are considered first -- this resolves a regression.
-
#11239: Fixed
:=
in asserts impacting unrelated test cases. -
#11439: Handled an edge case where :data:
sys.stderr
might already be closed when :ref:faulthandler
is tearing down.
v7.4.2
: pytest 7.4.2 (2023-09-07)
Bug Fixes
-
#11237: Fix doctest collection of
functools.cached_property
objects. -
#11306: Fixed bug using
--importmode=importlib
which would cause package__init__.py
files to be imported more than once in some cases. -
#11367: Fixed bug where
user_properties
where not being saved in the JUnit XML file if a fixture failed during teardown. -
#11394: Fixed crash when parsing long command line arguments that might be interpreted as files.
Improved Documentation
- #11391: Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing.
v7.4.1
: pytest 7.4.1 (2023-09-02)
Bug Fixes
-
#10337: Fixed bug where fake intermediate modules generated by
--import-mode=importlib
would not include the child modules as attributes of the parent modules. -
#10702: Fixed error assertion handling in
pytest.approx
whenNone
is an expected or received value when comparing dictionaries. -
#10811: Fixed issue when using
--import-mode=importlib
together with--doctest-modules
that caused modules to be imported more than once, causing problems with modules that have import side effects.
v7.4.0
pytest 7.4.0 (2023-06-23)
Features
-
#10901: Added
ExceptionInfo.from_exception() <pytest.ExceptionInfo.from_exception>
{.interpreted-text role="func"}, a simpler way to create an~pytest.ExceptionInfo
{.interpreted-text role="class"} from an exception. This can replaceExceptionInfo.from_exc_info() <pytest.ExceptionInfo.from_exc_info()>
{.interpreted-text role="func"} for most uses.
Improvements
-
#10872: Update test log report annotation to named tuple and fixed inconsistency in docs for
pytest_report_teststatus
{.interpreted-text role="hook"} hook. -
#10907: When an exception traceback to be displayed is completely filtered out (by mechanisms such as
__tracebackhide__
, internal frames, and similar), now only the exception string and the following message are shown:"All traceback entries are hidden. Pass [--full-trace]{.title-ref} to see hidden and internal frames.".
Previously, the last frame of the traceback was shown, even though it was hidden.
-
#10940: Improved verbose output (
-vv
) ofskip
andxfail
reasons by performing text wrapping while leaving a clear margin for progress output.Added
TerminalReporter.wrap_write()
as a helper for that. -
#10991: Added handling of
%f
directive to print microseconds in log format options, such aslog-date-format
. -
#11005: Added the underlying exception to the cache provider's path creation and write warning messages.
-
#11013: Added warning when
testpaths
{.interpreted-text role="confval"} is set, but paths are not found by glob. In this case, pytest will fall back to searching from the current directory. -
#11043: When [--confcutdir]{.title-ref} is not specified, and there is no config file present, the conftest cutoff directory ([--confcutdir]{.title-ref}) is now set to the
rootdir <rootdir>
{.interpreted-text role="ref"}. Previously in such cases, [conftest.py]{.title-ref} files would be probed all the way to the root directory of the filesystem. If you are badly affected by this change, consider adding an empty config file to your desired cutoff directory, or explicitly set [--confcutdir]{.title-ref}. -
#11081: The
norecursedirs
{.interpreted-text role="confval"} check is now performed in apytest_ignore_collect
{.interpreted-text role="hook"} implementation, so plugins can affect it.If after updating to this version you see that your [norecursedirs]{.title-ref} setting is not being respected, it means that a conftest or a plugin you use has a bad [pytest_ignore_collect]{.title-ref} implementation. Most likely, your hook returns [False]{.title-ref} for paths it does not want to ignore, which ends the processing and doesn't allow other plugins, including pytest itself, to ignore the path. The fix is to return [None]{.title-ref} instead of [False]{.title-ref} for paths your hook doesn't want to ignore.
-
#8711:
caplog.set_level() <pytest.LogCaptureFixture.set_level>
{.interpreted-text role="func"} andcaplog.at_level() <pytest.LogCaptureFixture.at_level>
{.interpreted-text role="func"} will temporarily enable the requestedlevel
iflevel
was disabled globally vialogging.disable(LEVEL)
.
Bug Fixes
-
#10831: Terminal Reporting: Fixed bug when running in
--tb=line
mode wherepytest.fail(pytrace=False)
tests reportNone
. -
#11068: Fixed the
--last-failed
whole-file skipping functionality ("skipped N files") fornon-python test files <non-python tests>
{.interpreted-text role="ref"}. -
#11104: Fixed a regression in pytest 7.3.2 which caused to
testpaths
{.interpreted-text role="confval"} to be considered for loading initial conftests, even when it was not utilized (e.g. when explicit paths were given on the command line). Now thetestpaths
are only considered when they are in use. -
#1904: Fixed traceback entries hidden with
__tracebackhide__ = True
still being shown for chained exceptions (parts after "... the above exception ..." message). -
#7781: Fix writing non-encodable text to log file when using
--debug
.
Improved Documentation
-
#9146: Improved documentation for
caplog.set_level() <pytest.LogCaptureFixture.set_level>
{.interpreted-text role="func"}.
Trivial/Internal Changes
-
#11031: Enhanced the CLI flag for
-c
to now include--config-file
to make it clear that this flag applies to the usage of a custom config file.
v7.3.2
pytest 7.3.2 (2023-06-10)
Bug Fixes
-
#10169: Fix bug where very long option names could cause pytest to break with
OSError: [Errno 36] File name too long
on some systems. - #10894: Support for Python 3.12 (beta at the time of writing).
-
#10987:
testpaths
{.interpreted-text role="confval"} is now honored to load rootconftests
. - #10999: The [monkeypatch]{.title-ref} [setitem]{.title-ref}/[delitem]{.title-ref} type annotations now allow [TypedDict]{.title-ref} arguments.
- #11028: Fixed bug in assertion rewriting where a variable assigned with the walrus operator could not be used later in a function call.
-
#11054: Fixed
--last-failed
's "(skipped N files)" functionality for files inside of packages (directories with [__init__.py]{.title-ref} files).
v7.3.1
pytest 7.3.1 (2023-04-14)
Improvements
-
#10875: Python 3.12 support: fixed
RuntimeError: TestResult has no addDuration method
when runningunittest
tests. -
#10890: Python 3.12 support: fixed
shutil.rmtree(onerror=...)
deprecation warning when usingtmp_path
{.interpreted-text role="fixture"}.
Bug Fixes
-
#10896: Fixed performance regression related to
tmp_path
{.interpreted-text role="fixture"} and the newtmp_path_retention_policy
{.interpreted-text role="confval"} option. -
#10903: Fix crash
INTERNALERROR IndexError: list index out of range
which happens when displaying an exception where all entries are hidden. This reverts the change "Correctly handle__tracebackhide__
for chained exceptions." introduced in version 7.3.0.
v7.3.0
pytest 7.3.0 (2023-04-08)
Features
-
#10525: Test methods decorated with
@classmethod
can now be discovered as tests, following the same rules as normal methods. This fills the gap that static methods were discoverable as tests but not class methods. -
#10755:
console_output_style
{.interpreted-text role="confval"} now supportsprogress-even-when-capture-no
to force the use of the progress output even when capture is disabled. This is useful in large test suites where capture may have significant performance impact. -
#7431:
--log-disable
CLI option added to disable individual loggers. -
#8141: Added
tmp_path_retention_count
{.interpreted-text role="confval"} andtmp_path_retention_policy
{.interpreted-text role="confval"} configuration options to control how directories created by thetmp_path
{.interpreted-text role="fixture"} fixture are kept.
Improvements
-
#10226: If multiple errors are raised in teardown, we now re-raise an
ExceptionGroup
of them instead of discarding all but the last. -
#10658: Allow
-p
arguments to include spaces (eg:-p no:logging
instead of-pno:logging
). Mostly useful in theaddopts
section of the configuration file. -
#10710: Added
start
andstop
timestamps toTestReport
objects. -
#10727: Split the report header for
rootdir
,config file
andtestpaths
so each has its own line. - #10840: pytest should no longer crash on AST with pathological position attributes, for example testing AST produced by [Hylang <https://github.com/hylang/hy>__]{.title-ref}.
- #6267: The full output of a test is no longer truncated if the truncation message would be longer than the hidden text. The line number shown has also been fixed.
Bug Fixes
- #10743: The assertion rewriting mechanism now works correctly when assertion expressions contain the walrus operator.
-
#10765: Fixed
tmp_path
{.interpreted-text role="fixture"} fixture always raisingOSError
{.interpreted-text role="class"} onemscripten
platform due to missingos.getuid
{.interpreted-text role="func"}. -
#1904: Correctly handle
__tracebackhide__
for chained exceptions.
Improved Documentation
-
#10782: Fixed the minimal example in
goodpractices
{.interpreted-text role="ref"}:pip install -e .
requires aversion
entry inpyproject.toml
to run successfully.
Trivial/Internal Changes
- #10669: pytest no longer depends on the [attrs]{.title-ref} package (don't worry, nice diffs for attrs classes are still supported).
v7.2.2
pytest 7.2.2 (2023-03-03)
Bug Fixes
-
#10533: Fixed
pytest.approx
{.interpreted-text role="func"} handling of dictionaries containing one or more values of [0.0]{.title-ref}. - #10592: Fixed crash if [--cache-show]{.title-ref} and [--help]{.title-ref} are passed at the same time.
-
#10597: Fixed bug where a fixture method named
teardown
would be called as part ofnose
teardown stage. -
#10626: Fixed crash if
--fixtures
and--help
are passed at the same time. -
#10660: Fixed :py
pytest.raises
{.interpreted-text role="func"} to return a 'ContextManager' so that type-checkers could narrowpytest.raises(...) if ... else nullcontext()
down to 'ContextManager' rather than 'object'.
Improved Documentation
- #10690: Added [CI]{.title-ref} and [BUILD_NUMBER]{.title-ref} environment variables to the documentation.
- #10721: Fixed entry-points declaration in the documentation example using Hatch.
- #10753: Changed wording of the module level skip to be very explicit about not collecting tests and not executing the rest of the module.
v7.2.1
pytest 7.2.1 (2023-01-13)
Bug Fixes
- #10452: Fix 'importlib.abc.TraversableResources' deprecation warning in Python 3.12.
- #10457: If a test is skipped from inside a fixture, the test summary now shows the test location instead of the fixture location.
-
#10506: Fix bug where sometimes pytest would use the file system root directory as
rootdir <rootdir>
{.interpreted-text role="ref"} on Windows. - #10607: Fix a race condition when creating junitxml reports, which could occur when multiple instances of pytest execute in parallel.
- #10641: Fix a race condition when creating or updating the stepwise plugin's cache, which could occur when multiple xdist worker nodes try to simultaneously update the stepwise plugin's cache.
pytest-dev/pytest-cov (pytest-cov)
v5.0.0
- Removed support for xdist rsync (now deprecated).
Contributed by Matthias Reichenbach in
#​623 <https://github.com/pytest-dev/pytest-cov/pull/623>
_. - Switched docs theme to Furo.
- Various legacy Python cleanup and CI improvements.
Contributed by Christian Clauss and Hugo van Kemenade in
#​630 <https://github.com/pytest-dev/pytest-cov/pull/630>
*,#​631 <https://github.com/pytest-dev/pytest-cov/pull/631>
*,#​632 <https://github.com/pytest-dev/pytest-cov/pull/632>
_ and#​633 <https://github.com/pytest-dev/pytest-cov/pull/633>
_. - Added a
pyproject.toml
example in the docs. Contributed by Dawn James in#​626 <https://github.com/pytest-dev/pytest-cov/pull/626>
_. - Modernized project's pre-commit hooks to use ruff. Initial POC contributed by
Christian Clauss in
#​584 <https://github.com/pytest-dev/pytest-cov/pull/584>
_.
v4.1.0
- Updated CI with new Pythons and dependencies.
- Removed rsyncdir support. This makes pytest-cov compatible with xdist 3.0.
Contributed by Sorin Sbarnea in
#​558 <https://github.com/pytest-dev/pytest-cov/pull/558>
_. - Optimized summary generation to not be performed if no reporting is active (for example,
when
--cov-report=''
is used without--cov-fail-under
). Contributed by Jonathan Stewmon in#​589 <https://github.com/pytest-dev/pytest-cov/pull/589>
_. - Added support for JSON reporting.
Contributed by Matthew Gamble in
#​582 <https://github.com/pytest-dev/pytest-cov/pull/582>
_. - Refactored code to use f-strings.
Contributed by Mark Mayo in
#​572 <https://github.com/pytest-dev/pytest-cov/pull/572>
_. - Fixed a skip in the test suite for some old xdist.
Contributed by a bunch of people in
#​565 <https://github.com/pytest-dev/pytest-cov/pull/565>
_.
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.