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
|
from __future__ import annotations
import logging
import pathlib
import runpy
import tempfile
import urllib.parse
from mkdocs.config import Config
from mkdocs.plugins import BasePlugin
from mkdocs.structure.files import Files
from mkdocs.structure.pages import Page
try:
from mkdocs.exceptions import PluginError
except ImportError:
PluginError = SystemExit # type: ignore
from .config_items import ListOfFiles
from .editor import FilesEditor
try:
from mkdocs.plugins import event_priority
except ImportError:
event_priority = lambda priority: lambda f: f # No-op fallback
log = logging.getLogger(f"mkdocs.plugins.{__name__}")
class GenFilesPlugin(BasePlugin):
config_scheme = (("scripts", ListOfFiles(required=True)),)
def on_files(self, files: Files, config: Config) -> Files:
self._dir = tempfile.TemporaryDirectory(prefix="mkdocs_gen_files_")
with FilesEditor(files, config, self._dir.name) as ed:
for file_name in self.config["scripts"]:
try:
runpy.run_path(file_name)
except SystemExit as e:
if e.code:
raise PluginError(f"Script {file_name!r} caused {e!r}")
self._edit_paths = dict(ed.edit_paths)
return ed.files
def on_page_content(self, html, page: Page, config: Config, files: Files):
repo_url = config.get("repo_url", None)
edit_uri = config.get("edit_uri", None)
src_path = pathlib.PurePath(page.file.src_path).as_posix()
if src_path in self._edit_paths:
path = self._edit_paths.pop(src_path)
if repo_url and edit_uri:
# Ensure urljoin behavior is correct
if not edit_uri.startswith(("?", "#")) and not repo_url.endswith("/"):
repo_url += "/"
page.edit_url = path and urllib.parse.urljoin(
urllib.parse.urljoin(repo_url, edit_uri), path
)
return html
@event_priority(-100)
def on_post_build(self, config: Config):
self._dir.cleanup()
unused_edit_paths = {k: str(v) for k, v in self._edit_paths.items() if v}
if unused_edit_paths:
msg = "mkdocs_gen_files: These set_edit_path invocations went unused (the files don't exist): %r"
log.warning(msg, unused_edit_paths)
|
