tests: Fix tests

Author: pawamoy

tests/conftest.py

@@ -86,16 +86,16 @@ def fixture_ext_markdown(plugin):
  return plugin.md
 
 
-@pytest.fixture(name="renderer")
-def fixture_renderer(plugin):
- """Return a PythonRenderer instance.
+@pytest.fixture(name="handler")
+def fixture_handler(plugin):
+ """Return a handler instance.
 
  Parameters:
  plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
 
  Returns:
- A renderer instance.
+ A handler instance.
  """
  handler = plugin.handlers.get_handler("python")
- handler.renderer._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
- return handler.renderer
+ handler._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
+ return handler

tests/test_collector.py

@@ -0,0 +1,60 @@
+"""Tests for the `handler` module."""
+
+import pytest
+from griffe.docstrings.dataclasses import DocstringSectionExamples, DocstringSectionKind
+
+from mkdocstrings_handlers.python.handler import CollectionError, get_handler
+
+
+def test_collect_missing_module():
+ """Assert error is raised for missing modules."""
+ handler = get_handler(theme="material")
+ with pytest.raises(CollectionError):
+ handler.collect("aaaaaaaa", {})
+
+
+def test_collect_missing_module_item():
+ """Assert error is raised for missing items within existing modules."""
+ handler = get_handler(theme="material")
+ with pytest.raises(CollectionError):
+ handler.collect("mkdocstrings.aaaaaaaa", {})
+
+
+def test_collect_module():
+ """Assert existing module can be collected."""
+ handler = get_handler(theme="material")
+ assert handler.collect("mkdocstrings", {})
+
+
+def test_collect_with_null_parser():
+ """Assert we can pass `None` as parser when collecting."""
+ handler = get_handler(theme="material")
+ assert handler.collect("mkdocstrings", {"docstring_style": None})
+
+
+@pytest.mark.parametrize(
+ "handler",
+ [
+ {"theme": "mkdocs"},
+ {"theme": "readthedocs"},
+ {"theme": {"name": "material"}},
+ ],
+ indirect=["handler"],
+)
+def test_render_docstring_examples_section(handler):
+ """Assert docstrings' examples section can be rendered.
+
+ Parameters:
+ handler: A handler instance (parametrized).
+ """
+ section = DocstringSectionExamples(
+ value=[
+ (DocstringSectionKind.text, "This is an example."),
+ (DocstringSectionKind.examples, ">>> print('Hello')\nHello"),
+ ],
+ )
+ template = handler.env.get_template("docstring/examples.html")
+ rendered = template.render(section=section)
+ assert "<p>This is an example.</p>" in rendered
+ assert "print" in rendered
+ assert "Hello" in rendered

tests/test_handler.py

@@ -0,0 +1,11 @@
+"""Tests for the `rendering` module."""
+
+from mkdocstrings_handlers.python import rendering
+
+
+def test_format_code_and_signature():
+ """Assert code and signatures can be Black-formatted."""
+ assert rendering.do_format_code("print('Hello')", 100)
+ assert rendering.do_format_code('print("Hello")', 100)
+ assert rendering.do_format_signature("(param: str = 'hello') -> 'Class'", 100)
+ assert rendering.do_format_signature('(param: str = "hello") -> "Class"', 100)

tests/test_renderer.py

@@ -35,6 +35,6 @@ def test_render_themes_templates_python(module, plugin):
  plugin: Pytest fixture: [tests.conftest.fixture_plugin][].
  """
  handler = plugin.handlers.get_handler("python")
- handler.renderer._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
- data = handler.collector.collect(module, {})
- handler.renderer.render(data, {})
+ handler._update_env(plugin.md, plugin.handlers._config) # noqa: WPS437
+ data = handler.collect(module, {})
+ handler.render(data, {})