When checking for consistency betwene the docstring arguments and the
arguments in the function signature, ignore underscore arguments (_,
__, ___, ...) in the arguments in the function signature
It's almost 2024, which means it's time for a new edition of Black's stable style!
Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft
2024 stable style, which we'll finalize in the January release. Please try it out and
share your feedback.
This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in --preview mode will be in the 2024 stable style.
Stable style
Fix bug where # fmt: off automatically dedents when used with the --line-ranges
option, even when it is not within the specified line range. (#4084)
Fix feature detection for parenthesized context managers (#4104)
Preview style
Prefer more equal signs before a break when splitting chained assignments (#4010)
Standalone form feed characters at the module level are no longer removed (#4021)
Additional cases of immediately nested tuples, lists, and dictionaries are now
indented less (#4012)
Allow empty lines at the beginning of all blocks, except immediately before a
docstring (#4060)
Fix crash in preview mode when using a short --line-length (#4086)
Keep suites consisting of only an ellipsis on their own lines if they are not
functions or class definitions (#4066) (#4103)
Configuration
--line-ranges now skips Black's internal stability check in --safe mode. This
avoids a crash on rare inputs that have many unformatted same-content lines. (#4034)
It's almost 2024, which means it's time for a new edition of Black's stable style!
Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft
2024 stable style, which we'll finalize in the January release. Please try it out and
share your feedback.
This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in --preview mode will be in the 2024 stable style.
Stable style
Fix bug where # fmt: off automatically dedents when used with the --line-ranges
option, even when it is not within the specified line range. (#4084)
Fix feature detection for parenthesized context managers (#4104)
Preview style
Prefer more equal signs before a break when splitting chained assignments (#4010)
Standalone form feed characters at the module level are no longer removed (#4021)
Additional cases of immediately nested tuples, lists, and dictionaries are now
indented less (#4012)
Allow empty lines at the beginning of all blocks, except immediately before a
docstring (#4060)
Fix crash in preview mode when using a short --line-length (#4086)
Keep suites consisting of only an ellipsis on their own lines if they are not
functions or class definitions (#4066) (#4103)
Configuration
--line-ranges now skips Black's internal stability check in --safe mode. This
avoids a crash on rare inputs that have many unformatted same-content lines. (#4034)
Fix a performance problem with HTML extraction where large HTML input could
trigger quadratic line counting behavior (#1392).
Improve and expand type annotations in the code base (#1394).
[3.5] -- 2023-10-06
Added
Add permalink_leading configuration option to the toc extension (#1339)
A new boolean option permalink_leading controls the position of the permanent
link anchors generated with permalink. Setting permalink_leading to True
will cause the links to be inserted at the start of the header, before any other
header content. The default behavior for permalink is to append permanent
links to the header, placing them after all other header content.
Changed
Add support for cPython version 3.12 (and PyPy 3.10) and drop support for
Python version 3.7 (#1357).
There is no need to re-generate the cookiecutter template for this release. Instead you can upgrade the mike package in your pyproject.toml file and add the new alias_type: redirect option to the plugins.mike key in the mkdocs.yml file.
You should be able to do this by running the following commands:
sed -i '/canonical_version: latest/ i\ alias_type: redirect' mkdocs.yml
sed -i 's/ "mike == .*",/ "mike == 2.0.0",/' pyproject.toml
Please make sure to check the diff and test if everything works as expected. After doing a git diff you should get something like:
Stubgen will now include __all__ in its output if it is in the input file (PR 16356).
Mypy 1.7
We’ve just uploaded mypy 1.7 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes. You can install it as follows:
python3 -m pip install -U mypy
You can read the full documentation for this release on Read the Docs.
Using TypedDict for **kwargs Typing
Mypy now has support for using Unpack[...] with a TypedDict type to annotate **kwargs arguments enabled by default. Example:
# Or 'from typing_extensions import ...'
from typing import TypedDict, Unpack
class Person(TypedDict):
name: str
age: int
def foo(**kwargs: Unpack[Person]) -> None:
...
foo(name="x", age=1) # Ok
foo(name=1) # Error
The definition of foo above is equivalent to the one below, with keyword-only arguments name and age:
def foo(*, name: str, age: int) -> None:
...
Refer to PEP 692 for more information. Note that unlike in the current version of the PEP, mypy always treats signatures with Unpack[SomeTypedDict] as equivalent to their expanded forms with explicit keyword arguments, and there aren't special type checking rules for TypedDict arguments.
This was contributed by Ivan Levkivskyi back in 2022 (PR 13471).
TypeVarTuple Support Enabled (Experimental)
Mypy now has support for variadic generics (TypeVarTuple) enabled by default, as an experimental feature. Refer to PEP 646 for the details.
TypeVarTuple was implemented by Jared Hance and Ivan Levkivskyi over several mypy releases, with help from Jukka Lehtosalo.
Bumps the optional group with 15 updates:
0.3.20.3.823.9.123.12.05.12.05.13.23.4.43.5.11.0.41.0.59.3.19.5.20.23.00.24.00.7.00.7.51.5.11.7.13.4.2.103.5.0.33.0.23.0.37.4.27.4.30.7.00.7.53.11.13.12.00.21.10.23.2Updates
pydoclintfrom 0.3.2 to 0.3.8Release notes
Sourced from pydoclint's releases.
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
b5612ffImprove documentation71cdf37Fix prepended escape char handling (#94)d2b1d21Update version; update changelogf70caa4Disable parallel mode in pre-commit (#93)def500fUpdate pre-commit dependencies04bd231Improve documentationef6dc07Update dependency to fix return section parsing (#90)38ae4c6Bump version to 0.3.507611e6Ignore underscore args when checking args (#89)dd59b87Add changelog for v0.3.4Updates
blackfrom 23.9.1 to 23.12.0Release notes
Sourced from black's releases.
... (truncated)
Changelog
Sourced from black's changelog.
... (truncated)
Commits
d9ad09aPrepare release 23.12.0 (#4105)ebd543cFix feature detection for parenthesized context managers (#4104)eb7661fFix another case where we format dummy implementation for non-functions/class...0c98999Fix path in test message (#4102)9aea976Only use dummy implementation logic for functions and classes (#4066)67b23d7Bump actions/setup-python from 4 to 5 (#4101)ce28be2Add dedicated preview feature for East Asian Width (#4097)61b529bAllow empty lines at beginning of blocks (again) (#4060)e7e122edocs: Movefmt: offdocs (#4090)432d905docs: Unify option descriptions between--helpandthe_basics.md(#4076)Updates
isortfrom 5.12.0 to 5.13.2Release notes
Sourced from isort's releases.
... (truncated)
Changelog
Sourced from isort's changelog.
Commits
c655831Merge pull request #2214 from PyCQA/version/5.13.2b4335b4Prepare version 5.13.2c36e43cMerge pull request #2184 from bp72/issue/2154e38702fMerge pull request #2213 from davidculley/confine-precommit-to-stagesee8d87fAdd fix for the error found by hypothesis5849ec2Apply the bracket fix from issue 471 only for use_parentheses=Truedf0e119confine pre-commit to stages9255bcaMerge pull request #2212 from PyCQA/bugfix/#2211-colors-extra5336d7dFix colors extras643d9c4Merge pull request #2210 from PyCQA/version/5.13.1Updates
markdownfrom 3.4.4 to 3.5.1Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
f50ac47Refactor changelog6662053TOC extension: Add new boolean option permalink_prepend (#1339)Updates
mkdocs-macros-pluginfrom 1.0.4 to 1.0.5Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
4bfda0bFix issue with changelog no longer displayed (#186)82c5cddMerge pull request #183 from marcospereira/add-short-tag298f07fAdd a short_tag attribute to git context428a015Remove include-markdown in webdoc, since it crashed readthedocs2161dd4Update .readthedocs.ymlc64a08dMerge pull request #182 from SimonMarquis/patch-11c1d2c4Fix typo inRich Markdown Pagesdocs9dba19eMerge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master7da7089Add experimental logo0d36ddeAdd experimental logoUpdates
mkdocs-materialfrom 9.3.1 to 9.5.2Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
2ca5cf0Prepare 9.5.2 release52feabaMerge branch 'master' of github.com:squidfunk/mkdocs-material649db51Updated dependencies738dd7dMerge pull request #6486 from squidfunk/dependabot/github_actions/actions/set...ef00a47Merge pull request #6487 from squidfunk/dependabot/github_actions/actions/dep...cc03f10Bump actions/deploy-pages from 2 to 385a3298Bump actions/setup-python from 4 to 5419898aDocumentation (#6477)afd9d0aMerge branch 'master' of github.com:squidfunk/mkdocs-materialadad823Fixed config types for blog plugin slugify functionsUpdates
mkdocstrings[python]from 0.23.0 to 0.24.0Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
032e417chore: Prepare release 0.24.0ce84dd5feat: Cache downloaded inventories as local file4a97755docs: Make recipe work with MkDocs-foptionb3edf89ci: Some typing fixes/ignored74fadatests: Stop passing config file path to MkDocsConfig4dbb6d6ci: Ruff auto-fix39694acchore: Template upgradeafc4ea4fix:custom_templatesconfig was dropped in previous commit (#630)b61d4d1refactor: Drop support for MkDocs < 1.4, modernize usages370a61dfix: Makecustom_templatesrelative to the config fileUpdates
frequenz-repo-config[lib]from 0.7.0 to 0.7.5Release notes
Sourced from frequenz-repo-config[lib]'s releases.
... (truncated)
Commits
7e74141Add support and bump tomike2.0.0 (#174)b9e2d84Don't fail if themikeversion can't be determined50980d6Upgrademiketo 2.0.086012aaClear release notes8bf6c38Fixmikeversion sorting (#171)0ee52d5Update release notesbe6df37Add tests forcompare_mike_version()andsort_mike_versions()6d8b449Use a more explicit name for the_TestCaseclass60e05f6Don't parse mike versions while sorting02de9femike: Remove unused functionUpdates
mypyfrom 1.5.1 to 1.7.1Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
6b3c418Update version to 1.7.1 (without +dev)c10e173[mypyc] Fix regression with nested functions (#16484)e6399d1Fix polymorphic application for callback protocols (#16514)661adb7Fix crash on strict-equality with recursive types (#16483)6c8e0ccIgnore position if imprecise arguments are matched by name (#16471)5c354c4Fix missing meet case exposed by len narrowing (#16470)88791caExclude private attributes from override checks (#16464)4b5b316Special-case unions in polymorphic inference (#16461)f862d3eFix crash on Callable self in call (#16453)fe79a59Looks like these dependencies are updatable in another way, so this is no longer needed.