chore(deps): update dev-dependencies

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
mkdocs-material (changelog)	^9.5.49 -> ^9.6.3
mkdocstrings (changelog)	^0.27.0 -> ^0.28.0
mkdocstrings-python (changelog)	^1.13.0 -> ^1.14.6
mypy (changelog)	^1.14.1 -> ^1.15.0
poethepoet	^0.32.1 -> ^0.32.2
pyright	^1.1.391 -> ^1.1.393
ruff (source, changelog)	^0.9.1 -> ^0.9.5

---

Release Notes

squidfunk/mkdocs-material (mkdocs-material)

v9.6.3: mkdocs-material-9.6.3

Compare Source

• Fixed rendering of arrow heads in Mermaid.js class diagrams
• Fixed #​7960: Tags plugin crashes on numeric metadata titles

v9.6.2: mkdocs-material-9.6.2

Compare Source

• Fixed #​7955: Excessively long words don't break on narrow screens
• Fixed #​7947: Scope setting interferes with outdated version banner

v9.6.1: mkdocs-material-9.6.1

Compare Source

• Fixed #​7943: Tags plugin crashing due to merge error

v9.6.0: mkdocs-material-9.6.0

Compare Source

• Added meta plugin
• Rewrite of the tags plugin
• Added support for allow lists in tags plugin
• Added support for and custom sorting in tags plugin
• Added support for related links in blog plugin
• Added support for custom index pages in blog plugin
• Added support for navigation subtitles
• Fixed #​7924: Anchors might require two clicks when using instant navigation

v9.5.50: mkdocs-material-9.5.50

Compare Source

• Fixed #​7913: Social plugin renders attribute lists in page title

mkdocstrings/mkdocstrings (mkdocstrings)

v0.28.0

Compare Source

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

• mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
• mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
• mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
• mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
• mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
• mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
• mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
• mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
• mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

• mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
• mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

• mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
    name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

class MyHandler:
    domain = "mh"

The theme argument must be passed as a keyword argument.

This argument could previously be passed as a positional argument (from the get_handler function), and must now be passed as a keyword argument.

The custom_templates argument must be passed as a keyword argument.

Same as for theme, but with custom_templates.

The mdx argument must be provided (as a keyword argument).

The get_handler function now receives a mdx argument, which it must forward to the handler constructor and then to the base handler, either explicitly or through **kwargs:

=== "Explicitly"

```python
def get_handler(..., mdx, ...):
    return MyHandler(..., mdx=mdx, ...)

class MyHandler:
    def __init__(self, ..., mdx, ...):
        super().__init__(..., mdx=mdx, ...)
```

=== "Through **kwargs"

```python
def get_handler(..., **kwargs):
    return MyHandler(..., **kwargs)

class MyHandler:
    def __init__(self, ..., **kwargs):
        super().__init__(**kwargs)
```

In the meantime we still retrieve this mdx value at a different moment, by reading it from the MkDocs configuration.

The mdx_config argument must be provided (as a keyword argument).

Same as for mdx, but with mdx_config.

mkdocstrings v1 will stop handling 'import' in handlers configuration. Instead your handler must define a get_inventory_urls method that returns a list of URLs to download.

Previously, mkdocstrings would pop the import key from a handler's configuration to download each item (URLs). Items could be strings, or dictionaries with a url key. Now mkdocstrings gives back control to handlers, which must store this inventory configuration within them, and expose it again through a get_inventory_urls method. This method returns a list of tuples: an URL, and a dictionary of options that will be passed again to their load_inventory method. Handlers have now full control over the "inventory" setting.

from copy import deepcopy

def get_handler(..., handler_config, ...):
    return MyHandler(..., config=handler_config, ...)

class MyHandler:
    def __init__(self, ..., config, ...):
        self.config = config

    def get_inventory_urls(self):
        config = deepcopy(self.config["import"])
        return [(inv, {}) if isinstance(inv, str) else (inv.pop("url"), inv) for inv in config]

Changing the name of the key (for example from import to inventories) involves a change in user configuration, and both keys will have to be supported by your handler for some time.

