Improved the violation message of DOC105: the arguments with inconsistent
type hints are now shown in the violation message to make violation
correction much easier
A new config option --show-filenames-in-every-violation-message (or
-sfn), which makes it more convenient to jump to the corresponding line
in IDEs by clicking on the violation message in the terminal
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
Release 3.5.2
Fixed
Fix type annotations for convertFile - it accepts only bytes-based buffers.
Also remove legacy checks from Python 2 (#1400)
Remove legacy import needed only in Python 2 (#1403)
Fix typo that left the attribute AdmonitionProcessor.content_indent unset
(#1404)
Fix edge-case crash in InlineProcessor with AtomicString (#1406).
Fix edge-case crash in codehilite with an empty code tag (#1405).
Improve and expand type annotations in the code base (#1401).
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
[3.5.2] -- 2024-01-10
Fixed
Fix type annotations for convertFile - it accepts only bytes-based buffers.
Also remove legacy checks from Python 2 (#1400)
Remove legacy import needed only in Python 2 (#1403)
Fix typo that left the attribute AdmonitionProcessor.content_indent unset
(#1404)
Fix edge-case crash in InlineProcessor with AtomicString (#1406).
Fix edge-case crash in codehilite with an empty code tag (#1405).
Improve and expand type annotations in the code base (#1401).
We’ve just uploaded mypy 1.9 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.
Breaking Changes
Because the version of typeshed we use in mypy 1.9 doesn't support 3.7, neither does mypy 1.9. (Jared Hance, PR 16883)
We are planning to enable
local partial types (enabled via the
--local-partial-types flag) later this year by default. This change
was announced years ago, but now it's finally happening. This is a
major backward-incompatible change, so we'll probably include it as
part of the upcoming mypy 2.0 release. This makes daemon and
non-daemon mypy runs have the same behavior by default.
Local partial types can also be enabled in the mypy config file:
local_partial_types = True
We are looking at providing a tool to make it easier to migrate
projects to use --local-partial-types, but it's not yet clear whether
this is practical. The migration usually involves adding some
explicit type annotations to module-level and class-level variables.
Basic Support for Type Parameter Defaults (PEP 696)
This release contains new experimental support for type parameter
defaults (PEP 696). Please try it
out! This feature was contributed by Marc Mueller.
Since this feature will be officially introduced in the next Python
feature release (3.13), you will need to import TypeVar, ParamSpec
or TypeVarTuple from typing_extensions to use defaults for now.
This example adapted from the PEP defines a default for BotT:
from typing import Generic
from typing_extensions import TypeVar
Bumps the optional group with 13 updates:
0.3.20.4.15.12.05.13.23.4.43.61.0.41.0.59.3.19.5.160.23.00.24.11.5.11.9.03.4.2.103.6.0.202403163.0.23.1.08.0.08.1.13.11.13.14.00.21.10.23.60.50.6Updates
pydoclintfrom 0.3.2 to 0.4.1Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
af2c326Update changelog3a5e4b0Remove useless argument--src(#124)70eb3c8Fix double quotes in Literal type hint (#123)d2b4b99Include args with different type hints in DOC105 msg (#120)fa41757Add option to show filename for each violation msg (#119)b8b4396Add py312 to CI pipeline01893dfExclude venv folders in flake8 (#116)676847eDocumenting tool integration (#104)75e485bFix false positive DOC203 in property methods (#115)55c0fdeExplain why allow-init-docstring defaults to FalseUpdates
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.6Release notes
Sourced from markdown's releases.
... (truncated)
Changelog
Sourced from markdown's changelog.
... (truncated)
Commits
e524b8fBump version to 3.63d8afc6Allow attr_list quoted values to contain curly braces9edba85Refactor abbr escapinge4ab4a6Refactor TOC sanitationa18765cExplicitly omit carot and backslash from abbr421f1e8Give smarty tree processor higher priority than tocc334a3eEnsure lines after heading in loose list are properly detabbedea92856Update the license template so GitHub can detect ita2effd6Disable mkdocstrings show_symbol_type_toc option to work around searching iss...91f9a12Restore Attribute symbol type in mkdocstrings templateUpdates
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.16Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
8956524Updated Insiders changelog0db4e66Updated changelog29cf44bImproved resilience of privacy plugin6c9ba87Prepare 9.5.16 releasef2bfab9Updated dependencies9e40207Updated dependenciesa2cb35dImproved error handling on social plugin (#6818)abfac1aSwitched to Babel'sformat_datetimeto allow for time in formatted dates (#...01b2dd1Updated Russian translationsad72336Fixed social plugin Google Fonts integrationUpdates
mkdocstrings[python]from 0.23.0 to 0.24.1Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
d716a88chore: Prepare release 0.24.1c161d26ci: Remove type ignore comment now that it's fixed in autorefs89f752astyle: Format2fe2b47chore: Template upgrade080ddaddocs: Fix insiders pagecdd946cdocs: Enable lang class and automatic inline highlight21380aedocs: Remove mention of directory watchingf553684ci: Type ignore comment waiting for fix in autorefsa7a2907refactor: Support new pymdownx-highlight optionsb5236b4refactor: Backup anchors with id and no href, for compatibility with autorefs...Updates
mypyfrom 1.5.1 to 1.9.0Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
5ff46f8Remove +dev.155909a[Release 1.9] Unsupport targetting 3.7. (#16883) (#16900)6615cab[Release 1.9] Stubtest: ignore a new protocol dunder (#16895) (#16899)b956e6astubtest: Private parameters can be omitted (#16507)ede0b20Bump ruff to 0.2.0 (#16870)7bdd61fstubgen: Fix crash on star unpack of TypeVarTuple (#16869)8c2ef9dUpdate hashes in sync-typeshed.py following recent typeshed sync0dd4b6fRevert use ofParamSpecforfunctools.wrapsdd12a2dRevert typeshed ctypes changed132999Revert sum literal integer change (#13961)Updates
types-markdownfrom 3.4.2.10 to 3.6.0.20240316Commits
Updates
pylintfrom 3.0.2 to 3.1.0Commits
053c2c3Bump pylint to 3.1.0, update changelogc954636Upgrade release documentation, and contributors.txt7300ed2Discover.pyifiles (#9241)9dbf3dfMerge maintenance 3.0.x into main following 3.0.4 release (#9459)28e89b0Remove changelog fragments pertaining to 3.0.44332ea1Merge branch 'maintenance/3.0.x' into main following 3.0.4 release8115381Bump pylint to 3.0.4, update changelog (#9458)4bf3524[false-negative] Fix for consider-using-min/max-builtin (#9127)8c24b1e[pre-commit.ci] pre-commit autoupdate (#9448)f499686Update astroid version to 3.1.0 (#9457)Updates
pytestfrom 8.0.0 to 8.1.1Release notes
Sourced from pytest's releases.