Sourced from black's releases.
23.10.1
Highlights
- Maintanence 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 psf/black#3968
23.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
... (truncated)
Sourced from black's changelog.
23.10.1
Highlights
- Maintanence 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 psf/black#3968
23.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
... (truncated)
744d23b
Prepare release 23.10.1 (#3969)8de4be5
Fix CI failing (#3957)c0adca3
docs: specifies the use of the .git-blame-ignore-revs file (#3961)a7643fa
Add summary parameter to action (#3958)d291c23
Move Docker image to hatch + compile (#3965)7f1c578
Bump peter-evans/create-or-update-comment from 3.0.2 to 3.1.0 (#3966)2db5ab0
Allow empty line after block open before a comment or compound statement (#3967)0a37888
Fix typos in CHANGES.md (#3963)882d879
Fix merging implicit multiline strings that have inline comments (#3956)9edba85
Prepare release 23.10.0 (#3951)Sourced from black's releases.
23.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 acccepted 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)
Sourced from black's changelog.
23.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 acccepted 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)
9edba85
Prepare release 23.10.0 (#3951)bb58807
Fix parser bug where "type" was misinterpreted as a keyword inside a match (#...722735d
Fix grammar for type alias support (#3949)abe57e3
Treat raw strings like other docstrings (#3947)1648ac5
Fix long lines with power operator(s) getting splitted before line length (#3...6f84f65
Migrate mypy config to pyproject.toml (#3936)3bb9214
CI Test: Deprecating 'Healthcheck.all()' from Hypothesis in fuzz.py (#3945)935f303
Fix test that was not being run (#3939)b7717c3
Standardise newlines after module-level docstrings (#3932)7aa37ea
Report all stacktraces in verbose mode (#3938)Sourced from sphinx's releases.
Sphinx 7.2.6
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from furo's changelog.
Changelog
2023.09.10 -- Zesty Zaffre
- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
... (truncated)
2718ca4
Prepare release: 2023.09.10c22c99d
Update changelogc37e849
Quote a not-runtime-generic type annotation9cfdf44
Rework infrastructure for linting5abeb9f
Fix the check for HTML buildersee2ab54
Tweak how tests are run with noxcdae236
Test against Sphinx minor versions in CI9e40071
Make asset hash injection idempotentaab86f4
Revert "Exclude incompatible Sphinx releases (#711)"4dd6eec
Exclude incompatible Sphinx releases (#711)Sourced from black's releases.
23.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)
23.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)
Sourced from black's changelog.
23.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)
23.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)
e877371
Prepare release 23.9.1 (#3878)62dca32
mypyc builds on PRs, skip mypyc wheels for 3.12 (#3870)751583a
Pickle raw tuples in FileData cache (#3877)f791745
Re-export black.Mode (#3875)0b62b9c
Ignore aiohttp DeprecationWarning for 3.12 (#3876)c83ad6c
Upgrade to Furo 2023.9.10 to fix docs build (#3873)4eebfd1
Add mypyc test marks to new tests that patch (#3871)add161b
Bump RTD Python version from 3.8 to 3.11 (#3868)4e93f2a
Add classifier for 3.12 (#3866)716fa08
Upgrade mypy (#3864)Sourced from furo's changelog.
Changelog
2023.09.10 -- Zesty Zaffre
- Make asset hash injection idempotent, fixing Sphinx 6 compatibility.
- Fix the check for HTML builders, fixing non-HTML Read the Docs builds.
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
... (truncated)
2718ca4
Prepare release: 2023.09.10c22c99d
Update changelogc37e849
Quote a not-runtime-generic type annotation9cfdf44
Rework infrastructure for linting5abeb9f
Fix the check for HTML buildersee2ab54
Tweak how tests are run with noxcdae236
Test against Sphinx minor versions in CI9e40071
Make asset hash injection idempotentaab86f4
Revert "Exclude incompatible Sphinx releases (#711)"4dd6eec
Exclude incompatible Sphinx releases (#711)Sourced from black's releases.
23.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)
23.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)
Sourced from black's changelog.
23.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)
23.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)
e877371
Prepare release 23.9.1 (#3878)62dca32
mypyc builds on PRs, skip mypyc wheels for 3.12 (#3870)751583a
Pickle raw tuples in FileData cache (#3877)f791745
Re-export black.Mode (#3875)0b62b9c
Ignore aiohttp DeprecationWarning for 3.12 (#3876)c83ad6c
Upgrade to Furo 2023.9.10 to fix docs build (#3873)4eebfd1
Add mypyc test marks to new tests that patch (#3871)add161b
Bump RTD Python version from 3.8 to 3.11 (#3868)4e93f2a
Add classifier for 3.12 (#3866)716fa08
Upgrade mypy (#3864)Sourced from sphinx's releases.
Sphinx 7.2.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.5 (released Aug 30, 2023)
Bugs fixed
- #11645: Fix a regression preventing autodoc from importing modules within packages that make use of
if typing.TYPE_CHECKING:
to guard circular imports needed by type checkers. Patch by Matt Wozniski.- #11634: Fixed inheritance diagram relative link resolution for sibling files in a subdirectory. Patch by Albert Shih.
- #11659: Allow
?config=...
in :confval:mathjax_path
.- #11654: autodoc: Fail with a more descriptive error message when an object claims to be an instance of
type
, but is not a class. Patch by James Braza.- 11620: Cease emitting :event:
source-read
events for files read via the :dudir:include
directive.- 11620: Add a new :event:
include-read
for observing and transforming the content of included files via the :dudir:include
directive.- #11627: Restore support for copyright lines of the form
YYYY
whenSOURCE_DATE_EPOCH
is set.
fcc3899
Bump to 7.2.5 final2a631f9
Restore support for YYYY copyright lines2730cc3
Remove double spaces in CHANGESff18318
Add an 'include-read'
event (#11657)74329d9
Fail better in ExceptionDocumenter.can_document_member
(#11660)7d046a8
Allow ?config=...
in mathjax_path
(#11659)4692208
Fix two relative link bugs in inheritance diagrams (#11634)ca0fc7a
Add git .mailmap file8248be3
autodoc: Reset sys.modules
on partial import failure (#11645)e494baa
Recommend correct replacement names for deprecated APIs (#11655)Sourced from sphinx's releases.
Sphinx 7.2.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.4 (released Aug 28, 2023)
Bugs fixed
- #11618: Fix a regression in the MoveModuleTargets transform, introduced in #10478 (#9662).
- #11649: linkcheck: Resolve hanging tests for timezones west of London and incorrect conversion from UTC to offsets from the UNIX epoch. Patch by Dmitry Shachnev and Adam Turner.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethod
methods whenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func:
os.fspath
to convert :py:class:~pathlib.Path
objects to strings, or :py:class:~pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
andJSModule
.Release 7.2.1 (released Aug 17, 2023)
... (truncated)
3256f1f
Bump to 7.2.4 final2f025a4
linkcheck: Fix conversion from UTC time to the UNIX epoch (#11649)1567281
autodoc: Fix UnboundLocalError in filter_members
(#11651)5e88b9f
Fix the MoveModuleTargets transform (#11647)694fcee
Fix markup in CHANGES (#11639)c503c90
Improve pathlib
type annotations (#11646)bf339b1
Bump version2f6ea14
Bump to 7.2.3 final511e407
Implement bool()
for string paths494de73
Implement hash()
for string pathsSourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.3 (released Aug 23, 2023)
Dependencies
- #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
- Fix regression in
autodoc.Documenter.parse_name()
.- Fix regression in JSON serialisation.
- #11543: autodoc: Support positional-only parameters in
classmethod
methods whenautodoc_preserve_defaults
isTrue
.- Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:func
os.fspath
to convert :py:class:pathlib.Path
objects to strings, or :py:class:pathlib.Path
's methods to work with path objects.Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
... (truncated)
2f6ea14
Bump to 7.2.3 final511e407
Implement bool()
for string paths494de73
Implement hash()
for string paths2986aa1
Override special methods for string paths07b87e9
Update CHANGES for 7.2.36b17dd1
Support string methods on path objects (#11619)a73fb59
Support positional-only parameters in classmethods (#11635)02cb02c
Fix invocation of python -m sphinx build
6183b6a
Require sphinxcontrib-serializinghtml 1.1.9 or later1e16f21
Fix regression in autodoc.Documenter.parse_name
(#11613)Sourced from furo's changelog.
Changelog
2023.08.19 -- Xenolithic Xanadu
- Fix missing search context with Sphinx 7.2, for dirhtml builds.
- Drop support for Python 3.7.
- Present configuration errors in a better format -- thanks
@AA-Turner
!- Bump
require_sphinx()
to Sphinx 6.0, in line with dependency changes in Unassuming Ultramarine.2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
... (truncated)
0766bb2
Prepare release: 2023.08.19807d73c
Update changelog364b261
Accomodate for the required data-content_root
for search0d38bc6
Simplify retrieval of pygments_dark_style
value (#699)3631ffc
Use sphinx.errors.ConfigError
(#697)d2e2448
Remove duplicate HTML builder check (#698)7b4f130
Drop Python 3.7 (#701)e322b71
Remove pointless assert (#702)ee2097a
Bump require_sphinx()
to Sphinx 6.0 (#700)c1ff10b
Back to developmentSourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.2 (released Aug 17, 2023)
Bugs fixed
- Fix the signature of the
StateMachine.insert_input()
patch, for when calling with keyword arguments.- Fixed membership testing (
in
) for the :py:class:str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon.- Fixed a type error in
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.- Fix
:noindex:
forPyModule
and JSModule``.Release 7.2.1 (released Aug 17, 2023)
Bugs fixed
- Restored the the :py:class:
str
interface of the asset classes (_CascadingStyleSheet
and_JavaScript
), which several extensions relied upon. This will be removed in Sphinx 9.- Restored calls to
Builder.add_{css,js}_file()
, which several extensions relied upon.- Restored the private API
TocTree.get_toctree_ancestors()
, which several extensions relied upon.Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
... (truncated)
ed84d63
Bump to 7.2.2 finalea4a73e
[bot]: Update message catalogues (#11612)e47846a
Fix :noindex:
for PyModule
and JSModule``b2fc47f
Add CHANGES entry for renaming the StateMachine.insert_input()
parameter0835c3e
Fix regression in SingleFileHTMLBuilder._get_local_toctree
49dc0dd
Fix asset class string interface membership testing8512855
Fix signature of docutils include_source monkeypatch (#11610)e1d9068
Bump version441a9e4
Bump to 7.2.1 finalec31853
Restore TocTree.get_toctree_ancestors()
Sourced from furo's changelog.
Changelog
2023.08.17 -- Wonderous White
- Fix compatiblity with Sphinx 7.2.0 and 7.2.1.
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
... (truncated)
Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.2.0 (released Aug 17, 2023)
Dependencies
Deprecated
- #11512: Deprecate
sphinx.util.md5
andsphinx.util.sha1
. Usehashlib
instead.- #11526: Deprecate
sphinx.testing.path
. Useos.path
orpathlib
instead.- #11528: Deprecate
sphinx.util.split_index_msg
andsphinx.util.split_into
. Usesphinx.util.index_entries.split_index_msg
instead.- Deprecate
sphinx.builders.html.Stylesheet
andsphinx.builders.html.Javascript
. Usesphinx.application.Sphinx.add_css_file()
andsphinx.application.Sphinx.add_js_file()
instead.- #11582: Deprecate
sphinx.builders.html.StandaloneHTMLBuilder.css_files
andsphinx.builders.html.StandaloneHTMLBuilder.script_files
. Usesphinx.application.Sphinx.add_css_file()
andsphinx.application.Sphinx.add_js_file()
instead.- #11459: Deprecate
sphinx.ext.autodoc.preserve_defaults.get_function_def()
. Patch by Bénédikt Tran.Features added
- #11526: Support
os.PathLike
types andpathlib.Path
objects in many more places.- #5474: coverage: Print summary statistics tables. Patch by Jorge Leitao.
- #6319: viewcode: Add :confval:
viewcode_line_numbers
to control whether line numbers are added to rendered source code. Patch by Ben Krikler.- #9662: Add the
:no-typesetting:
option to suppress textual output and only create a linkable anchor. Patch by Latosha Maltba.- #11221: C++: Support domain objects in the table of contents. Patch by Rouslan Korneychuk.
- #10938: doctest: Add :confval:
doctest_show_successes
option. Patch by Trey Hunner.- #11533: Add
:no-index:
,:no-index-entry:
, and:no-contents-entry:
.- #11572: Improve
debug
logging of reasons why files are detected as out of date. Patch by Eric Larson.
... (truncated)
da9f8a5
Bump to 7.2.0 final794324a
Declare support for Python 3.1303bceac
[bot]: Update message catalogues (#11538)aecebce
Make _resolve_toctree()
keyword-only76658c4
Fix sphinx.ext.autodoc.preserve_defaults
(#11550)4dee162
Fix layout issues in the agogo theme for smaller viewports (#11594)4ddbee4
Fix console_scripts
entry points4add50a
Remove unneeded type annotation9d8ef83
Fix test_inspect_main_noargs
ddf8a8e
Add CHANGES entry for GH-11533Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from blacken-docs's changelog.
1.16.0 (2023-08-16)
Allow Markdown fence options.
Thanks to initial work from Matthew Anderson in
PR [#246](https://github.com/asottile/blacken-docs/issues/246) <https://github.com/adamchainz/blacken-docs/pull/246>
__.Expand Markdown detection to all Python language names from Pygments:
py
,sage
,python3
,py3
, andnumpy
.Preserve leading whitespace lines in reStructuredText code blocks.
Thanks to Julianus Pfeuffer for the report in
Issue [#217](https://github.com/asottile/blacken-docs/issues/217) <https://github.com/adamchainz/blacken-docs/issues/217>
__.Use exit code 2 to indicate errors from Black, whilst exit code 1 remains for “files have been formatted”.
Thanks to Julianus Pfeuffer for the report in
Issue [#218](https://github.com/asottile/blacken-docs/issues/218) <https://github.com/adamchainz/blacken-docs/issues/218>
__.Support passing the
--preview
option through to Black, to select the future style.Remove
language_version
from.pre-commit-hooks.yaml
. This change allowsdefault_language_version
in ``.pre-commit-config.yaml` to take precedence.Thanks to Aneesh Agrawal in
PR [#258](https://github.com/asottile/blacken-docs/issues/258) <https://github.com/adamchainz/blacken-docs/pull/258>
__.
960ead2
Version 1.16.08f0ed18
Support passing --preview through to Black (#273)4eb4e4c
Tweak changelog note6c7450c
Use exit code 2 to indicate errors (#272)99dfc8d
Preserve leading whitespace lines in rST (#271)94465e8
Reformat markdown tests with dedent() (#270)7cd5f30
Use .md in glob examplef97e569
Document applying to many files (#269)ae612b0
Expand Markdown detection to all Python language names (#268)da9b455
Replace NamedTuple with plain class (#267)Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchors
and do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.2 (released Aug 02, 2023)
Bugs fixed
- #11542: linkcheck: Properly respect :confval:
linkcheck_anchors
and do not spuriously report failures to validate anchors. Patch by James Addison.Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
.
... (truncated)
320d0b6
Bump to 7.1.2 final06c1339
Ensure that linkcheck_anchors
is properly respected (#11544)89808c6
Emend attribution for GH-11431 in CHANGES (#11547)4958d2a
Fix flake8 E231 reported linting failure4862da8
Bump versiond8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 finalSourced from furo's changelog.
Changelog
2023.07.26 -- Vigilant Volt
- Fix compatiblity with Sphinx 7.1.
- Improve how content overflow is handled.
- Improve how literal blocks containing inline code are handled.
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
... (truncated)
35f5307
Prepare release: 2023.07.260a8bedc
Update changeloga92dd0c
Make _add_asset_hashes
a no-op with Sphinx 7.1f8db95b
Improve literals with inline code are handled1680dbe
Document the use of figclass
with figure
directivebeebd7e
Increase the specificity of the admonition title selector834e951
Setup uploads to Percy27bf2c0
[pre-commit.ci] pre-commit autoupdate (#672)c8b51d0
Fix how content overflow is handled80afa27
[pre-commit.ci] pre-commit autoupdate (#652)2e74dc4
Version 1.15.08ddb2f1
[pre-commit.ci] pre-commit autoupdate (#257)64fbca6
Drop Python 3.7 support (#256)f6a0817
[pre-commit.ci] pre-commit autoupdate (#255)cbdcb50
[pre-commit.ci] pre-commit autoupdate (#254)37fc70e
Upgrade requirements (#253)7bbe434
[pre-commit.ci] pre-commit autoupdate (#250)Sourced from sphinx's releases.
Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.1 (released Jul 27, 2023)
Bugs fixed
- #11514: Fix
SOURCE_DATE_EPOCH
in multi-line copyright footer. Patch by Bénédikt Tran.Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iterator
now clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -T
in parallel builds. Patch by Bénédikt Tran
... (truncated)
d8d73c1
Bump to 7.1.1 finala54e630
[internationalisation] Update message catalogues8452300
Fix multi-line copyright when SOURCE_DATE_EPOCH
is set (#11524)fe08cec
bump versione560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"Sourced from sphinx's releases.
Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.1.0 (released Jul 24, 2023)
Incompatible changes
Releases are no longer signed, given the
change in PyPI policy
_... _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
- #11412: Emit warnings on using a deprecated Python-specific index entry type (namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, and set the removal version to Sphinx 9. Patch by Adam Turner.Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinx
now allows the version requirement to be specified as(major, minor)
.- #11011: Allow configuring a line-length limit for object signatures, via :confval:
maximum_signature_line_length
and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:py:function:single-line-parameter-list
. Patch by Thomas Louf, Adam Turner, and Jean-François B.- #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iterator
now clears the current line with ANSI control codes, rather than overprinting with space characters.- #11431: linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran
- #11157: Keep the
translated
attribute on translated nodes.- #11451: Improve the traceback displayed when using :option:
sphinx-build -T
in parallel builds. Patch by Bénédikt Tran- #11324: linkcheck: Use session-basd HTTP requests.
- #11438: Add support for the :rst:dir:
py:class
and :rst:dir:py:function
directives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support (#11011) is enabled for type parameters list and can be locally controlled on object description directives, e.g., :rst:dir:py:function:single-line-type-parameter-list
. Patch by Bénédikt Tran.- #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis via :confval:
linkcheck_anchors_ignore_for_url
while
... (truncated)
e560f63
Bump to 7.1.0 final066e0fa
Add translation progress information (#11509)0882914
Target PyPI in create-release.yml21fbee5
Fix OIDC token payload1a403e4
Add informational log messaging258b0ea
Revert "Switch to using github.request
"f9c89e5
Switch to using github.request
52c7f66
Use the correct token minting URL for TestPyPI6079f28
Install twine in PyPI publish workflow3d43b9e
Fix github-script syntax in create-release.ymlSourced from furo's changelog.
Changelog
2023.05.20 -- Unassuming Ultramarine
- ✨ Add support for Sphinx 7.
- Drop support for Sphinx 5.
- Improve the screen-reader label for sidebar collapse.
- Make it easier to create derived themes from Furo.
- Bump all JS dependencies (NodeJS and npm packages).
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
meta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
... (truncated)
d2c9ca8
Prepare release: 2023.05.20662d21b
Update changelog591780b
Bump compatible Sphinx versionc2e7837
Bump NodeJS and package versionsdd85574
Use the reference HtmlFormatter class defined on PygmentsBridge. (#657)6bff419
Fix broken link (#654)e7f732e
Improve the screen-reader label for sidebar collapse48c0bf2
Drop the check for the theme name1b17d81
[pre-commit.ci] pre-commit autoupdate (#646)4904fd5
Remove Python 3.8 constraint from Black pre-commit config (#647)Sourced from sphinx's releases.
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.0.1 (released May 12, 2023)
Dependencies
- #11411: Support
Docutils 0.20
_. Patch by Adam Turner... _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04
Bugs fixed
- #11418: Clean up remaining references to
sphinx.setup_command
following the removal of support for setuptools. Patch by Willem Mulder.Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
- #11359: Remove long-deprecated aliases for
MecabSplitter
andDefaultSplitter
insphinx.search.ja
.- #11360: Remove deprecated
make_old_id
functions in domain object description classes.- #11363: Remove the Setuptools integration (
build_sphinx
hook insetup.py
).- #11364: Remove deprecated
sphinx.ext.napoleon.iterators
module.- #11365: Remove support for the
jsdump
format insphinx.search
.- #11366: Make
locale
a required argument tosphinx.util.i18n.format_date()
.- #11370: Remove deprecated
sphinx.util.stemmer
module.- #11371: Remove deprecated
sphinx.pycode.ast.parse()
function.- #11372: Remove deprecated
sphinx.io.read_doc()
function.- #11373: Removed deprecated
sphinx.util.get_matching_files()
function.- #11378: Remove deprecated
sphinx.util.docutils.is_html5_writer_available()
function.- #11379: Make the
env
argument toBuilder
subclasses required.- #11380: autosummary: Always emit grouped import exceptions.
- #11381: Remove deprecated
style
key for HTML templates.- #11382: Remove deprecated
sphinx.writers.latex.LaTeXTranslator.docclasses
attribute.- #11383: Remove deprecated
sphinx.builders.html.html5_ready
andsphinx.builders.html.HTMLTranslator
attributes.- #11385: Remove support for HTML 4 output.
Release 6.2.1 (released Apr 25, 2023)
... (truncated)
d48cc78
Bump to 7.0.1 finalde6b18a
Remove remaining references to the setuptools integration (#11418)db54618
Support Docutils 0.20 (#11411)8942a1d
Test with Docutils 0.20c9d0933
linkcheck: Use context managers for HTTP requests (#11318)2b1c106
Update documentation workflowba74082
Change concurrency groups for GitHub workflowsb546879
Bump versiond568b2f
Bump to 7.0.0 finalff79edf
Remove jsdump
references post removalSourced from black's releases.
23.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
... (truncated)
Sourced from black's changelog.
23.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
... (truncated)
193ee76
Prepare release 23.7.0 (#3776)38723bb
Unpin pytest-xdist (#3772)138769a
Disable coverage on pypy tests (#3777)ad3724b
Upgrade to latest mypy (#3775)b8e2ec7
Fix crash on type comment with trailing space (#3773)257d392
Fix removed comments in stub files (#3745)2593af2
Improve performance by skipping unnecessary normalisation (#3751)f3b50e4
Add CITATION.cff file (#3723)0b4d7d5
Run pyupgrade on blib2to3 and src (#3771)114e835
Remove click patch (#3768)4b94add
Version 1.14.0292cb18
Support Python 3.12 (#251)72ecf2c
[pre-commit.ci] pre-commit autoupdate (#249)ea8f1ca
Upgrade requirements (#248)9979d7a
Upgrade requirements (#247)7b71075
[pre-commit.ci] pre-commit autoupdate (#245)6280868
[pre-commit.ci] pre-commit autoupdate (#244)83efc37
Upgrade requirements (#243)7aedc23
[pre-commit.ci] pre-commit autoupdate (#242)d78d593
[pre-commit.ci] pre-commit autoupdate (#241)Sourced from sphinx's releases.
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
- #11359: Remove long-deprecated aliases for
MecabSplitter
andDefaultSplitter
insphinx.search.ja
.- #11360: Remove deprecated
make_old_id
functions in domain object description classes.- #11363: Remove the Setuptools integration (
build_sphinx
hook insetup.py
).- #11364: Remove deprecated
sphinx.ext.napoleon.iterators
module.- #11365: Remove support for the
jsdump
format insphinx.search
.- #11366: Make
locale
a required argument tosphinx.util.i18n.format_date()
.- #11370: Remove deprecated
sphinx.util.stemmer
module.- #11371: Remove deprecated
sphinx.pycode.ast.parse()
function.- #11372: Remove deprecated
sphinx.io.read_doc()
function.- #11373: Removed deprecated
sphinx.util.get_matching_files()
function.- #11378: Remove deprecated
sphinx.util.docutils.is_html5_writer_available()
function.- #11379: Make the
env
argument toBuilder
subclasses required.- #11380: autosummary: Always emit grouped import exceptions.
- #11381: Remove deprecated
style
key for HTML templates.- #11382: Remove deprecated
sphinx.writers.latex.LaTeXTranslator.docclasses
attribute.- #11383: Remove deprecated
sphinx.builders.html.html5_ready
andsphinx.builders.html.HTMLTranslator
attributes.- #11385: Remove support for HTML 4 output.
Release 6.2.1 (released Apr 25, 2023)
Bugs fixed
- #11355: Revert the default type of :confval:
nitpick_ignore
and :confval:nitpick_ignore_regex
tolist
.Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
... (truncated)
d568b2f
Bump to 7.0.0 finalff79edf
Remove jsdump
references post removal1a5133a
Bump to 7.0.0rc1 final5795fc7
Update sphinx.deprecation
for Sphinx 7.0 (#11386)6202087
Add a note to CHANGES for PR 11385ad47373
Remove HTML 4 support (#11385)3e3251d
Remove HTMLTranslator
and html5_ready
from sphinx.builders.html
(...77fd819
Remove deprecated LaTeXTranslator.docclasses
attribute (#11382)4be56f3
Remove deprecated style
key for HTML templates (#11381)49027a9
Autosummary: Always emit grouped ImportError
exceptions (#11380)Sourced from sphinx's releases.
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.2.1 (released Apr 25, 2023)
Bugs fixed
- #11355: Revert the default type of :confval:
nitpick_ignore
and :confval:nitpick_ignore_regex
tolist
.Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
- LaTeX: removal of some internal TeX
\dimen
registers (not previously publicly documented) as per 5.1.0 code comments insphinx.sty
:\sphinxverbatimsep
,\sphinxverbatimborder
,\sphinxshadowsep
,\sphinxshadowsize
, and\sphinxshadowrule
. (refs: #11105)- Remove
.egg
support from pycodeModuleAnalyser
; Python eggs are a now-obsolete binary distribution format- #11089: Remove deprecated code in
sphinx.builders.linkcheck
. Patch by Daniel Eades- Remove internal-only
sphinx.locale.setlocale
Deprecated
- #11247: Deprecate the legacy
intersphinx_mapping
formatsphinx.util.osutil.cd
is deprecated in favour ofcontextlib.chdir
.Features added
- #11277: :rst:dir:
autoproperty
allows the return type to be specified as a type comment (e.g.,# type: () -> int
). Patch by Bénédikt Tran- #10811: Autosummary: extend
__all__
to imported members for template rendering when optionautosummary_ignore_module_all
is set toFalse
. Patch by Clement Pinard- #11147: Add a
content_offset
parameter tonested_parse_with_titles()
, allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
- Add a
--jobs
synonym for-j
. Patch by Hugo van Kemenade- LaTeX: a command
\sphinxbox
for styling text elements with a (possibly
... (truncated)
ec993dd
Bump to 6.2.1 finald2aa91f
Revert the default type of nitpick_ignore[_regex]
to list
60d8fa1
Bump version70102ac
Bump to 6.2.0 final4e27a5f
Remove unneeded JavaScript from sphinx13
themebffb547
Note correct deprecation version for sphinx.util.osutil.cd
59de8d5
Revert "Support and prefer .jinja
to _t
for static templates (#11165)...aee3c0a
Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set (#10949)...186d596
Use overwrite_file
context manager in test_ext_autodoc_configs
(#11320)77483f2
Add missing test decorator for test_util_inspect
(#11321)Sourced from sphinx's releases.
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.2.0 (released Apr 23, 2023)
Dependencies
- Require Docutils 0.18.1 or greater.
Incompatible changes
- LaTeX: removal of some internal TeX
\dimen
registers (not previously publicly documented) as per 5.1.0 code comments insphinx.sty
:\sphinxverbatimsep
,\sphinxverbatimborder
,\sphinxshadowsep
,\sphinxshadowsize
, and\sphinxshadowrule
. (refs: #11105)- Remove
.egg
support from pycodeModuleAnalyser
; Python eggs are a now-obsolete binary distribution format- #11089: Remove deprecated code in
sphinx.builders.linkcheck
. Patch by Daniel Eades- Remove internal-only
sphinx.locale.setlocale
Deprecated
- #11247: Deprecate the legacy
intersphinx_mapping
formatsphinx.util.osutil.cd
is deprecated in favour ofcontextlib.chdir
.Features added
- #11277: :rst:dir:
autoproperty
allows the return type to be specified as a type comment (e.g.,# type: () -> int
). Patch by Bénédikt Tran- #10811: Autosummary: extend
__all__
to imported members for template rendering when optionautosummary_ignore_module_all
is set toFalse
. Patch by Clement Pinard- #11147: Add a
content_offset
parameter tonested_parse_with_titles()
, allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard- Update to Unicode CLDR 42
- Add a
--jobs
synonym for-j
. Patch by Hugo van Kemenade- LaTeX: a command
\sphinxbox
for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:sphinxbox
. (refs: #11224)- LaTeX: add
\sphinxstylenotetitle
, ...,\sphinxstylewarningtitle
, ..., for an extra layer of mark-up freeing up\sphinxstrong
for other uses. See :ref:latex-macros
. (refs: #11267)- LaTeX: :dudir:
note
, :dudir:hint
, :dudir:important
and :dudir:tip
can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:additionalcss
. (refs: #11234)
... (truncated)
e7d4c36
Bump to 6.2.0 final4e27a5f
Remove unneeded JavaScript from sphinx13
themebffb547
Note correct deprecation version for sphinx.util.osutil.cd
59de8d5
Revert "Support and prefer .jinja
to _t
for static templates (#11165)...aee3c0a
Partially revert "Disable localisation when SOURCE_DATE_EPOCH is set (#10949)...186d596
Use overwrite_file
context manager in test_ext_autodoc_configs
(#11320)77483f2
Add missing test decorator for test_util_inspect
(#11321)d8f15c7
Increase timeout threshold for linkcheck
tests (#11326)b430e05
Create a 'search field' component for themes (#11045)e2f66ce
Update CHANGES for PR #11333Sourced from black's releases.
23.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)
... (truncated)
Sourced from black's changelog.
23.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)
... (truncated)
bf7a162
Fixup the changelog (#3628)9b2b048
Prepare release 23.3.0 (#3625)bf5abdb
Specify Python exec path with minor version if available (#3508)b542f58
Use GH action version when version argument not specified (#3543)f3b1a3b
Bump furo from 2022.12.7 to 2023.3.23 in /docs (#3624)ef6e079
Let string splitters respect East_Asian_Width
property (#3445)5c064a9
Bump sphinx from 5.3.0 to 6.1.3 in /docs (#3499)3a9d6f0
Bump myst-parser from 0.18.1 to 1.0.0 in /docs (#3601)53c23e6
Support files with type comment syntax errors (#3594)dba3c26
Fix bug introduced in #3564. (#3615)Sourced from blacken-docs's changelog.
1.13.0 (2023-01-16)
Note Adam Johnson is new maintainer.
Require Black 22.1.0+.
Add
--rst-literal-blocks
option, to also format text in reStructuredText literal blocks, starting with::
. Sphinx highlights these with the project’s default language, which defaults to Python.
1238e1d
Version 1.13.04e6dc07
Fix setup.cfg long_description_content_type579a71a
Standardize setup.cfg (#212)a6b2ba0
Changelog entry about change in maintenance3cf8b9a
Standard pre-commit config (#211)bcd3669
Standardize test file name (#210)6d1771d
Remove setup.py (#209)4e5ab6e
Improve README (#208)c19c57f
Add support for reStructuredText literal blocks (#196)6af8099
Move from tmpdir pytest fixture to tmp_path (#206)Sourced from sphinx's releases.
v6.1.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
776d01e
Bump to 6.1.3 finala2e922a
CHANGES for Sphinx 6.1.331162a9
Handle exceptions for get_node_source
and get_node_line
dcb4429
Restore Sphinx 5 nodes.Element
copying behaviour2a7c40d
Undo parallel image changes7841d3d
Ignore more checks in Ruff 0.0.214ddbc5b5
Bump versionSourced from black's releases.
23.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, notably improvements to empty line handling and the removal of redundant parentheses in several contexts.
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)
- 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)- 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)
... (truncated)
Sourced from black's changelog.
23.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)
... (truncated)
b0d1fba
Prepare release 23.1.0 (#3536)69ca0a4
Infer target version based on project metadata (#3219)c4bd2e3
Draft for Black 2023 stable style (#3418)226cbf0
Fix unsafe cast in linegen.py w/ await yield handling (#3533)f4ebc68
Upgrade isort (#3534)6407ebb
Remove Python version in the_basics.md (#3528)196b1f3
Fix black --help
output for --python-cell-magics
option to be reproducibl...d950f15
Update document now that paren wrapping CMs on Python 3.9+ is implemented (#3...a36878e
Fix an invalid quote escaping bug in f-string expressions (#3509)eabff67
Format hex code in unicode escape sequences in string literals (#2916)Sourced from furo's changelog.
Changelog
2023.03.27 -- Tasty Tangerine
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Add missing class to Font Awesome examples
2023.03.23 -- Sassy Saffron
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
meta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass
.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
... (truncated)
2f61e10
Prepare release: 2023.03.275c7aedd
Update changelog0535011
Add missing class to Font Awesome examples (#629)811f1e7
Remove unused templates_path
(#627)961d4e9
Add a inline-code as an example heading48af8eb
Back to development81139dd
Prepare release: 2023.03.23dafa73a
Update changelog82591ef
Allow all pre
tags to have overflows55b32f0
Update Python version classifiers (#626)Sourced from furo's changelog.
Changelog
2023.03.23 -- Sassy Saffron
- Regenerate with newer version of sphinx-theme-builder, to fix RECORD hashes.
- Update Python version classifiers.
- Increase the icon size in mobile header.
- Increase admonition title bg opacity.
- Change the default API background to transparent.
- Transition the API background change.
- Remove the "indent" of API entries which have a background.
- Break long inline code literals.
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
meta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass
.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svg
in related pagesnav
.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
... (truncated)
81139dd
Prepare release: 2023.03.23dafa73a
Update changelog82591ef
Allow all pre
tags to have overflows55b32f0
Update Python version classifiers (#626)cd6ecdd
Update linters82a1cec
Drop the black pin in blacken-docs483b05c
Increase the icon size in mobile headerab3ca77
Revert "Increase icon sizes (#554)"82376d2
Supply encoding. Fixes #621. (#622)193643f
Increase admonition title bg opacity (#555)Sourced from sphinx's releases.
v6.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.2 (released Jan 07, 2023)
Bugs fixed
#11101: LaTeX:
div.topic_padding
key of sphinxsetup documented at 5.1.0 was implemented with nametopic_padding
#11099: LaTeX:
shadowrule
key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0#11096: LaTeX:
shadowsize
key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0#11095: LaTeX: shadow of :dudir:
topic
and contents_ boxes not in page margin since Sphinx 5.1.0.. _contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
#11100: Fix copying images when running under parallel mode.
Release 6.1.1 (released Jan 05, 2023)
Bugs fixed
- #11091: Fix
util.nodes.apply_source_workaround
forliteral_block
nodes with no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation
. This was unused and complicated other changes tosphinx.locale
.Deprecated
sphinx.util
functions:
- Renamed
sphinx.util.typing.stringify()
tosphinx.util.typing.stringify_annotation()
... (truncated)
393b408
Bump to 6.1.2 finald8a5dd8
Add note to CHANGES for PR 11100a1cd19e
Fix copying images under parallel execution (#11100)5008291
Ignore more checks in Ruff 0.0.2136259c2b
Markup typo in docs7945aeb
LaTeX: fix 5.1.0 bugs related to topic and contents boxes (#11102)77aaa86
Bump to 6.1.1 final476c115
Suppress ValueError
in apply_source_workaround
(#11092)c80d656
Bump version4e1004a
Bump to 6.1.0 finalSourced from sphinx's releases.
v6.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.1 (released Jan 05, 2023)
Bugs fixed
- #11091: Fix
util.nodes.apply_source_workaround
forliteral_block
nodes with no source information in the node or the node's parents.Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation
. This was unused and complicated other changes tosphinx.locale
.Deprecated
sphinx.util
functions:
- Renamed
sphinx.util.typing.stringify()
tosphinx.util.typing.stringify_annotation()
- Moved
sphinx.util.xmlname_checker()
tosphinx.builders.epub3._XML_NAME_PATTERN
Moved to
sphinx.util.display
:
sphinx.util.status_iterator
sphinx.util.display_chunk
sphinx.util.SkipProgressMessage
sphinx.util.progress_message
Moved to
sphinx.util.http_date
:
sphinx.util.epoch_to_rfc1123
sphinx.util.rfc1123_to_epoch
Moved to
sphinx.util.exceptions
:
sphinx.util.save_traceback
... (truncated)
77aaa86
Bump to 6.1.1 final476c115
Suppress ValueError
in apply_source_workaround
(#11092)c80d656
Bump version4e1004a
Bump to 6.1.0 finala2176d4
Fix deprecation warnings2c104e9
Merge branch '6.0.x'a27d262
Bump to 6.0.1 final821569e
Add note for Pygments222d366
imgmath: Fix relative file path (#10965)c499f66
Add SIM113 lint (#11057)Sourced from sphinx's releases.
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.1.0 (released Jan 05, 2023)
Dependencies
Adopted the
Ruff
_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
- #10979: gettext: Removed support for pluralisation in
get_translation
. This was unused and complicated other changes tosphinx.locale
.Deprecated
sphinx.util
functions:
- Renamed
sphinx.util.typing.stringify()
tosphinx.util.typing.stringify_annotation()
- Moved
sphinx.util.xmlname_checker()
tosphinx.builders.epub3._XML_NAME_PATTERN
Moved to
sphinx.util.display
:
sphinx.util.status_iterator
sphinx.util.display_chunk
sphinx.util.SkipProgressMessage
sphinx.util.progress_message
Moved to
sphinx.util.http_date
:
sphinx.util.epoch_to_rfc1123
sphinx.util.rfc1123_to_epoch
Moved to
sphinx.util.exceptions
:
sphinx.util.save_traceback
sphinx.util.format_exception_cut_frames
Features added
- Cache doctrees in the build environment during the writing phase.
- Make all writing phase tasks support parallel execution.
- #11072: Use PEP 604 (
X | Y
) display conventions fortyping.Optional
andtyping.Optional
types within the Python domain and autodoc.
... (truncated)
4e1004a
Bump to 6.1.0 finala2176d4
Fix deprecation warnings2c104e9
Merge branch '6.0.x'a27d262
Bump to 6.0.1 final821569e
Add note for Pygments222d366
imgmath: Fix relative file path (#10965)c499f66
Add SIM113 lint (#11057)0fbd8af
Add missing default arguments in sphinx-apidoc.rst (#11084)f89f943
Remove flake8 plugins in favour of Ruff (#11085)0479115
Suppress lint failures from Ruff 0.0.211 (#11086)Sourced from sphinx's releases.
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0b1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Sourced from sphinx's changelog.
Release 6.0.0 (released Dec 29, 2022)
Dependencies
- #10468: Drop Python 3.6 support
- #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner
Incompatible changes
#7405: Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the
jQuery
,$
, or$u
global objects, you need to update your JavaScript to modern standards, or use the mitigation below.The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add
sphinxcontrib.jquery
to theextensions
list inconf.py
, or callapp.setup_extension("sphinxcontrib.jquery")
if you develop a Sphinx theme or extension.The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy
jquery.js
andunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory, and add the following to yourlayout.html
:.. code-block:: html+jinja
{%- block scripts %} {{ super() }} {%- endblock %}
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:
dev-deprecated-apis
for details. Patch by Adam Turner.#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables
c_allow_pre_v3
andc_warn_on_allowed_pre_v3
. Patch by Adam Turner.Features added
... (truncated)
5b56a23
Bump to 6.0.0 finalf1d1e9c
Update coverage workflow for Tox 466a738c
Update coverage workflow for new configuration location041e5f8
Add test coverage for 'today_fmt' reference substitution (#10980)da25145
Remove unnecessary conditional import in sphinx.ext.napoleon
(#11043)45a0ea9
Migrate coveragepy config into pyproject.toml (#11025)3ec54f1
Create a pydata_sphinx_theme
section in usage examples (#11046)32bce8f
Copy edit the tutorial (#11049)9844162
Fix example using add_config_value
(#10937)bf4a626
RTD builder: add graphviz depedendency (#11040)Sourced from black's releases.
22.12.0
Preview style
- Enforce empty lines before classes and functions with sticky leading comments (#3302)
- 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)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)
Configuration
- Fix incorrectly applied
.gitignore
rules by considering the.gitignore
location and the relative path to the target file (#3338)- Fix incorrectly ignoring
.gitignore
presence when more than one source directory is specified (#3336)Parser
- Parsing support has been added for walruses inside generator expression that are passed as function args (for example,
any(match := my_re.match(text) for text in texts)
) (#3327).Integrations
- Vim plugin: Optionally allow using the system installation of Black via
let g:black_use_virtualenv = 0
(#3309)
Sourced from black's changelog.
22.12.0
Preview style
- Enforce empty lines before classes and functions with sticky leading comments (#3302)
- 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)
- Implicitly concatenated strings used as function args are now wrapped inside parentheses (#3307)
- Correctly handle trailing commas that are inside a line's leading non-nested parens (#3370)
Configuration
- Fix incorrectly applied
.gitignore
rules by considering the.gitignore
location and the relative path to the target file (#3338)- Fix incorrectly ignoring
.gitignore
presence when more than one source directory is specified (#3336)Parser
- Parsing support has been added for walruses inside generator expression that are passed as function args (for example,
any(match := my_re.match(text) for text in texts)
) (#3327).Integrations
- Vim plugin: Optionally allow using the system installation of Black via
let g:black_use_virtualenv = 0
(#3309)
2ddea29
Prepare release 22.12.0 (#3413)5b1443a
release: skip bad macos wheels for now (#3411)9ace064
Bump peter-evans/find-comment from 2.0.1 to 2.1.0 (#3404)19c5fe4
Fix CI with latest flake8-bugbear (#3412)d4a8564
Bump sphinx-copybutton from 0.5.0 to 0.5.1 in /docs (#3390)2793249
Wordsmith current_style.md (#3383)d97b789
Remove whitespaces of whitespace-only files (#3348)c23a5c1
Clarify that Black runs with --safe by default (#3378)8091b25
Correctly handle trailing commas that are inside a line's leading non-nested ...ffaaf48
Compare each .gitignore found with an appropiate relative path (#3338)Sourced from furo's changelog.
Changelog
2022.12.07 -- Reverent Raspberry
- ✨ Add support for Sphinx 6.
- ✨ Improve footnote presentation with docutils 0.18+.
- Drop support for Sphinx 4.
- Improve documentation about what the edit button does.
- Improve handling of empty-flexboxes for better print experience on Chrome.
- Improve styling for inline signatures.
- Replace the
meta
generator tag with a comment.- Tweak labels with icons to prevent users selecting icons as text on touch.
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass
.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svg
in related pagesnav
.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.x
compatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
... (truncated)
1034267
Prepare release: 2022.12.07239e69f
Update changelog8faac34
Remove the no-longer-useful gh-pages workflowfaa27fb
Fix the hyperlink warning9849ec0
Forward the arguments to stb serve
e0dc9b8
[pre-commit.ci] pre-commit autoupdate (#588)9842e25
Clarify what the edit button does (#587)0d2cf0b
[pre-commit.ci] pre-commit autoupdate (#578)b7d8866
Revert "Document that GCC is using Furo! (#575)" (#577)0ab12bb
Improve footnote presentation with docutils 0.18+ (#576)Sourced from black's releases.
22.10.0
Highlights
- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be supported until further notice.
Stable style
- Fix a crash when
# fmt: on
is used on a different block level than# fmt: off
(#3281)Preview style
- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys (#3262)
Configuration
.ipynb_checkpoints
directories are now excluded by default (#3293)- Add
--skip-source-first-line
/-x
option to ignore the first line of source code while formatting (#3299)Packaging
- Executables made with PyInstaller will no longer crash when formatting several files at once on macOS. Native x86-64 executables for macOS are available once again. (#3275)
- Hatchling is now used as the build backend. This will not have any effect for users who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)
Blackd
- Windows style (CRLF) newlines will be preserved (#3257).
Integrations
Sourced from black's changelog.
22.10.0
Highlights
- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be supported until further notice.
Stable style
- Fix a crash when
# fmt: on
is used on a different block level than# fmt: off
(#3281)Preview style
- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys (#3262)
Configuration
.ipynb_checkpoints
directories are now excluded by default (#3293)- Add
--skip-source-first-line
/-x
option to ignore the first line of source code while formatting (#3299)Packaging
- Executables made with PyInstaller will no longer crash when formatting several files at once on macOS. Native x86-64 executables for macOS are available once again. (#3275)
- Hatchling is now used as the build backend. This will not have any effect for users who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)
Blackd
- Windows style (CRLF) newlines will be preserved (#3257).
Integrations
27d2014
Prepare release 22.10.0 (#3311)4da0851
Add option to skip the first line of source code (#3299)0359b85
Preserve crlf line endings in blackd (#3257)27d7ea4
Bump docutils from 0.18.1 to 0.19 in /docs (#3161)1a20c4d
Bump sphinx from 5.2.1 to 5.2.3 in /docs (#3305)980997f
Bump furo from 2022.9.15 to 2022.9.29 in /docs (#3304)b1077aa
Bump myst-parser from 0.18.0 to 0.18.1 in /docs (#3303)956bf39
Add .ipynb_checkpoints to DEFAULT_EXCLUDES (#3293)141291a
Enable build isolation under CIWB (#3297)ddb9924
Bump pypa/cibuildwheel from 2.10.0 to 2.10.2 (#3290)Sourced from furo's changelog.
Changelog
2022.09.29 -- Quaint Quartz
- Add ability to set arbitrary URLs for edit button.
- Add support for aligning text in MyST-parser generated tables.
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass
.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svg
in related pagesnav
.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.x
compatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ng
as the base theme (from {pypi}sphinx-basic-ng
).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng
'sedit-this-page
component.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
... (truncated)
1375f9d
Prepare release: 2022.09.29af43607
Update changelogbc0fe52
Update user-facing documentation for edit button509c558
Modernise the edit-this-page.html
template5a0ceca
Add source_edit_link
as a theme configuration parameter (#510)52fc32f
Build documentation in pull requests149f77b
Fix stylesheet for MyST tables9af2e44
Support MyST table column alignment (#531)82dd61c
Back to developmentSourced from furo's changelog.
Changelog
2022.09.15 -- Pragmatic Pistachio
- Add a minimum version constraint on pygments.
- Add an explicit dependency on
sass
.- Change right sidebar title from "Contents" to "On this page".
- Correctly position sidebars on small screens.
- Correctly select only Furo's own
svg
in related pagesnav
.- Make numpy-style documentation headers consistent.
- Retitle the reference section.
- Update npm dependencies.
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.x
compatibility.- Bump to the latest Node.js LTS.
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ng
as the base theme (from {pypi}sphinx-basic-ng
).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng
'sedit-this-page
component.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl
.
... (truncated)
08e6b38
Prepare release: 2022.09.159de7613
Update changeloga064929
Tweak changelog content style46f4adc
Revert "Add initial theme.conf content for eventual ablog support"45b839b
Set a minimum constraint on pygmentsa4af988
[pre-commit.ci] pre-commit autoupdate (#518)a72186f
[pre-commit.ci] pre-commit autoupdate (#504)9f41ee6
Add initial theme.conf content for eventual ablog support75e0361
Make numpy-style documentation headers consistent9d280e6
[pre-commit.ci] pre-commit autoupdate (#487)Sourced from black's releases.
22.8.0
Highlights
- Python 3.11 is now supported, except for blackd as aiohttp does not support 3.11 as of publishing (#3234)
- This is the last release that supports running Black on Python 3.6 (formatting 3.6 code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that affect code that was not previously formatted by Black (#3155)
Stable style
- Fix an infinite loop when using
# fmt: on/off
in the middle of an expression or code block (#3158)- Fix incorrect handling of
# fmt: skip
on colon (:
) lines (#3148)- Comments are no longer deleted when a line had spaces removed around power operators (#2874)
Preview style
- Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (#3166)
--skip-string-normalization
/-S
now prevents docstring prefixes from being normalized as expected (#3168)- When using
--skip-magic-trailing-comma
or-C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227)
Blackd
blackd
now supports enabling the preview style via theX-Preview
header (#3217)Configuration
- Black now uses the presence of debug f-strings to detect target version (#3215)
- Fix misdetection of project root and verbose logging of sources in cases involving
--stdin-filename
(#3216)- Immediate
.gitignore
files in source directories given on the command line are now also respected, previously only.gitignore
files in the project root and automatically discovered directories were respected (#3237)Documentation
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
Integrations
- Vim plugin: prefix messages with
Black:
so it's clear they come from Black (#3194)- Docker: changed to a /opt/venv installation + added to PATH to be available to non-root users (#3202)
Output
- Change from deprecated
asyncio.get_event_loop()
to create our event loop which removes DeprecationWarning (#3164)- Remove logging from internal
blib2to3
library since it regularly emits error logs about failed caching that can and should be ignored (#3193)Parser
- Type comments are now included in the AST equivalence check consistently so accidental deletion raises an error. Though type comments can't be tracked when running on PyPy 3.7 due to standard library limitations. (#2874)
Performance
... (truncated)
Sourced from black's changelog.
22.8.0
Highlights
- Python 3.11 is now supported, except for blackd as aiohttp does not support 3.11 as of publishing (#3234)
- This is the last release that supports running Black on Python 3.6 (formatting 3.6 code will continue to be supported until further notice)
- Reword the stability policy to say that we may, in rare cases, make changes that affect code that was not previously formatted by Black (#3155)
Stable style
- Fix an infinite loop when using
# fmt: on/off
in the middle of an expression or code block (#3158)- Fix incorrect handling of
# fmt: skip
on colon (:
) lines (#3148)- Comments are no longer deleted when a line had spaces removed around power operators (#2874)
Preview style
- Single-character closing docstring quotes are no longer moved to their own line as this is invalid. This was a bug introduced in version 22.6.0. (#3166)
--skip-string-normalization
/-S
now prevents docstring prefixes from being normalized as expected (#3168)- When using
--skip-magic-trailing-comma
or-C
, trailing commas are stripped from subscript expressions with more than 1 element (#3209)- Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside parentheses (#3162)
- Fix a string merging/split issue when a comment is present in the middle of implicitly concatenated strings on its own line (#3227)
Blackd
blackd
now supports enabling the preview style via theX-Preview
header (#3217)Configuration
- Black now uses the presence of debug f-strings to detect target version (#3215)
- Fix misdetection of project root and verbose logging of sources in cases involving
--stdin-filename
(#3216)- Immediate
.gitignore
files in source directories given on the command line are now also respected, previously only.gitignore
files in the project root and automatically discovered directories were respected (#3237)Documentation
- Recommend using BlackConnect in IntelliJ IDEs (#3150)
Integrations
... (truncated)
2018e66
Prepare docs for release 22.8.0 (#3248)0019261
Update stable branch after publishing to PyPI (#3223)7757078
Improve & update release process to reflect recent changes (#3242)767604e
Use .gitignore files in the initial source directories (#3237)2c90480
Use strict mypy checking (#3222)ba618a3
Add parens around implicit string concatenations where it increases readabili...c0cc19b
Delay worker count determinationafed2c0
Load .gitignore and exclude regex at time of usee269f44
Lazily import parallelized format modulesc47b91f
Fix misdetection of project root with --stdin-filename
(#3216)Sourced from jinja2's releases.
3.1.0
This is a feature release, which includes new features and removes previously deprecated features. The 3.1.x branch is now the supported bugfix branch, the 3.0.x branch has become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades. We also encourage upgrading to MarkupSafe 2.1.1, the latest version at this time.
Sourced from jinja2's changelog.
Version 3.1.0
Released 2022-03-24
Drop support for Python 3.6. :pr:
1534
Remove previously deprecated code. :pr:
1544
WithExtension
andAutoEscapeExtension
are built-in now.contextfilter
andcontextfunction
are replaced bypass_context
.evalcontextfilter
andevalcontextfunction
are replaced bypass_eval_context
.environmentfilter
andenvironmentfunction
are replaced bypass_environment
.Markup
andescape
should be imported from MarkupSafe.- Compiled templates from very old Jinja versions may need to be recompiled.
- Legacy resolve mode for
Context
subclasses is no longer supported. Overrideresolve_or_missing
instead ofresolve
.unicode_urlencode
is renamed tourl_quote
.Add support for native types in macros. :issue:
1510
The
{% trans %}
tag can usepgettext
andnpgettext
by passing a context string as the first token in the tag, like{% trans "title" %}
. :issue:1430
Update valid identifier characters from Python 3.6 to 3.7. :pr:
1571
Filters and tests decorated with
@async_variant
are pickleable. :pr:1612
Add
items
filter. :issue:1561
Subscriptions (
[0]
, etc.) can be used after filters, tests, and calls when the environment is in async mode. :issue:1573
The
groupby
filter is case-insensitive by default, matching other comparison filters. Added thecase_sensitive
parameter to control this. :issue:1463
Windows drive-relative path segments in template names will not result in
FileSystemLoader
andPackageLoader
loading from drive-relative paths. :pr:1621
Version 3.0.3
Released 2021-11-09
- Fix traceback rewriting internals for Python 3.10 and 3.11. :issue:
1535
- Fix how the native environment treats leading and trailing spaces when parsing values on Python 3.10. :pr:
1537
... (truncated)
84c0e2c
Merge pull request #1625 from pallets/release-3.1.07b0c47f
release version 3.1.0ede0f98
Merge pull request #1621 from pallets/template-safe-path040088a
use posixpath.join
when loading template namesa292075
Merge pull request #1620 from janfilips/patch-16e4df02
Fix formatting in tricks.rst3a050b1
Merge pull request #1617 from pallets/docs-prose4b63cd8
rewrite include statement sectiona98d482
clean up faq, move technical discussions9de99f8
clean up engine comparisons9d697f5
22.1.06a14491
Update README76f8934
Update test deps885df35
Min Python to 3.7a93206b
Bump poetry to 1.2.0d2eda61
Add missing commab02cf6a
CI tweaks7636eff
Update README.rst9bc662a
Added os scantdir with is't tests and improved the tests for listdir2aefa1e
Added os listdir function with it's testsSourced from pytest-asyncio's releases.
pytest-asyncio 0.19.0
title: 'pytest-asyncio: pytest support for asyncio'
pytest-asyncio is an Apache2 licensed library, written in Python, for testing asyncio code with pytest.
asyncio code is usually written in the form of coroutines, which makes it slightly more difficult to test using normal testing tools. pytest-asyncio provides useful fixtures and markers to make testing easier.
@pytest.mark.asyncio async def test_some_asyncio_code(): res = await library.do_something() assert b"expected result" == res
pytest-asyncio has been strongly influenced by pytest-tornado.
Features
- fixtures for creating and injecting versions of the asyncio event loop
- fixtures for injecting unused tcp/udp ports
- pytest markers for treating tests as asyncio coroutines
- easy testing with non-default event loops
- support for [async def]{.title-ref} fixtures and async generator fixtures
- support auto mode to handle all async fixtures and tests automatically by asyncio; provide strict mode if a test suite should work with different async frameworks simultaneously, e.g.
asyncio
andtrio
.Installation
... (truncated)
Sourced from pytest-asyncio's changelog.
0.19.0 (22-07-13)
- BREAKING: The default
asyncio_mode
is now strict.[#293](https://github.com/pytest-dev/pytest-asyncio/issues/293) <https://github.com/pytest-dev/pytest-asyncio/issues/293>
_- Removes
setup.py
since all relevant configuration is presentsetup.cfg
. Users requiring an editable installation of pytest-asyncio need to use pip v21.1 or newer.[#283](https://github.com/pytest-dev/pytest-asyncio/issues/283) <https://github.com/pytest-dev/pytest-asyncio/issues/283>
_- Declare support for Python 3.11.
0.18.3 (22-03-25)
- Adds
pytest-trio <https://pypi.org/project/pytest-trio/>
_ to the test dependencies- Fixes a bug that caused pytest-asyncio to try to set up async pytest_trio fixtures in strict mode.
[#298](https://github.com/pytest-dev/pytest-asyncio/issues/298) <https://github.com/pytest-dev/pytest-asyncio/issues/298>
_0.18.2 (22-03-03)
- Fix asyncio auto mode not marking static methods.
[#295](https://github.com/pytest-dev/pytest-asyncio/issues/295) <https://github.com/pytest-dev/pytest-asyncio/issues/295>
_- Fix a compatibility issue with Hypothesis 6.39.0.
[#302](https://github.com/pytest-dev/pytest-asyncio/issues/302) <https://github.com/pytest-dev/pytest-asyncio/issues/302>
_0.18.1 (22-02-10)
- Fixes a regression that prevented async fixtures from working in synchronous tests.
[#286](https://github.com/pytest-dev/pytest-asyncio/issues/286) <https://github.com/pytest-dev/pytest-asyncio/issues/286>
_0.18.0 (22-02-07)
- Raise a warning if
@pytest
.mark.asyncio is applied to non-async function.[#275](https://github.com/pytest-dev/pytest-asyncio/issues/275) <https://github.com/pytest-dev/pytest-asyncio/issues/275>
_- Support parametrized
event_loop
fixture.[#278](https://github.com/pytest-dev/pytest-asyncio/issues/278) <https://github.com/pytest-dev/pytest-asyncio/issues/278>
_0.17.2 (22-01-17)
- Require
typing-extensions
on Python`_- Fix a regression in tests collection introduced by 0.17.1, the plugin works fine with non-python tests again.
[#267](https://github.com/pytest-dev/pytest-asyncio/issues/267) <https://github.com/pytest-dev/pytest-asyncio/issues/267>
_0.17.1 (22-01-16)
- Fixes a bug that prevents async Hypothesis tests from working without explicit
asyncio
marker when--asyncio-mode=auto
is set.[#258](https://github.com/pytest-dev/pytest-asyncio/issues/258) <https://github.com/pytest-dev/pytest-asyncio/issues/258>
_- Fixed a bug that closes the default event loop if the loop doesn't exist
[#257](https://github.com/pytest-dev/pytest-asyncio/issues/257) <https://github.com/pytest-dev/pytest-asyncio/issues/257>
_- Added type annotations.
[#198](https://github.com/pytest-dev/pytest-asyncio/issues/198) <https://github.com/pytest-dev/pytest-asyncio/issues/198>
_- Show asyncio mode in pytest report headers.
[#266](https://github.com/pytest-dev/pytest-asyncio/issues/266) <https://github.com/pytest-dev/pytest-asyncio/issues/266>
_- Relax
asyncio_mode
type definition; it allows to support pytest 6.1+.[#262](https://github.com/pytest-dev/pytest-asyncio/issues/262) <https://github.com/pytest-dev/pytest-asyncio/issues/262>
_0.17.0 (22-01-13)
pytest-asyncio
no longer alters existing event loop policies.[#168](https://github.com/pytest-dev/pytest-asyncio/issues/168) <https://github.com/pytest-dev/pytest-asyncio/issues/168>
,[#188](https://github.com/pytest-dev/pytest-asyncio/issues/188) <https://github.com/pytest-dev/pytest-asyncio/issues/168>
- Drop support for Python 3.6
- Fixed an issue when pytest-asyncio was used in combination with
flaky
or inherited asynchronous Hypothesis tests.[#178](https://github.com/pytest-dev/pytest-asyncio/issues/178) <https://github.com/pytest-dev/pytest-asyncio/issues/178>
_[#231](https://github.com/pytest-dev/pytest-asyncio/issues/231) <https://github.com/pytest-dev/pytest-asyncio/issues/231>
_- Added
flaky <https://pypi.org/project/flaky/>
_ to test dependencies- Added
unused_udp_port
andunused_udp_port_factory
fixtures (similar tounused_tcp_port
andunused_tcp_port_factory
counterparts.[#99](https://github.com/pytest-dev/pytest-asyncio/issues/99) <https://github.com/pytest-dev/pytest-asyncio/issues/99>
_- Added the plugin modes: strict, auto, and legacy. See
documentation <https://github.com/pytest-dev/pytest-asyncio#modes>
_ for details.[#125](https://github.com/pytest-dev/pytest-asyncio/issues/125) <https://github.com/pytest-dev/pytest-asyncio/issues/125>
_- Correctly process
KeyboardInterrupt
during async fixture setup phase[#219](https://github.com/pytest-dev/pytest-asyncio/issues/219) <https://github.com/pytest-dev/pytest-asyncio/issues/219>
_
... (truncated)
2da33c4
docs: Prepare v0.19.0 release. (#385)07beb80
opt into strict mode by default (#380)25c54a5
Clarify documentation of event_loop fixture (#375)49f07a4
Bump typing-extensions from 4.2.0 to 4.3.0 in /dependencies/default (#382)739198b
Bump hypothesis from 6.48.0 to 6.48.3 in /dependencies/default (#381)db72f25
Bump importlib-metadata from 4.11.4 to 4.12.0 in /dependencies/default (#378)4cf16cf
Bump hypothesis from 6.47.3 to 6.48.0 in /dependencies/default (#377)f13c85f
docs: Fix typo in README.b463f72
Python 3.11 support (#370)860ff51
Bump hypothesis from 6.47.2 to 6.47.3 in /dependencies/default (#373)Sourced from furo's changelog.
Changelog
2022.06.21 -- Opulent Opal
- Fix
docutils <= 0.17.x
compatibility- Bump to the latest Node.js LTS
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ng
as the base theme (from {pypi}sphinx-basic-ng
).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng
'sedit-this-page
component.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl
.- Improve "Edit this page" icon to be more accessible.
- Improve
html_sidebars
example.- Tweak positioning of back to top on desktop.
2022.03.04 -- Lucent Lilac
- Improve support for print media.
- Reduce heading sizes for h3 and below.
- Don't allow selecting headerlink content.
- Improve how overflow wrapping is handled.
- Add a reference from the configuration variables to the color customisation page.
2022.02.23 -- Keen Kobi
... (truncated)
a2e8f42
Prepare release: 2022.06.21d4967e5
Update changelog2969c23
[pre-commit.ci] pre-commit autoupdate (#455)2365493
Use findall from docutils only if it's availablebb3c355
Merge pull request #450 from polyzen/patch-14fb1a74
Bump to the latest Node.js LTS9970aac
Back to development1142fad
Prepare release: 2022.06.04.1211abb4
Update changelog06cdba6
Fix the edit this page URLSourced from black's releases.
22.6.0
Style
- Fix unstable formatting involving
#fmt: skip
and# fmt:skip
comments (notice the lack of spaces) (#2970)Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in
with
statements (#2926)- Remove trailing newlines after code block open (#3035)
Integrations
- Add
scripts/migrate-black.py
script to ease introduction of Black to a Git project (#3038)Output
- Output Python version and implementation as part of
--version
flag (#2997)Packaging
- Use
tomli
instead oftomllib
on Python 3.11 builds wheretomllib
is not available (#2987)Parser
- PEP 654 syntax (for example,
except *ExceptionGroup:
) is now supported (#3016)- PEP 646 syntax (for example,
Array[Batch, *Shape]
ordef fn(*args: *T) -> None
) is now supported (#3071)Vim Plugin
- Fix
strtobool
function. It didn't parse true/on/false/off. (#3025)Full Changelog: https://github.com/psf/black/compare/22.3.0...22.6.0
Thank you!
@jpy-git
for improving our parentheses formatting significantly@siuryan
for fixing a fmt: skip bug, making it a little less annoying to use :)@isidentical
for implementing support for PEP 654 and 646 syntax@defntvdm
for fixing our vim plugin, especially as we (the maintainers) don't really know vim script sadly@idorrington92
for fixing the docstring bug where Black would move the closing quotes causing it to violate the line length limit (whoops!)@hbrunn
for contributing the migrate-black script@saroad2
for improving newline handling after code blocks and test infrastructure improvements... and everyone else who contributed documentation, tests, or other improvements to the Black project!
... (truncated)
Sourced from black's changelog.
22.6.0
Style
- Fix unstable formatting involving
#fmt: skip
and# fmt:skip
comments (notice the lack of spaces) (#2970)Preview style
- Docstring quotes are no longer moved if it would violate the line length limit (#3044)
- Parentheses around return annotations are now managed (#2990)
- Remove unnecessary parentheses around awaited objects (#2991)
- Remove unnecessary parentheses in
with
statements (#2926)- Remove trailing newlines after code block open (#3035)
Integrations
- Add
scripts/migrate-black.py
script to ease introduction of Black to a Git project (#3038)Output
- Output Python version and implementation as part of
--version
flag (#2997)Packaging
- Use
tomli
instead oftomllib
on Python 3.11 builds wheretomllib
is not available (#2987)Parser
- PEP 654 syntax (for example,
except *ExceptionGroup:
) is now supported (#3016)- PEP 646 syntax (for example,
Array[Batch, *Shape]
ordef fn(*args: *T) -> None
) is now supported (#3071)Vim Plugin
- Fix
strtobool
function. It didn't parse true/on/false/off. (#3025)22.3.0
Preview style
- Code cell separators
#%%
are now standardised to# %%
(#2919)- Remove unnecessary parentheses from
except
statements (#2939)- Remove unnecessary parentheses from tuple unpacking in
for
loops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
... (truncated)
f6c139c
Prepare docs for release 22.6.0 (#3139)eb5d175
Update preview style docs to include recent changes (#3136)d848209
Bump furo from 2022.6.4.1 to 2022.6.21 in /docs (#3138)fa6caa6
Only call get_future_imports when needed (#3135)6463fb8
Bump sphinx from 5.0.1 to 5.0.2 in /docs (#3128)e3c9b04
Replace link to Requests documentation (#3125)6c1bd08
Test run black on self (#3114)799adb5
Bump actions/setup-python from 3 to 4 (#3121)162ecd1
Use is_number_token instead of assertion (#3069)8c8675c
Update documentation dependencies (#3118)Sourced from black's releases.
22.3.0
Preview style
- Code cell separators
#%%
are now standardised to# %%
(#2919)- Remove unnecessary parentheses from
except
statements (#2939)- Remove unnecessary parentheses from tuple unpacking in
for
loops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
- Do not format
__pypackages__
directories by default (#2836)- Add support for specifying stable version with
--required-version
(#2832).- Avoid crashing when the user has no homedir (#2814)
- Avoid crashing when md5 is not available (#2905)
- Fix handling of directory junctions on Windows (#2904)
Documentation
- Update pylint config documentation (#2931)
Integrations
- Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
Output
- In verbose, mode, log when Black is using user-level config (#2861)
Packaging
- Fix Black to work with Click 8.1.0 (#2966)
- On Python 3.11 and newer, use the standard library's
tomllib
instead oftomli
(#2903)black-primer
, the deprecated internal devtool, has been removed and copied to a separate repository (#2924)Parser
- Black can now parse starred expressions in the target of
for
andasync for
statements, e.gfor item in *items_1, *items_2: pass
(#2879).
Sourced from black's changelog.
22.3.0
Preview style
- Code cell separators
#%%
are now standardised to# %%
(#2919)- Remove unnecessary parentheses from
except
statements (#2939)- Remove unnecessary parentheses from tuple unpacking in
for
loops (#2945)- Avoid magic-trailing-comma in single-element subscripts (#2942)
Configuration
- Do not format
__pypackages__
directories by default (#2836)- Add support for specifying stable version with
--required-version
(#2832).- Avoid crashing when the user has no homedir (#2814)
- Avoid crashing when md5 is not available (#2905)
- Fix handling of directory junctions on Windows (#2904)
Documentation
- Update pylint config documentation (#2931)
Integrations
- Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
Output
- In verbose, mode, log when Black is using user-level config (#2861)
Packaging
- Fix Black to work with Click 8.1.0 (#2966)
- On Python 3.11 and newer, use the standard library's
tomllib
instead oftomli
(#2903)black-primer
, the deprecated internal devtool, has been removed and copied to a separate repository (#2924)Parser
- Black can now parse starred expressions in the target of
for
andasync for
statements, e.gfor item in *items_1, *items_2: pass
(#2879).
ae2c075
Prepare release 22.3.0 (#2968)e9681a4
Fix _unicodefun patch code for Click 8.1.0 (#2966)ac7402c
Bump sphinx from 4.4.0 to 4.5.0 in /docs (GH-2959)f239d22
Enforce no formatting changes for PRs via CI (GH-2951)bd1e980
Remove unnecessary parentheses from except
clauses (#2939)14d84ba
Resolve new flake8-bugbear errors (B020) (GH-2950)14e5ce5
Remove unnecessary parentheses from tuple unpacking in for
loops (#2945)3800ebd
Avoid magic-trailing-comma in single-element subscripts (#2942)062b549
Github now supports .git-blame-ignore-revs (GH-2948)5379d4f
stub style: remove some possible future changes (#2940)Sourced from furo's changelog.
Changelog
2022.06.04.1 -- Naughty Nickel bugfix
- Fix the URL used in the "Edit this page" for Read the Docs builds.
2022.06.04 -- Naughty Nickel
- ✨ Advertise Sphinx 5 compatibility.
- ✨ Change to
basic-ng
as the base theme (from {pypi}sphinx-basic-ng
).- Document site-wide announcement banners.
- Drop the pin on pygments.
- Improve edit button, using
basic-ng
'sedit-this-page
component.- Tweak headings to better match what users expect.
- Tweak how Sphinx's default HTML is rendered, using docutils post-transforms (this replaces parsing+modifying it with BeautifulSoup).
- When built with docutils 0.18, footnotes are rendered differently and stylised differently in Furo.
2022.04.07 -- Magical Mauve
- ✨ Make sphinx-copybutton look better.
- Add margin to indentations in line blocks.
- Add styling for non-arabic list styles
- Add support for
html_baseurl
.- Improve "Edit this page" icon to be more accessible.
- Improve
html_sidebars
example.- Tweak positioning of back to top on desktop.
2022.03.04 -- Lucent Lilac
- Improve support for print media.
- Reduce heading sizes for h3 and below.
- Don't allow selecting headerlink content.
- Improve how overflow wrapping is handled.
- Add a reference from the configuration variables to the color customisation page.
2022.02.23 -- Keen Kobi
- ✨ Add a "Back to Top" button that shows up when scrolling up.
- Add a URL to GitHub in Project-URLs.
- Break long words in the prev/next buttons.
- Fix includes in Kitchen sink.
... (truncated)
1142fad
Prepare release: 2022.06.04.1211abb4
Update changelog06cdba6
Fix the edit this page URL43ce491
Back to developmentfb6e486
Prepare release: 2022.06.04090b02e
Update changelog098d51d
Fix the Just the Docs link7fa8d08
Change to a post-transform for wrapping math blocks and table51f1e52
Speed up determining if there's multiple toc entries99a6ff8
Update caniuse-lite NPM packageSourced from click's releases.
8.1.0
This is a feature release, which includes new features and removes previously deprecated features. The 8.1.x branch is now the supported bugfix branch, the 8.0.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades.
Sourced from click's changelog.
Version 8.1.0
Released 2022-03-28
Drop support for Python 3.6. :pr:
2129
Remove previously deprecated code. :pr:
2130
Group.resultcallback
is renamed toresult_callback
.autocompletion
parameter toCommand
is renamed toshell_complete
.get_terminal_size
is removed, useshutil.get_terminal_size
instead.get_os_args
is removed, usesys.argv[1:]
instead.Rely on :pep:
538
and :pep:540
to handle selecting UTF-8 encoding instead of ASCII. Click's locale encoding detection is removed. :issue:2198
Single options boolean flags with
show_default=True
only show the default if it isTrue
. :issue:1971
The
command
andgroup
decorators can be applied with or without parentheses. :issue:1359
The
Path
type can check whether the target is executable. :issue:1961
Command.show_default
overridesContext.show_default
, instead of the other way around. :issue:1963
Parameter decorators and
@group
handlescls=None
the same as not passingcls
.@option
handleshelp=None
the same as not passinghelp
. :issue:[#1959](https://github.com/pallets/click/issues/1959)
A flag option with
required=True
requires that the flag is passed instead of choosing the implicit default value. :issue:1978
Indentation in help text passed to
Option
andCommand
is cleaned the same as using the@option
and@command
decorators does. A command'sepilog
andshort_help
are also processed. :issue:1985
Store unprocessed
Command.help
,epilog
andshort_help
strings. Processing is only done when formatting help text for output. :issue:2149
Allow empty str input for
prompt()
whenconfirmation_prompt=True
anddefault=""
. :issue:2157
Windows glob pattern expansion doesn't fail if a value is an invalid pattern. :issue:
2195
It's possible to pass a list of
params
to@command
. Any params defined with decorators are appended to the passed params. :issue:2131
.
@command
decorator is annotated as returning the correct type if acls
argument is used. :issue:2211
A
Group
withinvoke_without_command=True
andchain=False
will invoke its result callback with the group function's return value. :issue:2124
... (truncated)
e4aceee
Merge pull request #2224 from pallets/release-8.1.0f8d811e
release version 8.1.020c88f0
Merge pull request #2223 from pallets/env-var8d7f03d
treat empty auto_envvar as Noneef11be6
Merge pull request #2041 from spanglerco/shell-completion-option-valuesf2e579a
shell completion prioritizes option values over new optionsd251cb0
Merge pull request #2219 from pallets/paramtype-namee003331
fix ParamType.to_info_dict() with no name19be092
Merge pull request #2217 from pallets/group-return7d3a871
group without command passes return value to result callbackSourced from pytest's releases.
7.1.0
pytest 7.1.0 (2022-03-13)
Breaking Changes
#8838: As per our policy, the following features have been deprecated in the 6.X series and are now removed:
pytest._fillfuncargs
function.pytest_warning_captured
hook - usepytest_warning_recorded
instead.-k -foobar
syntax - use-k 'not foobar'
instead.-k foobar:
syntax.pytest.collect
module - import frompytest
directly.For more information consult Deprecations and Removals in the docs.
#9437: Dropped support for Python 3.6, which reached end-of-life at 2021-12-23.
Improvements
#5192: Fixed test output for some data types where
-v
would show less information.Also, when showing diffs for sequences,
-q
would produce full diffs instead of the expected diff.#9362: pytest now avoids specialized assert formatting when it is detected that the default
__eq__
is overridden inattrs
ordataclasses
.#9536: When
-vv
is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width.#9644: More information about the location of resources that led Python to raise
ResourceWarning
{.interpreted-text role="class"} can now be obtained by enablingtracemalloc
{.interpreted-text role="mod"}.See
resource-warnings
{.interpreted-text role="ref"} for more information.#9678: More types are now accepted in the
ids
argument to@pytest.mark.parametrize
. Previously only [str]{.title-ref}, [float]{.title-ref}, [int]{.title-ref} and [bool]{.title-ref} were accepted; now [bytes]{.title-ref}, [complex]{.title-ref}, [re.Pattern]{.title-ref}, [Enum]{.title-ref} and anything with a [__name__]{.title-ref} are also accepted.#9692:
pytest.approx
{.interpreted-text role="func"} now raises aTypeError
{.interpreted-text role="class"} when given an unordered sequence (such asset
{.interpreted-text role="class"}).Note that this implies that custom classes which only implement
__iter__
and__len__
are no longer supported as they don't guarantee order.Bug Fixes
- #8242: The deprecation of raising
unittest.SkipTest
{.interpreted-text role="class"} to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again.- #9493: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice.
... (truncated)
1dbffcc
[pre-commit.ci] auto fixes from pre-commit.com hooksd53a5fb
Prepare release version 7.1.0d306ec0
Update upcoming trainings (#9744)3e4c14b
Merge pull request #9751 from fabianegli/main7f924b1
Fix typo in deprecation documentation4a8f8ad
build(deps): Bump django from 4.0.2 to 4.0.3 in /testing/plugins_integration ...c0fd2d8
build(deps): Bump pytest-asyncio from 0.18.1 to 0.18.2 in /testing/plugins_in...843e018
Merge pull request #9732 from nicoddemus/9730-toml-failurebc43d66
[automated] Update plugin list (#9733)e38d1ca
Improve error message for malformed pyproject.toml files8e4800e
Fixup readmedc1efca
2.1.0 releasedd9d608
Add custom hooks specifications for overriding setup_timeout and teardown_tim...ed8ecd6
module names, they're difficult3ab4319
Add changelog4f7ebae
Replace deprecated py.io.get_terminal_width() with shutil.get_terminal_size()...b8a2fa6
Prep release951972d
Update changelog748a9c3
Making detection of whether a debugger is currently attached more flexible. (...f8a46a1
Github removed the git protocol (#112)Sourced from asgiref's changelog.
3.5.0 (2022-01-22)
Python 3.6 is no longer supported, and asyncio calls have been changed to use only the modern versions of the APIs as a result
Several causes of RuntimeErrors in cases where an event loop was assigned to a thread but not running
Speed improvements in the Local class
3.4.1 (2021-07-01)
- Fixed an issue with the deadlock detection where it had false positives during exception handling.
3.4.0 (2021-06-27)
Calling sync_to_async directly from inside itself (which causes a deadlock when in the default, thread-sensitive mode) now has deadlock detection.
asyncio usage has been updated to use the new versions of get_event_loop, ensure_future, wait and gather, avoiding deprecation warnings in Python 3.10. Python 3.6 installs continue to use the old versions; this is only for 3.7+
sync_to_async and async_to_sync now have improved type hints that pass through the underlying function type correctly.
All Websocket* types are now spelled WebSocket, to match our specs and the official spelling. The old names will work until release 3.5.0, but will raise deprecation warnings.
The typing for WebSocketScope and HTTPScope's
extensions
key has been fixed.3.3.4 (2021-04-06)
- The async_to_sync type error is now a warning due the high false negative rate when trying to detect coroutine-returning callables in Python.
3.3.3 (2021-04-06)
... (truncated)
8b61513
Releasing 3.5.0b2e1c9d
Fixed pytest_asyncio deprecation warning.2eda551
Added testing for Python 3.10.02fecb6
Drop Python 3.6 (#307)6689c0a
Added stacklevel to warning in AsyncToSync.4364f9b
Changed how StatelessServer handles event loops7bc055c
Update implementations.rst (#295)c758984
Move current_task import choice to module definition timedfe87b2
Fixed #292: Use get_event_loop in class-level codeb3a65e3
Removed class variable which has been unused since a0bbe90Sourced from pytest's releases.
7.0.0
pytest 7.0.0 (2022-02-03)
(Please see the full set of changes for this release also in the 7.0.0rc1 notes below)
Deprecations
#9488: If custom subclasses of nodes like
pytest.Item
{.interpreted-text role="class"} override the__init__
method, they should take**kwargs
. Seeuncooperative-constructors-deprecated
{.interpreted-text role="ref"} for details.Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented.
Bug Fixes
- #9355: Fixed error message prints function decorators when using assert in Python 3.8 and above.
- #9396: Ensure
pytest.Config.inifile
{.interpreted-text role="attr"} is available during thepytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>
{.interpreted-text role="func"} hook (regression during7.0.0rc1
).Improved Documentation
- #9404: Added extra documentation on alternatives to common misuses of [pytest.warns(None)]{.title-ref} ahead of its deprecation.
- #9505: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository.
Trivial/Internal Changes
- #9521: Add test coverage to assertion rewrite path.
pytest 7.0.0rc1 (2021-12-06)
Breaking Changes
#7259: The
Node.reportinfo() <non-python tests>
{.interpreted-text role="ref"} function first return value type has been expanded from [py.path.local | str]{.title-ref} to [os.PathLike[str] | str]{.title-ref}.Most plugins which refer to [reportinfo()]{.title-ref} only define it as part of a custom
pytest.Item
{.interpreted-text role="class"} implementation. Since [py.path.local]{.title-ref} is a [os.PathLike[str]]{.title-ref}, these plugins are unaffacted.Plugins and users which call [reportinfo()]{.title-ref}, use the first return value and interact with it as a [py.path.local]{.title-ref}, would need to adjust by calling [py.path.local(fspath)]{.title-ref}. Although preferably, avoid the legacy [py.path.local]{.title-ref} and use [pathlib.Path]{.title-ref}, or use [item.location]{.title-ref} or [item.path]{.title-ref}, instead.
Note: pytest was not able to provide a deprecation period for this change.
... (truncated)
3554b83
Add note to changelog6ea7f99
Prepare release version 7.0.0737b220
[7.0.x] releasing: Add template for major releases (#9597)7fa3972
[7.0.x] releasing: Always set doc_version (#9590)b304499
[7.0.x] Make 'warnings' and 'deselected' in assert_outcomes optional (#9566)f17525d
[7.0.x] doc: Add ellipsis to warning usecase list (#9562)0a7be97
ci: Bump up timeout (#9565)c17908c
[7.0.x] doc: Recategorize 7.0.0 changelog items (#9564)ab549bb
[7.0.x] Add missing cooperative constructor changelog (#9563)4b1707f
[7.0.x] Autouse linearization graph (#9557)Sourced from pytest-asyncio's releases.
pytest-asyncio 0.18.0
title: 'pytest-asyncio: pytest support for asyncio'
pytest-asyncio is an Apache2 licensed library, written in Python, for testing asyncio code with pytest.
asyncio code is usually written in the form of coroutines, which makes it slightly more difficult to test using normal testing tools. pytest-asyncio provides useful fixtures and markers to make testing easier.
@pytest.mark.asyncio async def test_some_asyncio_code(): res = await library.do_something() assert b"expected result" == res
pytest-asyncio has been strongly influenced by pytest-tornado.
Features
- fixtures for creating and injecting versions of the asyncio event loop
- fixtures for injecting unused tcp/udp ports
- pytest markers for treating tests as asyncio coroutines
- easy testing with non-default event loops
- support for [async def]{.title-ref} fixtures and async generator fixtures
- support auto mode to handle all async fixtures and tests automatically by asyncio; provide strict mode if a test suite should work with different async frameworks simultaneously, e.g.
asyncio
andtrio
.Installation
... (truncated)
07e9922
Prepare release of v0.18.0 (#282)a92d894
Relax dependency on typing-extensions (#284)e78b59d
Fix setuptools_scm configuration (#279)d8efa64
Support parametrized event_loop fixture (#278)dab3b51
Raise a warning if @pytest
.mark.asyncio is applied to non-async function (#275)048a6ed
Code cleanup: drop 'request' argument from async fixtures (#270)4353327
Update changelogc919fd7
Remove unconditional test item attribute access (#268)39c6d0c
Update README547933d
Require typing-extensions on py<3.8 only (#269)Sourced from pytest-asyncio's releases.
pytest-asyncio 0.17.0
title: 'pytest-asyncio: pytest support for asyncio'
pytest-asyncio is an Apache2 licensed library, written in Python, for testing asyncio code with pytest.
asyncio code is usually written in the form of coroutines, which makes it slightly more difficult to test using normal testing tools. pytest-asyncio provides useful fixtures and markers to make testing easier.
@pytest.mark.asyncio async def test_some_asyncio_code(): res = await library.do_something() assert b"expected result" == res
pytest-asyncio has been strongly influenced by pytest-tornado.
Features
- fixtures for creating and injecting versions of the asyncio event loop
- fixtures for injecting unused tcp/udp ports
- pytest markers for treating tests as asyncio coroutines
- easy testing with non-default event loops
- support for [async def]{.title-ref} fixtures and async generator fixtures
- support auto mode to handle all async fixtures and tests automatically by asyncio; provide strict mode if a test suite should work with different async frameworks simultaneously, e.g.
asyncio
andtrio
.Installation
... (truncated)
2e2d5d2
Bump to 0.17 release90436c9
Fix pandoc installation procedured291c66
Convert README.rst to Markdown for making githun release141937b
Fix release artifacts696cf7d
Fix trove classifier for asyncio8ccb306
Build on tagcd84987
Release process automation (#252)2eb12a7
Setup GitHub Workflows linter and yaml-reformatter (#253)d28b826
Bump codecov/codecov-action from 1 to 2.1.0 (#251)2f523ba
Configure dependabot version updater (#250)Sourced from black's releases.
22.1.0
At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our new stability policy.
Highlights
Style
- Deprecate
--experimental-string-processing
and move the functionality under--preview
(#2789)- For stubs, one blank line between class attributes and methods is now kept if there's at least one pre-existing blank line (#2736)
- Black now normalizes string prefix order (#2297)
- Remove spaces around power operators if both operands are simple (#2726)
- Work around bug that causes unstable formatting in some cases in the presence of the magic trailing comma (#2807)
- Use parentheses for attribute access on decimal float and int literals (#2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex literals (#2799)
- Treat blank lines in stubs the same inside top-level if statements (#2820)
- Fix unstable formatting with semicolons and arithmetic expressions (#2817)
- Fix unstable formatting around magic trailing comma (#2572)
Parser
- Fix mapping cases that contain as-expressions, like
case {"key": 1 | 2 as password}
(#2686)- Fix cases that contain multiple top-level as-expressions, like
case 1 as a, 2 as b
(#2716)- Fix call patterns that contain as-expressions with keyword arguments, like
case Foo(bar=baz as quux)
(#2749)- Tuple unpacking on
return
andyield
constructs now implies 3.8+ (#2700)- Unparenthesized tuples on annotated assignments (e.g
values: Tuple[int, ...] = 1, 2, 3
) now implies 3.8+ (#2708)- Fix handling of standalone
match()
orcase()
when there is a trailing newline or a comment inside of the parentheses. (#2760)from __future__ import annotations
statement now implies Python 3.7+ (#2690)Performance
- Speed-up the new backtracking parser about 4X in general (enabled when
--target-version
is set to 3.10 and higher). (#2728)- Black is now compiled with mypyc for an overall 2x speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009, #2431)
Configuration
- Do not accept bare carriage return line endings in pyproject.toml (#2408)
- Add configuration option (
python-cell-magics
) to format cells with custom magics in Jupyter Notebooks (#2744)- Allow setting custom cache directory on all platforms with environment variable
BLACK_CACHE_DIR
(#2739).- Enable Python 3.10+ by default, without any extra need to specify -
-target-version=py310
. (#2758)- Make passing
SRC
or--code
mandatory and mutually exclusive (#2804)Output
- Improve error message for invalid regular expression (#2678)
- Improve error message when parsing fails during AST safety check by embedding the underlying SyntaxError (#2693)
- No longer color diff headers white as it's unreadable in light themed terminals (#2691)
- Text coloring added in the final statistics (#2712)
- Verbose mode also now describes how a project root was discovered and which paths will be formatted. (#2526)
Packaging
... (truncated)
Sourced from black's changelog.
22.1.0
At long last, Black is no longer a beta product! This is the first non-beta release and the first release covered by our new stability policy.
Highlights
Style
- Deprecate
--experimental-string-processing
and move the functionality under--preview
(#2789)- For stubs, one blank line between class attributes and methods is now kept if there's at least one pre-existing blank line (#2736)
- Black now normalizes string prefix order (#2297)
- Remove spaces around power operators if both operands are simple (#2726)
- Work around bug that causes unstable formatting in some cases in the presence of the magic trailing comma (#2807)
- Use parentheses for attribute access on decimal float and int literals (#2799)
- Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex literals (#2799)
- Treat blank lines in stubs the same inside top-level
if
statements (#2820)- Fix unstable formatting with semicolons and arithmetic expressions (#2817)
- Fix unstable formatting around magic trailing comma (#2572)
Parser
- Fix mapping cases that contain as-expressions, like
case {"key": 1 | 2 as password}
(#2686)- Fix cases that contain multiple top-level as-expressions, like
case 1 as a, 2 as b
(#2716)- Fix call patterns that contain as-expressions with keyword arguments, like
case Foo(bar=baz as quux)
(#2749)- Tuple unpacking on
return
andyield
constructs now implies 3.8+ (#2700)- Unparenthesized tuples on annotated assignments (e.g
values: Tuple[int, ...] = 1, 2, 3
) now implies 3.8+ (#2708)- Fix handling of standalone
match()
orcase()
when there is a trailing newline or a comment inside of the parentheses. (#2760)from __future__ import annotations
statement now implies Python 3.7+ (#2690)Performance
... (truncated)
Sourced from janus's releases.
janus 1.0.0 release
- Dropped Python 3.6 support
- Janus is marked as stable, no API changes was made for years
Sourced from janus's changelog.
1.0.0 (2021-12-17)
- Drop Python 3.6 support
0.7.0 (2021-11-24)
- Add SyncQueue and AsyncQueue Protocols to provide type hints for sync and async queues #374
0.6.2 (2021-10-24)
- Fix Python 3.10 compatibility #358
0.6.1 (2020-10-26)
Raise RuntimeError on queue.join() after queue closing. #295
Replace
timeout
type fromOptional[int]
toOptional[float]
#2670.6.0 (2020-10-10)
Drop Python 3.5, the minimal supported version is Python 3.6
Support Python 3.9
Refomat with
black
0.5.0 (2020-04-23)
- Remove explicit loop arguments and forbid creating queues outside event loops #246
0.4.0 (2018-07-28)
Add
py.typed
macro #89Drop python 3.4 support and fix minimal version python3.5.3 #88
Add property with that indicates if queue is closed #86
0.3.2 (2018-07-06)
- Fixed python 3.7 support #97
... (truncated)
0783f9b
Fix coverage upload41c49ba
Make deployment only if checks are greenec94b35
Fix CI again2303208
Fix CIdff5078
Bump to 1.0.03421545
Bump mypy from 0.910 to 0.920 (#384)56b2d1d
Bump black from 21.11b1 to 21.12b0 (#383)883e82b
Update README.rst2e30d8a
Bump coverage from 6.1.2 to 6.2 (#382)7b72d85
Bump to 0.7Sourced from black's releases.
21.12b0
Black
- Fix determination of f-string expression spans (#2654)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)
- Functions and classes in blocks now have more consistent surrounding spacing (#2472)
Jupyter Notebook support
- Cell magics are now only processed if they are known Python cell magics. Earlier, all cell magics were tokenized, leading to possible indentation errors e.g. with
%%writefile
. (#2630)- Fix assignment to environment variables in Jupyter Notebooks (#2642)
Python 3.10 support
- Point users to using
--target-version py310
if we detect 3.10-only syntax (#2668)- Fix
match
statements with open sequence subjects, likematch a, b:
ormatch a, *b:
(#2639) (#2659)- Fix
match
/case
statements that containmatch
/case
soft keywords multiple times, likematch re.match()
(#2661)- Fix
case
statements with an inline body (#2665)- Fix styling of starred expressions inside
match
subject (#2667)- Fix parser error location on invalid syntax in a
match
statement (#2649)- Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Improve parsing performance on code that uses
match
under--target-version py310
up to ~50% (#2670)Packaging
Thank you!
@isidentical
for the polishing up 3.10 syntax support (which they contributed in the first place!)@MarcoGorelli
for their ever-continuing work on Black's jupyter support@jalaziz
for cleaning up our Pyinstaller CD workflow@hauntsaninja
for helping us drop theregex
dependencyAnd also congrats to first contributors!
@MatthewScholefield
made their first contribution in psf/black#2631@AshIsbitt
made their first contribution in psf/black#2632@kalbasit
made their first contribution in psf/black#2638@danieleades
made their first contribution in psf/black#2653@danielsparing
made their first contribution in psf/black#2630@tanvimoharir
made their first contribution in psf/black#2343
Sourced from black's changelog.
21.12b0
Black
- Fix determination of f-string expression spans (#2654)
- Fix bad formatting of error messages about EOF in multi-line statements (#2343)
- Functions and classes in blocks now have more consistent surrounding spacing (#2472)
Jupyter Notebook support
- Cell magics are now only processed if they are known Python cell magics. Earlier, all cell magics were tokenized, leading to possible indentation errors e.g. with
%%writefile
. (#2630)- Fix assignment to environment variables in Jupyter Notebooks (#2642)
Python 3.10 support
- Point users to using
--target-version py310
if we detect 3.10-only syntax (#2668)- Fix
match
statements with open sequence subjects, likematch a, b:
ormatch a, *b:
(#2639) (#2659)- Fix
match
/case
statements that containmatch
/case
soft keywords multiple times, likematch re.match()
(#2661)- Fix
case
statements with an inline body (#2665)- Fix styling of starred expressions inside
match
subject (#2667)- Fix parser error location on invalid syntax in a
match
statement (#2649)- Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Improve parsing performance on code that uses
match
under--target-version py310
up to ~50% (#2670)Packaging
Sourced from pytest-xdist's changelog.
pytest-xdist 2.5.0 (2021-12-10)
Features
[#722](https://github.com/pytest-dev/pytest-xdist/issues/722) <https://github.com/pytest-dev/pytest-xdist/issues/722>
_: Full compatibility with pytest 7 - no deprecation warnings or use of legacy features.
[#733](https://github.com/pytest-dev/pytest-xdist/issues/733) <https://github.com/pytest-dev/pytest-xdist/issues/733>
_: New--dist=loadgroup
option, which ensures all tests marked with@pytest.mark.xdist_group
run in the same session/worker. Other tests run distributed as in--dist=load
.Trivial Changes
[#708](https://github.com/pytest-dev/pytest-xdist/issues/708) <https://github.com/pytest-dev/pytest-xdist/issues/708>
_: Use@pytest.hookspec
decorator to declare hook options innewhooks.py
to avoid warnings inpytest 7.0
.
[#719](https://github.com/pytest-dev/pytest-xdist/issues/719) <https://github.com/pytest-dev/pytest-xdist/issues/719>
_: Use up-to-datesetup.cfg
/pyproject.toml
packaging setup.
[#720](https://github.com/pytest-dev/pytest-xdist/issues/720) <https://github.com/pytest-dev/pytest-xdist/issues/720>
_: Require pytest>=6.2.0.
[#721](https://github.com/pytest-dev/pytest-xdist/issues/721) <https://github.com/pytest-dev/pytest-xdist/issues/721>
_: Started using type annotations and mypy checking internally. The types are incomplete and not published.pytest-xdist 2.4.0 (2021-09-20)
Features
[#696](https://github.com/pytest-dev/pytest-xdist/issues/696) <https://github.com/pytest-dev/pytest-xdist/issues/696>
_: On Linux, the process title now changes to indicate the current worker state (running/idle).Depends on the
setproctitle <https://pypi.org/project/setproctitle/>
__ package, which can be installed withpip install pytest-xdist[setproctitle]
.
[#704](https://github.com/pytest-dev/pytest-xdist/issues/704) <https://github.com/pytest-dev/pytest-xdist/issues/704>
_: Add support for Python 3.10.pytest-xdist 2.3.0 (2021-06-16)
Deprecations and Removals
[#654](https://github.com/pytest-dev/pytest-xdist/issues/654) <https://github.com/pytest-dev/pytest-xdist/issues/654>
_: Python 3.5 is no longer supported.Features
[#646](https://github.com/pytest-dev/pytest-xdist/issues/646) <https://github.com/pytest-dev/pytest-xdist/issues/646>
_: Add--numprocesses=logical
flag, which automatically uses the number of logical CPUs available, instead of physical CPUs withauto
.
... (truncated)
13f3934
Remove unnecessary skip from test_logfinish_hook as we require pytest>=6.2c76d562
Skip test_warning_captured_deprecated_in_pytest_6 in pytest>=7.15f78c71
Fix CHANGELOG headerc8bbc03
Release 2.5.08dbf367
Merge pull request #738 from pytest-dev/pre-commit-ci-update-configa25c14b
[pre-commit.ci] pre-commit autoupdate110c114
Merge pull request #734 from nicoddemus/revamp-readme83bdbf4
Revamp README630c1eb
Merge pull request #733 from baekdohyeop/feature-loadgroup62e50d0
Address reviewSourced from janus's changelog.
0.7.0 (2021-11-24)
- Add SyncQueue and AsyncQueue Protocols to provide type hints for sync and async queues #374
0.6.2 (2021-10-24)
- Fix Python 3.10 compatibility #358
0.6.1 (2020-10-26)
Raise RuntimeError on queue.join() after queue closing. #295
Replace
timeout
type fromOptional[int]
toOptional[float]
#2670.6.0 (2020-10-10)
Drop Python 3.5, the minimal supported version is Python 3.6
Support Python 3.9
Refomat with
black
0.5.0 (2020-04-23)
- Remove explicit loop arguments and forbid creating queues outside event loops #246
0.4.0 (2018-07-28)
Add
py.typed
macro #89Drop python 3.4 support and fix minimal version python3.5.3 #88
Add property with that indicates if queue is closed #86
0.3.2 (2018-07-06)
- Fixed python 3.7 support #97
0.3.1 (2018-01-30)
- Fixed bug with join() in case tasks are added by sync_q.put() #75
... (truncated)
7b72d85
Bump to 0.75389dec
add SyncQueue and AsyncQueue Protocols (#374)d54ae42
Bump docutils from 0.18 to 0.18.1 (#381)76ccc92
Bump black from 21.11b0 to 21.11b1 (#380)967c284
Bump black from 21.10b0 to 21.11b0 (#379)4d625a2
Bump bandit from 1.7.0 to 1.7.1 (#378)e21eec2
Bump coverage from 6.1.1 to 6.1.2 (#377)7ff20af
Bump isort from 5.10.0 to 5.10.1 (#376)67e3782
Switch from setup.py to declarative setup.cfg (#375)8a0c498
Bump isort from 5.9.3 to 5.10.0 (#373)Sourced from black's releases.
21.11b1
Black
- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310
is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.11b1
Black
- Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310
is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
d010ff4
0.8.03e3830d
Tweak README713984e
Update README9570975
Use os.sep2b2500d
Add prefix, suffix, dir args to TemporaryDirectory8895eb4
Fix ospath.exists test8308355
Fix typo: aiofiles.ospath.existsb8cf8dd
Update Readme with os.makedirs and os.removedirsaea353e
Merge branch 'patch-2'761f06e
Fix READMESourced from black's releases.
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310
is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.11b0
Black
- Warn about Python 2 deprecation in more cases by improving Python 2 only syntax detection (#2592)
- Add experimental PyPy support (#2559)
- Add partial support for the match statement. As it's experimental, it's only enabled when
--target-version py310
is explicitly specified (#2586)- Add support for parenthesized with (#2586)
- Declare support for Python 3.10 for running Black (#2562)
Integrations
- Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
- The vim plugin now parses
skip_magic_trailing_comma
from pyproject.toml (#2613)21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's releases.
21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
Sourced from black's changelog.
21.10b0
Black
- Document stability policy, that will apply for non-beta releases (#2529)
- Add new
--workers
parameter (#2514)- Fixed feature detection for positional-only arguments in lambdas (#2532)
- Bumped typed-ast version minimum to 1.4.3 for 3.10 compatiblity (#2519)
- Fixed a Python 3.10 compatibility issue where the loop argument was still being passed even though it has been removed (#2580)
- Deprecate Python 2 formatting support (#2523)
Blackd
Black-Primer
Integrations
f2fe98e
0.16.04e1df31
Remove obsolete test, add make test6ec7647
feat: Add support for Python 3.10.42ff5d1
ci: Include Python 3.10 in the CI test run.be3b327
build: Include Python 3.10 in Tox test runs.1c283bd
refactor: test_async_fixtures_with_finalizer no longer trigger a DeprecationW...2751982
refactor: Replaced tests asserting that the event loop is properly closed.70989fd
refactor: Grouped test cases together that are related to the use of the asyn...b27abe8
refactor: Removed TestUnexistingLoop.remove_loop fixture, because it has no e...e3ec312
Adjusted Hypothesis integration test to use the same event loop initializatio...Sourced from pyyaml's changelog.
6.0 (2021-10-13)
- yaml/pyyaml#327 -- Change README format to Markdown
- yaml/pyyaml#483 -- Add a test for YAML 1.1 types
- yaml/pyyaml#497 -- fix float resolver to ignore
.
and._
- yaml/pyyaml#550 -- drop Python 2.7
- yaml/pyyaml#553 -- Fix spelling of “hexadecimal”
- yaml/pyyaml#556 -- fix representation of Enum subclasses
- yaml/pyyaml#557 -- fix libyaml extension compiler warnings
- yaml/pyyaml#560 -- fix ResourceWarning on leaked file descriptors
- yaml/pyyaml#561 -- always require
Loader
arg toyaml.load()
- yaml/pyyaml#564 -- remove remaining direct distutils usage
5.4.1 (2021-01-20)
- yaml/pyyaml#480 -- Fix stub compat with older pyyaml versions that may unwittingly load it
5.4 (2021-01-19)
- yaml/pyyaml#407 -- Build modernization, remove distutils, fix metadata, build wheels, CI to GHA
- yaml/pyyaml#472 -- Fix for CVE-2020-14343, moves arbitrary python tags to UnsafeLoader
- yaml/pyyaml#441 -- Fix memory leak in implicit resolver setup
- yaml/pyyaml#392 -- Fix py2 copy support for timezone objects
- yaml/pyyaml#378 -- Fix compatibility with Jython
5.3.1 (2020-03-18)
- yaml/pyyaml#386 -- Prevents arbitrary code execution during python/object/new constructor
5.3 (2020-01-06)
- yaml/pyyaml#290 -- Use
is
instead of equality for comparing withNone
- yaml/pyyaml#270 -- Fix typos and stylistic nit
- yaml/pyyaml#309 -- Fix up small typo
- yaml/pyyaml#161 -- Fix handling of slots
- yaml/pyyaml#358 -- Allow calling add_multi_constructor with None
- yaml/pyyaml#285 -- Add use of safe_load() function in README
- yaml/pyyaml#351 -- Fix reader for Unicode code points over 0xFFFF
- yaml/pyyaml#360 -- Enable certain unicode tests when maxunicode not > 0xffff
- yaml/pyyaml#359 -- Use full_load in yaml-highlight example
- yaml/pyyaml#244 -- Document that PyYAML is implemented with Cython
- yaml/pyyaml#329 -- Fix for Python 3.10
- yaml/pyyaml#310 -- Increase size of index, line, and column fields
- yaml/pyyaml#260 -- Remove some unused imports
- yaml/pyyaml#163 -- Create timezone-aware datetimes when parsed as such
- yaml/pyyaml#363 -- Add tests for timezone
5.2 (2019-12-02)
... (truncated)
8cdff2c
6.0 releasea4fb55e
Update Python 3.10 versions for Windows builde45b964
Add Python 3.10 to tox.ini4808fba
6.0b1 released5aba40
Omnibus CI/artifact build updatea6d384c
Various setup fixes8f3f979
No longer using appveyorc274365
The yaml.load{,_all} functions require Loader= now2f87ac4
Add a basic test file for yaml.load and yaml.dump7bd92df
Makefile tweaksSourced from black's releases.
21.9b0
Packaging
- Fix missing modules in self-contained binaries (#2466)
- Fix missing toml extra used during installation (#2475)
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirs
dependency toplatformdirs
(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scm
build-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_version
to avoid overridingdefault_language_version
(#2430)
Sourced from black's changelog.
21.9b0
Packaging
- Fix missing modules in self-contained binaries (#2466)
- Fix missing toml extra used during installation (#2475)
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirs
dependency toplatformdirs
(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scm
build-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_version
to avoid overridingdefault_language_version
(#2430)
Sourced from pluggy's changelog.
pluggy 1.0.0 (2021-08-25)
Deprecations and Removals
[#116](https://github.com/pytest-dev/pluggy/issues/116) <https://github.com/pytest-dev/pluggy/issues/116>
_: Remove deprecatedimplprefix
support. Decorate hook implementations using an instance of HookimplMarker instead. The deprecation was announced in release0.7.0
.
[#120](https://github.com/pytest-dev/pluggy/issues/120) <https://github.com/pytest-dev/pluggy/issues/120>
_: Remove the deprecatedproc
argument tocall_historic
. Useresult_callback
instead, which has the same behavior. The deprecation was announced in release0.7.0
.
[#265](https://github.com/pytest-dev/pluggy/issues/265) <https://github.com/pytest-dev/pluggy/issues/265>
_: Remove the_Result.result
property. Use_Result.get_result()
instead. Note that unlikeresult
,get_result()
raises the exception if the hook raised. The deprecation was announced in release0.6.0
.
[#267](https://github.com/pytest-dev/pluggy/issues/267) <https://github.com/pytest-dev/pluggy/issues/267>
_: Remove official support for Python 3.4.
[#272](https://github.com/pytest-dev/pluggy/issues/272) <https://github.com/pytest-dev/pluggy/issues/272>
_: Dropped support for Python 2. Continue to use pluggy 0.13.x for Python 2 support.
[#308](https://github.com/pytest-dev/pluggy/issues/308) <https://github.com/pytest-dev/pluggy/issues/308>
_: Remove official support for Python 3.5.
[#313](https://github.com/pytest-dev/pluggy/issues/313) <https://github.com/pytest-dev/pluggy/issues/313>
_: The internalpluggy.callers
,pluggy.manager
andpluggy.hooks
are now explicitly marked private by a_
prefix (e.g.pluggy._callers
). Only API exported by the top-levelpluggy
module is considered public.
[#59](https://github.com/pytest-dev/pluggy/issues/59) <https://github.com/pytest-dev/pluggy/issues/59>
_: Remove legacy__multicall__
recursive hook calling system. The deprecation was announced in release0.5.0
.Features
[#282](https://github.com/pytest-dev/pluggy/issues/282) <https://github.com/pytest-dev/pluggy/issues/282>
_: When registering a hookimpl which is declared ashookwrapper=True
but whose function is not a generator function, aPluggyValidationError
exception is now raised.Previously this problem would cause an error only later, when calling the hook.
In the unlikely case that you have a hookwrapper that returns a generator
... (truncated)
4259fdd
Fix CHANGELOG title manually906abca
Preparing release 1.0.056eb23c
Rename HOWTORELEASE to RELEASING to follow pytestfc6395c
Fix scripts/release.py to use main instead of mastere04816f
Merge pull request #324 from RonnyPfannschmidt/benchmarks1424ab0
add micro benchmarks for hook calling playing with a the number of callers, w...5e51864
Merge pull request #323 from RonnyPfannschmidt/switch-to-main05c3bbd
switch to main as primary branch6b344fb
Merge pull request #319 from RonnyPfannschmidt/pre-commit-update71f2d6b
introduce pyupgrade and update blackSourced from pytest-xdist's changelog.
pytest-xdist 2.4.0 (2021-09-20)
Features
[#696](https://github.com/pytest-dev/pytest-xdist/issues/696) <https://github.com/pytest-dev/pytest-xdist/issues/696>
_: On Linux, the process title now changes to indicate the current worker state (running/idle).Depends on the
setproctitle <https://pypi.org/project/setproctitle/>
__ package, which can be installed withpip install pytest-xdist[setproctitle]
.
[#704](https://github.com/pytest-dev/pytest-xdist/issues/704) <https://github.com/pytest-dev/pytest-xdist/issues/704>
_: Add support for Python 3.10.pytest-xdist 2.3.0 (2021-06-16)
Deprecations and Removals
[#654](https://github.com/pytest-dev/pytest-xdist/issues/654) <https://github.com/pytest-dev/pytest-xdist/issues/654>
_: Python 3.5 is no longer supported.Features
[#646](https://github.com/pytest-dev/pytest-xdist/issues/646) <https://github.com/pytest-dev/pytest-xdist/issues/646>
_: Add--numprocesses=logical
flag, which automatically uses the number of logical CPUs available, instead of physical CPUs withauto
.This is very useful for test suites which are not CPU-bound.
[#650](https://github.com/pytest-dev/pytest-xdist/issues/650) <https://github.com/pytest-dev/pytest-xdist/issues/650>
_: Added newpytest_handlecrashitem
hook to allow handling and rescheduling crashed items.Bug Fixes
[#421](https://github.com/pytest-dev/pytest-xdist/issues/421) <https://github.com/pytest-dev/pytest-xdist/issues/421>
_: Copy the parent process sys.path into local workers, to work around execnet's python -c adding the current directory to sys.path.
[#638](https://github.com/pytest-dev/pytest-xdist/issues/638) <https://github.com/pytest-dev/pytest-xdist/issues/638>
_: Fix issue caused by changing the branch name of the pytest repository.Trivial Changes
[#592](https://github.com/pytest-dev/pytest-xdist/issues/592) <https://github.com/pytest-dev/pytest-xdist/issues/592>
_: Replace master with controller where ever possible.
[#643](https://github.com/pytest-dev/pytest-xdist/issues/643) <https://github.com/pytest-dev/pytest-xdist/issues/643>
_: Use 'main' to refer to pytest default branch in tox env names.pytest-xdist 2.2.1 (2021-02-09)
... (truncated)
4b487ed
Manually fix changelog titleecf4d3b
Release 2.4.087d8979
Merge pull request #704 from hugovk/add-3.10b4544c8
Merge pull request #706 from pytest-dev/pre-commit-ci-update-config66dc390
[pre-commit.ci] pre-commit autoupdatee0ce1b7
Add news file to add support for Python 3.10ed47f0e
Add support for Python 3.101c8178a
Merge pull request #703 from pytest-dev/pre-commit-ci-update-config9807064
[pre-commit.ci] pre-commit autoupdate766e67c
Use setproctitle if available to show state (#696)Sourced from black's releases.
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirs
dependency toplatformdirs
(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scm
build-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_version
to avoid overridingdefault_language_version
(#2430)
Sourced from black's changelog.
21.8b0
Black
- Add support for formatting Jupyter Notebook files (#2357)
- Move from
appdirs
dependency toplatformdirs
(#2375)- Present a more user-friendly error if .gitignore is invalid (#2414)
- The failsafe for accidentally added backslashes in f-string expressions has been hardened to handle more edge cases during quote normalization (#2437)
- Avoid changing a function return type annotation's type to a tuple by adding a trailing comma (#2384)
- Parsing support has been added for unparenthesized walruses in set literals, set comprehensions, and indices (#2447).
- Pin
setuptools-scm
build-time dependency version (#2457)- Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10 (#2460)
Blackd
- Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that scan installed packages (#2440)
Integrations
- The provided pre-commit hooks no longer specify
language_version
to avoid overridingdefault_language_version
(#2430)
Sourced from black's releases.
21.7b0
Black
- Configuration files using TOML features higher than spec v0.5.0 are now supported (#2301)
- Add primer support and test for code piped into black via STDIN (#2315)
- Fix internal error when
FORCE_OPTIONAL_PARENTHESES
feature is enabled (#2332)- Accept empty stdin (#2346)
- Provide a more useful error when parsing fails during AST safety checks (#2304)
Docker
- Add new
latest_release
tag automation to follow latest black release on docker images (#2374)Integrations
- The vim plugin now searches upwards from the directory containing the current buffer instead of the current working directory for pyproject.toml. (#1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml (#1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml (#1869)
Sourced from black's changelog.
21.7b0
Black
- Configuration files using TOML features higher than spec v0.5.0 are now supported (#2301)
- Add primer support and test for code piped into black via STDIN (#2315)
- Fix internal error when
FORCE_OPTIONAL_PARENTHESES
feature is enabled (#2332)- Accept empty stdin (#2346)
- Provide a more useful error when parsing fails during AST safety checks (#2304)
Docker
- Add new
latest_release
tag automation to follow latest black release on docker images (#2374)Integrations
- The vim plugin now searches upwards from the directory containing the current buffer instead of the current working directory for pyproject.toml. (#1871)
- The vim plugin now reads the correct string normalization option in pyproject.toml (#1869)
- The vim plugin no longer crashes Black when there's boolean values in pyproject.toml (#1869)
8fc5bf9
Bump version to 0.9.0913e21d
Bump types-cryptography from 3.3.3 to 3.3.5 (#342)c66709d
Bump types-pyopenssl from 20.0.4 to 20.0.5 (#343)5131f79
Add type annotations (#341)a411dad
Bump charset-normalizer from 2.0.3 to 2.0.4 (#340)be5ec8a
Bump sphinx from 4.1.1 to 4.1.2d3b8865
Bump charset-normalizer from 2.0.2 to 2.0.34503bef
Merge pull request #334 from python-trio/dependabot/pip/charset-normalizer-2.0.2ce8099d
Merge pull request #335 from python-trio/dependabot/pip/sphinx-4.1.18b6d3c6
Merge pull request #336 from python-trio/dependabot/pip/idna-3.2Sourced from asgiref's changelog.
3.4.0 (2021-06-27)
Calling sync_to_async directly from inside itself (which causes a deadlock when in the default, thread-sensitive mode) now has deadlock detection.
asyncio usage has been updated to use the new versions of get_event_loop, ensure_future, wait and gather, avoiding deprecation warnings in Python 3.10. Python 3.6 installs continue to use the old versions; this is only for 3.7+
sync_to_async and async_to_sync now have improved type hints that pass through the underlying function type correctly.
All Websocket* types are now spelled WebSocket, to match our specs and the official spelling. The old names will work until release 3.5.0, but will raise deprecation warnings.
The typing for WebSocketScope and HTTPScope's
extensions
key has been fixed.3.3.4 (2021-04-06)
- The async_to_sync type error is now a warning due the high false negative rate when trying to detect coroutine-returning callables in Python.
3.3.3 (2021-04-06)
- The sync conversion functions now correctly detect functools.partial and other wrappers around async functions on earlier Python releases.
3.3.2 (2021-04-05)
SyncToAsync now takes an optional "executor" argument if you want to supply your own executor rather than using the built-in one.
async_to_sync and sync_to_async now check their arguments are functions of the correct type.
Raising CancelledError inside a SyncToAsync function no longer stops a future call from functioning.
ThreadSensitive now provides context hooks/override options so it can be made to be sensitive in a unit smaller than threads (e.g. per request)
... (truncated)
Sourced from pytest-xdist's changelog.
pytest-xdist 2.3.0 (2021-06-16)
Deprecations and Removals
[#654](https://github.com/pytest-dev/pytest-xdist/issues/654) <https://github.com/pytest-dev/pytest-xdist/issues/654>
_: Python 3.5 is no longer supported.Features
[#646](https://github.com/pytest-dev/pytest-xdist/issues/646) <https://github.com/pytest-dev/pytest-xdist/issues/646>
_: Add--numprocesses=logical
flag, which automatically uses the number of logical CPUs available, instead of physical CPUs withauto
.This is very useful for test suites which are not CPU-bound.
[#650](https://github.com/pytest-dev/pytest-xdist/issues/650) <https://github.com/pytest-dev/pytest-xdist/issues/650>
_: Added newpytest_handlecrashitem
hook to allow handling and rescheduling crashed items.Bug Fixes
[#421](https://github.com/pytest-dev/pytest-xdist/issues/421) <https://github.com/pytest-dev/pytest-xdist/issues/421>
_: Copy the parent process sys.path into local workers, to work around execnet's python -c adding the current directory to sys.path.
[#638](https://github.com/pytest-dev/pytest-xdist/issues/638) <https://github.com/pytest-dev/pytest-xdist/issues/638>
_: Fix issue caused by changing the branch name of the pytest repository.Trivial Changes
[#592](https://github.com/pytest-dev/pytest-xdist/issues/592) <https://github.com/pytest-dev/pytest-xdist/issues/592>
_: Replace master with controller where ever possible.
[#643](https://github.com/pytest-dev/pytest-xdist/issues/643) <https://github.com/pytest-dev/pytest-xdist/issues/643>
_: Use 'main' to refer to pytest default branch in tox env names.pytest-xdist 2.2.1 (2021-02-09)
Bug Fixes
[#623](https://github.com/pytest-dev/pytest-xdist/issues/623) <https://github.com/pytest-dev/pytest-xdist/issues/623>
_: Gracefully handle the pending deprecation of Node.fspath by using config.rootpath for topdir.pytest-xdist 2.2.0 (2020-12-14)
Features
... (truncated)
fe57b39
fixup: add release title underline for 2.3.026e7d95
prepare release 2.3.0b02a6db
Merge pull request #667 from graingert/fix-sys-pathb072267
add newsfile881cc48
Merge pull request #672 from pytest-dev/pre-commit-ci-update-config958679e
[pre-commit.ci] pre-commit autoupdate7f07d50
Merge pull request #646 from kroeschl/numprocesses-logicalfb518de
Merge pull request #669 from pytest-dev/pre-commit-ci-update-config0b14d92
[pre-commit.ci] pre-commit autoupdate02f971d
swap docstringf9e13e0
Release 0.8.04ae4435
Merge pull request #304 from python-trio/dependabot/add-v2-config-file8767902
Merge pull request #327 from graingert/test-on-py3106abfddd
Merge branch 'master' of github.com:python-trio/trustme into test-on-py31051d3bdf
Merge pull request #328 from tiran/correct_ku_eku034fb3a
retry codecov more53e121d
try codecov harderc1e7923
require codecov in cie3ac2d6
Update tests/test_trustme.py496dca6
close the wrapped sockets to prevent Unraisable ResourceWarningsSourced from black's releases.
21.6b0
Black
- Fix failure caused by
fmt: skip
and indentation (#2281)- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the
--code
flag (#2259)- Do not call
uvloop.install()
when Black is used as a library (#2303)- Added
--required-version
option to require a specific version to be running (#2300)- Fix incorrect custom breakpoint indices when string group contains fake f-strings (#2311)
- Fix regression where
R
prefixes would be lowercased for docstrings (#2285)- Fix handling of named escapes (
\N{...}
) when--experimental-string-processing
is used (#2319)
Sourced from black's changelog.
21.6b0
Black
- Fix failure caused by
fmt: skip
and indentation (#2281)- Account for += assignment when deciding whether to split string (#2312)
- Correct max string length calculation when there are string operators (#2292)
- Fixed option usage when using the
--code
flag (#2259)- Do not call
uvloop.install()
when Black is used as a library (#2303)- Added
--required-version
option to require a specific version to be running (#2300)- Fix incorrect custom breakpoint indices when string group contains fake f-strings (#2311)
- Fix regression where
R
prefixes would be lowercased for docstrings (#2285)- Fix handling of named escapes (
\N{...}
) when--experimental-string-processing
is used (#2319)
Sourced from black's releases.
21.5b2
Black
- A space is no longer inserted into empty docstrings (#2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
- Respect
.gitignore
files in all levels, not onlyroot/.gitignore
file (apply.gitignore
rules likegit
does) (#2225)- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
- Add extra uvloop install + import support if in python env (#2258)
- Fix --experimental-string-processing crash when matching parens are not found (#2283)
- Make sure to split lines that start with a string operator (#2286)
- Fix regular expression that black uses to identify f-expressions (#2287)
Blackd
- Add a lower bound for the
aiohttp-cors
dependency. Only 0.4.0 or higher is supported. (#2231)Packaging
- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline (#2198)
- Always build binaries with the latest available Python (#2260)
Documentation
- Add discussion of magic comments to FAQ page (#2272)
--experimental-string-processing
will be enabled by default in the future (#2273)- Fix typos discovered by codespell (#2228)
- Fix Vim plugin installation instructions. (#2235)
- Add new Frequently Asked Questions page (#2247)
- Fix encoding + symlink issues preventing proper build on Windows (#2262)
Sourced from black's changelog.
21.5b2
Black
- A space is no longer inserted into empty docstrings (#2249)
- Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
- Respect
.gitignore
files in all levels, not onlyroot/.gitignore
file (apply.gitignore
rules likegit
does) (#2225)- Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
- Add extra uvloop install + import support if in python env (#2258)
- Fix --experimental-string-processing crash when matching parens are not found (#2283)
- Make sure to split lines that start with a string operator (#2286)
- Fix regular expression that black uses to identify f-expressions (#2287)
Blackd
- Add a lower bound for the
aiohttp-cors
dependency. Only 0.4.0 or higher is supported. (#2231)Integrations
- The official Black action now supports choosing what version to use, and supports the major 3 OSes. (#1940)
Packaging
- Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline (#2198)
- Always build binaries with the latest available Python (#2260)
Documentation
- Add discussion of magic comments to FAQ page (#2272)
--experimental-string-processing
will be enabled by default in the future (#2273)- Fix typos discovered by codespell (#2228)
- Fix Vim plugin installation instructions. (#2235)
- Add new Frequently Asked Questions page (#2247)
- Fix encoding + symlink issues preventing proper build on Windows (#2262)
Sourced from black's releases.
21.5b1
Black
- Refactor
src/black/__init__.py
into many files (#2206)Documentation
- Replaced all remaining references to the
master
branch with themain
branch. Some additional changes in the source code were also made. (#2210)- Sigificantly reorganized the documentation to make much more sense. Check them out by heading over to the stable docs on RTD. (#2174)
21.5b0
Black
- Set
--pyi
mode if--stdin-filename
ends in.pyi
(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diff
to black-primer to suppress formatting changes (#2187)
Sourced from black's changelog.
21.5b1
Black
- Refactor
src/black/__init__.py
into many files (#2206)Documentation
- Replaced all remaining references to the
master
branch with themain
branch. Some additional changes in the source code were also made. (#2210)- Sigificantly reorganized the documentation to make much more sense. Check them out by heading over to the stable docs on RTD. (#2174)
21.5b0
Black
- Set
--pyi
mode if--stdin-filename
ends in.pyi
(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diff
to black-primer to suppress formatting changes (#2187)
Sourced from click's releases.
8.0.0
New major versions of all the core Pallets libraries, including Click 8.0, have been released! :tada:
- Read the announcement on our blog: https://palletsprojects.com/blog/flask-2-0-released/
- Read the full list of changes: https://click.palletsprojects.com/changes/#version-8-0-0
- Retweet the announcement on Twitter: https://twitter.com/PalletsTeam/status/1392266507296514048
- Follow our blog, Twitter, or GitHub to see future announcements.
This represents a significant amount of work, and there are quite a few changes. Be sure to carefully read the changelog, and use tools such as pip-compile and Dependabot to pin your dependencies and control your updates.
Sourced from click's changelog.
Version 8.0.0
Released 2021-05-11
- Drop support for Python 2 and 3.5.
- Colorama is always installed on Windows in order to provide style and color support. :pr:
1784
- Adds a repr to Command, showing the command name for friendlier debugging. :issue:
1267
, :pr:1295
- Add support for distinguishing the source of a command line parameter. :issue:
1264
, :pr:1329
- Add an optional parameter to
ProgressBar.update
to set thecurrent_item
. :issue:1226
, :pr:1332
version_option
usesimportlib.metadata
(or theimportlib_metadata
backport) instead ofpkg_resources
. :issue:1582
- If validation fails for a prompt with
hide_input=True
, the value is not shown in the error message. :issue:1460
- An
IntRange
orFloatRange
option shows the accepted range in its help text. :issue:1525
, :pr:1303
IntRange
andFloatRange
bounds can be open (<
) instead of closed (<=
) by settingmin_open
andmax_open
. Error messages have changed to reflect this. :issue:1100
- An option defined with duplicate flag names (
"--foo/--foo"
) raises aValueError
. :issue:1465
echo()
will not fail when using pytest'scapsys
fixture on Windows. :issue:1590
- Resolving commands returns the canonical command name instead of the matched name. This makes behavior such as help text and
Context.invoked_subcommand
consistent when using patterns likeAliasedGroup
. :issue:1422
- The
BOOL
type accepts the values "on" and "off". :issue:1629
- A
Group
withinvoke_without_command=True
will always invoke its result callback. :issue:1178
nargs == -1
andnargs > 1
is parsed and validated for values from environment variables and defaults. :issue:729
- Detect the program name when executing a module or package with
python -m name
. :issue:1603
- Include required parent arguments in help synopsis of subcommands. :issue:
1475
- Help for boolean flags with
show_default=True
shows the flag name instead ofTrue
orFalse
. :issue:1538
- Non-string objects passed to
style()
andsecho()
will be converted to string. :pr:1146
edit(require_save=True)
will detect saves for editors that exit very fast on filesystems with 1 second resolution. :pr:1050
- New class attributes make it easier to use custom core objects throughout an entire application. :pr:
938
... (truncated)
9da1669
Merge pull request #1877 from pallets/release-8.0.0dfa6369
release version 8.0.0b862cb1
update requirementsf51584c
Merge pull request #1876 from pallets/pre-commit-ci-schedule804c71c
update pre-commit monthlyac655f8
Merge pull request #1872 from janLuke/fix/formatter_write_textdcd991d
HelpFormatter.write_text uses full width5215fc1
Merge pull request #1870 from AdrienPensart/allow_colors_in_metavare3e1691
repr is erasing ANSI escapes codes482e6e6
Merge pull request #1875 from pallets/pre-commit-ci-update-configSourced from itsdangerous's releases.
2.0.0
New major versions of all the core Pallets libraries, including ItsDangerous 2.0, have been released! :tada:
- Read the announcement on our blog: https://palletsprojects.com/blog/flask-2-0-released/
- Read the full list of changes: https://itsdangerous.palletsprojects.com/changes/#version-2-0-0
- Retweet the announcement on Twitter: https://twitter.com/PalletsTeam/status/1392266507296514048
- Follow our blog, Twitter, or GitHub to see future announcements.
This represents a significant amount of work, and there are quite a few changes. Be sure to carefully read the changelog, and use tools such as pip-compile and Dependabot to pin your dependencies and control your updates.
Sourced from itsdangerous's changelog.
Version 2.0.0
Released 2021-05-11
- Drop support for Python 2 and 3.5.
- JWS support (
JSONWebSignatureSerializer
,TimedJSONWebSignatureSerializer
) is deprecated. Use a dedicated JWS/JWT library such as authlib instead. :issue:129
- Importing
itsdangerous.json
is deprecated. Import Python'sjson
module instead. :pr:152
- Simplejson is no longer used if it is installed. To use a different library, pass it as
Serializer(serializer=...)
. :issue:146
datetime
values are timezone-aware withtimezone.utc
. Code usingTimestampSigner.unsign(return_timestamp=True)
orBadTimeSignature.date_signed
may need to change. :issue:150
- If a signature has an age less than 0, it will raise
SignatureExpired
rather than appearing valid. This can happen if the timestamp offset is changed. :issue:126
BadTimeSignature.date_signed
is always adatetime
object rather than anint
in some cases. :issue:124
- Added support for key rotation. A list of keys can be passed as
secret_key
, oldest to newest. The newest key is used for signing, all keys are tried for unsigning. :pr:141
- Removed the default SHA-512 fallback signer from
default_fallback_signers
. :issue:155
- Add type information for static typing tools. :pr:
186
Version 1.1.0
Released 2018-10-26
- Change default signing algorithm back to SHA-1. :pr:
113
- Added a default SHA-512 fallback for users who used the yanked 1.0.0 release which defaulted to SHA-512. :pr:
114
- Add support for fallback algorithms during deserialization to support changing the default in the future without breaking existing signatures. :pr:
113
- Changed capitalization of packages back to lowercase as the change in capitalization broke some tooling. :pr:
113
Version 1.0.0
Released 2018-10-18
YANKED
... (truncated)
d101100
Merge pull request #235 from pallets/release-2.0.0ca0f59a
release version 2.0.0d1ed89f
update requirementsd1722ea
Merge pull request #234 from pallets/pre-commit-ci-scheduled1eb7aa
update pre-commit monthlyacbc456
Merge pull request #233 from pallets/pre-commit-ci-update-config04e485a
[pre-commit.ci] pre-commit autoupdatec0e6b48
Merge pull request #232 from pallets/pre-commit-ci-update-config6a9df83
[pre-commit.ci] pre-commit autoupdate477f42c
Merge pull request #231 from pallets/dependabot/pip/pre-commit-2.12.1Sourced from jinja2's releases.
3.0.0
New major versions of all the core Pallets libraries, including Jinja 3.0, have been released! :tada:
- Read the announcement on our blog: https://palletsprojects.com/blog/flask-2-0-released/
- Read the full list of changes: https://jinja.palletsprojects.com/changes/#version-3-0-0
- Retweet the announcement on Twitter: https://twitter.com/PalletsTeam/status/1392266507296514048
- Follow our blog, Twitter, or GitHub to see future announcements.
This represents a significant amount of work, and there are quite a few changes. Be sure to carefully read the changelog, and use tools such as pip-compile and Dependabot to pin your dependencies and control your updates.
Sourced from jinja2's changelog.
Version 3.0.0
Released 2021-05-11
- Drop support for Python 2.7 and 3.5.
- Bump MarkupSafe dependency to >=1.1.
- Bump Babel optional dependency to >=2.1.
- Remove code that was marked deprecated.
- Add type hinting. :pr:
1412
- Use :pep:
451
API to load templates with :class:~loaders.PackageLoader
. :issue:1168
- Fix a bug that caused imported macros to not have access to the current template's globals. :issue:
688
- Add ability to ignore
trim_blocks
using+%}
. :issue:1036
- Fix a bug that caused custom async-only filters to fail with constant input. :issue:
1279
- Fix UndefinedError incorrectly being thrown on an undefined variable instead of
Undefined
being returned onNativeEnvironment
on Python 3.10. :issue:1335
- Blocks can be marked as
required
. They must be overridden at some point, but not necessarily by the direct child. :issue:1147
- Deprecate the
autoescape
andwith
extensions, they are built-in to the compiler. :issue:1203
- The
urlize
filter recognizesmailto:
links and takesextra_schemes
(orenv.policies["urlize.extra_schemes"]
) to recognize other schemes. It tries to balance parentheses within a URL instead of ignoring trailing characters. The parsing in general has been updated to be more efficient and match more cases. URLs without a scheme are linked ashttps://
instead ofhttp://
. :issue:522, 827, 1172
, :pr:1195
- Filters that get attributes, such as
map
andgroupby
, can use a false or empty value as a default. :issue:1331
- Fix a bug that prevented variables set in blocks or loops from being accessed in custom context functions. :issue:
768
- Fix a bug that caused scoped blocks from accessing special loop variables. :issue:
1088
- Update the template globals when calling
Environment.get_template(globals=...)
even if the template was already loaded. :issue:295
- Do not raise an error for undefined filters in unexecuted if-statements and conditional expressions. :issue:
842
- Add
is filter
andis test
tests to test if a name is a registered filter or test. This allows checking if a filter is available in a template before using it. Test functions can be decorated with@pass_environment
,@pass_eval_context
, or@pass_context
. :issue:842
, :pr:1248
- Support
pgettext
andnpgettext
(message contexts) in i18n extension. :issue:441
- The
|indent
filter'swidth
argument can be a string to
... (truncated)
417f822
Merge pull request #1417 from pallets/release-3.0.0b15fd1c
release version 3.0.0eed1546
update requirements9627e73
Merge pull request #1416 from pallets/pre-commit-ci-schedule6630044
update pre-commit monthlye1bf3bc
Merge pull request #1415 from pallets/pre-commit-ci-update-config0798a66
[pre-commit.ci] pre-commit autoupdate53fea33
Merge pull request #1414 from pallets/typing-markerba1f27e
fix py.typed in manifest1a3342b
Merge pull request #1412 from pallets/typingSourced from black's releases.
21.5b0
Black
- Set
--pyi
mode if--stdin-filename
ends in.pyi
(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diff
to black-primer to suppress formatting changes (#2187)
Sourced from black's changelog.
21.5b0
Black
- Set
--pyi
mode if--stdin-filename
ends in.pyi
(#2169)- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are being called but with no arguments (#2182)
Black-Primer
- Add
--no-diff
to black-primer to suppress formatting changes (#2187)