def get_handler(..., handler_config, ...):
    if "inventories" not in handler_config and "import" in handler_config:
        warn("The 'import' key is renamed 'inventories'", FutureWarning)
        handler_config["inventories"] = handler_config.pop("import")
    return MyHandler(..., config=handler_config, ...)

Setting a fallback anchor function is deprecated and will be removed in a future release.

This comes from mkdocstrings and mkdocs-autorefs, and will disappear with mkdocstrings v0.28.

mkdocstrings v1 will start using your handler's get_options method to build options instead of merging the global and local options (dictionaries).

Handlers must now store their own global options (in an instance attribute), and implement a get_options method that receives local_options (a dict) and returns combined options (dict or custom object). These combined options are then passed to collect and render, so that these methods can use them right away.

def get_handler(..., handler_config, ...):
    return MyHandler(..., config=handler_config, ...)

class MyHandler:
    def __init__(self, ..., config, ...):
        self.config = config

    def get_options(local_options):
        return {**self.default_options, **self.config["options"], **local_options}

The update_env(md) parameter is deprecated. Use self.md instead.

Handlers can remove the md parameter from their update_env method implementation, and use self.md instead, if they need it.

No need to call super().update_env() anymore.

Handlers don't have to call the parent update_env method from their own implementation anymore, and can just drop the call.

The get_anchors method is deprecated. Declare a get_aliases method instead, accepting a string (identifier) instead of a collected object.

Previously, handlers would implement a get_anchors method that received a data object (typed CollectorItem) to return aliases for this object. This forced mkdocstrings to collect this object through the handler's collect method, which then required some logic with "fallback config" as to prevent unwanted collection. mkdocstrings gives back control to handlers and now calls get_aliases instead, which accepts an identifier (string) and lets the handler decide how to return aliases for this identifier. For example, it can replicate previous behavior by calling its own collect method with its own "fallback config", or do something different (cache lookup, etc.).

class MyHandler:
    def get_aliases(identifier):
        try:
            obj = self.collect(identifier, self.fallback_config)

### or obj = self._objects_cache[identifier]
        except CollectionError:  # or KeyError
            return ()
        return ...  # previous logic in `get_anchors`

The config_file_path argument in get_handler functions is deprecated. Use tool_config.get('config_file_path') instead.

The config_file_path argument is now deprecated and only passed to get_handler functions if they accept it. If you used it to compute a "base directory", you can now use the tool_config argument instead, which is the configuration of the SSG tool in use (here MkDocs):

base_dir = Path(tool_config.config_file_path or "./mkdocs.yml").parent

Most of these warnings will disappear with the next version of mkdocstrings-python.

Bug Fixes

• Update handlers in JSON schema to be an object instead of an array (3cf7d51 by Matthew Messinger). Issue-733, PR-734
• Fix broken table of contents when nesting autodoc instructions (12c8f82 by Timothée Mazzucotelli). Issue-348

Code Refactoring

• Pass config_file_path to get_handler if it expects it (8c476ee by Timothée Mazzucotelli).
• Give back inventory control to handlers (b84653f by Timothée Mazzucotelli). Related-to-issue-719
• Give back control to handlers on how they want to handle global/local options (c00de7a by Timothée Mazzucotelli). Issue-719
• Deprecate base handler's get_anchors method in favor of get_aliases method (7a668f0 by Timothée Mazzucotelli).
• Register all identifiers of rendered objects into autorefs (434d8c7 by Timothée Mazzucotelli).
• Use mkdocs-get-deps' download utility to remove duplicated code (bb87cd8 by Timothée Mazzucotelli).
• Clean up data passed down from plugin to extension and handlers (b8e8703 by Timothée Mazzucotelli). PR-726

mkdocstrings/python (mkdocstrings-python)

v1.14.6

Compare Source

Compare with 1.14.5

Bug Fixes

• Catch alias resolution errors when getting aliases for an identifier (0aaa260 by Timothée Mazzucotelli). Issue-358

Code Refactoring

• Improve translations for Simplified Chinese and Japanese (753a0df by Zhikang Yan). PR-244

v1.14.5

Compare Source

Compare with 1.14.4

Bug Fixes

• Remove type from property docstring summary in summary sections (15f2cd4 by Uchechukwu Orji). PR-242

v1.14.4

Compare Source

Compare with 1.14.3

Bug Fixes

