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)
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.
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
- `@dependabot ignore minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
- `@dependabot ignore ` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore ` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore ` will remove the ignore condition of the specified dependency and ignore conditions
Bumps the required group with 8 updates:
0.5.3
0.5.6
9.5.27
9.5.30
0.25.1
0.25.2
0.9.2
0.10.0
1.10.1
1.11.1
3.2.5
3.2.6
8.2.2
8.3.2
0.9.2
0.10.0
Updates
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
mkdocs-material
from 9.5.27 to 9.5.30Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
557a3d5
Prepare 9.5.30 releasea798a0d
Fixed link in comment914bed2
Updated dependencies906e966
Fixed navigation icons disappearing on hover in Safari6b13c56
Fixed blog readtime calculation to ignore non-content text (#7370)4f8081c
Prepare 9.5.29 release33452c9
Fixed annotations in figure captions672c403
Documentation (#7361)c7c8fcb
Updated Galician translations5d1f77c
DocumentationUpdates
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
frequenz-repo-config[api]
from 0.9.2 to 0.10.0Release notes
Sourced from frequenz-repo-config[api]'s releases.
... (truncated)
Changelog
Sourced from frequenz-repo-config[api]'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.1Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
570b90a
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)6cf9180
Fix types.GenericAlias lookup crash (#17543)64c1ebf
Bump version to 1.11.1+devdbd5f5c
Remove +dev from version for 1.11 releasef0a8c69
Update CHANGELOG for mypy 1.11 (#17540)371f780
CHANGELOG.md update for 1.11 (#17539)2563da0
Fix daemon crash on invalid type in TypedDict (#17495)Updates
pylint
from 3.2.5 to 3.2.6Commits
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)8410f57
Fix a false positive formissing-param-doc
(#9740) (#9793)bd4c8f1
Handle assert_never() when imported from typing_extensions (#9782) (#9790)8eb2c4d
Fix FP forunexpected-keyword-arg
with ambiguous constructors (#9785) (#9788)9882537
Bump astroid to 3.2.3 (#9787)aea868c
Fixinvalid-name
regression for class attributes in subclasses (#9772) (#9775)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
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.
... (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 migrationDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show