Skip to content

Commit

Permalink
refactor: Use new mkdocstrings_handlers namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Apr 1, 2022
1 parent 171faf1 commit d688c87
Show file tree
Hide file tree
Showing 39 changed files with 19 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/usage.md
Expand Up @@ -73,7 +73,7 @@ Option | Type | Description | Default

### Rendering

::: mkdocstrings.handlers.python:PythonRenderer.default_config
::: mkdocstrings_handlers.python.renderer:PythonRenderer.default_config
rendering:
show_root_toc_entry: false

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Expand Up @@ -46,7 +46,8 @@ Funding = "https://github.com/sponsors/pawamoy"

[tool.pdm]
version = {use_scm = true}
includes = ["src/mkdocstrings"]
includes = ["src/mkdocstrings_handlers"]
editable-backend = "editables"

[tool.pdm.dev-dependencies]
duty = ["duty>=0.7"]
Expand Down
File renamed without changes.
5 changes: 5 additions & 0 deletions src/mkdocstrings_handlers/python/__init__.py
@@ -0,0 +1,5 @@
"""This package implements a handler for the Python language."""

from mkdocstrings_handlers.python.handler import get_handler

__all__ = ["get_handler"] # noqa: WPS410
Expand Up @@ -120,7 +120,7 @@ def collect(self, identifier: str, config: dict) -> CollectorItem:
Then we pick up the only object within the `objects` list (there's always only one, because we collect
them one by one), rebuild it's categories lists
(see [`rebuild_category_lists()`][mkdocstrings.handlers.python.collector.rebuild_category_lists]),
(see [`rebuild_category_lists()`][mkdocstrings_handlers.python.collector.rebuild_category_lists]),
and return it.
Arguments:
Expand Down
Expand Up @@ -4,10 +4,10 @@
from typing import Any, BinaryIO, Iterator, List, Optional, Tuple

from mkdocstrings.handlers.base import BaseHandler
from mkdocstrings.handlers.python.collector import PythonCollector
from mkdocstrings.handlers.python.renderer import PythonRenderer
from mkdocstrings.inventory import Inventory
from mkdocstrings.loggers import get_logger
from mkdocstrings_handlers.python.collector import PythonCollector
from mkdocstrings_handlers.python.renderer import PythonRenderer

# TODO: add a deprecation warning once the new handler handles 95% of use-cases

Expand Down
Expand Up @@ -23,7 +23,7 @@ class PythonRenderer(BaseRenderer):
Attributes:
fallback_theme: The theme to fallback to.
default_config: The default rendering options,
see [`default_config`][mkdocstrings.handlers.python.PythonRenderer.default_config].
see [`default_config`][mkdocstrings_handlers.python.renderer.PythonRenderer.default_config].
"""

fallback_theme = "material"
Expand Down
4 changes: 2 additions & 2 deletions tests/test_collector.py
Expand Up @@ -5,7 +5,7 @@
import pytest

from mkdocstrings.handlers.base import CollectionError
from mkdocstrings.handlers.python import collector
from mkdocstrings_handlers.python import collector


def test_init():
Expand All @@ -28,7 +28,7 @@ def test_collect_result_error(retval, exp_res):
retval: Return value to mock `json.loads` with.
exp_res: Expected result.
"""
with mock.patch("mkdocstrings.handlers.python.collector.json.loads") as m_loads:
with mock.patch("mkdocstrings_handlers.python.collector.json.loads") as m_loads:
with pytest.raises(CollectionError) as excinfo: # noqa: PT012
m_loads.return_value = retval
obj = collector.PythonCollector()
Expand Down
4 changes: 2 additions & 2 deletions tests/test_renderer.py
Expand Up @@ -2,8 +2,8 @@

from copy import deepcopy

from mkdocstrings.handlers.python.collector import rebuild_category_lists
from mkdocstrings.handlers.python.renderer import _sort_key_alphabetical, _sort_key_source, sort_object # noqa: WPS450
from mkdocstrings_handlers.python.collector import rebuild_category_lists
from mkdocstrings_handlers.python.renderer import _sort_key_alphabetical, _sort_key_source, sort_object # noqa: WPS450


def test_members_order():
Expand Down
4 changes: 3 additions & 1 deletion tests/test_themes.py
Expand Up @@ -22,8 +22,10 @@
"mkdocstrings.loggers",
"mkdocstrings.plugin",
"mkdocstrings.handlers.base",
"mkdocstrings.handlers.python",
"mkdocstrings.handlers.rendering",
"mkdocstrings_handlers.python.renderer",
"mkdocstrings_handlers.python.collector",
"mkdocstrings_handlers.python.handler",
],
)
@pytest.mark.skipif(sys.version_info < (3, 7), reason="material is not installed on Python 3.6")
Expand Down

0 comments on commit d688c87

Please sign in to comment.