-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tests: Refactor fixtures and helpers
- Loading branch information
Showing
3 changed files
with
174 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
"""Configuration for the pytest test suite.""" | ||
|
||
from __future__ import annotations | ||
|
||
from collections import ChainMap | ||
from contextlib import contextmanager | ||
from typing import TYPE_CHECKING, Any | ||
|
||
from markdown.core import Markdown | ||
from mkdocs.config.defaults import MkDocsConfig | ||
|
||
if TYPE_CHECKING: | ||
from collections.abc import Iterator | ||
from pathlib import Path | ||
|
||
import pytest | ||
from mkdocstrings.plugin import MkdocstringsPlugin | ||
|
||
from mkdocstrings_handlers.python.handler import PythonHandler | ||
|
||
|
||
@contextmanager | ||
def mkdocs_conf(request: pytest.FixtureRequest, tmp_path: Path) -> Iterator[MkDocsConfig]: | ||
"""Yield a MkDocs configuration object. | ||
Parameters: | ||
request: Pytest request fixture. | ||
tmp_path: Temporary path. | ||
Yields: | ||
MkDocs config. | ||
""" | ||
conf = MkDocsConfig() | ||
while hasattr(request, "_parent_request") and hasattr(request._parent_request, "_parent_request"): | ||
request = request._parent_request | ||
|
||
conf_dict = { | ||
"site_name": "foo", | ||
"site_url": "https://example.org/", | ||
"site_dir": str(tmp_path), | ||
"plugins": [{"mkdocstrings": {"default_handler": "python"}}], | ||
**getattr(request, "param", {}), | ||
} | ||
# Re-create it manually as a workaround for https://github.com/mkdocs/mkdocs/issues/2289 | ||
mdx_configs: dict[str, Any] = dict(ChainMap(*conf_dict.get("markdown_extensions", []))) | ||
|
||
conf.load_dict(conf_dict) | ||
assert conf.validate() == ([], []) | ||
|
||
conf["mdx_configs"] = mdx_configs | ||
conf["markdown_extensions"].insert(0, "toc") # Guaranteed to be added by MkDocs. | ||
|
||
conf = conf["plugins"]["mkdocstrings"].on_config(conf) | ||
conf = conf["plugins"]["autorefs"].on_config(conf) | ||
yield conf | ||
conf["plugins"]["mkdocstrings"].on_post_build(conf) | ||
|
||
|
||
def plugin(mkdocs_conf: MkDocsConfig) -> MkdocstringsPlugin: | ||
"""Return a plugin instance. | ||
Parameters: | ||
mkdocs_conf: MkDocs configuration. | ||
Returns: | ||
mkdocstrings plugin instance. | ||
""" | ||
return mkdocs_conf["plugins"]["mkdocstrings"] | ||
|
||
|
||
def ext_markdown(mkdocs_conf: MkDocsConfig) -> Markdown: | ||
"""Return a Markdown instance with MkdocstringsExtension. | ||
Parameters: | ||
mkdocs_conf: MkDocs configuration. | ||
Returns: | ||
A Markdown instance. | ||
""" | ||
return Markdown(extensions=mkdocs_conf["markdown_extensions"], extension_configs=mkdocs_conf["mdx_configs"]) | ||
|
||
|
||
def handler(plugin: MkdocstringsPlugin, ext_markdown: Markdown) -> PythonHandler: | ||
"""Return a handler instance. | ||
Parameters: | ||
plugin: Plugin instance. | ||
Returns: | ||
A handler instance. | ||
""" | ||
handler = plugin.handlers.get_handler("python") | ||
handler._update_env(ext_markdown, plugin.handlers._config) | ||
return handler # type: ignore[return-value] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters