Improved the violation message of DOC105: the arguments with inconsistent
type hints are now shown in the violation message to make violation
correction much easier
A new config option --show-filenames-in-every-violation-message (or
-sfn), which makes it more convenient to jump to the corresponding line
in IDEs by clicking on the violation message in the terminal
Fix a performance problem with HTML extraction where large HTML input could
trigger quadratic line counting behavior (#1392).
Improve and expand type annotations in the code base (#1394).
[3.5] -- 2023-10-06
Added
Add permalink_leading configuration option to the toc extension (#1339)
A new boolean option permalink_leading controls the position of the permanent
link anchors generated with permalink. Setting permalink_leading to True
will cause the links to be inserted at the start of the header, before any other
header content. The default behavior for permalink is to append permanent
links to the header, placing them after all other header content.
Changed
Add support for cPython version 3.12 (and PyPy 3.10) and drop support for
Python version 3.7 (#1357).
This release brings support for pytest 8, a couple of bug fixes and many improvements to the cookiecutter template.
Upgrading
Once you upgraded, you'll be able to upgrade to pytest 8, and indirectly to sybil 6, which includes types hints. If you do so, you should remove the mypy exception for sybil in the pyproject.toml file.
Search for the tool.mypy.overrides section and remove the "sybil", "sybil.*" enties from the module list.
Cookiecutter template
To upgrade without regenerating the project, you can follow these steps:
Run the following command to add the new pylint ignore rules:
sed '/ # Checked by flake8/a\ "redefined-outer-name",\n "unused-import",' -i pyproject.toml
It is recommended to update this rule in your repository to use the new bypass rule for the Protect version branches ruleset that allows maintainers to force-merge.
You can do this by re-importing the ruleset or manually:
Go to the repository settings -> Rules -> Rulesets -> Protect version branches -> Bypass list -> Add bypass -> Select Maintain role and change the dropdown bypass rule to use Pull requests instead of Always.
The labeler action was upgraded to 5.0.0. This needs a new configuration file.
If you haven't diverged much from the default configuration (and you are not using exclusion rules), you can update the configuration file by running this script in the root of your repository:
import sys
lines = []
state = "looking"
with open(".github/labeler.yml", encoding="utf-8") as fin:
for line in fin:
if "changed-files:" in line:
sys.stderr.write("Already fixed, aborting...\n")
sys.exit(1)
match state:
case "looking":
if not line.startswith(("#", " ", "\t")) and line.rstrip().endswith(":"):
line = f"{line} - changed-files:\n - any-glob-to-any-file:\n"
state = "in-label"
case "in-label":
if not line.lstrip().startswith("-"):
state = "looking"
Stubtest will ignore private function/method parameters when they are missing from the stub. Private parameters
names start with a single underscore and have a default (PR 16507).
Mypy 1.8
We’ve just uploaded mypy 1.8 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.
Type-checking Improvements
Do not intersect types in isinstance checks if at least one is final (Christoph Tyralla, PR 16330)
Detect that @final class without __bool__ cannot have falsey instances (Ilya Priven, PR 16566)
Do not allow TypedDict classes with extra keywords (Nikita Sobolev, PR 16438)
Do not allow class-level keywords for NamedTuple (Nikita Sobolev, PR 16526)
Make imprecise constraints handling more robust (Ivan Levkivskyi, PR 16502)
Fix strict-optional in extending generic TypedDict (Ivan Levkivskyi, PR 16398)
Allow type ignores of PEP 695 constructs (Shantanu, PR 16608)
Enable type_check_only support for TypedDict and NamedTuple (Nikita Sobolev, PR 16469)
Performance Improvements
Add fast path to analyzing special form assignments (Jukka Lehtosalo, PR 16561)
Improvements to Error Reporting
Don't show documentation links for plugin error codes (Ivan Levkivskyi, PR 16383)
Improve error messages for super checks and add more tests (Nikita Sobolev, PR 16393)
This includes an upgrade of repo-config, which requires manual changes (I mean, not technically, as it does work without them, but it would be good to keep in sync with the templates too). It looks like you only applied one of them. Can you maybe apply the rest?
Bumps the optional group with 14 updates:
0.3.20.4.15.12.05.13.23.4.43.5.21.0.41.0.59.3.19.5.100.23.00.24.00.8.00.9.01.5.11.8.03.4.2.103.5.0.202401293.0.23.0.30.8.00.9.03.11.13.12.00.21.10.23.56.98.86.98.9Updates
pydoclintfrom 0.3.2 to 0.4.1Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
af2c326Update changelog3a5e4b0Remove useless argument--src(#124)70eb3c8Fix double quotes in Literal type hint (#123)d2b4b99Include args with different type hints in DOC105 msg (#120)fa41757Add option to show filename for each violation msg (#119)b8b4396Add py312 to CI pipeline01893dfExclude venv folders in flake8 (#116)676847eDocumenting tool integration (#104)75e485bFix false positive DOC203 in property methods (#115)55c0fdeExplain why allow-init-docstring defaults to FalseUpdates
isortfrom 5.12.0 to 5.13.2Release notes
Sourced from isort's releases.
... (truncated)
Changelog
Sourced from isort's changelog.
Commits
c655831Merge pull request #2214 from PyCQA/version/5.13.2b4335b4Prepare version 5.13.2c36e43cMerge pull request #2184 from bp72/issue/2154e38702fMerge pull request #2213 from davidculley/confine-precommit-to-stagesee8d87fAdd fix for the error found by hypothesis5849ec2Apply the bracket fix from issue 471 only for use_parentheses=Truedf0e119confine pre-commit to stages9255bcaMerge pull request #2212 from PyCQA/bugfix/#2211-colors-extra5336d7dFix colors extras643d9c4Merge pull request #2210 from PyCQA/version/5.13.1Updates
markdownfrom 3.4.4 to 3.5.2Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
08dacaeBump version to 3.5.2e466f38Fix handling of bogus comments.a2a9c53Update change log link in README.mdcef5afeUpdate Changelog URL5d7f255Fix missing search in docsbc14d59Split changelog workflows to separate logic on when each gets run.9b06df2ghp-import it not a command moduledac7977Fix a minor oversight in #1407dcd69b1Update docs deploy scriptsa63e6f3Fix edge-case crash in InlineProcessorUpdates
mkdocs-macros-pluginfrom 1.0.4 to 1.0.5Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
4bfda0bFix issue with changelog no longer displayed (#186)82c5cddMerge pull request #183 from marcospereira/add-short-tag298f07fAdd a short_tag attribute to git context428a015Remove include-markdown in webdoc, since it crashed readthedocs2161dd4Update .readthedocs.ymlc64a08dMerge pull request #182 from SimonMarquis/patch-11c1d2c4Fix typo inRich Markdown Pagesdocs9dba19eMerge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master7da7089Add experimental logo0d36ddeAdd experimental logoUpdates
mkdocs-materialfrom 9.3.1 to 9.5.10Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
b688cfdUpdated changelogfea265dPrepare 9.5.10 releaseadf061eUpdated dependencies7bbc9f9Fixed positioning of integrated table of contents3e2a1fcMerge branch 'master' of github.com:squidfunk/mkdocs-material2986acaDocumentation4fd52fdMerge pull request #6791 from squidfunk/docs/updating-faq7922c8fUpdated FAQsf1673ecUpdated FAQse423784Updated FAQsUpdates
mkdocstrings[python]from 0.23.0 to 0.24.0Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
032e417chore: Prepare release 0.24.0ce84dd5feat: Cache downloaded inventories as local file4a97755docs: Make recipe work with MkDocs-foptionb3edf89ci: Some typing fixes/ignored74fadatests: Stop passing config file path to MkDocsConfig4dbb6d6ci: Ruff auto-fix39694acchore: Template upgradeafc4ea4fix:custom_templatesconfig was dropped in previous commit (#630)b61d4d1refactor: Drop support for MkDocs < 1.4, modernize usages370a61dfix: Makecustom_templatesrelative to the config fileUpdates
frequenz-repo-config[lib]from 0.8.0 to 0.9.0Release notes
Sourced from frequenz-repo-config[lib]'s releases.
... (truncated)
Commits
3e198cePrepare release notes for v0.9.0 (#227)665c447Remove placeholder from RELEASE_NOTES.md9545f59Add summary to release notes3258f97Remove conflict markers from RELEASE_NOTES.md0916f1bFetch submodules when doing cross-arch tests (#225)eb09fb4Fetch submodules when doing cross-arch testse2bae45Update pytest and sybil (#221)f479301ci: Support using git for dependencies intest-installation(#222)4b09189Update release notes21067adRemovemypyexceptions forsybilUpdates
mypyfrom 1.5.1 to 1.8.0Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
3b46750remove +dev suffix from versionc9bc833Fix tests broken by hatchling (#16655)60d30e3Fix crash with type alias toCallable[[Unpack[Tuple[Any, ...]]], Any](#16541)f53f422Allow type ignores of PEP 695 constructs (#16608)7c33e7c@finalclass without bool cannot have falsey instances (#16566)c224da5Do not intersect types in isinstance checks if at least one is final (#16330)d54cc35Change example in test cases with no stubs available (#16513)eb1ee97Update hashes insync-typeshed.pyfollowing recent typeshed sync (#16600)344298eRevert use ofParamSpecforfunctools.wraps3e5d813Revert typeshed ctypes changeUpdates
types-markdownfrom 3.4.2.10 to 3.5.0.20240129Commits
Updates
pylintfrom 3.0.2 to 3.0.3Commits
1a5ffc1Bump pylint to 3.0.3, update changelog54687e7Disallow isort 5.13.0 (#9290) (#9292)This includes an upgrade of repo-config, which requires manual changes (I mean, not technically, as it does work without them, but it would be good to keep in sync with the templates too). It looks like you only applied one of them. Can you maybe apply the rest?
https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/20