• Deactivate Pydantic validation on Python 3.9 is eval-type-backport is not available (for modern typing syntax support) (0de0e5e by Timothée Mazzucotelli). Issue-241

v1.14.3

Compare Source

Compare with 1.14.2

Bug Fixes

• Let dataclass implement __init__ method, set extra fields in get_options (477b9e4 by Timothée Mazzucotelli).

v1.14.2

Compare Source

Compare with 1.14.1

Bug Fixes

• Deactivate Pydantic logic if v1 is installed instead of v2 (c5ecd70 by Timothée Mazzucotelli). Issue-240

v1.14.1

Compare Source

Compare with 1.14.0

Bug Fixes

• Fix type errors with options during collection and docstring parsing (15ca6d8 by Timothée Mazzucotelli).

v1.14.0

Compare Source

Compare with 1.13.0

Features

• Add heading and toc_label options (7cabacf by Yann Van Crombrugge). Issue-mkdocstrings-725, PR-236
• Add force_inspection option to force dynamic analysis (83823be by Uchechukwu Orji). Issue-94, PR-231

Code Refactoring

• Use dataclasses for configuration/options and automate schema generation (5ebeda6 by Timothée Mazzucotelli).

python/mypy (mypy)

v1.15.0

Compare Source

RobertCraigie/pyright-python (pyright)

v1.1.393

Compare Source

v1.1.392

Compare Source

astral-sh/ruff (ruff)

v0.9.5

Compare Source

Preview features

