Install and use Ruff to check and format python (#41)

Author: pgiraud

.github/workflows/python_lint.yml

@@ -0,0 +1,29 @@
+name: Check python syntax
+
+on:
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set Python Version
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+
+    - name: Python Ruff Lint and Format
+      run: |
+        ruff check --output-format=github .
+        ruff format --check --diff

.ruff.toml

@@ -0,0 +1,18 @@
+target-version = "py313"
+exclude = ["migrations"]
+
+[lint]
+extend-select = [
+    "B",  # flake8-bugbear
+    "B9", # flake8-bugbear
+    "C",  # mccabe
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+    "RUF100",  # unused-noqa
+    "UP", # pyupgrade
+    "W",  # pycodestyle warnings
+]
+ignore = [
+    "C901", # too complex
+]

app/__init__.py

@@ -31,12 +31,12 @@ class Plan(db.Model):
     __table_args__ = {"postgresql_partition_by": "HASH (id)"}
 
     def as_dict(self):
-        return dict(
-            shareId=self.id,
-            title=self.title,
-            plan=self.plan,
-            sql=self.sql,
-        )
+        return {
+            "shareId": self.id,
+            "title": self.title,
+            "plan": self.plan,
+            "sql": self.sql,
+        }
 
 
 @app.route("/")
@@ -87,7 +87,7 @@ def save(json=False):
         result = query.fetchone()[0]
         (id, delete_key) = tuple(x for x in result[1:-1].split(","))
         if json:
-            return jsonify(dict(id=id, deleteKey=delete_key))
+            return jsonify({"id": id, "deleteKey": delete_key})
         return redirect(url_for("plan_from_db", id=id))
     return redirect(url_for("index"))
 
@@ -148,7 +148,7 @@ def generate_tags(entrypoint, tags):
             if "css" in manifest_entry:
                 tags.append(build_css_tag(manifest_entry["css"]))
 
-    return dict(assets=load_assets)
+    return {"assets": load_assets}
 
 
 @app.route("/plan_error")

config.py

@@ -1,13 +1,14 @@
 import os
+
 WTF_CSRF_ENABLED = False
-SECRET_KEY = os.environ.get('SECRET_KEY', 'aSup3rS33kret')
-DB_NAME = os.environ.get('DB_NAME', 'postgres')
-DB_USER = os.environ.get('DB_USER', 'postgres')
-DB_PASS = os.environ.get('DB_PASS', 'postgres')
-DB_SERVICE = os.environ.get('DB_SERVICE', '0.0.0.0')
-DB_PORT = os.environ.get('DB_PORT', 5432)
-SQLALCHEMY_DATABASE_URI = 'postgresql://{0}:{1}@{2}:{3}/{4}'.format(
-    DB_USER, DB_PASS, DB_SERVICE, DB_PORT, DB_NAME
+SECRET_KEY = os.environ.get("SECRET_KEY", "aSup3rS33kret")
+DB_NAME = os.environ.get("DB_NAME", "postgres")
+DB_USER = os.environ.get("DB_USER", "postgres")
+DB_PASS = os.environ.get("DB_PASS", "postgres")
+DB_SERVICE = os.environ.get("DB_SERVICE", "0.0.0.0")
+DB_PORT = os.environ.get("DB_PORT", 5432)
+SQLALCHEMY_DATABASE_URI = (
+    f"postgresql://{DB_USER}:{DB_PASS}@{DB_SERVICE}:{DB_PORT}/{DB_NAME}"
 )
 DEBUG_TB_INTERCEPT_REDIRECTS = False
 DEBUG_TB_PROFILER_ENABLED = True

requirements-dev.txt

@@ -1,3 +1 @@
-flake8
-black
-isort
+ruff