chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,6 +1,6 @@
 # Changes here will be overwritten by Copier
-_commit: 0.2.1
-_src_path: gh:pawamoy/copier-poetry
+_commit: e9e472d
+_src_path: gh:pawamoy/copier-pdm
 author_email: pawamoy@pm.me
 author_fullname: "Timoth\xE9e Mazzucotelli"
 author_username: pawamoy
@@ -16,3 +16,4 @@ python_package_import_name: pytkdocs
 repository_name: pytkdocs
 repository_namespace: pawamoy
 repository_provider: github.com
+use_precommit: false

.github/workflows/ci.yml

@@ -13,10 +13,17 @@ defaults:
     shell: bash
 
 env:
-  LANG: "en_US.utf-8"
-  LC_ALL: "en_US.utf-8"
-  POETRY_VIRTUALENVS_IN_PROJECT: "true"
-  PYTHONIOENCODING: "UTF-8"
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
+
+  # To fix an error when running Poetry on Windows
+  # (https://github.com/python-poetry/poetry/issues/2629),
+  # we set Poetry's cache directory to .poetry_cache in the current directory.
+  # It makes it easier to later remove the virtualenv when it's broken.
+  # Absolute path is necessary to avoid this issue:
+  # https://github.com/python-poetry/poetry/issues/3049
+  POETRY_CACHE_DIR: ${{ github.workspace }}/.poetry_cache
 
 jobs:
 
@@ -33,17 +40,17 @@ jobs:
       with:
         python-version: 3.8
 
+    - name: Set up Poetry
+      run: pip install poetry
+
     - name: Set up the cache
       uses: actions/cache@v1
       with:
-        path: .venv
-        key: quality-venv-cache
+        path: .poetry_cache
+        key: quality-poetry-cache
 
     - name: Set up the project
-      run: |
-        pip install poetry
-        poetry install -v -E numpy-style || { rm -rf .venv; poetry install -v -E numpy-style; }
-        poetry update
+      run: poetry install -vv -E numpy-style
 
     - name: Check if the documentation builds correctly
       run: poetry run duty check-docs
@@ -77,17 +84,17 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Set up Poetry
+      run: pip install poetry
+
     - name: Set up the cache
       uses: actions/cache@v1
       with:
-        path: .venv
-        key: tests-venv-cache-${{ matrix.os }}-py${{ matrix.python-version }}
+        path: .poetry_cache
+        key: tests-poetry-cache-${{ matrix.os }}-py${{ matrix.python-version }}
 
     - name: Set up the project