• Recognize all symbols named TYPE_CHECKING for in_type_checking_block (#​15719)
• [flake8-comprehensions] Handle builtins at top of file correctly for unnecessary-dict-comprehension-for-iterable (C420) (#​15837)
• [flake8-logging] .exception() and exc_info= outside exception handlers (LOG004, LOG014) (#​15799)
• [flake8-pyi] Fix incorrect behaviour of custom-typevar-return-type preview-mode autofix if typing was already imported (PYI019) (#​15853)
• [flake8-pyi] Fix more complex cases (PYI019) (#​15821)
• [flake8-pyi] Make PYI019 autofixable for .py files in preview mode as well as stubs (#​15889)
• [flake8-pyi] Remove type parameter correctly when it is the last (PYI019) (#​15854)
• [pylint] Fix missing parens in unsafe fix for unnecessary-dunder-call (PLC2801) (#​15762)
• [pyupgrade] Better messages and diagnostic range (UP015) (#​15872)
• [pyupgrade] Rename private type parameters in PEP 695 generics (UP049) (#​15862)
• [refurb] Also report non-name expressions (FURB169) (#​15905)
• [refurb] Mark fix as unsafe if there are comments (FURB171) (#​15832)
• [ruff] Classes with mixed type variable style (RUF053) (#​15841)
• [airflow] BashOperator has been moved to airflow.providers.standard.operators.bash.BashOperator (AIR302) (#​15922)
• [flake8-pyi] Add autofix for unused-private-type-var (PYI018) (#​15999)
• [flake8-pyi] Significantly improve accuracy of PYI019 if preview mode is enabled (#​15888)

Rule changes

• Preserve triple quotes and prefixes for strings (#​15818)
• [flake8-comprehensions] Skip when TypeError present from too many (kw)args for C410,C411, and C418 (#​15838)
• [flake8-pyi] Rename PYI019 and improve its diagnostic message (#​15885)
• [pep8-naming] Ignore @override methods (N803) (#​15954)
• [pyupgrade] Reuse replacement logic from UP046 and UP047 to preserve more comments (UP040) (#​15840)
• [ruff] Analyze deferred annotations before enforcing mutable-(data)class-default and function-call-in-dataclass-default-argument (RUF008,RUF009,RUF012) (#​15921)
• [pycodestyle] Exempt sys.path += ... calls (E402) (#​15980)

Configuration

• Config error only when flake8-import-conventions alias conflicts with isort.required-imports bound name (#​15918)
• Workaround Even Better TOML crash related to allOf (#​15992)

Bug fixes

• [flake8-comprehensions] Unnecessary list comprehension (rewrite as a set comprehension) (C403) - Handle extraneous parentheses around list comprehension (#​15877)
• [flake8-comprehensions] Handle trailing comma in fixes for unnecessary-generator-list/set (C400,C401) (#​15929)
• [flake8-pyi] Fix several correctness issues with custom-type-var-return-type (PYI019) (#​15851)
• [pep8-naming] Consider any number of leading underscore for N801 (#​15988)
• [pyflakes] Visit forward annotations in TypeAliasType as types (F401) (#​15829)
• [pylint] Correct min/max auto-fix and suggestion for (PL1730) (#​15930)
• [refurb] Handle unparenthesized tuples correctly (FURB122, FURB142) (#​15953)
• [refurb] Avoid None | None as well as better detection and fix (FURB168) (#​15779)

Documentation

• Add deprecation warning for ruff-lsp related settings (#​15850)
• Docs (linter.md): clarify that Python files are always searched for in subdirectories (#​15882)
• Fix a typo in non_pep695_generic_class.rs (#​15946)
• Improve Docs: Pylint subcategories' codes (#​15909)
• Remove non-existing lint.extendIgnore editor setting (#​15844)
• Update black deviations (#​15928)
• Mention UP049 in UP046 and UP047, add See also section to UP040 (#​15956)
• Add instance variable examples to RUF012 (#​15982)
• Explain precedence for ignore and select config (#​15883)

v0.9.4

Compare Source

Preview features

• [airflow] Extend airflow context parameter check for BaseOperator.execute (AIR302) (#​15713)
• [airflow] Update AIR302 to check for deprecated context keys (#​15144)
• [flake8-bandit] Permit suspicious imports within stub files (S4) (#​15822)
• [pylint] Do not trigger PLR6201 on empty collections (#​15732)
• [refurb] Do not emit diagnostic when loop variables are used outside loop body (FURB122) (#​15757)
• [ruff] Add support for more re patterns (RUF055) (#​15764)
• [ruff] Check for shadowed map before suggesting fix (RUF058) (#​15790)
• [ruff] Do not emit diagnostic when all arguments to zip() are variadic (RUF058) (#​15744)
• [ruff] Parenthesize fix when argument spans multiple lines for unnecessary-round (RUF057) (#​15703)

Rule changes

• Preserve quote style in generated code (#​15726, #​15778, #​15794)
• [flake8-bugbear] Exempt NewType calls where the original type is immutable (B008) (#​15765)
• [pylint] Honor banned top-level imports by TID253 in PLC0415. (#​15628)
• [pyupgrade] Ignore is_typeddict and TypedDict for deprecated-import (UP035) (#​15800)

CLI

• Fix formatter warning message for flake8-quotes option (#​15788)
• Implement tab autocomplete for ruff config (#​15603)

Bug fixes

• [flake8-comprehensions] Do not emit unnecessary-map diagnostic when lambda has different arity (C417) (#​15802)
• [flake8-comprehensions] Parenthesize sorted when needed for unnecessary-call-around-sorted (C413) (#​15825)
• [pyupgrade] Handle end-of-line comments for quoted-annotation (UP037) (#​15824)

Documentation

• Add missing config docstrings (#​15803)
• Add references to trio.run_process and anyio.run_process (#​15761)
• Use uv init --lib in tutorial (#​15718)

v0.9.3

Compare Source

Preview features

• [airflow] Argument fail_stop in DAG has been renamed as fail_fast (AIR302) (#​15633)
• [airflow] Extend AIR303 with more symbols (#​15611)
• [flake8-bandit] Report all references to suspicious functions (S3) (#​15541)
• [flake8-pytest-style] Do not emit diagnostics for empty for loops (PT012, PT031) (#​15542)
• [flake8-simplify] Avoid double negations (SIM103) (#​15562)
• [pyflakes] Fix infinite loop with unused local import in __init__.py (F401) (#​15517)
• [pylint] Do not report methods with only one EM101-compatible raise (PLR6301) (#​15507)
• [pylint] Implement redefined-slots-in-subclass (W0244) (#​9640)
• [pyupgrade] Add rules to use PEP 695 generics in classes and functions (UP046, UP047) (#​15565, #​15659)
• [refurb] Implement for-loop-writes (FURB122) (#​10630)
• [ruff] Implement needless-else clause (RUF047) (#​15051)
• [ruff] Implement starmap-zip (RUF058) (#​15483)

Rule changes

• [flake8-bugbear] Do not raise error if keyword argument is present and target-python version is less or equals than 3.9 (B903) (#​15549)
• [flake8-comprehensions] strip parentheses around generators in unnecessary-generator-set (C401) (#​15553)
• [flake8-pytest-style] Rewrite references to .exception (PT027) (#​15680)
• [flake8-simplify] Mark fixes as unsafe (SIM201, SIM202) (#​15626)
• [flake8-type-checking] Fix some safe fixes being labeled unsafe (TC006,TC008) (#​15638)
• [isort] Omit trailing whitespace in unsorted-imports (I001) (#​15518)
• [pydoclint] Allow ignoring one line docstrings for DOC rules (#​13302)
• [pyflakes] Apply redefinition fixes by source code order (F811) (#​15575)
• [pyflakes] Avoid removing too many imports in redefined-while-unused (F811) (#​15585)
• [pyflakes] Group redefinition fixes by source statement (F811) (#​15574)
• [pylint] Include name of base class in message for redefined-slots-in-subclass (W0244) (#​15559)
• [ruff] Update fix for RUF055 to use var == value (#​15605)

Formatter

• Fix bracket spacing for single-element tuples in f-string expressions (#​15537)
• Fix unstable f-string formatting for expressions containing a trailing comma (#​15545)

Performance

• Avoid quadratic membership check in import fixes (#​15576)

Server

• Allow unsafe-fixes settings for code actions (#​15666)

Bug fixes

• [flake8-bandit] Add missing single-line/dotall regex flag (S608) (#​15654)
• [flake8-import-conventions] Fix infinite loop between ICN001 and I002 (ICN001) (#​15480)
• [flake8-simplify] Do not emit diagnostics for expressions inside string type annotations (SIM222, SIM223) (#​15405)
• [pyflakes] Treat arguments passed to the default= parameter of TypeVar as type expressions (F821) (#​15679)
• [pyupgrade] Avoid syntax error when the iterable is a non-parenthesized tuple (UP028) (#​15543)
• [ruff] Exempt NewType calls where the original type is immutable (RUF009) (#​15588)
• Preserve raw string prefix and escapes in all codegen fixes (#​15694)

Documentation

• Generate documentation redirects for lowercase rule codes (#​15564)
• TRY300: Add some extra notes on not catching exceptions you didn't expect (#​15036)

v0.9.2

Compare Source

Preview features

• [airflow] Fix typo "security_managr" to "security_manager" (AIR303) (#​15463)
• [airflow] extend and fix AIR302 rules (#​15525)
• [fastapi] Handle parameters with Depends correctly (FAST003) (#​15364)
• [flake8-pytest-style] Implement pytest.warns diagnostics (PT029, PT030, PT031) (#​15444)
• [flake8-pytest-style] Test function parameters with default arguments (PT028) (#​15449)
• [flake8-type-checking] Avoid false positives for | in TC008 (#​15201)

Rule changes

• [flake8-todos] Allow VSCode GitHub PR extension style links in missing-todo-link (TD003) (#​15519)
• [pyflakes] Show syntax error message for F722 (#​15523)

Formatter

• Fix curly bracket spacing around f-string expressions containing curly braces (#​15471)
• Fix joining of f-strings with different quotes when using quote style Preserve (#​15524)

Server

• Avoid indexing the same workspace multiple times (#​15495)
• Display context for ruff.configuration errors (#​15452)

Configuration

• Remove flatten to improve deserialization error messages (#​15414)

Bug fixes

• Parse triple-quoted string annotations as if parenthesized (#​15387)
• [fastapi] Update Annotated fixes (FAST002) (#​15462)
• [flake8-bandit] Check for builtins instead of builtin (S102, PTH123) (#​15443)
• [flake8-pathlib] Fix --select for os-path-dirname (PTH120) (#​15446)
• [ruff] Fix false positive on global keyword (RUF052) (#​15235)

---

Configuration

📅 Schedule: Branch creation - "before 5am on Saturday every 4 weeks of the year starting on the 2th week" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6bfc95d) to head (b391e98).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #322   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           20        20           
=========================================
  Hits            20        20           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.