Black is now officially tested with Python 3.13 and provides Python 3.13
mypyc-compiled wheels. (#4436) (#4449)
Black will issue an error when used with Python 3.12.5, due to an upstream memory
safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please
use Python 3.12.6 or Python 3.12.4 instead. (#4447)
Black no longer supports running with Python 3.8 (#4452)
Stable style
Fix crashes involving comments in parenthesised return types or X | Y style unions.
(#4453)
Fix skipping Jupyter cells with unknown %% magic (#4462)
Preview style
Fix type annotation spacing between * and more complex type variable tuple (i.e. def fn(*args: *tuple[*Ts, T]) -> None: pass) (#4440)
Caching
Fix bug where the cache was shared between runs with and without --unstable (#4466)
Packaging
Upgrade version of mypyc used to 1.12 beta (#4450) (#4449)
blackd now requires a newer version of aiohttp. (#4451)
Output
Added Python target version information on parse error (#4378)
Add information about Black version to internal error messages (#4457)
24.8.0
Stable style
Fix crash when # fmt: off is used before a closing parenthesis or bracket. (#4363)
Packaging
Packaging metadata updated: docs are explictly linked, the issue tracker is now also
linked. This improves the PyPI listing for Black. (#4345)
Parser
Fix regression where Black failed to parse a multiline f-string containing another
multiline string (#4339)
Black is now officially tested with Python 3.13 and provides Python 3.13
mypyc-compiled wheels. (#4436) (#4449)
Black will issue an error when used with Python 3.12.5, due to an upstream memory
safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please
use Python 3.12.6 or Python 3.12.4 instead. (#4447)
Black no longer supports running with Python 3.8 (#4452)
Stable style
Fix crashes involving comments in parenthesised return types or X | Y style unions.
(#4453)
Fix skipping Jupyter cells with unknown %% magic (#4462)
Preview style
Fix type annotation spacing between * and more complex type variable tuple (i.e. def fn(*args: *tuple[*Ts, T]) -> None: pass) (#4440)
Caching
Fix bug where the cache was shared between runs with and without --unstable (#4466)
Packaging
Upgrade version of mypyc used to 1.12 beta (#4450) (#4449)
blackd now requires a newer version of aiohttp. (#4451)
Output
Added Python target version information on parse error (#4378)
Add information about Black version to internal error messages (#4457)
24.8.0
Stable style
Fix crash when # fmt: off is used before a closing parenthesis or bracket. (#4363)
Packaging
Packaging metadata updated: docs are explictly linked, the issue tracker is now also
linked. This improves the PyPI listing for Black. (#4345)
Parser
Fix regression where Black failed to parse a multiline f-string containing another
A new AbbrTreeprocessor has been introduced, which replaces the now deprecated
AbbrInlineProcessor. Abbreviation processing now happens after Attribute Lists,
avoiding a conflict between the two extensions (#1460).
The AbbrPreprocessor class has been renamed to AbbrBlockprocessor, which
better reflects what it is. AbbrPreprocessor has been deprecated.
A call to Markdown.reset() now clears all previously defined abbreviations.
Abbreviations are now sorted by length before executing AbbrTreeprocessor
to ensure that multi-word abbreviations are implemented even if an abbreviation
exists for one of those component words. (#1465)
Abbreviations without a definition are now ignored. This avoids applying
abbr tags to text without a title value.
Added an optional glossary configuration option to the abbreviations extension.
This provides a simple and efficient way to apply a dictionary of abbreviations
to every page.
Abbreviations can now be disabled by setting their definition to "" or ''.
This can be useful when using the glossary option.
Fixed
Fixed links to source code on GitHub from the documentation (#1453).
Release 3.6
Changed
Refactor TOC Sanitation
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
A new AbbrTreeprocessor has been introduced, which replaces the now deprecated
AbbrInlineProcessor. Abbreviation processing now happens after Attribute Lists,
avoiding a conflict between the two extensions (#1460).
The AbbrPreprocessor class has been renamed to AbbrBlockprocessor, which
better reflects what it is. AbbrPreprocessor has been deprecated.
A call to Markdown.reset() now clears all previously defined abbreviations.
Abbreviations are now sorted by length before executing AbbrTreeprocessor
to ensure that multi-word abbreviations are implemented even if an abbreviation
exists for one of those component words. (#1465)
Abbreviations without a definition are now ignored. This avoids applying
abbr tags to text without a title value.
Added an optional glossary configuration option to the abbreviations extension.
This provides a simple and efficient way to apply a dictionary of abbreviations
to every page.
Abbreviations can now be disabled by setting their definition to "" or ''.
This can be useful when using the glossary option.
Fixed
Fixed links to source code on GitHub from the documentation (#1453).
[3.6] -- 2024-03-14
Changed
Refactor TOC Sanitation
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
Added: complete test framework, using pytest and Mkdocs-Test (#244)
A number of automated test cases are implemented.
Changed: move from setup.py to pyproject.toml (#250)
1.2.0, 2024-09-15
Added: three hooks register_variables/macros/filters to facilitate
cooperation with other MkDocs plugins.
Fixed: `define_env() was always required in module (#191)
Added: trace the case when no module is found (INFO)
Improved documentation, particularly about HTML pages
Added: parameters j2_comment_start_string and
j2_comment_end_string to plugin's parameters,
to specify alternate markers for comments.
Added the multiline parameter force_render_paths in the config file,
to specify directories or file patterns to be rendered for the case when render_by_default = false
(the render_macros parameter in the YAML header of the page
has the last word).
py/frequenz/client/weather/_types.py:149:1: DOC503 Method Forecasts.to_ndarray_vlf exceptions in the "Raises" section in the docstring do not match those in the function body Raises values in the docstring: ['ValueError']. Raised exceptions in the body: ['RuntimeError', 'ValueError'].
tests/test_types.py:177:1: DOC603 Class TestForecasts: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [invalid_ts: , valid_ts1: , valid_ts2: , valid_ts3: ]. Arguments in the docstring but not in the actual class attributes: [forecasts_proto: , num_features: , num_locations: , num_times: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
The docs are missing the RuntimeError in the Raises: section.
Bumps the required group with 16 updates in the / directory:
7.0.0
7.1.1
0.3.2
0.5.9
24.4.2
24.10.0
5.12.0
5.13.2
3.4.4
3.7
2.0.0
2.1.3
1.0.4
1.3.7
9.4.4
9.5.43
0.25.0
0.26.2
1.10.8
1.12.2
0.9.2
0.10.0
1.5.1
1.13.0
3.4.2.10
3.7.0.20240822
2024.4.15
2024.10.9
3.0.2
3.3.1
0.9.2
0.10.0
Updates
flake8
from 7.0.0 to 7.1.1Commits
cf1542c
Release 7.1.1939ea3d
Merge pull request #1949 from stephenfin/issue-1948bdcd5c2
Handle escaped braces in f-strings2a811cc
Merge pull request #1946 from Viicos/patch-110314ad
Fix wording of plugins documentation65a38c4
Release 7.1.034c97e0
Merge pull request #1939 from PyCQA/new-pycodestyledefd315
latest pycodestyle408d4d6
Merge pull request #1930 from mzagol/patch-1866ad72
Add --extend-exclude to the TOCUpdates
pydoclint
from 0.3.2 to 0.5.9Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
8170436
Improve handling of long type annotations (#173)27ff769
doc(usage): Including a null-ls use with neovim. (#167)5e941f5
fix: DOC503 catch namespaced exceptions (#168)f758604
feat: introduce DOC503 for checking specific raised exceptions (#161)ae28589
Switch from tab to 4 spaces in baseline (#152)1e80fd3
tox: usedeps = .
instead ofpip install
(#160)23b89f6
docs: add "sphinx" as an allowed style (#159)94efc5f
Stop trying to check folder with names ending in.py
(#155)0247ef5
Improve class attr comparison logic (#154)0b750d5
Add option to treat property methods as class attributes (#153)Updates
black
from 24.4.2 to 24.10.0Release notes
Sourced from black's releases.
... (truncated)
Changelog
Sourced from black's changelog.
... (truncated)
Commits
1b2427a
Prepare release 24.10.0 (#4471)a22b1eb
Add mypyc 3.13 wheel build (#4449)b7d0e72
Bump AndreMiras/coveralls-python-action from 65c1672f0b8a201702d86c81b79187df...f1a2f92
Include --unstable in cache key (#4466)8d9d18c
Fix skipping Jupyter cells with unknown %% magic (#4462)bbfdba3
Fix docs CI: use venv for uv to fix 'failed to create directory' (#4460)8fb2add
Use builtin generics (#4458)2a45cec
Fix crashes with comments in parentheses (#4453)b4d6d86
Drop Python 3.8 support (#4452)ac018c1
Require newer aiohttp for blackd (#4451)Updates
isort
from 5.12.0 to 5.13.2Release notes
Sourced from isort's releases.
... (truncated)
Changelog
Sourced from isort's changelog.
Commits
c655831
Merge pull request #2214 from PyCQA/version/5.13.2b4335b4
Prepare version 5.13.2c36e43c
Merge pull request #2184 from bp72/issue/2154e38702f
Merge pull request #2213 from davidculley/confine-precommit-to-stagesee8d87f
Add fix for the error found by hypothesis5849ec2
Apply the bracket fix from issue 471 only for use_parentheses=Truedf0e119
confine pre-commit to stages9255bca
Merge pull request #2212 from PyCQA/bugfix/#2211-colors-extra5336d7d
Fix colors extras643d9c4
Merge pull request #2210 from PyCQA/version/5.13.1Updates
markdown
from 3.4.4 to 3.7Release notes
Sourced from markdown's releases.
... (truncated)
Changelog
Sourced from markdown's changelog.
... (truncated)
Commits
da03cd6
Bump version to 3.7bd836a1
Update griffe_extensions to support Griffe v 1.0.33359fa
Abbr Extension: Definition Sorting and Glossary storageec8c305
Refactorabbr
Extension993b57b
Fixed links to source code on GitHub from the documentatione524b8f
Bump version to 3.63d8afc6
Allow attr_list quoted values to contain curly braces9edba85
Refactor abbr escapinge4ab4a6
Refactor TOC sanitationa18765c
Explicitly omit carot and backslash from abbrUpdates
mike
from 2.0.0 to 2.1.3Release notes
Sourced from mike's releases.
Changelog
Sourced from mike's changelog.
Commits
c4e9608
Update version to 2.1.33b19e27
Announce the previous changedd9826a
Consult deploy prefix when deleting files during deploy; resolves #22791cf5ee
Properly escape parameters in regex90cf131
Update version to 2.2.0.dev062aaeaf
Update version to 2.1.23f7d756
Use "--" to disambiguate Git arguments in a few more places; resolves #2185e6970d
Belatedly update copyright year9291efb
Update version to 2.2.0.dev00bdfe24
Update version to 2.1.1Updates
mkdocs-macros-plugin
from 1.0.4 to 1.3.7Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
b906a36
Bump version number5641806
Fixed incompatibility with d2 module (#249)3a73707
Migrate to pyproject.toml99733be
Demote info messages as debug (#248)6a9a0e4
Bump version number, for distribution (should solve #247)32cd528
Test the hooks for external registration (#237)16be58d
Migrate all tests toward the mkdocs-test framework (#244)59f82db
Replacing local implementation of SuperDict by super-collections version38b9681
Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into mastereebbbd1
Merge pull request #246 from dwreeves/add-pathspec-as-dependencyUpdates
mkdocs-material
from 9.4.4 to 9.5.43Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
8a60b49
Prepare 9.5.43 releasef82a345
Documentation4918a10
Added support for quoted external CSS URLs in privacy plugin (#7651)7dc96f1
Added support for downloading external images in SVG for privacy plugin (#7650)1357cd2
Updated dependencies198a680
Documentation (#7633)9aebe14
Updated dependenciesf3a390e
Prepare 9.5.42 releaseade227c
Updated README.md (#7631)cc1508f
Fixed encoding of boolean attributes in privacy pluginUpdates
mkdocstrings[python]
from 0.25.0 to 0.26.2Release notes
Sourced from mkdocstrings[python]'s releases.
... (truncated)
Changelog
Sourced from mkdocstrings[python]'s changelog.