Coverage for tests/conftest.py: 100.00%
27 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-14 19:41 +0100
« prev ^ index » next coverage.py v7.3.2, created at 2023-11-14 19:41 +0100
1"""Configuration for the pytest test suite."""
3from __future__ import annotations
5from collections import ChainMap
6from typing import TYPE_CHECKING, Any, Iterator
8import pytest
9from markdown.core import Markdown
10from mkdocs.config.defaults import MkDocsConfig
12if TYPE_CHECKING:
13 from pathlib import Path
15 from mkdocs import config
17 from mkdocstrings.plugin import MkdocstringsPlugin
20@pytest.fixture(name="mkdocs_conf")
21def fixture_mkdocs_conf(request: pytest.FixtureRequest, tmp_path: Path) -> Iterator[config.Config]:
22 """Yield a MkDocs configuration object."""
23 conf = MkDocsConfig()
24 while hasattr(request, "_parent_request") and hasattr(request._parent_request, "_parent_request"):
25 request = request._parent_request
27 conf_dict = {
28 "site_name": "foo",
29 "site_url": "https://example.org/",
30 "site_dir": str(tmp_path),
31 "plugins": [{"mkdocstrings": {"default_handler": "python"}}],
32 **getattr(request, "param", {}),
33 }
34 # Re-create it manually as a workaround for https://github.com/mkdocs/mkdocs/issues/2289
35 mdx_configs: dict[str, Any] = dict(ChainMap(*conf_dict.get("markdown_extensions", [])))
37 conf.load_dict(conf_dict)
38 assert conf.validate() == ([], [])
40 conf["mdx_configs"] = mdx_configs
41 conf["markdown_extensions"].insert(0, "toc") # Guaranteed to be added by MkDocs.
43 conf = conf["plugins"]["mkdocstrings"].on_config(conf)
44 conf = conf["plugins"]["autorefs"].on_config(conf)
45 yield conf
46 conf["plugins"]["mkdocstrings"].on_post_build(conf)
49@pytest.fixture(name="plugin")
50def fixture_plugin(mkdocs_conf: config.Config) -> MkdocstringsPlugin:
51 """Return a plugin instance."""
52 return mkdocs_conf["plugins"]["mkdocstrings"]
55@pytest.fixture(name="ext_markdown")
56def fixture_ext_markdown(mkdocs_conf: MkDocsConfig) -> Markdown:
57 """Return a Markdown instance with MkdocstringsExtension."""
58 return Markdown(extensions=mkdocs_conf["markdown_extensions"], extension_configs=mkdocs_conf["mdx_configs"])