chore: Template upgrade

pawamoy · pawamoy · commit a22bbdb60908 · 2021-02-28T15:50:20.000+01:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.1.9
+_commit: 0.2.1
 _src_path: gh:pawamoy/copier-poetry
 author_email: pawamoy@pm.me
 author_fullname: "Timoth\xE9e Mazzucotelli"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,6 +43,7 @@ jobs:
       run: |
         pip install poetry
         poetry install -v -E numpy-style || { rm -rf .venv; poetry install -v -E numpy-style; }
+        poetry update
 
     - name: Check if the documentation builds correctly
       run: poetry run duty check-docs
@@ -86,6 +87,7 @@ jobs:
       run: |
         pip install poetry
         poetry install -v -E numpy-style || { rm -rf .venv; poetry install -v -E numpy-style; }
+        poetry update
 
     - name: Run the test suite
       run: poetry run duty test
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -38,7 +38,7 @@ Run `make help` to see all the available actions!
 
 ## Tasks
 
-This project uses [Duty](https://github.com/pawamoy/duty) to run tasks.
+This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
 A Makefile is also provided. The Makefile will try to run certain tasks
 on multiple Python versions. If for some reason you don't want to run the task
 on multiple Python versions, you can do one of the following:
diff --git a/Makefile b/Makefile
@@ -7,7 +7,7 @@ args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
 check_code_quality_args = files
 docs_serve_args = host port
 release_args = version
-test_args = match
+test_args = cleancov match
 
 BASIC_DUTIES = \
 	changelog \
diff --git a/config/coverage.ini b/config/coverage.ini
@@ -6,7 +6,7 @@ source =
 [coverage:run]
 branch = true
 source =
-  pytkdocs
+  src/pytkdocs
   tests
 parallel = true
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1 +1 @@
-{!CHANGELOG.md!}
+--8<-- "CHANGELOG.md"
diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md
@@ -1 +1 @@
-{!CODE_OF_CONDUCT.md!}
+--8<-- "CODE_OF_CONDUCT.md"
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1 +1 @@
-{!CONTRIBUTING.md!}
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/credits.md b/docs/credits.md
@@ -1 +1 @@
-{!CREDITS.md!}
+{{ credits() }}
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1 @@
-{!README.md!}
+--8<-- "README.md"
diff --git a/docs/license.md b/docs/license.md
@@ -0,0 +1,3 @@
+```
+--8<-- "LICENSE"
+```
diff --git a/docs/macros.py b/docs/macros.py
@@ -0,0 +1,81 @@
+"""Macros and filters made available in Markdown pages."""
+
+import functools
+from itertools import chain
+from pathlib import Path
+
+import httpx
+import toml
+from jinja2 import StrictUndefined
+from jinja2.sandbox import SandboxedEnvironment
+from pip._internal.commands.show import search_packages_info  # noqa: WPS436 (no other way?)
+
+
+def get_credits_data() -> dict:
+    """
+    Return data used to generate the credits file.
+
+    Returns:
+        Data required to render the credits template.
+    """
+    project_dir = Path(__file__).parent.parent
+    metadata = toml.load(project_dir / "pyproject.toml")["tool"]["poetry"]
+    lock_data = toml.load(project_dir / "poetry.lock")
+    project_name = metadata["name"]
+
+    poetry_dependencies = chain(metadata["dependencies"].keys(), metadata["dev-dependencies"].keys())
+    direct_dependencies = {dep.lower() for dep in poetry_dependencies}
+    direct_dependencies.remove("python")
+    indirect_dependencies = {pkg["name"].lower() for pkg in lock_data["package"]}
+    indirect_dependencies -= direct_dependencies
+    dependencies = direct_dependencies | indirect_dependencies
+
+    packages = {}
+    for pkg in search_packages_info(dependencies):
+        pkg = {_: pkg[_] for _ in ("name", "home-page")}
+        packages[pkg["name"].lower()] = pkg
+
+    # all packages might not be credited,
+    # like the ones that are now part of the standard library
+    # or the ones that are only used on other operating systems,
+    # and therefore are not installed,
+    # but it's not that important
+
+    return {
+        "project_name": project_name,
+        "direct_dependencies": sorted(direct_dependencies),
+        "indirect_dependencies": sorted(indirect_dependencies),
+        "package_info": packages,
+    }
+
+
+@functools.lru_cache(maxsize=None)
+def get_credits():
+    """
+    Return credits as Markdown.
+
+    Returns:
+        The credits page Markdown.
+    """
+    jinja_env = SandboxedEnvironment(undefined=StrictUndefined)
+    commit = "166758a98d5e544aaa94fda698128e00733497f4"
+    template_url = f"https://raw.githubusercontent.com/pawamoy/jinja-templates/{commit}/credits.md"
+    template_data = get_credits_data()
+    template_text = httpx.get(template_url).text
+    return jinja_env.from_string(template_text).render(**template_data)
+
+
+def define_env(env):
+    """
+    Add macros and filters into the Jinja2 environment.
+
+    This hook is called by `mkdocs-macros-plugin`
+    when building the documentation.
+
+    Arguments:
+        env: An object used to add macros and filters to the environment.
+    """
+
+    @env.macro  # noqa: WPS430 (nested function)
+    def credits():  # noqa: W0612,W0622,WPS430 (unused, shadows credits)
+        return get_credits()
diff --git a/duties.py b/duties.py
@@ -2,20 +2,16 @@
 
 import os
 import re
-from itertools import chain
 from pathlib import Path
 from shutil import which
 from typing import List, Optional, Pattern
 
 import httpx
-import toml
 from duty import duty
 from git_changelog.build import Changelog, Version
-from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
-from pip._internal.commands.show import search_packages_info  # noqa: WPS436 (no other way?)
 
-PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "scripts", "duties.py"))
+PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "docs/macros.py"))
 PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS)
 PY_SRC = " ".join(PY_SRC_LIST)
 TESTING = os.environ.get("TESTING", "0") in {"1", "true"}
