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).
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).
Commits
e8b3f45 Document hooks for #237 (register macros/variables/filters)
c1029d5 Document how to correct issue with macros / admonitions (#240)
67ccb15 Merge pull request #238 from timvink/master
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)
Bumps the required group with 14 updates in the / directory:
7.0.07.1.10.4.10.5.924.4.224.8.03.63.72.1.12.1.31.0.51.2.09.5.259.5.390.25.10.26.10.9.20.10.01.10.01.11.23.6.0.202403163.7.0.202408223.2.23.3.18.2.18.3.30.9.20.10.0Updates
flake8from 7.0.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 documentation65a38c4Release 7.1.034c97e0Merge pull request #1939 from PyCQA/new-pycodestyledefd315latest pycodestyle408d4d6Merge pull request #1930 from mzagol/patch-1866ad72Add --extend-exclude to the TOCUpdates
pydoclintfrom 0.4.1 to 0.5.9Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
8170436Improve handling of long type annotations (#173)27ff769doc(usage): Including a null-ls use with neovim. (#167)5e941f5fix: DOC503 catch namespaced exceptions (#168)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)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
markdownfrom 3.6 to 3.7Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
da03cd6Bump version to 3.7bd836a1Update griffe_extensions to support Griffe v 1.0.33359faAbbr Extension: Definition Sorting and Glossary storageec8c305RefactorabbrExtension993b57bFixed links to source code on GitHub from the documentationUpdates
mikefrom 2.1.1 to 2.1.3Release notes
Sourced from mike's releases.
Changelog
Sourced from mike's changelog.
Commits
c4e9608Update version to 2.1.33b19e27Announce the previous changedd9826aConsult deploy prefix when deleting files during deploy; resolves #22791cf5eeProperly escape parameters in regex90cf131Update version to 2.2.0.dev062aaeafUpdate version to 2.1.23f7d756Use "--" to disambiguate Git arguments in a few more places; resolves #2185e6970dBelatedly update copyright year9291efbUpdate version to 2.2.0.dev0Updates
mkdocs-macros-pluginfrom 1.0.5 to 1.2.0Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
e8b3f45Document hooks for #237 (register macros/variables/filters)c1029d5Document how to correct issue with macros / admonitions (#240)67ccb15Merge pull request #238 from timvink/master03f5e89Fix registration systemddace97remove property on register methods363d904Add three hooksregister_variables/macros/filters(#237)2fb833eImproved implementation for relative url (#236)69e7cadMerge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master5bec964Add standard filternormalize_url(#236)9a08f11Merge pull request #228 from caomingpei/masterUpdates
mkdocs-materialfrom 9.5.25 to 9.5.39Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
70db88fPrepare 9.5.39 release187705eUpdated dependencies56fdb28Adjusted code copy button documentationaeb9492Fixed stay no page functionality when using mike's canonical versioning (#7559)50a15beUpdated link to step-by-step guide on YouTube117250aPrepare 9.5.38 release74ca234Added Albanian translations84ddbbaPrepare 9.5.37 releasefd98413Documentation (#7557)573d23dUpdated dependenciesUpdates
mkdocstrings[python]from 0.25.1 to 0.26.1Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
651d176chore: Prepare release 0.26.1db2ab34fix: Instantiate config of the autorefs plugin when it is not enabled by the ...a65035adocs: Clarify that Installation sectionb1aa042chore: Prepare release 0.26.0b63e726feat: Allow hooking into autorefs when converting Markdown docstrings3c878b7chore: Upgrade mkdocs-redirects lower bound to avoid deprecation warning28565f9build: Upgrade Python-Markdown lower bound to 3.652fad11style: Formatc6ca522docs: Fix dead link8041ef3docs: Update code highlight linesUpdates
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.0 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
types-markdownfrom 3.6.0.20240316 to 3.7.0.20240822Commits
Updates
pylintfrom 3.2.2 to 3.3.1Commits
76bce72Bump pylint to 3.3.1, update changelog (#9954)55ee816Bump astroid to 3.3.4 (#9951) (#9952)6350dfaBump pylint to 3.3.0, update changelog78f3dfaBump astroid to 3.3.3 (#9939)b28c1f6Add check forunnecessary-default-type-args(#9938)bd97b93[doc framework] Assert that the good and bad example exists in the doc (#9936)7aa4436Fix duplicate workflow step ids (#9934)0950916[pre-commit] Add codespell, and fix some existing typos (#9912)3b4a7f9Add details.rst for c-extension-no-member (#9933)7d60c27Explicitly save cache in primer jobsUpdates
pytestfrom 8.2.1 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) (#12797Looks like these dependencies are updatable in another way, so this is no longer needed.