chore: Template upgrade

pawamoy · pawamoy · commit 028a8026dc13 · 2023-05-11T17:51:38.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.15.2
+_commit: 0.15.7
 _src_path: gh:pawamoy/copier-pdm.git
 author_email: pawamoy@pm.me
 author_fullname: Timothée Mazzucotelli
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,10 +32,10 @@ jobs:
         python-version: "3.8"
 
     - name: Resolving dependencies
-      run: pdm lock -v
+      run: pdm lock -v --no-cross-platform -G ci-quality
 
     - name: Install dependencies
-      run: pdm install -G duty -G docs -G quality -G typing -G security
+      run: pdm install -G ci-quality
 
     - name: Check if the documentation builds correctly
       run: pdm run duty check-docs
@@ -55,6 +55,7 @@ jobs:
   tests:
 
     strategy:
+      max-parallel: 4
       matrix:
         os:
         - ubuntu-latest
@@ -79,10 +80,10 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Resolving dependencies
-      run: pdm lock -v
+      run: pdm lock -v --no-cross-platform -G ci-tests
 
     - name: Install dependencies
-      run: pdm install --no-editable -G duty -G tests -G docs
+      run: pdm install --no-editable -G ci-tests
 
     - name: Run the test suite
       run: pdm run duty test
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,7 @@ pip-wheel-metadata/
 site/
 pdm.lock
 pdm.toml
+.pdm-plugins/
 .pdm-python
 __pypackages__/
 .mypy_cache/
diff --git a/Makefile b/Makefile
@@ -32,7 +32,7 @@ help:
 
 .PHONY: lock
 lock:
-	@pdm lock
+	@pdm lock --dev
 
 .PHONY: setup
 setup:
diff --git a/docs/.overrides/main.html b/docs/.overrides/main.html
@@ -6,9 +6,9 @@
     is now available!
     <span class="twemoji heart pulse">
       {% include ".icons/octicons/heart-fill-16.svg" %}
-    </span>
+    </span> &mdash;
   
-  &mdash; For updates follow <strong>@pawamoy</strong> on
+  For updates follow <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">
     <span class="twemoji mastodon">
       {% include ".icons/fontawesome/brands/mastodon.svg" %}
diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css
@@ -4,7 +4,30 @@ div.doc-contents:not(.first) {
   border-left: .05rem solid var(--md-typeset-table-color);
 }
 
+/* Mark external links as such. */
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  background-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="rgb(0, 0, 0)" d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+  bottom: 0.1em;
+  margin-left: 0.2em;
+  margin-right: 0.1em;
+
+  height: 0.7em;
+  width: 0.7em;
+  border-radius: 100%;
+  background-color: var(--md-typeset-a-color);
+}
+
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
+
 /* Avoid breaking parameters name, etc. in table cells. */
 td code {
   word-break: normal !important;
-}
+}
diff --git a/duties.py b/duties.py
@@ -5,7 +5,7 @@
 import os
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from duty import duty
 from duty.callables import black, blacken_docs, coverage, lazy, mkdocs, mypy, pytest, ruff, safety
@@ -35,7 +35,29 @@ def pyprefix(title: str) -> str:  # noqa: D103
     return title
 
 
+def merge(d1: Any, d2: Any) -> Any:  # noqa: D103
+    basic_types = (int, float, str, bool, complex)
+    if isinstance(d1, dict) and isinstance(d2, dict):
+        for key, value in d2.items():
+            if key in d1:
+                if isinstance(d1[key], basic_types):
+                    d1[key] = value
+                else:
+                    d1[key] = merge(d1[key], value)
+            else:
+                d1[key] = value
+        return d1
+    if isinstance(d1, list) and isinstance(d2, list):
+        return d1 + d2
+    return d2
+
+
 def mkdocs_config() -> str:  # noqa: D103
+    from mkdocs import utils
+
+    # patch YAML loader to merge arrays
+    utils.merge = merge
+
     if "+insiders" in pkgversion("mkdocs-material"):
         return "mkdocs.insiders.yml"
     return "mkdocs.yml"
diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml
@@ -2,4 +2,4 @@ INHERIT: mkdocs.yml
 
 # waiting for https://github.com/squidfunk/mkdocs-material/issues/5446
 # plugins:
-#   typeset: {}
+# - typeset
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -108,15 +108,15 @@ markdown_extensions:
     permalink: "¤"
 
 plugins:
-  search: {}
-  markdown-exec: {}
-  gen-files:
+- search
+- markdown-exec
+- gen-files:
     scripts:
     - scripts/gen_ref_nav.py
-  literate-nav:
+- literate-nav:
     nav_file: SUMMARY.txt