@@ -102,7 +98,7 @@ def update_changelog(
         template_url: The URL to the Jinja template used to render contents.
         commit_style: The style of commit messages to parse.
     """
-    env = SandboxedEnvironment(autoescape=True)
+    env = SandboxedEnvironment(autoescape=False)
     template = env.from_string(httpx.get(template_url).text)
     changelog = Changelog(".", style=commit_style)  # noqa: W0621 (shadowing changelog)
 
@@ -233,78 +229,7 @@ def clean(ctx):
     ctx.run("find . -name '*.rej' -delete")
 
 
-def get_credits_data() -> dict:
-    """
-    Return data used to generate the credits file.
-
-    Returns:
-        Data required to render the credits template.
-    """
-    project_dir = Path(__file__).parent.parent
-    metadata = toml.load(project_dir / "pyproject.toml")["tool"]["poetry"]
-    lock_data = toml.load(project_dir / "poetry.lock")
-    project_name = metadata["name"]
-
-    poetry_dependencies = chain(metadata["dependencies"].keys(), metadata["dev-dependencies"].keys())
-    direct_dependencies = {dep.lower() for dep in poetry_dependencies}
-    direct_dependencies.remove("python")
-    indirect_dependencies = {pkg["name"].lower() for pkg in lock_data["package"]}
-    indirect_dependencies -= direct_dependencies
-    dependencies = direct_dependencies | indirect_dependencies
-
-    packages = {}
-    for pkg in search_packages_info(dependencies):
-        pkg = {_: pkg[_] for _ in ("name", "home-page")}
-        packages[pkg["name"].lower()] = pkg
-
-    for dependency in dependencies:
-        if dependency not in packages:
-            pkg_data = httpx.get(f"https://pypi.python.org/pypi/{dependency}/json").json()["info"]
-            home_page = pkg_data["home_page"] or pkg_data["project_url"] or pkg_data["package_url"]
-            pkg_name = pkg_data["name"]
-            package = {"name": pkg_name, "home-page": home_page}
-            packages.update({pkg_name.lower(): package})
-
-    return {
-        "project_name": project_name,
-        "direct_dependencies": sorted(direct_dependencies),
-        "indirect_dependencies": sorted(indirect_dependencies),
-        "package_info": packages,
-    }
-
-
 @duty
-def docs_regen(ctx):
-    """
-    Regenerate some documentation pages.
-
-    Arguments:
-        ctx: The context instance (passed automatically).
-    """
-    url_prefix = "https://raw.githubusercontent.com/pawamoy/jinja-templates/master/"
-    regen_list = (("CREDITS.md", get_credits_data, url_prefix + "credits.md"),)
-
-    def regen() -> int:  # noqa: WPS430 (nested function)
-        """
-        Regenerate pages listed in global `REGEN` list.
-
-        Returns:
-            An exit code.
-        """
-        env = SandboxedEnvironment(undefined=StrictUndefined)
-        for target, get_data, template in regen_list:
-            print("Regenerating", target)  # noqa: WPS421 (print)
-            template_data = get_data()
-            template_text = httpx.get(template).text
-            rendered = env.from_string(template_text).render(**template_data)
-            with open(target, "w") as stream:
-                stream.write(rendered)
-        return 0
-
-    ctx.run(regen, title="Regenerating docfiles", pty=PTY)
-
-
-@duty(pre=[docs_regen])
 def docs(ctx):
     """
     Build the documentation locally.
@@ -315,7 +240,7 @@ def docs(ctx):
     ctx.run("mkdocs build", title="Building documentation")
 
 
-@duty(pre=[docs_regen])
+@duty
 def docs_serve(ctx, host="127.0.0.1", port=8000):
     """
     Serve the documentation (localhost:8000).
@@ -328,7 +253,7 @@ def docs_serve(ctx, host="127.0.0.1", port=8000):
     ctx.run(f"mkdocs serve -a {host}:{port}", title="Serving documentation", capture=False)
 
 
-@duty(pre=[docs_regen])
+@duty
 def docs_deploy(ctx):
     """
     Deploy the documentation on GitHub pages.
@@ -389,15 +314,18 @@ def coverage(ctx):
     ctx.run("coverage html --rcfile=config/coverage.ini")
 
 
-@duty(pre=[duty(lambda ctx: ctx.run("rm -f .coverage", silent=True))])
-def test(ctx, match=""):
+@duty
+def test(ctx, cleancov: bool = True, match: str = ""):
     """
     Run the test suite.
 
     Arguments:
         ctx: The context instance (passed automatically).
+        cleancov: Whether to remove the `.coverage` file before running the tests.
         match: A pytest expression to filter selected tests.
     """
+    if cleancov:
+        ctx.run("rm -f .coverage", silent=True)
     ctx.run(
         ["pytest", "-c", "config/pytest.ini", "-n", "auto", "-k", match, "tests"],
         title="Running tests",
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{!CHANGELOG.md!}`
	`1`	`+--8<-- "CHANGELOG.md"`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{!CODE_OF_CONDUCT.md!}`
	`1`	`+--8<-- "CODE_OF_CONDUCT.md"`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{!CONTRIBUTING.md!}`
	`1`	`+--8<-- "CONTRIBUTING.md"`