An option --should-document-private-class-attributes (if False, private
class attributes should not appear in the docstring)
An option --treat-property-methods-as-class-attributes (if True,
@property methods are treated like class attributes and need to be
documented in the class docstring)
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).
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
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
The generated docs now show the symbol type in the table of contents.
The dependecies were updated to the latest versions.
Disabled some pylint checks that are already checked by other tools.
The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.
Bug Fixes
The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.
Cookiecutter template
Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
Make the nox-cross-arch-all job fail if any nox-cross-arch matrix job fails.
Fix credentials not being passed to the test-installation job in the CI workflow.
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
The generated docs now show the symbol type in the table of contents.
The dependecies were updated to the latest versions.
Disabled some pylint checks that are already checked by other tools.
The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.
Bug Fixes
The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.
Cookiecutter template
Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
Make the nox-cross-arch-all job fail if any nox-cross-arch matrix job fails.
Fix credentials not being passed to the test-installation job in the CI workflow.
Make sure credentials are configured for all jobs that check out the repository in the CI workflow.
... (truncated)
Commits
bfd45a8 Add pull-requests read permission to the release-notes-check workflow (#289)
We’ve just uploaded mypy 1.11 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.
Support Python 3.12 Syntax for Generics (PEP 695)
Mypy now supports the new type parameter syntax introduced in Python 3.12 (PEP 695).
This feature is still experimental and must be enabled with the --enable-incomplete-feature=NewGenericSyntax flag, or with enable_incomplete_feature = NewGenericSyntax in the mypy configuration file.
We plan to enable this by default in the next mypy feature release.
This example demonstrates the new syntax:
# Generic function
def f[T](https://github.com/python/mypy/blob/master/x: T) -> T: ...
reveal_type(f(1)) # Revealed type is 'int'
Generic class
class C[T]:
def init(self, x: T) -> None:
self.x = x
c = C('a')
reveal_type(c.x) # Revealed type is 'str'
Type alias
type A[T] = C[list[T]]
This feature was contributed by Jukka Lehtosalo.
Support for functools.partial
Mypy now type checks uses of functools.partial. Previously mypy would accept arbitrary arguments.
#12652: Resolve regression [conda]{.title-ref} environments where no longer being automatically detected.
-- by RonnyPfannschmidt{.interpreted-text role="user"}
8.3.1
pytest 8.3.1 (2024-07-20)
The 8.3.0 release failed to include the change notes and docs for the release. This patch release remedies this. There are no other changes.
8.3.0
pytest 8.3.0 (2024-07-20)
New features
#12231: Added [--xfail-tb]{.title-ref} flag, which turns on traceback output for XFAIL results.
If the [--xfail-tb]{.title-ref} flag is not given, tracebacks for XFAIL results are NOT shown.
The style of traceback for XFAIL is set with [--tb]{.title-ref}, and can be [auto|long|short|line|native|no]{.title-ref}.
Note: Even if you have [--xfail-tb]{.title-ref} set, you won't see them if [--tb=no]{.title-ref}.
Some history:
With pytest 8.0, [-rx]{.title-ref} or [-ra]{.title-ref} would not only turn on summary reports for xfail, but also report the tracebacks for xfail results. This caused issues with some projects that utilize xfail, but don't want to see all of the xfail tracebacks.
This change detaches xfail tracebacks from [-rx]{.title-ref}, and now we turn on xfail tracebacks with [--xfail-tb]{.title-ref}. With this, the default [-rx]{.title-ref}/ [-ra]{.title-ref} behavior is identical to pre-8.0 with respect to xfail tracebacks. While this is a behavior change, it brings default behavior back to pre-8.0.0 behavior, which ultimately was considered the better course of action.
#12281: Added support for keyword matching in marker expressions.
Now tests can be selected by marker keyword arguments.
Supported values are int{.interpreted-text role="class"}, (unescaped) str{.interpreted-text role="class"}, bool{.interpreted-text role="class"} & None{.interpreted-text role="data"}.
See marker examples <marker_keyword_expression_example>{.interpreted-text role="ref"} for more information.
-- by lovetheguitar{.interpreted-text role="user"}
#12567: Added --no-fold-skipped command line option.
If this option is set, then skipped tests in short summary are no longer grouped
by reason but all tests are printed individually with their nodeid in the same
way as other statuses.
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
The generated docs now show the symbol type in the table of contents.
The dependecies were updated to the latest versions.
Disabled some pylint checks that are already checked by other tools.
The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.
Bug Fixes
The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.
Cookiecutter template
Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
Make the nox-cross-arch-all job fail if any nox-cross-arch matrix job fails.
Fix credentials not being passed to the test-installation job in the CI workflow.
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
Bumps the required group with 17 updates in the / directory:
7.1.0
7.1.1
0.5.3
0.5.6
24.4.2
24.8.0
3.6.0
3.7
2.1.2
2.1.3
9.5.27
9.5.34
0.25.1
0.25.2
1.10.5
1.10.9
0.9.2
0.10.0
1.10.1
1.11.2
3.6.0.20240316
3.7.0.20240822
8.2.2
8.3.2
3.2.5
3.2.7
0.9.2
0.10.0
0.23.7
0.24.0
0.6
0.7
6.104.2
6.111.2
Updates
flake8
from 7.1.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 documentationUpdates
pydoclint
from 0.5.3 to 0.5.6Release notes
Sourced from pydoclint's releases.
Changelog
Sourced from pydoclint's changelog.
Commits
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)3c39d2e
Add an option for private class attributes (#149)Updates
black
from 24.4.2 to 24.8.0Release notes
Sourced from black's releases.
Changelog
Sourced from black's changelog.
Commits
b965c2a
Prepare release 24.8.0 (#4426)9ccf279
Documentfind_project_root
ignoringpyproject.toml
without[tool.black]
...14b6e61
fix: Enhace black efficiently to skip directories listed in .gitignore (#4415)b1c4dd9
fix: respect braces better in f-string parsing (#4422)4b4ae43
Fix incorrect linenos on fstring tokens with escaped newlines (#4423)7fa1faf
docs: fix the installation command of extra for blackd (#4413)8827acc
Bump sphinx from 7.3.7 to 7.4.0 in /docs (#4404)b0da11d
Bump furo from 2024.5.6 to 2024.7.18 in /docs (#4409)721dff5
fix: avoid formatting backslash strings inside f-strings (#4401)7e2afc9
Updateactions/checkout
to v4 to stop node deprecation warnings (#4379)Updates
markdown
from 3.6.0 to 3.7Release notes
Sourced from markdown's releases.
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 documentationUpdates
mike
from 2.1.2 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.dev0Updates
mkdocs-material
from 9.5.27 to 9.5.34Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
7d6096a
Prepare 9.5.34 release6f3c05b
Updated dependenciesd3b1792
Updated Mermaid to v11 (#7475)f88c436
Unpinned Stylelint and plugins3b12816
Unpinned TypeScript ESLint integration and checkscafd67b
Fixed error in build script80ae560
Unpinned svgo dependencya91ee70
Prepare 9.5.33 release4104faf
Updated dependencies8ee7137
Updated premium sponsorsUpdates
mkdocstrings[python]
from 0.25.1 to 0.25.2Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
afb2a2f
chore: Prepare release 0.25.2e7c8abd
tests: Ignore deprecation warnings for now924ecd8
chore: Template upgradeda216b0
ci: Ignore unused arg80ab498
chore: Clean up pytest warning filters2e5f89e
refactor: Give precedence to Markdown heading level (##
)fb194d8
chore: Clean upget_anchors
64c5ff6
chore: Improve code comments8013be4
chore: Clean up unused conditionUpdates
mkdocstrings-python
from 1.10.5 to 1.10.9Release notes
Sourced from mkdocstrings-python's releases.
Changelog
Sourced from mkdocstrings-python's changelog.
Commits
2d59cdb
chore: Prepare release 1.10.968cb72f
refactor: Use new autorefs syntax2299ab5
build: Explicitly depend on mkdocs-autorefs to be able to specify lower bound81d698e
chore: Clean up check dutya541b5b
chore: Prepare release 1.10.8a87dcad
build: Depend on Griffe 0.4941de4d1
chore: Prepare release 1.10.7c49bde8
chore: Template upgrade0817708
chore: Prepare release 1.10.6eff10cc
refactor: Update code for Griffe 0.48 (removing deprecation warnings)Updates
frequenz-repo-config[lib]
from 0.9.2 to 0.10.0Release notes
Sourced from frequenz-repo-config[lib]'s releases.
... (truncated)
Changelog
Sourced from frequenz-repo-config[lib]'s changelog.
... (truncated)
Commits
bfd45a8
Add pull-requests read permission to the release-notes-check workflow (#289)6aa6bc0
Prepare for the v0.10.0 release (#290)297b184
Update version in the template pyproject.toml632283d
Prepare the release notes for v0.10.0 release1778ff8
Add pull-requests read permission to the release-notes-check workflow2ac253a
Disable the newcheck-class-attributes
check in pydoclint 0.5.3 (#288)1660756
Disable the newcheck-class-attributes
check in pydoclint 0.5.3327879b
Fix credentials not passed or configured the CI workflow (#286)6195bc7
Update release notesbef233c
Remove the TODOs from the migrationUpdates
mypy
from 1.10.1 to 1.11.2Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
789f02c
Bump version to 1.11.2917cc75
An alternative fix for a union-like literal string (#17639)7d805b3
Unwrap TypedDict item types before storing (#17640)32675dd
Revert "Fix Literal strings containing pipe characters" (#17638)778542b
Revert "FixRawExpressionType.accept
crash with--cache-fine-grained
" (#1...14ab742
Bump version to 1.11.2+dev570b90a
Bump version to 1.11b3a102e
FixRawExpressionType.accept
crash with--cache-fine-grained
(#17588)aec04c7
Fix PEP 604 isinstance caching (#17563)cb44e4d
Fixtyping.TypeAliasType
being undefined on python < 3.12 (#17558)Updates
types-markdown
from 3.6.0.20240316 to 3.7.0.20240822Commits
Updates
pytest
from 8.2.2 to 8.3.2Release notes
Sourced from pytest's releases.
... (truncated)
Commits
bbcec9c
Prepare release version 8.3.278fe8b6
Merge pull request #12657 from pytest-dev/patchback/backports/8.3.x/6c806b499...238bad2
Merge pull request #12656 from RonnyPfannschmidt/fix-12652-detect-conda-envae6034a
Merge pull request #12641 from pytest-dev/patchback/backports/8.3.x/c03989cee...31337ab
Merge pull request #12640 from pytest-dev/update-userca3070b
Merge pull request #12637 from pytest-dev/release-8.3.1de98446
Prepare release version 8.3.1bd0a042
Merge pull request #12636 from pytest-dev/update-release-notes664325b
doc/changelog: update 8.3.0 notes19d225d
Merge pull request #12635 from pytest-dev/release-8.3.0Updates
pylint
from 3.2.5 to 3.2.7Commits
a98215b
Bump pylint to 3.2.7, update changelog1deaffa
Fix to maintain order of package paths (#9887) (#9897)b4c2951
[Backport maintenance/3.2.x] Fix a crash inundefined-loop-variable
with `e...f1925f4
Fix crash in refactoring checker when calling bound lambda (#9867)7d1626c
Fix a false positiveunreachable
forNoReturn
coroutine functions (#9844)...da19566
Bump pylint to 3.2.6, update changelog (#9825)810c59c
Update setuptools to >=71.0.4 (#9812) (#9824)5f19cd5
Fix a crash when a subclass extends__slots__
(#9817) (#9822)c0b1d22
Bump astroid to 3.2.4 (#9816) (#9821)1d877de
Fix consider-using-min-max-builtin (#9802) (#9803)Updates
frequenz-repo-config[extra-lint-examples]
from 0.9.2 to 0.10.0Release notes
Sourced from frequenz-repo-config[extra-lint-examples]'s releases.
... (truncated)
Changelog
Sourced from frequenz-repo-config[extra-lint-examples]'s changelog.