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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
|
from __future__ import annotations as _annotations
import json
import logging
import os
import re
import textwrap
from pathlib import Path
from textwrap import indent
import autoflake
import pyupgrade._main as pyupgrade_main # type: ignore
import requests
import tomli
import yaml
from build.__main__ import (
build_package,
) # Might be private, but there's currently no public API to programmatically build wheels..
from jinja2 import Template # type: ignore
from mkdocs.config.defaults import MkDocsConfig
from mkdocs.exceptions import PluginError
from mkdocs.structure.files import Files
from mkdocs.structure.pages import Page
from packaging.version import Version
logger = logging.getLogger('mkdocs.plugin')
THIS_DIR = Path(__file__).parent
DOCS_DIR = THIS_DIR.parent
PROJECT_ROOT = DOCS_DIR.parent
try:
from .conversion_table import conversion_table
except ImportError:
# Due to how MkDocs requires this file to be specified (as a path and not a
# dot-separated module name), relative imports don't work:
# MkDocs is adding the dir. of this file to `sys.path` and uses
# `importlib.spec_from_file_location` and `module_from_spec`, which isn't ideal.
from conversion_table import conversion_table
# Start definition of MkDocs hooks
def on_pre_build(config: MkDocsConfig) -> None:
"""
Before the build starts.
"""
add_changelog()
if not config.site_url:
raise PluginError("'site_url' must be set")
add_mkdocs_run_deps(config.site_url)
def on_page_markdown(markdown: str, page: Page, config: MkDocsConfig, files: Files) -> str:
"""
Called on each file after it is read and before it is converted to HTML.
"""
markdown = upgrade_python(markdown)
markdown = insert_json_output(markdown)
if md := render_index(markdown, page):
return md
if md := render_why(markdown, page):
return md
if md := render_pydantic_settings(markdown, page):
return md
elif md := build_schema_mappings(markdown, page):
return md
elif md := build_conversion_table(markdown, page):
return md
elif md := devtools_example(markdown, page):
return md
elif md := populate_pydantic_people(markdown, page):
return md
else:
return markdown
# End definition of MkDocs hooks
def add_changelog() -> None:
history = (PROJECT_ROOT / 'HISTORY.md').read_text(encoding='utf-8')
history = re.sub(r'(\s)@([\w\-]+)', r'\1[@\2](https://github.com/\2)', history, flags=re.I)
history = re.sub(r'\[GitHub release]\(', r'[:simple-github: GitHub release](', history)
history = re.sub('@@', '@', history)
new_file = DOCS_DIR / 'changelog.md'
# avoid writing file unless the content has changed to avoid infinite build loop
if not new_file.is_file() or new_file.read_text(encoding='utf-8') != history:
new_file.write_text(history, encoding='utf-8')
def add_mkdocs_run_deps(site_url: str) -> None:
# set the pydantic, pydantic-core, pydantic-extra-types versions to configure for running examples in the browser
pyproject_toml = (PROJECT_ROOT / 'pyproject.toml').read_text()
m = re.search(r'pydantic-core==(.+?)["\']', pyproject_toml)
if not m:
logger.info(
"Could not find pydantic-core version in pyproject.toml, this is expected if you're using a git ref"
)
return
pydantic_core_version = m.group(1)
version_py = (PROJECT_ROOT / 'pydantic' / 'version.py').read_text()
pydantic_version_str: str = re.search(r'^VERSION ?= (["\'])(.+)\1', version_py, flags=re.M).group(2) # pyright: ignore[reportOptionalMemberAccess]
if os.getenv('CI') and Version(pydantic_version_str).local == 'dev':
build_package(
PROJECT_ROOT,
DOCS_DIR,
distributions=['wheel'],
)
wheel_file = next(DOCS_DIR.glob('*.whl'))
pydantic_dep = f'{site_url.removesuffix("/").removesuffix("/latest")}/dev/{wheel_file.name}'
else:
pydantic_dep = f'pydantic=={pydantic_version_str}'
uv_lock = (PROJECT_ROOT / 'uv.lock').read_text()
pydantic_extra_types_version: str = re.search(r'name = "pydantic-extra-types"\nversion = "(.+?)"', uv_lock).group(1) # pyright: ignore[reportOptionalMemberAccess]
mkdocs_run_deps = json.dumps(
[
pydantic_dep,
'email-validator>=2.0.0',
f'pydantic-core=={pydantic_core_version}',
f'pydantic-extra-types=={pydantic_extra_types_version}',
]
)
logger.info('Setting mkdocs_run_deps=%s', mkdocs_run_deps)
html = f"""\
<script>
window.mkdocs_run_deps = {mkdocs_run_deps}
</script>
"""
path = DOCS_DIR / 'theme/mkdocs_run_deps.html'
path.write_text(html)
MIN_MINOR_VERSION = 9
MAX_MINOR_VERSION = 13
def upgrade_python(markdown: str) -> str:
"""
Apply pyupgrade to all Python code blocks, unless explicitly skipped, create a tab for each version.
"""
def add_tabs(match: re.Match[str]) -> str:
prefix = match.group(1)
if 'upgrade="skip"' in prefix:
return match.group(0)
if m := re.search(r'requires="3.(\d+)"', prefix):
min_minor_version = int(m.group(1))
else:
min_minor_version = MIN_MINOR_VERSION
py_code = match.group(2)
numbers = match.group(3)
# import devtools
# devtools.debug(numbers)
output = []
last_code = py_code
for minor_version in range(min_minor_version, MAX_MINOR_VERSION + 1):
if minor_version == min_minor_version:
tab_code = py_code
else:
tab_code = _upgrade_code(py_code, minor_version)
if tab_code == last_code:
continue
last_code = tab_code
content = indent(f'{prefix}\n{tab_code}```{numbers}', ' ' * 4)
output.append(f'=== "Python 3.{minor_version} and above"\n\n{content}')
if len(output) == 1:
return match.group(0)
else:
return '\n\n'.join(output)
# Note: we should move away from this regex approach. It does not handle edge cases (indented code blocks inside
# other blocks, etc) and can lead to bugs in the rendering of annotations. Edit with care and make sure the rendered
# documentation does not break:
return re.sub(r'(``` *py.*?)\n(.+?)^```(\s+(?:^\d+\. (?:[^\n][\n]?)+\n?)*)', add_tabs, markdown, flags=re.M | re.S)
def _upgrade_code(code: str, min_version: int) -> str:
upgraded = pyupgrade_main._fix_plugins(
code,
settings=pyupgrade_main.Settings(
min_version=(3, min_version),
keep_percent_format=True,
keep_mock=False,
keep_runtime_typing=True,
),
)
return autoflake.fix_code(upgraded, remove_all_unused_imports=True)
def insert_json_output(markdown: str) -> str:
"""
Find `output="json"` code fence tags and replace with a separate JSON section
"""
def replace_json(m: re.Match[str]) -> str:
start, attrs, code = m.groups()
def replace_last_print(m2: re.Match[str]) -> str:
ind, json_text = m2.groups()
json_text = indent(json.dumps(json.loads(json_text), indent=2), ind)
# no trailing fence as that's not part of code
return f'\n{ind}```\n\n{ind}JSON output:\n\n{ind}```json\n{json_text}\n'
code = re.sub(r'\n( *)"""(.*?)\1"""\n$', replace_last_print, code, flags=re.S)
return f'{start}{attrs}{code}{start}\n'
return re.sub(r'(^ *```)([^\n]*?output="json"[^\n]*?\n)(.+?)\1', replace_json, markdown, flags=re.M | re.S)
def get_orgs_data() -> list[dict[str, str]]:
with (THIS_DIR / 'orgs.toml').open('rb') as f:
orgs_data = tomli.load(f)
return orgs_data['orgs']
tile_template = """
<div class="tile">
<a href="why/#org-{key}" title="{name}">
<img src="logos/{key}_logo.png" alt="{name}" />
</a>
</div>"""
def render_index(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'index.md':
return None
if version := os.getenv('PYDANTIC_VERSION'):
url = f'https://github.com/pydantic/pydantic/releases/tag/{version}'
version_str = f'Documentation for version: [{version}]({url})'
elif (version_ref := os.getenv('GITHUB_REF')) and version_ref.startswith('refs/tags/'):
version = re.sub('^refs/tags/', '', version_ref.lower())
url = f'https://github.com/pydantic/pydantic/releases/tag/{version}'
version_str = f'Documentation for version: [{version}]({url})'
elif sha := os.getenv('GITHUB_SHA'):
url = f'https://github.com/pydantic/pydantic/commit/{sha}'
sha = sha[:7]
version_str = f'Documentation for development version: [{sha}]({url})'
else:
version_str = 'Documentation for development version'
logger.info('Setting version prefix: %r', version_str)
markdown = re.sub(r'{{ *version *}}', version_str, markdown)
elements = [tile_template.format(**org) for org in get_orgs_data()]
orgs_grid = f'<div id="grid-container"><div id="company-grid" class="grid">{"".join(elements)}</div></div>'
return re.sub(r'{{ *organisations *}}', orgs_grid, markdown)
def render_why(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'why.md':
return None
with (THIS_DIR / 'using.toml').open('rb') as f:
using = tomli.load(f)['libs']
libraries = '\n'.join('* [`{repo}`](https://github.com/{repo}) {stars:,} stars'.format(**lib) for lib in using)
markdown = re.sub(r'{{ *libraries *}}', libraries, markdown)
default_description = '_(Based on the criteria described above)_'
elements = [
f'### {org["name"]} {{#org-{org["key"]}}}\n\n{org.get("description") or default_description}'
for org in get_orgs_data()
]
return re.sub(r'{{ *organisations *}}', '\n\n'.join(elements), markdown)
def render_pydantic_settings(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'concepts/pydantic_settings.md':
return None
req = requests.get('https://raw.githubusercontent.com/pydantic/pydantic-settings/main/docs/index.md')
if req.status_code != 200:
logger.warning(
'Got HTTP status %d when trying to fetch content of the `pydantic-settings` docs', req.status_code
)
return
docs_content = req.text.strip()
return re.sub(r'{{ *pydantic_settings *}}', docs_content, markdown)
def _generate_table_row(col_values: list[str]) -> str:
return f'| {" | ".join(col_values)} |\n'
def _generate_table_heading(col_names: list[str]) -> str:
return _generate_table_row(col_names) + _generate_table_row(['-'] * len(col_names))
def build_schema_mappings(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'usage/schema.md':
return None
col_names = [
'Python type',
'JSON Schema Type',
'Additional JSON Schema',
'Defined in',
'Notes',
]
table_text = _generate_table_heading(col_names)
with (THIS_DIR / 'schema_mappings.toml').open('rb') as f:
table = tomli.load(f)
for t in table.values():
py_type = t['py_type']
json_type = t['json_type']
additional = t['additional']
defined_in = t['defined_in']
notes = t['notes']
if additional and not isinstance(additional, str):
additional = json.dumps(additional)
cols = [f'`{py_type}`', f'`{json_type}`', f'`{additional}`' if additional else '', defined_in, notes]
table_text += _generate_table_row(cols)
return re.sub(r'{{ *schema_mappings_table *}}', table_text, markdown)
def build_conversion_table(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'concepts/conversion_table.md':
return None
filtered_table_predicates = {
'all': lambda r: True,
'json': lambda r: r.json_input,
'json_strict': lambda r: r.json_input and r.strict,
'python': lambda r: r.python_input,
'python_strict': lambda r: r.python_input and r.strict,
}
for table_id, predicate in filtered_table_predicates.items():
table_markdown = conversion_table.filtered(predicate).as_markdown()
table_markdown = textwrap.indent(table_markdown, ' ')
markdown = re.sub(rf'{{{{ *conversion_table_{table_id} *}}}}', table_markdown, markdown)
return markdown
def devtools_example(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'integrations/devtools.md':
return None
html = (THIS_DIR / 'devtools_output.html').read_text().strip('\n')
full_html = f'<div class="highlight">\n<pre><code>{html}</code></pre>\n</div>'
return re.sub(r'{{ *devtools_example *}}', full_html, markdown)
experts_template = Template(
"""
<div class="user-list user-list-center">
{% for user in people.experts %}
<div class="user">
<a href="{{ user.url }}" target="_blank">
<div class="avatar-wrapper">
<img src="{{ user.avatarUrl }}"/>
</div>
<div class="title">@{{ user.login }}</div>
</a>
<div class="count">Questions replied: {{ user.count }}</div>
</div>
{% endfor %}
</div>
"""
)
most_active_users_template = Template(
"""
<div class="user-list user-list-center">
{% for user in people.last_month_active %}
<div class="user">
<a href="{{ user.url }}" target="_blank">
<div class="avatar-wrapper">
<img src="{{ user.avatarUrl }}"/>
</div>
<div class="title">@{{ user.login }}</div>
</a>
<div class="count">Questions replied: {{ user.count }}</div>
</div>
{% endfor %}
</div>
"""
)
top_contributors_template = Template(
"""
<div class="user-list user-list-center">
{% for user in people.top_contributors %}
<div class="user">
<a href="{{ user.url }}" target="_blank">
<div class="avatar-wrapper">
<img src="{{ user.avatarUrl }}"/>
</div>
<div class="title">@{{ user.login }}</div>
</a>
<div class="count">Contributions: {{ user.count }}</div>
</div>
{% endfor %}
</div>
"""
)
top_reviewers_template = Template(
"""
<div class="user-list user-list-center">
{% for user in people.top_reviewers %}
<div class="user">
<a href="{{ user.url }}" target="_blank">
<div class="avatar-wrapper">
<img src="{{ user.avatarUrl }}"/>
</div>
<div class="title">@{{ user.login }}</div>
</a>
<div class="count">Reviews: {{ user.count }}</div>
</div>
{% endfor %}
</div>
"""
)
maintainers_template = Template(
"""
<div class="user-list user-list-center">
{% for user in people.maintainers %}
<div class="user">
<a href="{{ user.url }}" target="_blank">
<div class="avatar-wrapper">
<img src="{{ user.avatarUrl }}"/>
</div>
<div class="title">@{{ user.login }}</div>
</a>
</div>
{% endfor %}
</div>
"""
)
def populate_pydantic_people(markdown: str, page: Page) -> str | None:
if page.file.src_uri != 'pydantic_people.md':
return None
# read people.yml file data
with (THIS_DIR / 'people.yml').open('rb') as f:
people = yaml.load(f, Loader=yaml.FullLoader)
# Render the templates
for name, template in [
('experts', experts_template),
('most_active_users', most_active_users_template),
('top_contributors', top_contributors_template),
('top_reviewers', top_reviewers_template),
('maintainers', maintainers_template),
]:
rendered = template.render(people=people)
markdown = re.sub(f'{{{{ {name} }}}}', rendered, markdown)
return markdown
|