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.
#12446: Avoid calling @property (and other instance descriptors) during fixture discovery -- by asottile{.interpreted-text role="user"}
#12659: Fixed the issue of not displaying assertion failure differences when using the parameter --import-mode=importlib in pytest>=8.1.
#12667: Fixed a regression where type change in [ExceptionInfo.errisinstance]{.title-ref} caused [mypy]{.title-ref} to fail.
#12744: Fixed typing compatibility with Python 3.9 or less -- replaced [typing.Self]{.title-ref} with [typing_extensions.Self]{.title-ref} -- by Avasam{.interpreted-text role="user"}
#12745: Fixed an issue with backslashes being incorrectly converted in nodeid paths on Windows, ensuring consistent path handling across environments.
#6682: Fixed bug where the verbosity levels where not being respected when printing the "msg" part of failed assertion (as in assert condition, msg).
#9422: Fix bug where disabling the terminal plugin via -p no:terminal would cause crashes related to missing the verbose option.
-- by GTowers1{.interpreted-text role="user"}
Improved documentation
#12663: Clarify that the [pytest_deselected]{.title-ref} hook should be called from [pytest_collection_modifyitems]{.title-ref} hook implementations when items are deselected.
#12678: Remove erroneous quotes from [tmp_path_retention_policy]{.title-ref} example in docs.
Miscellaneous internal changes
#12769: Fix typos discovered by codespell and add codespell to pre-commit hooks.
8.3.2
pytest 8.3.2 (2024-07-24)
Bug fixes
#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.
... (truncated)
Commits
d0f136f build(deps): Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 (#12790)
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 9 updates in the / directory:
7.1.07.1.10.5.30.5.724.4.224.8.09.5.209.5.340.9.20.10.01.10.11.11.23.2.53.2.78.2.28.3.30.9.20.10.0Updates
flake8from 7.1.0 to 7.1.1Commits
cf1542cRelease 7.1.1939ea3dMerge pull request #1949 from stephenfin/issue-1948bdcd5c2Handle escaped braces in f-strings2a811ccMerge pull request #1946 from Viicos/patch-110314adFix wording of plugins documentationUpdates
pydoclintfrom 0.5.3 to 0.5.7Release notes
Sourced from pydoclint's releases.
Changelog
Sourced from pydoclint's changelog.
Commits
f758604feat: introduce DOC503 for checking specific raised exceptions (#161)ae28589Switch from tab to 4 spaces in baseline (#152)1e80fd3tox: usedeps = .instead ofpip install(#160)23b89f6docs: add "sphinx" as an allowed style (#159)94efc5fStop trying to check folder with names ending in.py(#155)0247ef5Improve class attr comparison logic (#154)0b750d5Add option to treat property methods as class attributes (#153)3c39d2eAdd an option for private class attributes (#149)Updates
blackfrom 24.4.2 to 24.8.0Release notes
Sourced from black's releases.
Changelog
Sourced from black's changelog.
Commits
b965c2aPrepare release 24.8.0 (#4426)9ccf279Documentfind_project_rootignoringpyproject.tomlwithout[tool.black]...14b6e61fix: Enhace black efficiently to skip directories listed in .gitignore (#4415)b1c4dd9fix: respect braces better in f-string parsing (#4422)4b4ae43Fix incorrect linenos on fstring tokens with escaped newlines (#4423)7fa1fafdocs: fix the installation command of extra for blackd (#4413)8827accBump sphinx from 7.3.7 to 7.4.0 in /docs (#4404)b0da11dBump furo from 2024.5.6 to 2024.7.18 in /docs (#4409)721dff5fix: avoid formatting backslash strings inside f-strings (#4401)7e2afc9Updateactions/checkoutto v4 to stop node deprecation warnings (#4379)Updates
mkdocs-materialfrom 9.5.20 to 9.5.34Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
7d6096aPrepare 9.5.34 release6f3c05bUpdated dependenciesd3b1792Updated Mermaid to v11 (#7475)f88c436Unpinned Stylelint and plugins3b12816Unpinned TypeScript ESLint integration and checkscafd67bFixed error in build script80ae560Unpinned svgo dependencya91ee70Prepare 9.5.33 release4104fafUpdated dependencies8ee7137Updated premium sponsorsUpdates
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
bfd45a8Add pull-requests read permission to the release-notes-check workflow (#289)6aa6bc0Prepare for the v0.10.0 release (#290)297b184Update version in the template pyproject.toml632283dPrepare the release notes for v0.10.0 release1778ff8Add pull-requests read permission to the release-notes-check workflow2ac253aDisable the newcheck-class-attributescheck in pydoclint 0.5.3 (#288)1660756Disable the newcheck-class-attributescheck in pydoclint 0.5.3327879bFix credentials not passed or configured the CI workflow (#286)6195bc7Update release notesbef233cRemove the TODOs from the migrationUpdates
mypyfrom 1.10.1 to 1.11.2Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
789f02cBump version to 1.11.2917cc75An alternative fix for a union-like literal string (#17639)7d805b3Unwrap TypedDict item types before storing (#17640)32675ddRevert "Fix Literal strings containing pipe characters" (#17638)778542bRevert "FixRawExpressionType.acceptcrash with--cache-fine-grained" (#1...14ab742Bump version to 1.11.2+dev570b90aBump version to 1.11b3a102eFixRawExpressionType.acceptcrash with--cache-fine-grained(#17588)aec04c7Fix PEP 604 isinstance caching (#17563)cb44e4dFixtyping.TypeAliasTypebeing undefined on python < 3.12 (#17558)Updates
pylintfrom 3.2.5 to 3.2.7Commits
a98215bBump pylint to 3.2.7, update changelog1deaffaFix to maintain order of package paths (#9887) (#9897)b4c2951[Backport maintenance/3.2.x] Fix a crash inundefined-loop-variablewith `e...f1925f4Fix crash in refactoring checker when calling bound lambda (#9867)7d1626cFix a false positiveunreachableforNoReturncoroutine functions (#9844)...da19566Bump pylint to 3.2.6, update changelog (#9825)810c59cUpdate setuptools to >=71.0.4 (#9812) (#9824)5f19cd5Fix a crash when a subclass extends__slots__(#9817) (#9822)c0b1d22Bump astroid to 3.2.4 (#9816) (#9821)1d877deFix consider-using-min-max-builtin (#9802) (#9803)Updates
pytestfrom 8.2.2 to 8.3.3Release notes
Sourced from pytest's releases.
... (truncated)
Commits
d0f136fbuild(deps): Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.1 (#12790)972f307Prepare release version 8.3.30dabdcfInclude co-authors in release announcement (#12795) (#12797)a9910a4Do not discover properties when iterating fixtures (#12781) (#12788)0f10b6bFix issue with slashes being turned into backslashes on Windows (#12760) (#12...300d13dMerge pull request #12785 from pytest-dev/patchback/backports/8.3.x/57cccf7f4...e5d32c7Merge pull request #12784 from svenevs/fix/docs-example-parametrize-minor-typobc913d1Streamline checks for verbose option (#12706) (#12778)01cfcc9Fix typos and introduce codespell pre-commit hook (#12769) (#12774)4873394doc: Remove past training (#12772) (#12773)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.
... (truncated)
Commits
bfd45a8Add pull-requests read permission to the release-notes-check workflow (#289)6aa6bc0Prepare for the v0.10.0 release (#290)297b184Update version in the template pyproject.toml632283dPrepare the release notes for v0.10.0 release1778ff8Add pull-requests read permission to the release-notes-check workflow2ac253aDisable the newcheck-class-attributescheck in pydoclint 0.5.3 (#288)1660756Disable the newcheck-class-attributescheck in pydoclint 0.5.3327879bFix credentials not passed or configured the CI workflow (#286)6195bc7Update release notesbef233cRemove 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