[skip-changelog] add linting infrastructure and apply formatting

Author: umbynos

.flake8

@@ -0,0 +1,9 @@
+[flake8]
+doctests = True
+ignore =
+    # W503 and W504 are mutually exclusive, so one or the other must be ignored.
+    # PEP 8 recommends line break before, so we keep W504.
+    W503
+max-complexity = 10
+max-line-length = 120
+select = E,W,F,C,N

.github/workflows/lint-python.yml

@@ -0,0 +1,40 @@
+name: Lint Python code
+
+on:
+  push:
+    paths:
+      - "**.py"
+      - ".flake8"
+      - "pyproject.toml"
+      - "Taskfile.yml"
+  pull_request:
+    paths:
+      - "**.py"
+      - ".flake8"
+      - "pyproject.toml"
+      - "Taskfile.yml"
+
+jobs:
+  lint-python:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Taskfile
+        uses: arduino/setup-task@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: 3.x
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.8"
+
+      - name: Install Poetry
+        run: pip install poetry
+
+      - name: Lint Python files
+        run: task python:check

Taskfile.yml

@@ -56,6 +56,7 @@ tasks:
       - "'{{.GOLINTBIN}}' {{.GOLINTFLAGS}} ./..."
       - task: docs:check
       - task: config:check
+      - task: python:check
 
   config:check:
     desc: Check linting of configuration and supporting files
@@ -67,6 +68,22 @@ tasks:
     cmds:
       - npx {{ .PRETTIER }} --write "**/*.{yml,yaml}"
 
+  python:check:
+    cmds:
+      - task: python:lint
+
+  python:lint:
+    desc: Lint Python code
+    cmds:
+      - poetry install --no-root
+      - poetry run flake8
+
+  python:format:
+    desc: Automatically formats Python files
+    cmds:
+      - poetry install --no-root
+      - poetry run black .
+
 vars:
   PROJECT_NAME: "FirmwareUploader"
   DIST_DIR: "dist"

go.sum

@@ -307,6 +307,7 @@ golang.org/x/lint v0.0.0-20190301231843-5614ed5bae6f/go.mod h1:UVdnD1Gm6xHRNCYTk
 golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/lint v0.0.0-20190409202823-959b441ac422/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/lint v0.0.0-20190909230951-414d861bb4ac/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
+golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs=
 golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE=
 golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o=

poetry.lock

@@ -9,3 +9,11 @@ python = "^3.8"
 pytest = "6.1.2"
 invoke = "^1.5.0"
 semver = "^2.13.0"
+
+[tool.poetry.dev-dependencies]
+flake8 = "^3.9.2"
+black = "^21.5b1"
+
+[tool.black]
+line-length = 120
+target-version = ["py38"]

pyproject.toml

@@ -17,9 +17,10 @@
 
 import pathlib
 import platform
-import invoke.context 
+import invoke.context
 import pytest
 
+
 @pytest.fixture(scope="function")
 def run_command(pytestconfig, working_dir):
     """Provide a wrapper around invoke's `run` API so that every test will work in the same temporary folder.
@@ -56,4 +57,4 @@ def working_dir(tmpdir_factory):
     end. This way all the tests work in isolation.
     """
     work_dir = tmpdir_factory.mktemp(basename="FirmwareUploaderTestWork")
-    yield str(work_dir)
+    yield str(work_dir)