Lint: improve linting rules (#54)

* Lint: improve linting rules

* fix: incorrect black command and isort config

Author: rdettai

.github/workflows/semantic-pr.yaml

@@ -0,0 +1,17 @@
+name: Semantic PR Title
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/style-check.yaml

@@ -19,11 +19,12 @@ jobs:
       - name: Black
         run: |
           pip install --upgrade black
-          # Note: black fails when it doesn't have to do anything.
-          git diff --name-only --no-color --diff-filter=ACM $(git merge-base origin/main HEAD) |
-            grep -v '\(\.json\|\.csv\|\.ipynb\|\.hpp\.in\|\.ref\|\.example\|\.txt\|\.lock\|\.js\|\.properties\)$' |
-            2>/dev/null xargs black || true
-          git diff --exit-code
+          black --check --diff --include "(\\.pyi?|\\.ipynb)$" --exclude "" .
+
+      - name: isort
+        run: |
+          pip install --upgrade isort
+          isort . -c
 
       - name: yamllint
         run: |

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

cli/common.py

@@ -1,14 +1,15 @@
-from functools import cache
-import sys
-from typing import Dict, List, Set
-from flags import TRACE
-from invoke import Context, Exit, Failure
-import dynaconf
 import json
 import os
+import shutil
+import sys
+from functools import cache
+from typing import Dict, List, Set
+
 import boto3
 import botocore.client
-import shutil
+import dynaconf
+from flags import TRACE
+from invoke import Context, Exit, Failure
 
 # Validate and provide defaults for the terraform state backend configuration
 TF_BACKEND_VALIDATORS = [

cli/core.py

@@ -1,21 +1,21 @@
-from invoke import Context, task, Exit
-from botocore.exceptions import ClientError
-import time
 import base64
-import json
 import io
+import json
+import time
+
+from botocore.exceptions import ClientError
 from common import (
+    AWS_REGION_VALIDATOR,
+    RUNTIME_TFDIR,
     TF_BACKEND_VALIDATORS,
     active_modules,
-    clean_modules,
-    RUNTIME_TFDIR,
     auto_app_fmt,
-    AWS_REGION_VALIDATOR,
-    terraform_output,
     aws,
+    clean_modules,
     parse_env,
+    terraform_output,
 )
-
+from invoke import Context, Exit, task
 
 VALIDATORS = [
     *TF_BACKEND_VALIDATORS,

cli/main.py

@@ -1,10 +1,11 @@
-from invoke import Program, Collection
+import pkgutil
 import sys
-import core
+
 import common
-import plugins
-import pkgutil
+import core
 import flags
+import plugins
+from invoke import Collection, Program
 
 
 def unhandled_exception(type, value, traceback):

cli/plugins/dask.py

@@ -1,7 +1,7 @@
 """Dask on AWS Lambda"""
 
-from invoke import task
 import core
+from invoke import task
 
 
 @task(autoprint=True)

cli/plugins/databend.py

@@ -1,7 +1,7 @@
 """Dremio on AWS Lambda"""
 
-from invoke import task
 import core
+from invoke import task
 
 
 @task(autoprint=True)

cli/plugins/dremio.py

@@ -1,7 +1,7 @@
 """Dremio on AWS Lambda"""
 
-from invoke import task
 import core
+from invoke import task
 
 
 @task(autoprint=True)

cli/plugins/monitoring.py

@@ -1,19 +1,19 @@
 import base64
-import dynaconf
 import json
 import time
+from datetime import datetime
+
 import common
+import dynaconf
+import plugins.dask as dask
 import plugins.databend as databend
-import plugins.spark as spark
 import plugins.dremio as dremio
-import plugins.dask as dask
+import plugins.spark as spark
 import plugins.trino as trino
-from datetime import datetime
+from common import REPOROOT, TF_BACKEND_VALIDATORS, auto_app_fmt
 from google.cloud import bigquery
 from google.oauth2 import service_account
-from invoke import task, Context
-
-from common import REPOROOT, TF_BACKEND_VALIDATORS, auto_app_fmt
+from invoke import Context, task
 
 MONITORING_TFDIR = f"{REPOROOT}/infra/monitoring"
 MONITORING_MODULE_DIR = f"{MONITORING_TFDIR}/bigquery"