-
-
Notifications
You must be signed in to change notification settings - Fork 122
Expand file tree
/
Copy pathplugin.py
More file actions
372 lines (302 loc) · 15 KB
/
plugin.py
File metadata and controls
372 lines (302 loc) · 15 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
"""This module contains the "mkdocstrings" plugin for MkDocs.
The plugin instantiates a Markdown extension ([`MkdocstringsExtension`][mkdocstrings.extension.MkdocstringsExtension]),
and adds it to the list of Markdown extensions used by `mkdocs`
during the [`on_config` event hook](https://www.mkdocs.org/user-guide/plugins/#on_config).
Once the documentation is built, the [`on_post_build` event hook](https://www.mkdocs.org/user-guide/plugins/#on_post_build)
is triggered and calls the [`handlers.teardown()` method][mkdocstrings.handlers.base.Handlers.teardown]. This method is
used to teardown the handlers that were instantiated during documentation buildup.
Finally, when serving the documentation, it can add directories to watch
during the [`on_serve` event hook](https://www.mkdocs.org/user-guide/plugins/#on_serve).
"""
from __future__ import annotations
import functools
import gzip
import os
import sys
from concurrent import futures
from typing import TYPE_CHECKING, Any, BinaryIO, Callable, Iterable, List, Mapping, Tuple, TypeVar
from urllib import request
from mkdocs.config.config_options import Type as MkType
from mkdocs.plugins import BasePlugin
from mkdocs.utils import write_file
from mkdocs_autorefs.plugin import AutorefsPlugin
from mkdocstrings.extension import MkdocstringsExtension
from mkdocstrings.handlers.base import BaseHandler, Handlers
from mkdocstrings.loggers import get_logger
if TYPE_CHECKING:
from jinja2.environment import Environment
from mkdocs.config import Config
from mkdocs.livereload import LiveReloadServer
if sys.version_info < (3, 10):
from typing_extensions import ParamSpec
else:
from typing import ParamSpec
log = get_logger(__name__)
SELECTION_OPTS_KEY: str = "selection"
"""Deprecated. The name of the selection parameter in YAML configuration blocks."""
RENDERING_OPTS_KEY: str = "rendering"
"""Deprecated. The name of the rendering parameter in YAML configuration blocks."""
InventoryImportType = List[Tuple[str, Mapping[str, Any]]]
InventoryLoaderType = Callable[..., Iterable[Tuple[str, str]]]
P = ParamSpec("P")
R = TypeVar("R")
def list_to_tuple(function: Callable[P, R]) -> Callable[P, R]:
"""Decorater to convert lists to tuples in the arguments."""
def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
safe_args = [tuple(item) if isinstance(item, list) else item for item in args]
if kwargs:
kwargs = {key: tuple(value) if isinstance(value, list) else value for key, value in kwargs.items()} # type: ignore[assignment]
return function(*safe_args, **kwargs) # type: ignore[arg-type]
return wrapper
class MkdocstringsPlugin(BasePlugin):
"""An `mkdocs` plugin.
This plugin defines the following event hooks:
- `on_config`
- `on_env`
- `on_post_build`
- `on_serve`
Check the [Developing Plugins](https://www.mkdocs.org/user-guide/plugins/#developing-plugins) page of `mkdocs`
for more information about its plugin system.
"""
config_scheme: tuple[tuple[str, MkType]] = (
("watch", MkType(list, default=[])), # type: ignore[assignment]
("handlers", MkType(dict, default={})),
("default_handler", MkType(str, default="python")),
("custom_templates", MkType(str, default=None)),
("enable_inventory", MkType(bool, default=None)),
("enabled", MkType(bool, default=True)),
)
"""
The configuration options of `mkdocstrings`, written in `mkdocs.yml`.
Available options are:
- **`watch` (deprecated)**: A list of directories to watch. Only used when serving the documentation with mkdocs.
Whenever a file changes in one of directories, the whole documentation is built again, and the browser refreshed.
Deprecated in favor of the now built-in `watch` feature of MkDocs.
- **`default_handler`**: The default handler to use. The value is the name of the handler module. Default is "python".
- **`enabled`**: Whether to enable the plugin. Default is true. If false, *mkdocstrings* will not collect or render anything.
- **`handlers`**: Global configuration of handlers. You can set global configuration per handler, applied everywhere,
but overridable in each "autodoc" instruction. Example:
```yaml
plugins:
- mkdocstrings:
handlers:
python:
options:
selection_opt: true
rendering_opt: "value"
rust:
options:
selection_opt: 2
```
"""
css_filename = "assets/_mkdocstrings.css"
def __init__(self) -> None:
"""Initialize the object."""
super().__init__()
self._handlers: Handlers | None = None
@property
def handlers(self) -> Handlers:
"""Get the instance of [mkdocstrings.handlers.base.Handlers][] for this plugin/build.
Raises:
RuntimeError: If the plugin hasn't been initialized with a config.
Returns:
An instance of [mkdocstrings.handlers.base.Handlers][] (the same throughout the build).
"""
if not self._handlers:
raise RuntimeError("The plugin hasn't been initialized with a config yet")
return self._handlers
# TODO: remove once watch feature is removed
def on_serve(
self,
server: LiveReloadServer,
config: Config, # noqa: ARG002
builder: Callable,
*args: Any, # noqa: ARG002
**kwargs: Any, # noqa: ARG002
) -> None:
"""Watch directories.
Hook for the [`on_serve` event](https://www.mkdocs.org/user-guide/plugins/#on_serve).
In this hook, we add the directories specified in the plugin's configuration to the list of directories
watched by `mkdocs`. Whenever a change occurs in one of these directories, the documentation is built again
and the site reloaded.
Arguments:
server: The `livereload` server instance.
config: The MkDocs config object (unused).
builder: The function to build the site.
*args: Additional arguments passed by MkDocs.
**kwargs: Additional arguments passed by MkDocs.
"""
if not self.plugin_enabled:
return
if self.config["watch"]:
for element in self.config["watch"]:
log.debug(f"Adding directory '{element}' to watcher")
server.watch(element, builder)
def on_config(self, config: Config, **kwargs: Any) -> Config: # noqa: ARG002
"""Instantiate our Markdown extension.
Hook for the [`on_config` event](https://www.mkdocs.org/user-guide/plugins/#on_config).
In this hook, we instantiate our [`MkdocstringsExtension`][mkdocstrings.extension.MkdocstringsExtension]
and add it to the list of Markdown extensions used by `mkdocs`.
We pass this plugin's configuration dictionary to the extension when instantiating it (it will need it
later when processing markdown to get handlers and their global configurations).
Arguments:
config: The MkDocs config object.
**kwargs: Additional arguments passed by MkDocs.
Returns:
The modified config.
"""
if not self.plugin_enabled:
log.debug("Plugin is not enabled. Skipping.")
return config
log.debug("Adding extension to the list")
theme_name = config["theme"].name or os.path.dirname(config["theme"].dirs[0])
to_import: InventoryImportType = []
for handler_name, conf in self.config["handlers"].items():
for import_item in conf.pop("import", ()):
if isinstance(import_item, str):
import_item = {"url": import_item} # noqa: PLW2901
to_import.append((handler_name, import_item))
extension_config = {
"theme_name": theme_name,
"mdx": config["markdown_extensions"],
"mdx_configs": config["mdx_configs"],
"mkdocstrings": self.config,
"mkdocs": config,
}
self._handlers = Handlers(extension_config)
try:
# If autorefs plugin is explicitly enabled, just use it.
autorefs = config["plugins"]["autorefs"]
log.debug(f"Picked up existing autorefs instance {autorefs!r}")
except KeyError:
# Otherwise, add a limited instance of it that acts only on what's added through `register_anchor`.
autorefs = AutorefsPlugin()
autorefs.scan_toc = False
config["plugins"]["autorefs"] = autorefs
log.debug(f"Added a subdued autorefs instance {autorefs!r}")
# Add collector-based fallback in either case.
autorefs.get_fallback_anchor = self.handlers.get_anchors
mkdocstrings_extension = MkdocstringsExtension(extension_config, self.handlers, autorefs)
config["markdown_extensions"].append(mkdocstrings_extension)
config["extra_css"].insert(0, self.css_filename) # So that it has lower priority than user files.
self._inv_futures = {}
if to_import:
inv_loader = futures.ThreadPoolExecutor(4)
for handler_name, import_item in to_import:
loader = self.get_handler(handler_name).load_inventory
future = inv_loader.submit(
self._load_inventory, # type: ignore[misc]
loader,
**import_item,
)
self._inv_futures[future] = (loader, import_item)
inv_loader.shutdown(wait=False)
if self.config["watch"]:
self._warn_about_watch_option()
return config
@property
def inventory_enabled(self) -> bool:
"""Tell if the inventory is enabled or not.
Returns:
Whether the inventory is enabled.
"""
inventory_enabled = self.config["enable_inventory"]
if inventory_enabled is None:
inventory_enabled = any(handler.enable_inventory for handler in self.handlers.seen_handlers)
return inventory_enabled
@property
def plugin_enabled(self) -> bool:
"""Tell if the plugin is enabled or not.
Returns:
Whether the plugin is enabled.
"""
return self.config["enabled"]
def on_env(self, env: Environment, config: Config, *args: Any, **kwargs: Any) -> None: # noqa: ARG002
"""Extra actions that need to happen after all Markdown rendering and before HTML rendering.
Hook for the [`on_env` event](https://www.mkdocs.org/user-guide/plugins/#on_env).
- Write mkdocstrings' extra files into the site dir.
- Gather results from background inventory download tasks.
"""
if not self.plugin_enabled:
return
if self._handlers:
css_content = "\n".join(handler.extra_css for handler in self.handlers.seen_handlers)
write_file(css_content.encode("utf-8"), os.path.join(config["site_dir"], self.css_filename))
if self.inventory_enabled:
log.debug("Creating inventory file objects.inv")
inv_contents = self.handlers.inventory.format_sphinx()
write_file(inv_contents, os.path.join(config["site_dir"], "objects.inv"))
if self._inv_futures:
log.debug(f"Waiting for {len(self._inv_futures)} inventory download(s)")
futures.wait(self._inv_futures, timeout=30)
results = {}
# Reversed order so that pages from first futures take precedence:
for fut in reversed(list(self._inv_futures)):
try:
results.update(fut.result())
except Exception as error: # noqa: BLE001
loader, import_item = self._inv_futures[fut]
loader_name = loader.__func__.__qualname__
log.error(f"Couldn't load inventory {import_item} through {loader_name}: {error}") # noqa: TRY400
for page, identifier in results.items():
config["plugins"]["autorefs"].register_url(page, identifier)
self._inv_futures = {}
def on_post_build(
self,
config: Config, # noqa: ARG002
**kwargs: Any, # noqa: ARG002
) -> None:
"""Teardown the handlers.
Hook for the [`on_post_build` event](https://www.mkdocs.org/user-guide/plugins/#on_post_build).
This hook is used to teardown all the handlers that were instantiated and cached during documentation buildup.
For example, a handler could open a subprocess in the background and keep it open
to feed it "autodoc" instructions and get back JSON data. If so, it should then close the subprocess at some point:
the proper place to do this is in the collector's `teardown` method, which is indirectly called by this hook.
Arguments:
config: The MkDocs config object.
**kwargs: Additional arguments passed by MkDocs.
"""
if not self.plugin_enabled:
return
for future in self._inv_futures:
future.cancel()
if self._handlers:
log.debug("Tearing handlers down")
self.handlers.teardown()
def get_handler(self, handler_name: str) -> BaseHandler:
"""Get a handler by its name. See [mkdocstrings.handlers.base.Handlers.get_handler][].
Arguments:
handler_name: The name of the handler.
Returns:
An instance of a subclass of [`BaseHandler`][mkdocstrings.handlers.base.BaseHandler].
"""
return self.handlers.get_handler(handler_name)
@classmethod
# lru_cache does not allow mutable arguments such lists, but that is what we load from YAML config.
@list_to_tuple
@functools.lru_cache(maxsize=None)
def _load_inventory(cls, loader: InventoryLoaderType, url: str, **kwargs: Any) -> Mapping[str, str]:
"""Download and process inventory files using a handler.
Arguments:
loader: A function returning a sequence of pairs (identifier, url).
url: The URL to download and process.
**kwargs: Extra arguments to pass to the loader.
Returns:
A mapping from identifier to absolute URL.
"""
log.debug(f"Downloading inventory from {url!r}")
req = request.Request(url, headers={"Accept-Encoding": "gzip", "User-Agent": "mkdocstrings/0.15.0"})
with request.urlopen(req) as resp: # noqa: S310 (URL audit OK: comes from a checked-in config)
content: BinaryIO = resp
if "gzip" in resp.headers.get("content-encoding", ""):
content = gzip.GzipFile(fileobj=resp) # type: ignore[assignment]
result = dict(loader(content, url=url, **kwargs))
log.debug(f"Loaded inventory from {url!r}: {len(result)} items")
return result
@classmethod
@functools.lru_cache(maxsize=None) # Warn only once
def _warn_about_watch_option(cls) -> None:
log.info(
"DEPRECATION: mkdocstrings' watch feature is deprecated in favor of MkDocs' watch feature, "
"see https://www.mkdocs.org/user-guide/configuration/#watch",
)