Update dependency mkdocstrings to ^0.28.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
mkdocstrings (changelog)	^0.19.0 -> ^0.28.0

---

Release Notes

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

v0.27.0

Compare Source

Compare with 0.26.2

Features

• Add support for authentication in inventory file URLs (1c23c1b by Stefan Mejlgaard). Issue-707, PR-710

Performance Improvements

• Reduce footprint of template debug messages (5648e5a by Timothée Mazzucotelli).

Code Refactoring

• Use %-formatting for logging messages (0bbb8ca by Timothée Mazzucotelli).

v0.26.2

Compare Source

Compare with 0.26.1

Build

• Drop support for Python 3.8 (f26edeb by Timothée Mazzucotelli).

v0.26.1

Compare Source

Compare with 0.26.0

Bug Fixes

• Instantiate config of the autorefs plugin when it is not enabled by the user (db2ab34 by Timothée Mazzucotelli). Issue-autorefs#57

v0.26.0

Compare Source

Compare with 0.25.2

Build

• Upgrade Python-Markdown lower bound to 3.6 (28565f9 by Timothée Mazzucotelli).

Dependencies

• Depend on mkdocs-autorefs v1 (33aa573 by Timothée Mazzucotelli).

Features

• Allow hooking into autorefs when converting Markdown docstrings (b63e726 by Timothée Mazzucotelli). Based-on-PR-autorefs#46

v0.25.2

Compare Source

Compare with 0.25.1

Code Refactoring

• Give precedence to Markdown heading level (##) (2e5f89e by Timothée Mazzucotelli).

v0.25.1

Compare Source

Compare with 0.25.0

Bug Fixes

• Always descend into sub-headings when re-applying their label (cb86e08 by Timothée Mazzucotelli). Issue-mkdocstrings/python-158

v0.25.0

Compare Source

Compare with 0.24.3

Features

• Support once parameter in logging methods, allowing to log a message only once with a given logger (1532b59 by Timothée Mazzucotelli).
• Support blank line between ::: path and YAML options (d799d2f by Timothée Mazzucotelli). Issue-450

Code Refactoring

• Allow specifying name of template loggers (c5b5f69 by Timothée Mazzucotelli).

v0.24.3

Compare Source

Compare with 0.24.2

Bug Fixes

• Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...) (7fe3e5f by Timothée Mazzucotelli).

v0.24.2

Compare Source

Compare with 0.24.1

Bug Fixes

• Support HTML toc labels with Python-Markdown 3.6+ (c0d0090 by Timothée Mazzucotelli). Issue-mkdocstrings/python-143

v0.24.1

Compare Source

Compare with 0.24.0

Code Refactoring

• Support new pymdownx-highlight options (a7a2907 by Timothée Mazzucotelli).
• Backup anchors with id and no href, for compatibility with autorefs' Markdown anchors (b5236b4 by Timothée Mazzucotelli). PR-#​651, Related-to-mkdocs-autorefs#39, Co-authored-by: Oleh Prypin [email protected]

v0.24.0

Compare Source

Compare with 0.23.0

Features

• Cache downloaded inventories as local file (ce84dd5 by Oleh Prypin). PR #​632

Bug Fixes

• Make custom_templates relative to the config file (370a61d by Waylan Limberg). Issue #​477, PR #​627
• Remove duplicated headings for docstrings nested in tabs/admonitions (e2123a9 by Perceval Wajsburt, f4a94f7 by Oleh Prypin). Issue #​609, PR #​610, PR #​613

Code Refactoring

• Drop support for MkDocs < 1.4, modernize usages (b61d4d1 by Oleh Prypin). PR #​629

v0.23.0

Compare Source

Compare with 0.22.0

Breaking Changes

• Removed BaseCollector and BaseRenderer classes: they were merged into the BaseHandler class.
• Removed the watch feature, as MkDocs now provides it natively.
• Removed support for selection and rendering keys in YAML blocks: use options instead.
• Removed support for loading handlers from the mkdocstrings.handler namespace.
  Handlers must now be packaged under the mkdocstrings_handlers namespace.

