Formatting and repo-management

- added import for `importlib.abc` so it's always found
- fixed long string in setup.py so it doesn't need to be excluded
- completed and added ranges for the list of dev requirements
- added a new `check` command to invoke tasks verifying formatting and linting
- fixed import order in test according to black+isort
- test workflow to use invoke check instead of duplicating commands
- adding coverage reporting to invoke test

Author: renaud gaudin

.github/workflows/test.yml

@@ -5,7 +5,6 @@ env:
   LIBZIM_VERSION: 2021-10-05
   LIBZIM_INCLUDE_PATH: include/zim
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-  MAX_LINE_LENGTH: 88
   PROFILE: 1
 
 jobs:
@@ -20,18 +19,11 @@ jobs:
           python-version: 3.6
           architecture: x64
 
-      - name: Autoformat with black
+      - name: Check formatting and linting
         run: |
-          pip install black
-          black --check .
-
-      - name: Lint with flake8
-        run: |
-          pip install flake8
-          # one pass for show-stopper syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # one pass for small stylistic things
-          flake8 . --count --max-line-length=$MAX_LINE_LENGTH --statistics
+          pip install -U invoke
+          invoke install-dev
+          invoke check
 
   test:
     runs-on: ${{ matrix.os }}

CONTRIBUTING.md

@@ -30,14 +30,14 @@ pipenv run pip install -e .
 ### Run Linters & Tests
 
 ```bash
-# Autoformat code with black
-black --exclude=setup.py .
-# Lint and check for errors with flake8
-flake8 --exclude=setup.py .
+# Check format and linting
+invoke check
+# Autoformat and import sorting
+invoke lint
 # Typecheck with mypy (optional)
 mypy .
 # Run tests
-pytest .
+invoke test
 ```
 
 ### Rebuild Cython extension during development

libzim/libzim.pyx

@@ -34,6 +34,7 @@ cimport zim
 import datetime
 import enum
 import importlib
+import importlib.abc
 import os
 import pathlib
 import sys

requirements-dev.txt

@@ -1,4 +1,8 @@
-isort
-black
-flake8
-pytest
+isort>=5.9,<6.0
+black>=21.9b0,<22.0
+flake8>=3.9,<4.0
+invoke>=1.5,<2.0
+coverage>=5.0,<7.0
+pytest>=6.2,<7.0
+pytest-cov>=2.10,<4.0
+Cython>=0.29.24

setup.py

@@ -33,13 +33,11 @@
 on environment variables side.
 """
 
-
 import os
 import platform
 import sys
 from ctypes.util import find_library
 from pathlib import Path
-from textwrap import dedent
 
 from Cython.Build import cythonize
 from Cython.Distutils.build_ext import new_build_ext as build_ext
@@ -83,30 +81,24 @@ def finalize_options(self):
 lib_file = base_dir / "lib" / f"libzim.{dyn_lib_ext}"
 if header_file.exists() and lib_file.exists():
     print(
-        dedent(
-            """\
-        Found lizim library and headers in local directory.
-        We will use them to compile python-libzim.
-        Hint : If you don't want to use them (and use "system" installed one), remove them.
-    """
-        )
+        "Found lizim library and headers in local directory. "
+        "We will use them to compile python-libzim.\n"
+        "Hint : If you don't want to use them "
+        "(and use “system” installed one), remove them."
     )
     include_dirs.append("include")
     library_dirs = ["lib"]
 else:
     # Check for library.
     if not find_library("zim"):
         print(
-            dedent(
-                """\
-            "[!] The libzim library cannot be found.
-            "Please verify that the library is correctly installed of and can be found.
-        """
-            )
+            "[!] The libzim library cannot be found.\n"
+            "Please verify that the library is correctly installed and can be found."
         )
         sys.exit(1)
     print(
-        "Using system installed library. We are assuming CFLAGS/LDFLAGS are correctly set."
+        "Using system installed library. "
+        "We are assuming CFLAGS/LDFLAGS are correctly set."
     )
 
 wrapper_extension = Extension(

tasks.py

@@ -7,15 +7,21 @@
 
 from invoke import task
 
+MAX_LINE_LENGTH = 88
+
 
 @task
 def build_ext(c):
-    c.run("python setup.py build_ext -i")
+    c.run("PROFILE=1 python setup.py build_ext -i")
 
 
 @task
 def test(c):
-    c.run(f"python -m pytest --color=yes --ff")
+    c.run(
+        "python -m pytest --color=yes --ff "
+        "--cov=libzim --cov-config=.coveragerc "
+        "--cov-report=term --cov-report term-missing ."
+    )
 
 
 @task
@@ -29,17 +35,25 @@ def install_dev(c):
     c.run("pip install -r requirements-dev.txt")
 
 
+@task
+def check(c):
+    c.run("isort --profile=black --check-only .")
+    c.run("black --check .")
+    c.run('echo "one pass for show-stopper syntax errors or undefined names"')
+    c.run("flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics")
+    c.run('echo "one pass for small stylistic things"')
+    c.run(f"flake8 . --count --max-line-length={MAX_LINE_LENGTH} --statistics")
+
+
 @task
 def lint(c):
-    c.run("isort .")
+    c.run("isort --profile=black .")
     c.run("black .")
     c.run("flake8 .")
 
 
 if __name__ == "__main__":
     print(
-        """\
-This file is not intended to be directly run.
-Install invoke and run the `invoke` command line.
-"""
+        "This file is not intended to be directly run.\n"
+        "Install invoke and run the `invoke` command line."
     )