Merge pull request #2928 from Agenta-AI/ci/add-check-python

[CI] Add `ruff` checks

Author: junaway

.github/workflows/02-check-python-formatting.yml

@@ -0,0 +1,28 @@
+name: 02 - check python formatting
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    paths:
+      - 'api/**'
+      - 'sdk/**'
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Ruff
+        run: pip install ruff==0.14.0
+
+      - name: Run Ruff formatting check
+        run: ruff format --check api sdk

.github/workflows/03-check-python-linting.yml

@@ -0,0 +1,28 @@
+name: 03 - check python linting
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    paths:
+      - 'api/**'
+      - 'sdk/**'
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Ruff
+        run: pip install ruff==0.14.0
+
+      - name: Run Ruff linting check
+        run: ruff check api sdk

api/ee/databases/postgres/migrations/core/data_migrations/workspaces.py

@@ -56,7 +56,8 @@ def create_default_project_for_workspaces(session: Connection):
             for workspace in workspaces:
                 # Create a new default project for each workspace
                 get_or_create_workspace_default_project(
-                    session=session, workspace=workspace  # type: ignore
+                    session=session,
+                    workspace=workspace,  # type: ignore
                 )
 
             # Commit the changes for the current batch

api/ee/databases/postgres/migrations/core/utils.py

@@ -73,7 +73,9 @@ async def get_current_migration_head_from_db(engine: AsyncEngine):
 
     async with engine.connect() as connection:
         try:
-            result = await connection.execute(text("SELECT version_num FROM alembic_version"))  # type: ignore
+            result = await connection.execute(
+                text("SELECT version_num FROM alembic_version")
+            )  # type: ignore
         except (asyncpg.exceptions.UndefinedTableError, ProgrammingError):
             # Note: If the alembic_version table does not exist, it will result in raising an UndefinedTableError exception.
             # We need to suppress the error and return a list with the alembic_version table name to inform the user that there is a pending migration \
@@ -83,9 +85,9 @@ async def get_current_migration_head_from_db(engine: AsyncEngine):
             return "alembic_version"
 
         migration_heads = [row[0] for row in result.fetchall()]
-        assert (
-            len(migration_heads) == 1
-        ), "There can only be one migration head stored in the database."
+        assert len(migration_heads) == 1, (
+            "There can only be one migration head stored in the database."
+        )
         return migration_heads[0]
 
 

api/ee/databases/postgres/migrations/tracing/utils.py

@@ -66,7 +66,9 @@ async def get_current_migration_head_from_db(engine: AsyncEngine):
 
     async with engine.connect() as connection:
         try:
-            result = await connection.execute(text("SELECT version_num FROM alembic_version"))  # type: ignore
+            result = await connection.execute(
+                text("SELECT version_num FROM alembic_version")
+            )  # type: ignore
         except (asyncpg.exceptions.UndefinedTableError, ProgrammingError):
             # Note: If the alembic_version table does not exist, it will result in raising an UndefinedTableError exception.
             # We need to suppress the error and return a list with the alembic_version table name to inform the user that there is a pending migration \
@@ -76,9 +78,9 @@ async def get_current_migration_head_from_db(engine: AsyncEngine):
             return "alembic_version"
 
         migration_heads = [row[0] for row in result.fetchall()]
-        assert (
-            len(migration_heads) == 1
-        ), "There can only be one migration head stored in the database."
+        assert len(migration_heads) == 1, (
+            "There can only be one migration head stored in the database."
+        )
         return migration_heads[0]
 
 

api/ee/src/apis/fastapi/billing/router.py

@@ -35,7 +35,7 @@
 
 stripe.api_key = environ.get("STRIPE_API_KEY")
 
-MAC_ADDRESS = ":".join(f"{(getnode() >> ele) & 0xff:02x}" for ele in range(40, -1, -8))
+MAC_ADDRESS = ":".join(f"{(getnode() >> ele) & 0xFF:02x}" for ele in range(40, -1, -8))
 STRIPE_WEBHOOK_SECRET = environ.get("STRIPE_WEBHOOK_SECRET")
 STRIPE_TARGET = environ.get("STRIPE_TARGET") or MAC_ADDRESS
 AGENTA_PRICING = loads(environ.get("AGENTA_PRICING") or "{}")