-  coverage: {}
-  mkdocstrings:
+- coverage
+- mkdocstrings:
     handlers:
       python:
         import:
@@ -128,14 +128,14 @@ plugins:
           merge_init_into_class: true
           docstring_options:
             ignore_init_summary: true
-  git-committers:
+- git-committers:
     enabled: !ENV [DEPLOY, false]
     repository: mkdocstrings/mkdocstrings
-  redirects:
+- redirects:
     redirect_maps:
       theming.md: usage/theming.md
       handlers/overview.md: usage/handlers.md
-  minify:
+- minify:
     minify_html: !ENV [DEPLOY, false]
 
 extra:
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,9 @@ mkdocstrings = "mkdocstrings.plugin:MkdocstringsPlugin"
 
 [tool.pdm]
 version = {source = "scm"}
+plugins = [
+    "pdm-multirun",
+]
 
 [tool.pdm.build]
 package-dir = "src"
@@ -66,6 +69,8 @@ editable-backend = "editables"
 
 [tool.pdm.dev-dependencies]
 duty = ["duty>=0.10"]
+ci-quality = ["mkdocstrings[duty,docs,quality,typing,security]"]
+ci-tests = ["mkdocstrings[duty,docs,tests]"]
 docs = [
     "black>=23.1",
     "markdown-callouts>=0.2",
@@ -105,4 +110,6 @@ typing = [
     "types-pyyaml>=6.0",
     "types-toml>=0.10",
 ]
-security = ["safety>=2"]
+security = [
+    "safety>=2",
+]
diff --git a/scripts/insiders.py b/scripts/insiders.py
@@ -112,7 +112,32 @@ def load_goals(data: str, funding: int = 0, project: Project | None = None) -> d
     }
 
 
-def funding_goals(source: str | list[tuple[str, str, str]], funding: int = 0) -> dict:
+def _load_goals_from_disk(path: str, funding: int = 0) -> dict[int, Goal]:
+    try:
+        data = Path(path).read_text()
+    except OSError as error:
+        raise RuntimeError(f"Could not load data from disk: {path}") from error
+    return load_goals(data, funding)
+
+
+def _load_goals_from_url(source_data: tuple[str, str, str], funding: int = 0) -> dict[int, Goal]:
+    project_name, project_url, data_fragment = source_data
+    data_url = urljoin(project_url, data_fragment)
+    try:
+        with urlopen(data_url) as response:  # noqa: S310
+            data = response.read()
+    except HTTPError as error:
+        raise RuntimeError(f"Could not load data from network: {data_url}") from error
+    return load_goals(data, funding, project=Project(name=project_name, url=project_url))
+
+
+def _load_goals(source: str | tuple[str, str, str], funding: int = 0) -> dict[int, Goal]:
+    if isinstance(source, str):
+        return _load_goals_from_disk(source, funding)
+    return _load_goals_from_url(source, funding)
+
+
+def funding_goals(source: str | list[str | tuple[str, str, str]], funding: int = 0) -> dict[int, Goal]:
     """Load funding goals from a given data source.
 
     Parameters:
@@ -123,20 +148,10 @@ def funding_goals(source: str | list[tuple[str, str, str]], funding: int = 0) ->
         A dictionaries of goals, keys being their target monthly amount.
     """
     if isinstance(source, str):
-        try:
-            data = Path(source).read_text()
-        except OSError as error:
-            raise RuntimeError(f"Could not load data from disk: {source}") from error
-        return load_goals(data, funding)
+        return _load_goals_from_disk(source, funding)
     goals = {}
-    for project_name, project_url, data_fragment in source:
-        data_url = urljoin(project_url, data_fragment)
-        try:
-            with urlopen(data_url) as response:  # noqa: S310
-                data = response.read()
-        except HTTPError as error:
-            raise RuntimeError(f"Could not load data from network: {data_url}") from error
-        source_goals = load_goals(data, funding, project=Project(name=project_name, url=project_url))
+    for src in source:
+        source_goals = _load_goals(src)
         for amount, goal in source_goals.items():
             if amount not in goals:
                 goals[amount] = goal
diff --git a/scripts/setup.sh b/scripts/setup.sh
@@ -10,11 +10,11 @@ if ! command -v pdm &>/dev/null; then
     pipx install pdm
 fi
 if ! pdm self list 2>/dev/null | grep -q pdm-multirun; then
-    pipx inject pdm pdm-multirun
+    pdm install --plugins
 fi
 
 if [ -n "${PYTHON_VERSIONS}" ]; then
-    pdm multirun -vi ${PYTHON_VERSIONS// /,} pdm install -G:all
+    pdm multirun -vi ${PYTHON_VERSIONS// /,} pdm install --dev
 else
-    pdm install -G:all
+    pdm install --dev
 fi
