Merge pull request #126 from mkdocstrings/template-upgrade

Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 0.4.3
+_commit: 0.7.1
 _src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: "Timoth\xE9e Mazzucotelli"

.github/workflows/ci.yml

@@ -28,9 +28,9 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v2
+      uses: pdm-project/setup-pdm@v2.5
       with:
-        python-version: 3.8
+        python-version: "3.8"
 
     - name: Set cache variables
       id: set_variables
@@ -50,15 +50,13 @@ jobs:
       run: pdm lock
 
     - name: Install dependencies
-      run: |
-        pdm install -G duty -G docs -G quality -G typing -G numpy-style
-        pip install safety
+      run: pdm install -G duty -G docs -G quality -G typing -G security -G numpy-style
 
     - name: Check if the documentation builds correctly
       run: pdm run duty check-docs
 
     - name: Check the code quality
-      run: pdm run duty check-code-quality
+      run: pdm run duty check-quality
 
     - name: Check if the code is correctly typed
       run: pdm run duty check-types
@@ -70,8 +68,17 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        python-version:
+        - "3.6"
+        - "3.7"
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11-dev"
 
     runs-on: ${{ matrix.os }}
 
@@ -80,7 +87,7 @@ jobs:
       uses: actions/checkout@v2    
 
     - name: Set up PDM
-      uses: pdm-project/setup-pdm@v2
+      uses: pdm-project/setup-pdm@v2.5
       with:
         python-version: ${{ matrix.python-version }}
 

.gitpod.dockerfile

@@ -0,0 +1,7 @@
+FROM gitpod/workspace-full
+USER gitpod
+ENV PIP_USER=no
+ENV PYTHON_VERSIONS=
+RUN pip3 install pipx; \
+    pipx install pdm; \
+    pipx ensurepath

.gitpod.yml

@@ -0,0 +1,13 @@
+vscode:
+  extensions:
+  - ms-python.python
+
+image:
+  file: .gitpod.dockerfile
+
+ports:
+- port: 8000
+  onOpen: notify
+
+tasks:
+- init: make setup

Makefile

@@ -4,13 +4,14 @@ SHELL := bash
 DUTY = $(shell [ -n "${VIRTUAL_ENV}" ] || echo pdm run) duty
 
 args = $(foreach a,$($(subst -,_,$1)_args),$(if $(value $a),$a="$($a)"))
-check_code_quality_args = files
+check_quality_args = files
 docs_serve_args = host port
 release_args = version
 test_args = match
 
 BASIC_DUTIES = \
 	changelog \
+	check-dependencies \
 	clean \
 	coverage \
 	docs \
@@ -21,9 +22,7 @@ BASIC_DUTIES = \
 	release
 
 QUALITY_DUTIES = \
-	check \
-	check-code-quality \
-	check-dependencies \
+	check-quality \
 	check-docs \
 	check-types \
 	test
@@ -32,10 +31,19 @@ QUALITY_DUTIES = \
 help:
 	@$(DUTY) --list
 
+.PHONY: lock
+lock:
+	@pdm lock
+
 .PHONY: setup
 setup:
 	@bash scripts/setup.sh
 
+.PHONY: check
+check:
+	@bash scripts/multirun.sh duty check-quality check-types check-docs
+	@$(DUTY) check-dependencies
+
 .PHONY: $(BASIC_DUTIES)
 $(BASIC_DUTIES):
 	@$(DUTY) $@ $(call args,$@)

README.md

@@ -4,6 +4,7 @@
 [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://pawamoy.github.io/pytkdocs/)
 [![pypi version](https://img.shields.io/pypi/v/pytkdocs.svg)](https://pypi.org/project/pytkdocs/)
 [![conda version](https://img.shields.io/conda/vn/conda-forge/pytkdocs)](https://anaconda.org/conda-forge/pytkdocs)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/pytkdocs)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/pytkdocs/community)
 
 Load Python objects documentation.

config/flake8.ini

@@ -10,6 +10,8 @@ ignore =
     D105
     # multi-line docstring summary should start at the first line
     D212
+    # does not support Parameters sections
+    D417
     # whitespace before ':' (incompatible with Black)
     E203
     # redundant with E0602 (undefined variable)

config/mypy.ini

@@ -1,9 +1,3 @@
 [mypy]
 ignore_missing_imports = true
 exclude = tests/fixtures/
-
-[mypy-toml.*]
-ignore_missing_imports = true
-
-[mypy-dataclasses.*]
-ignore_missing_imports = true

duties.py

@@ -1,11 +1,14 @@
 """Development tasks."""
 
+import importlib
 import os
 import re
 import sys
+import tempfile
+from contextlib import suppress
 from functools import wraps
+from io import StringIO
 from pathlib import Path
-from shutil import which
 from typing import List, Optional, Pattern
 from urllib.request import urlopen
 
@@ -105,7 +108,7 @@ def changelog(ctx):
     )
 
 
-@duty(pre=["check_code_quality", "check_types", "check_docs", "check_dependencies"])
+@duty(pre=["check_quality", "check_types", "check_docs", "check_dependencies"])
 def check(ctx):
     """
     Check it all!
@@ -116,7 +119,7 @@ def check(ctx):
 
 
 @duty
-def check_code_quality(ctx, files=PY_SRC):
+def check_quality(ctx, files=PY_SRC):
     """
     Check the code quality.
 
@@ -141,22 +144,36 @@ def check_dependencies(ctx):
     Arguments:
         ctx: The context instance (passed automatically).
     """
-    nofail = False
-    safety = which("safety")
-    if not safety:
-        pipx = which("pipx")
-        if pipx:
-            safety = f"{pipx} run safety"
-        else:
-            safety = "safety"
-            nofail = True
-    ctx.run(
-        f"pdm export -f requirements --without-hashes | {safety} check --stdin --full-report",
-        title="Checking dependencies",
-        pty=PTY,
-        nofail=nofail,
+    # undo possible patching
+    # see https://github.com/pyupio/safety/issues/348
+    for module in sys.modules:  # noqa: WPS528
+        if module.startswith("safety.") or module == "safety":
+            del sys.modules[module]  # noqa: WPS420
+
+    importlib.invalidate_caches()
+
+    # reload original, unpatched safety
+    from safety.formatter import report
+    from safety.safety import check as safety_check
+    from safety.util import read_requirements
+
+    # retrieve the list of dependencies
+    requirements = ctx.run(
+        ["pdm", "export", "-f", "requirements", "--without-hashes"],
+        title="Exporting dependencies as requirements",
+        allow_overrides=False,
     )
 
+    # check using safety as a library
+    def safety():  # noqa: WPS430
+        packages = list(read_requirements(StringIO(requirements)))
+        vulns = safety_check(packages=packages, ignore_ids="", key="", db_mirror="", cached=False, proxy={})
+        output_report = report(vulns=vulns, full=True, checked_packages=len(packages))
+        if vulns:
+            print(output_report)
+
+    ctx.run(safety, title="Checking dependencies")
+
 
 def no_docs_py36(nofail=True):
     """
@@ -197,15 +214,57 @@ def check_docs(ctx, strict: bool = False):
     ctx.run(f"mkdocs build{' -s' if strict else ''}", title="Building documentation", pty=PTY)
 
 
-@duty
-def check_types(ctx):
+@duty  # noqa: WPS231
+def check_types(ctx):  # noqa: WPS231
     """
     Check that the code is correctly typed.
 
     Arguments:
         ctx: The context instance (passed automatically).
     """
-    ctx.run(f"mypy --config-file config/mypy.ini {PY_SRC}", title="Type-checking", pty=PTY)
+    # NOTE: the following code works around this issue:
+    # https://github.com/python/mypy/issues/10633
+
+    # compute packages directory path
+    py = f"{sys.version_info.major}.{sys.version_info.minor}"
+    pkgs_dir = Path("__pypackages__", py, "lib").resolve()
+
+    # build the list of available packages
+    packages = {}
+    for package in pkgs_dir.glob("*"):
+        if package.suffix not in {".dist-info", ".pth"} and package.name != "__pycache__":
+            packages[package.name] = package
+
+    # handle .pth files
+    for pth in pkgs_dir.glob("*.pth"):
+        with suppress(OSError):
+            for package in Path(pth.read_text().splitlines()[0]).glob("*"):  # noqa: WPS440
+                if package.suffix != ".dist-info":
+                    packages[package.name] = package
+
+    # create a temporary directory to assign to MYPYPATH
+    with tempfile.TemporaryDirectory() as tmpdir:
+
+        # symlink the stubs
+        ignore = set()
+        for stubs in (path for name, path in packages.items() if name.endswith("-stubs")):  # noqa: WPS335
+            Path(tmpdir, stubs.name).symlink_to(stubs, target_is_directory=True)
+            # try to symlink the corresponding package
+            # see https://www.python.org/dev/peps/pep-0561/#stub-only-packages
+            pkg_name = stubs.name.replace("-stubs", "")
+            if pkg_name in packages:
+                ignore.add(pkg_name)
+                Path(tmpdir, pkg_name).symlink_to(packages[pkg_name], target_is_directory=True)
+
+        # create temporary mypy config to ignore stubbed packages
+        newconfig = Path("config", "mypy.ini").read_text()
+        newconfig += "\n" + "\n\n".join(f"[mypy-{pkg}.*]\nignore_errors=true" for pkg in ignore)
+        tmpconfig = Path(tmpdir, "mypy.ini")
+        tmpconfig.write_text(newconfig)
+
+        # set MYPYPATH and run mypy
+        os.environ["MYPYPATH"] = tmpdir
+        ctx.run(f"mypy --config-file {tmpconfig} {PY_SRC}", title="Type-checking", pty=PTY)
 
 
 @duty(silent=True)
@@ -301,7 +360,7 @@ def release(ctx, version):
         ctx.run("git push --tags", title="Pushing tags", pty=False)
         ctx.run("pdm build", title="Building dist/wheel", pty=PTY)
         ctx.run("twine upload --skip-existing dist/*", title="Publishing version", pty=PTY)
-        docs_deploy.run()  # type: ignore
+        docs_deploy.run()
 
 
 @duty(silent=True)