-      run: |
-        pip install poetry
-        poetry install -v -E numpy-style || { rm -rf .venv; poetry install -v -E numpy-style; }
-        poetry update
+      run: poetry install -vv -E numpy-style || { rm -rf .poetry_cache/virtualenvs/*; poetry install -vv -E numpy-style; }
 
     - name: Run the test suite
       run: poetry run duty test

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 = cleancov match
+test_args = match
 
 BASIC_DUTIES = \
 	changelog \

config/flake8.ini

@@ -0,0 +1,104 @@
+[flake8]
+exclude = fixtures,docs,site
+max-line-length = 132
+docstring-convention = google
+ban-relative-imports = true
+ignore =
+    # redundant with W0622 (builtin override), which is more precise about line number
+    A001
+    # missing docstring in magic method
+    D105
+    # multi-line docstring summary should start at the first line
+    D212
+    # whitespace before ':' (incompatible with Black)
+    E203
+    # redundant with E0602 (undefined variable)
+    F821
+    # black already deals with quoting
+    Q000
+    # use of assert
+    S101
+    # we are not parsing XML
+    S405
+    # line break before binary operator (incompatible with Black)
+    W503
+    # two-lowercase-letters variable DO conform to snake_case naming style
+    C0103
+    # redunant with D102 (missing docstring)
+    C0116
+    # line too long
+    C0301
+    # too many instance attributes
+    R0902
+    # too few public methods
+    R0903
+    # too many public methods
+    R0904
+    # too many branches
+    R0912
+    # too many methods
+    R0913
+    # too many local variables
+    R0914
+    # too many statements
+    R0915
+    # redundant with F401 (unused import)
+    W0611
+    # lazy formatting for logging calls
+    W1203
+    # short name
+    VNE001
+    # f-strings
+    WPS305
+    # common variable names (too annoying)
+    WPS110
+    # redundant with W0622 (builtin override), which is more precise about line number
+    WPS125
+    # too many imports
+    WPS201
+    # too many module members
+    WPS202
+    # overused expression
+    WPS204
+    # too many local variables
+    WPS210
+    # too many arguments
+    WPS211
+    # too many expressions
+    WPS213
+    # too many methods
+    WPS214
+    # too deep nesting
+    WPS220
+    # high Jones complexity
+    WPS221
+    # too many elif branches
+    WPS223
+    # string over-use: can't disable it per file?
+    WPS226
+    # too many public instance attributes
+    WPS230
+    # too complex f-string
+    WPS237
+    # too cumbersome, asks to write class A(object)
+    WPS306
+    # multi-line paramaters (incompatible with Black)
+    WPS317
+    # multi-line strings (incompatible with attributes docstrings)
+    WPS322
+    # implicit string concatenation
+    WPS326
+    # explicit string concatenation
+    WPS336
+    # noqa overuse
+    WPS402
+    # __init__ modules with logic
+    WPS412
+    # print statements
+    WPS421
+    # statement with no effect (not compatible with attribute docstrings)
+    WPS428
+    # redundant with C0415 (not top-level import)
+    WPS433
+    # implicit dict.get usage (generally false-positive)
+    WPS529

config/mypy.ini

@@ -1,5 +1,6 @@
 [mypy]
 ignore_missing_imports = true
+exclude = tests/fixtures/
 
 [mypy-tests.fixtures.*]
-ignore_errors = true
+ignore_errors = true

config/pytest.ini

@@ -11,5 +11,6 @@ python_files =
   tests.py
 addopts =
   --cov
-  --cov-append
   --cov-config config/coverage.ini
+testpaths =
+  tests

docs/macros.py

@@ -77,5 +77,5 @@ def define_env(env):
     """
 
     @env.macro  # noqa: WPS430 (nested function)
-    def credits():  # noqa: W0612,W0622,WPS430 (unused, shadows credits)
+    def credits():  # noqa: WPS430
         return get_credits()

duties.py

@@ -2,6 +2,7 @@
 
 import os
 import re
+import sys
 from pathlib import Path
 from shutil import which
 from typing import List, Optional, Pattern
@@ -100,7 +101,7 @@ def update_changelog(
     """
     env = SandboxedEnvironment(autoescape=False)
     template = env.from_string(httpx.get(template_url).text)
-    changelog = Changelog(".", style=commit_style)  # noqa: W0621 (shadowing changelog)
+    changelog = Changelog(".", style=commit_style)
 
     if len(changelog.versions_list) == 1:
         last_version = changelog.versions_list[0]
@@ -142,13 +143,13 @@ def changelog(ctx):
 
 
 @duty(pre=["check_code_quality", "check_types", "check_docs", "check_dependencies"])
-def check(ctx):  # noqa: W0613 (no use for the context argument)
+def check(ctx):
     """
     Check it all!
 
     Arguments:
         ctx: The context instance (passed automatically).
-    """  # noqa: D400 (exclamation mark is funnier)
+    """
 
 
 @duty
@@ -160,7 +161,7 @@ def check_code_quality(ctx, files=PY_SRC):
         ctx: The context instance (passed automatically).
         files: The files to check.
     """
-    ctx.run(f"flakehell lint {files}", title="Checking code quality", pty=PTY, nofail=True, quiet=True)
+    ctx.run(f"flake8 --config=config/flake8.ini {files}", title="Checking code quality", pty=PTY)
 
 
 @duty
@@ -196,7 +197,9 @@ def check_docs(ctx, strict: bool = False):
     Arguments:
         ctx: The context instance (passed automatically).
     """
-    ctx.run(f"mkdocs build{' -s' if strict else ''}", title="Building documentation", pty=PTY)
+    Path("build/coverage").mkdir(parents=True, exist_ok=True)
+    Path("build/coverage/index.html").touch(exist_ok=True)
+    ctx.run("mkdocs build -s", title="Building documentation", pty=PTY)
 
 
 @duty
@@ -221,6 +224,7 @@ def clean(ctx):
     ctx.run("rm -rf .coverage*")
     ctx.run("rm -rf .mypy_cache")
     ctx.run("rm -rf .pytest_cache")
+    ctx.run("rm -rf tests/.pytest_cache")
     ctx.run("rm -rf build")
     ctx.run("rm -rf dist")
     ctx.run("rm -rf pip-wheel-metadata")
@@ -265,7 +269,7 @@ def docs_deploy(ctx):
 
 
 @duty
-def format(ctx):  # noqa: W0622 (we don't mind shadowing the format builtin)
+def format(ctx):
     """
     Run formatting tools on the code.
 
@@ -277,7 +281,7 @@ def format(ctx):  # noqa: W0622 (we don't mind shadowing the format builtin)
         title="Removing unused imports",
         pty=PTY,
     )
-    ctx.run(f"isort -y -rc {PY_SRC}", title="Ordering imports", pty=PTY)
+    ctx.run(f"isort {PY_SRC}", title="Ordering imports", pty=PTY)
     ctx.run(f"black {PY_SRC}", title="Formatting code", pty=PTY)
 
 
@@ -299,7 +303,7 @@ def release(ctx, version):
         ctx.run("git push --tags", title="Pushing tags", pty=False)
         ctx.run("poetry build", title="Building dist/wheel", pty=PTY)
         ctx.run("poetry publish", title="Publishing version", pty=PTY)
-        ctx.run("mkdocs gh-deploy", title="Deploying documentation", pty=PTY)
+        docs_deploy.run()  # type: ignore
 
 
 @duty(silent=True)
@@ -310,22 +314,22 @@ def coverage(ctx):
     Arguments:
         ctx: The context instance (passed automatically).
     """
+    ctx.run("coverage combine .coverage-*", nofail=True)
     ctx.run("coverage report --rcfile=config/coverage.ini", capture=False)
     ctx.run("coverage html --rcfile=config/coverage.ini")
 
 
 @duty
-def test(ctx, cleancov: bool = True, match: str = ""):
+def test(ctx, 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)
+    py_version = f"{sys.version_info.major}{sys.version_info.minor}"
+    os.environ["COVERAGE_FILE"] = f".coverage-{py_version}"
     ctx.run(
         ["pytest", "-c", "config/pytest.ini", "-n", "auto", "-k", match, "tests"],
         title="Running tests",

mkdocs.yml

@@ -3,6 +3,7 @@ site_description: "Load Python objects documentation."
 site_url: "https://pawamoy.github.io/pytkdocs"
 repo_url: "https://github.com/pawamoy/pytkdocs"
 repo_name: "pawamoy/pytkdocs"
+site_dir: "site"
 
 nav:
 - Home:
@@ -71,4 +72,4 @@ plugins:
     watch:
     - src/pytkdocs
 - macros:
-    module_name: docs/macros
+    module_name: docs/macros