api/ee/src/core/subscriptions/service.py

@@ -25,7 +25,7 @@
 
 stripe.api_key = environ.get("STRIPE_SECRET_KEY")
 
-MAC_ADDRESS = ":".join(f"{(getnode() >> ele) & 0xff:02x}" for ele in range(40, -1, -8))
+MAC_ADDRESS = ":".join(f"{(getnode() >> ele) & 0xFF:02x}" for ele in range(40, -1, -8))
 STRIPE_TARGET = environ.get("STRIPE_TARGET") or MAC_ADDRESS
 AGENTA_PRICING = loads(environ.get("AGENTA_PRICING") or "{}")
 

api/ee/src/services/db_manager_ee.py

@@ -645,9 +645,7 @@ async def remove_user_from_workspace(
     project = await db_manager.get_project_by_id(project_id=project_id)
 
     async with engine.core_session() as session:
-        if (
-            not user
-        ):  # User is an invited user who has not yet created an account and therefore does not have a user object
+        if not user:  # User is an invited user who has not yet created an account and therefore does not have a user object
             pass
         else:
             # Ensure that a user can not remove the owner of the workspace

api/ee/src/services/workspace_manager.py

@@ -317,9 +317,9 @@ async def accept_workspace_invitation(
 
         invitation = await check_valid_invitation(project_id, user.email, token)
         if invitation is not None:
-            assert (
-                invitation.role is not None
-            ), "Invitation does not have any workspace role"
+            assert invitation.role is not None, (
+                "Invitation does not have any workspace role"
+            )
             await db_manager_ee.add_user_to_workspace_and_org(
                 organization, workspace, user, project_id, invitation.role
             )

api/ee/src/utils/entitlements.py

@@ -36,25 +36,25 @@ class EntitlementsException(Exception):
     pass
 
 
-NOT_ENTITLED_RESPONSE: Callable[
-    [Tracker], JSONResponse
-] = lambda tracker=None: JSONResponse(
-    status_code=403,
-    content={
-        "detail": (
-            "You have reached your monthly quota limit. Please upgrade your plan to continue."
-            if tracker == Tracker.COUNTERS
-            else (
-                "You have reached your quota limit. Please upgrade your plan to continue."
-                if tracker == Tracker.GAUGES
+NOT_ENTITLED_RESPONSE: Callable[[Tracker], JSONResponse] = (
+    lambda tracker=None: JSONResponse(
+        status_code=403,
+        content={
+            "detail": (
+                "You have reached your monthly quota limit. Please upgrade your plan to continue."
+                if tracker == Tracker.COUNTERS
                 else (
-                    "You do not have access to this feature. Please upgrade your plan to continue."
-                    if tracker == Tracker.FLAGS
-                    else "You do not have access to this feature."
+                    "You have reached your quota limit. Please upgrade your plan to continue."
+                    if tracker == Tracker.GAUGES
+                    else (
+                        "You do not have access to this feature. Please upgrade your plan to continue."
+                        if tracker == Tracker.FLAGS
+                        else "You do not have access to this feature."
+                    )
                 )
-            )
-        ),
-    },
+            ),
+        },
+    )
 )
 
 
@@ -163,7 +163,7 @@ async def check_entitlements(
 
     # TODO: remove this line
     log.info(
-        f"adjusting: {organization_id} | {(('0' if (meter.month != 0 and meter.month < 10) else '') + str(meter.month)) if meter.month != 0 else '  '}.{meter.year if meter.year else '    '} | {'allow' if check else 'deny '} | {meter.key}: {meter.value-meter.synced} [{meter.value}]"
+        f"adjusting: {organization_id} | {(('0' if (meter.month != 0 and meter.month < 10) else '') + str(meter.month)) if meter.month != 0 else '  '}.{meter.year if meter.year else '    '} | {'allow' if check else 'deny '} | {meter.key}: {meter.value - meter.synced} [{meter.value}]"
     )
 
     return check is True, meter, _