Features

• Register all anchors for each object in the inventory (228fb73 by Timothée Mazzucotelli).

Bug Fixes

• Don't add codehilite CSS class to inline code (7690d41 by Timothée Mazzucotelli).
• Support cross-references for API docs rendered in top-level index page (b194452 by Timothée Mazzucotelli).

Code Refactoring

• Sort inventories before writing them to disk (9371e9f by Timothée Mazzucotelli).
• Stop accepting sets as return value of get_anchors (only tuples), to preserve order (2e10374 by Timothée Mazzucotelli).
• Remove deprecated parts (0a90a47 by Timothée Mazzucotelli).
• Use proper parameters in Inventory.register method (433c6e0 by Timothée Mazzucotelli).

v0.22.0

Compare Source

Compare with 0.21.2

Features

• Allow extensions to add templates (cf0af05 by Timothée Mazzucotelli). PR #​569

Code Refactoring

• Report inventory loading errors (2c05d78 by Timothée Mazzucotelli). Co-authored-by: Oleh Prypin [email protected]

v0.21.2

Compare Source

Compare with 0.21.1

Bug Fixes

• Fix regression with LRU cached method (85efbd2 by Timothée Mazzucotelli). Issue #​549

v0.21.1

Compare Source

Compare with 0.21.0

Bug Fixes

• Fix missing typing-extensions dependency on Python less than 3.10 (bff760b by Timothée Mazzucotelli). Issue #​548

v0.21.0

Compare Source

Compare with 0.20.0

Features

• Expose the full config to handlers (15dacf6 by David Patterson). Issue #​501, PR #​509

v0.20.0

Compare Source

Compare with 0.19.1

Features

• Add enabled configuration option (8cf117d by StefanBRas). Issue #​478, PR #​504

Bug Fixes

• Handle updating Jinja environment of multiple handlers (a6ea80c by David Patterson). Related PR #​201, Issue #​502, PR #​507

Code Refactoring

• Make _load_inventory accept lists as arguments (105ed82 by Sorin Sbarnea). Needed by PR mkdocstrings/python#49, PR #​511
• Remove support for MkDocs < 1.2 (we already depended on MkDocs >= 1.2) (ac963c8 by Timothée Mazzucotelli).

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

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

---

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

[renovate]

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock

Creating virtualenv godel-yDhMs833-py3.10 in /home/ubuntu/.cache/pypoetry/virtualenvs
Updating dependencies
Resolving dependencies...


The current project's Python requirement (>=3.7.10,<3.11) is not compatible with some of the required packages Python requirement:
  - mkdocstrings requires Python >=3.8, so it will not be satisfied for Python >=3.7.10,<3.8

Because mkdocstrings (0.25.0) requires Python >=3.8
 and no versions of mkdocstrings match >0.25.0,<0.26.0, mkdocstrings is forbidden.
So, because godel depends on mkdocstrings (^0.25.0), version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For mkdocstrings, a possible solution would be to set the `python` property to ">=3.8,<3.11"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

[renovate]

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock

Creating virtualenv godel-yDhMs833-py3.10 in /home/ubuntu/.cache/pypoetry/virtualenvs
Updating dependencies
Resolving dependencies...


The current project's Python requirement (>=3.7.10,<3.11) is not compatible with some of the required packages Python requirement:
  - mkdocstrings requires Python >=3.9, so it will not be satisfied for Python >=3.7.10,<3.9

Because mkdocstrings (0.28.0) requires Python >=3.9
 and no versions of mkdocstrings match >0.28.0,<0.29.0, mkdocstrings is forbidden.
So, because godel depends on mkdocstrings (^0.28.0), version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For mkdocstrings, a possible solution would be to set the `python` property to ">=3.9,<3.11"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers