1  """Script to generate the project's credits."""
  2  
  3  from __future__ import annotations
  4  
  5  import os
  6  import re
  7  import sys
  8  from importlib.metadata import PackageNotFoundError, metadata
  9  from itertools import chain
 10  from pathlib import Path
 11  from textwrap import dedent
 12  from typing import Mapping, cast
 13  
 14  from jinja2 import StrictUndefined
 15  from jinja2.sandbox import SandboxedEnvironment
 16  
 17  # TODO: Remove once support for Python 3.10 is dropped.
 18  if sys.version_info >= (3, 11):
 19      import tomllib
 20  else:
 21      import tomli as tomllib
 22  
 23  project_dir = Path(os.getenv("MKDOCS_CONFIG_DIR", "."))
 24  with project_dir.joinpath("pyproject.toml").open("rb") as pyproject_file:
 25      pyproject = tomllib.load(pyproject_file)
 26  project = pyproject["project"]
 27  pdm = pyproject["tool"]["pdm"]
 28  with project_dir.joinpath("pdm.lock").open("rb") as lock_file:
 29      lock_data = tomllib.load(lock_file)
 30  lock_pkgs = {pkg["name"].lower(): pkg for pkg in lock_data["package"]}
 31  project_name = project["name"]
 32  regex = re.compile(r"(?P<dist>[\w.-]+)(?P<spec>.*)$")
 33  
 34  
 35  def _get_license(pkg_name: str) -> str:
 36      try:
 37          data = metadata(pkg_name)
 38      except PackageNotFoundError:
 39          return "?"
 40      license_name = cast(dict, data).get("License", "").strip()
 41      multiple_lines = bool(license_name.count("\n"))
 42      # TODO: Remove author logic once all my packages licenses are fixed.
 43      author = ""
 44      if multiple_lines or not license_name or license_name == "UNKNOWN":
 45          for header, value in cast(dict, data).items():
 46              if header == "Classifier" and value.startswith("License ::"):
 47                  license_name = value.rsplit("::", 1)[1].strip()
 48              elif header == "Author-email":
 49                  author = value
 50      if license_name == "Other/Proprietary License" and "pawamoy" in author:
 51          license_name = "ISC"
 52      return license_name or "?"
 53  
 54  
 55  def _get_deps(base_deps: Mapping[str, Mapping[str, str]]) -> dict[str, dict[str, str]]:
 56      deps = {}
 57      for dep in base_deps:
 58          parsed = regex.match(dep).groupdict()  # type: ignore[union-attr]
 59          dep_name = parsed["dist"].lower()
 60          if dep_name not in lock_pkgs:
 61              continue
 62          deps[dep_name] = {"license": _get_license(dep_name), **parsed, **lock_pkgs[dep_name]}
 63  
 64      again = True
 65      while again:
 66          again = False
 67          for pkg_name in lock_pkgs:
 68              if pkg_name in deps:
 69                  for pkg_dependency in lock_pkgs[pkg_name].get("dependencies", []):
 70                      parsed = regex.match(pkg_dependency).groupdict()  # type: ignore[union-attr]
 71                      dep_name = parsed["dist"].lower()
 72                      if dep_name in lock_pkgs and dep_name not in deps and dep_name != project["name"]:
 73                          deps[dep_name] = {"license": _get_license(dep_name), **parsed, **lock_pkgs[dep_name]}
 74                          again = True
 75  
 76      return deps
 77  
 78  
 79  def _render_credits() -> str:
 80      dev_dependencies = _get_deps(chain(*pdm.get("dev-dependencies", {}).values()))  # type: ignore[arg-type]
 81      prod_dependencies = _get_deps(
 82          chain(  # type: ignore[arg-type]
 83              project.get("dependencies", []),
 84              chain(*project.get("optional-dependencies", {}).values()),
 85          ),
 86      )
 87  
 88      template_data = {
 89          "project_name": project_name,
 90          "prod_dependencies": sorted(prod_dependencies.values(), key=lambda dep: dep["name"]),
 91          "dev_dependencies": sorted(dev_dependencies.values(), key=lambda dep: dep["name"]),
 92          "more_credits": "http://pawamoy.github.io/credits/",
 93      }
 94      template_text = dedent(
 95          """
 96          # Credits
 97  
 98          These projects were used to build *{{ project_name }}*. **Thank you!**
 99  
100          [`python`](https://www.python.org/) |
101          [`pdm`](https://pdm.fming.dev/) |
102          [`copier-pdm`](https://github.com/pawamoy/copier-pdm)
103  
104          {% macro dep_line(dep) -%}
105          [`{{ dep.name }}`](https://pypi.org/project/{{ dep.name }}/) | {{ dep.summary }} | {{ ("`" ~ dep.spec ~ "`") if dep.spec else "" }} | `{{ dep.version }}` | {{ dep.license }}
106          {%- endmacro %}
107  
108          ### Runtime dependencies
109  
110          Project | Summary | Version (accepted) | Version (last resolved) | License
111          ------- | ------- | ------------------ | ----------------------- | -------
112          {% for dep in prod_dependencies -%}
113          {{ dep_line(dep) }}
114          {% endfor %}
115  
116          ### Development dependencies
117  
118          Project | Summary | Version (accepted) | Version (last resolved) | License
119          ------- | ------- | ------------------ | ----------------------- | -------
120          {% for dep in dev_dependencies -%}
121          {{ dep_line(dep) }}
122          {% endfor %}
123  
124          {% if more_credits %}**[More credits from the author]({{ more_credits }})**{% endif %}
125          """,
126      )
127      jinja_env = SandboxedEnvironment(undefined=StrictUndefined)
128      return jinja_env.from_string(template_text).render(**template_data)
129  
130  
131  print(_render_credits())