gen_credits.py
1 """Script to generate the project's credits.""" 2 3 from __future__ import annotations 4 5 import os 6 import sys 7 from collections import defaultdict 8 from collections.abc import Iterable 9 from importlib.metadata import distributions 10 from itertools import chain 11 from pathlib import Path 12 from textwrap import dedent 13 from typing import Union 14 15 from jinja2 import StrictUndefined 16 from jinja2.sandbox import SandboxedEnvironment 17 from packaging.requirements import Requirement 18 19 # YORE: EOL 3.10: Replace block with line 2. 20 if sys.version_info >= (3, 11): 21 import tomllib 22 else: 23 import tomli as tomllib 24 25 project_dir = Path(os.getenv("MKDOCS_CONFIG_DIR", ".")) 26 with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file: 27 pyproject = tomllib.load(pyproject_file) 28 project = pyproject["project"] 29 project_name = project["name"] 30 devdeps = [dep for dep in pyproject["dependency-groups"]["dev"] if not dep.startswith("-e")] 31 32 PackageMetadata = dict[str, Union[str, Iterable[str]]] 33 Metadata = dict[str, PackageMetadata] 34 35 36 def _merge_fields(metadata: dict) -> PackageMetadata: 37 fields = defaultdict(list) 38 for header, value in metadata.items(): 39 fields[header.lower()].append(value.strip()) 40 return { 41 field: value if len(value) > 1 or field in ("classifier", "requires-dist") else value[0] 42 for field, value in fields.items() 43 } 44 45 46 def _norm_name(name: str) -> str: 47 return name.replace("_", "-").replace(".", "-").lower() 48 49 50 def _requirements(deps: list[str]) -> dict[str, Requirement]: 51 return {_norm_name((req := Requirement(dep)).name): req for dep in deps} 52 53 54 def _extra_marker(req: Requirement) -> str | None: 55 if not req.marker: 56 return None 57 try: 58 return next(marker[2].value for marker in req.marker._markers if getattr(marker[0], "value", None) == "extra") 59 except StopIteration: 60 return None 61 62 63 def _get_metadata() -> Metadata: 64 metadata = {} 65 for pkg in distributions(): 66 name = _norm_name(pkg.name) # type: ignore[attr-defined,unused-ignore] 67 metadata[name] = _merge_fields(pkg.metadata) # type: ignore[arg-type] 68 metadata[name]["spec"] = set() 69 metadata[name]["extras"] = set() 70 metadata[name].setdefault("summary", "") 71 _set_license(metadata[name]) 72 return metadata 73 74 75 def _set_license(metadata: PackageMetadata) -> None: 76 license_field = metadata.get("license-expression", metadata.get("license", "")) 77 license_name = license_field if isinstance(license_field, str) else " + ".join(license_field) 78 check_classifiers = license_name in ("UNKNOWN", "Dual License", "") or license_name.count("\n") 79 if check_classifiers: 80 license_names = [] 81 for classifier in metadata["classifier"]: 82 if classifier.startswith("License ::"): 83 license_names.append(classifier.rsplit("::", 1)[1].strip()) 84 license_name = " + ".join(license_names) 85 metadata["license"] = license_name or "?" 86 87 88 def _get_deps(base_deps: dict[str, Requirement], metadata: Metadata) -> Metadata: 89 deps = {} 90 for dep_name, dep_req in base_deps.items(): 91 if dep_name not in metadata or dep_name == "aria2p": 92 continue 93 metadata[dep_name]["spec"] |= {str(spec) for spec in dep_req.specifier} # type: ignore[operator] 94 metadata[dep_name]["extras"] |= dep_req.extras # type: ignore[operator] 95 deps[dep_name] = metadata[dep_name] 96 97 again = True 98 while again: 99 again = False 100 for pkg_name in metadata: 101 if pkg_name in deps: 102 for pkg_dependency in metadata[pkg_name].get("requires-dist", []): 103 requirement = Requirement(pkg_dependency) 104 dep_name = _norm_name(requirement.name) 105 extra_marker = _extra_marker(requirement) 106 if ( 107 dep_name in metadata 108 and dep_name not in deps 109 and dep_name != project["name"] 110 and (not extra_marker or extra_marker in deps[pkg_name]["extras"]) 111 ): 112 metadata[dep_name]["spec"] |= {str(spec) for spec in requirement.specifier} # type: ignore[operator] 113 deps[dep_name] = metadata[dep_name] 114 again = True 115 116 return deps 117 118 119 def _render_credits() -> str: 120 metadata = _get_metadata() 121 dev_dependencies = _get_deps(_requirements(devdeps), metadata) 122 prod_dependencies = _get_deps( 123 _requirements( 124 chain( # type: ignore[arg-type] 125 project.get("dependencies", []), 126 chain(*project.get("optional-dependencies", {}).values()), 127 ), 128 ), 129 metadata, 130 ) 131 132 template_data = { 133 "project_name": project_name, 134 "prod_dependencies": sorted(prod_dependencies.values(), key=lambda dep: str(dep["name"]).lower()), 135 "dev_dependencies": sorted(dev_dependencies.values(), key=lambda dep: str(dep["name"]).lower()), 136 "more_credits": "http://pawamoy.github.io/credits/", 137 } 138 template_text = dedent( 139 """ 140 # Credits 141 142 These projects were used to build *{{ project_name }}*. **Thank you!** 143 144 [Python](https://www.python.org/) | 145 [uv](https://github.com/astral-sh/uv) | 146 [copier-uv](https://github.com/pawamoy/copier-uv) 147 148 {% macro dep_line(dep) -%} 149 [{{ dep.name }}](https://pypi.org/project/{{ dep.name }}/) | {{ dep.summary }} | {{ ("`" ~ dep.spec|sort(reverse=True)|join(", ") ~ "`") if dep.spec else "" }} | `{{ dep.version }}` | {{ dep.license }} 150 {%- endmacro %} 151 152 {% if prod_dependencies -%} 153 ### Runtime dependencies 154 155 Project | Summary | Version (accepted) | Version (last resolved) | License 156 ------- | ------- | ------------------ | ----------------------- | ------- 157 {% for dep in prod_dependencies -%} 158 {{ dep_line(dep) }} 159 {% endfor %} 160 161 {% endif -%} 162 {% if dev_dependencies -%} 163 ### Development dependencies 164 165 Project | Summary | Version (accepted) | Version (last resolved) | License 166 ------- | ------- | ------------------ | ----------------------- | ------- 167 {% for dep in dev_dependencies -%} 168 {{ dep_line(dep) }} 169 {% endfor %} 170 171 {% endif -%} 172 {% if more_credits %}**[More credits from the author]({{ more_credits }})**{% endif %} 173 """, 174 ) 175 jinja_env = SandboxedEnvironment(undefined=StrictUndefined) 176 return jinja_env.from_string(template_text).render(**template_data) 177 178 179 print(_render_credits())