Merge pull request #59 from microsoft/hotfix-pylintfix

style: Pylint fixes

Author: Roopan-Microsoft

.flake8

@@ -2,4 +2,4 @@
 max-line-length = 88
 extend-ignore = E501
 exclude = .venv, frontend
-ignore = E203, W503, G004, G200
+ignore = E203, W503, G004, G200,B008,ANN,D100,D101,D102,D103,D104,D105,D106,D107

src/backend/api/api_routes.py

@@ -1,13 +1,15 @@
-"""FastAPI API routes for file processing and conversion"""
+"""FastAPI API routes for file processing and conversion."""
 
 import asyncio
 import io
 import zipfile
 
 from api.auth.auth_utils import get_authenticated_user
 from api.status_updates import app_connection_manager, close_connection
+
 from common.logger.app_logger import AppLogger
 from common.services.batch_service import BatchService
+
 from fastapi import (
     APIRouter,
     File,
@@ -24,13 +26,14 @@
 logger = AppLogger("APIRoutes")
 
 # start processing the batch
-from sql_agents_start import process_batch_async
+from sql_agents_start import process_batch_async  # noqa: E402
 
 
 @router.post("/start-processing")
 async def start_processing(request: Request):
     """
-    Start processing files for a given batch
+    Start processing files for a given batch.
+
     ---
     tags:
     - File Processing
@@ -50,6 +53,7 @@ async def start_processing(request: Request):
     responses:
       200:
         description: Processing initiated successfully
+
         content:
           application/json:
             schema:
@@ -61,6 +65,7 @@ async def start_processing(request: Request):
                   type: string
       400:
         description: Invalid processing request
+
       500:
         description: Internal server error
     """
@@ -89,7 +94,7 @@ async def start_processing(request: Request):
 )
 async def download_files(batch_id: str):
     """
-    Download files as ZIP
+    Download files as ZIP.
 
     ---
     tags:
@@ -118,7 +123,6 @@ async def download_files(batch_id: str):
               type: string
               example: Batch not found
     """
-
     # call batch_service get_batch_for_zip to get all files for batch_id
     batch_service = BatchService()
     await batch_service.initialize_database()
@@ -172,7 +176,7 @@ async def batch_status_updates(
     websocket: WebSocket, batch_id: str
 ):  # , request: Request):
     """
-    WebSocket endpoint for real-time batch status updates
+    Web-Socket endpoint for real-time batch status updates.
 
     ---
     tags:
@@ -248,7 +252,7 @@ async def batch_status_updates(
 @router.get("/batch-story/{batch_id}")
 async def get_batch_status(request: Request, batch_id: str):
     """
-    Retrieve batch history and file statuses
+    Retrieve batch history and file statuses.
 
     ---
     tags:
@@ -371,9 +375,7 @@ async def get_batch_status(request: Request, batch_id: str):
 
 @router.get("/batch-summary/{batch_id}")
 async def get_batch_summary(request: Request, batch_id: str):
-    """
-    Retrieve batch summary for a given batch ID.
-    """
+    """Retrieve batch summary for a given batch ID."""
     try:
         batch_service = BatchService()
         await batch_service.initialize_database()
@@ -404,7 +406,7 @@ async def upload_file(
     request: Request, file: UploadFile = File(...), batch_id: str = Form(...)
 ):
     """
-    Upload file for conversion
+    Upload file for conversion.
 
     ---
     tags:
@@ -634,7 +636,7 @@ async def get_file_details(request: Request, file_id: str):
 @router.delete("/delete-batch/{batch_id}")
 async def delete_batch_details(request: Request, batch_id: str):
     """
-    delete batch history using batch_id
+    Delete batch history using batch_id.
 
     ---
     tags:
@@ -689,7 +691,7 @@ async def delete_batch_details(request: Request, batch_id: str):
 @router.delete("/delete-file/{file_id}")
 async def delete_file_details(request: Request, file_id: str):
     """
-    delete file history using batch_id
+    Delete file history using batch_id.
 
     ---
     tags:
@@ -747,7 +749,7 @@ async def delete_file_details(request: Request, file_id: str):
 @router.delete("/delete_all")
 async def delete_all_details(request: Request):
     """
-    delete all the history of batches, files and logs
+    Delete all the history of batches, files and logs.
 
     ---
     tags:

src/backend/api/auth/auth_utils.py

@@ -1,10 +1,12 @@
-from fastapi import Request, HTTPException
-import logging
 import base64
 import json
+import logging
 from typing import Dict
+
 from api.auth.sample_user import sample_user
 
+from fastapi import HTTPException, Request
+
 logger = logging.getLogger(__name__)
 
 
@@ -26,19 +28,19 @@ def __init__(self, user_details: Dict):
 
 
 def get_tenant_id(client_principal_b64: str) -> str:
-    """Extract tenant ID from base64 encoded client principal"""
+    """Extract tenant ID from base64 encoded client principal."""
     try:
         decoded_bytes = base64.b64decode(client_principal_b64)
         decoded_string = decoded_bytes.decode("utf-8")
         user_info = json.loads(decoded_string)
         return user_info.get("tid", "")
-    except Exception as ex:
+    except Exception :
         logger.exception("Error decoding client principal")
         return ""
 
 
 def get_authenticated_user(request: Request) -> UserDetails:
-    """Get authenticated user details from request headers"""
+    """Get authenticated user details from request headers."""
     user_object = {}
     headers = dict(request.headers)
     # Check if we're in production with real headers

src/backend/api/auth/sample_user.py

@@ -5,4 +5,4 @@
     "x-ms-client-principal-idp": "aad",
     "x-ms-token-aad-id-token": "dev.token",
     "x-ms-client-principal": "your_base_64_encoded_token"
-}
+}

src/backend/api/status_updates.py

@@ -1,5 +1,6 @@
 """
 Holds collection of websocket connections.
+
 from clients registering for status updates.
 These socket references are used to send updates to
 registered clients from the backend processing code.
@@ -11,6 +12,7 @@
 from typing import Dict
 
 from common.models.api import FileProcessUpdate, FileProcessUpdateJSONEncoder
+
 from fastapi import WebSocket
 
 logger = logging.getLogger(__name__)

src/backend/app.py

@@ -1,12 +1,14 @@
-import uvicorn
-
-# Import our route modules
+"""Create and configure the FastAPI application."""
 from api.api_routes import router as backend_router
+
 from common.logger.app_logger import AppLogger
+
 from dotenv import load_dotenv
+
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
+import uvicorn
 # from agent_services.agents_routes import router as agents_router
 
 # Load environment variables
@@ -17,9 +19,7 @@
 
 
 def create_app() -> FastAPI:
-    """
-    Factory function to create and configure the FastAPI application
-    """
+    """Create and return the FastAPI application instance."""
     app = FastAPI(title="Code Gen Accelerator", version="1.0.0")
 
     # Configure CORS
@@ -37,7 +37,7 @@ def create_app() -> FastAPI:
 
     @app.get("/health")
     async def health_check():
-        """Health check endpoint"""
+        """Health check endpoint."""
         return {"status": "healthy"}
 
     return app

src/backend/common/config/config.py

@@ -1,6 +1,7 @@
 import os
 
 from azure.identity.aio import ClientSecretCredential, DefaultAzureCredential
+
 from dotenv import load_dotenv
 
 load_dotenv()

src/backend/common/database/cosmosdb.py

@@ -1,15 +1,14 @@
 from datetime import datetime, timezone
-from enum import Enum
 from typing import Dict, List, Optional
 from uuid import UUID, uuid4
 
 from azure.cosmos import PartitionKey, exceptions
 from azure.cosmos.aio import CosmosClient
 from azure.cosmos.aio._database import DatabaseProxy
 from azure.cosmos.exceptions import (
-    CosmosResourceExistsError,
-    CosmosResourceNotFoundError,
+    CosmosResourceExistsError
 )
+
 from common.database.database_base import DatabaseBase
 from common.logger.app_logger import AppLogger
 from common.models.api import (
@@ -20,6 +19,7 @@
     LogType,
     ProcessStatus,
 )
+
 from semantic_kernel.contents import AuthorRole
 
 
@@ -208,7 +208,7 @@ async def get_batch_files(self, batch_id: str) -> List[Dict]:
             raise
 
     async def get_batch_from_id(self, batch_id: str) -> Dict:
-        """Retrieve a batch from the database using the batch ID"""
+        """Retrieve a batch from the database using the batch ID."""
         try:
             query = "SELECT * FROM c WHERE c.batch_id = @batch_id"
             params = [{"name": "@batch_id", "value": batch_id}]
@@ -225,7 +225,7 @@ async def get_batch_from_id(self, batch_id: str) -> Dict:
             raise
 
     async def get_user_batches(self, user_id: str) -> Dict:
-        """Retrieve all batches for a given user"""
+        """Retrieve all batches for a given user."""
         try:
             query = "SELECT * FROM c WHERE c.user_id = @user_id"
             params = [{"name": "@user_id", "value": user_id}]
@@ -242,7 +242,7 @@ async def get_user_batches(self, user_id: str) -> Dict:
             raise
 
     async def get_file_logs(self, file_id: str) -> List[Dict]:
-        """Retrieve all logs for a given file"""
+        """Retrieve all logs for a given file."""
         try:
             query = (
                 "SELECT * FROM c WHERE c.file_id = @file_id ORDER BY c.timestamp DESC"
@@ -322,7 +322,7 @@ async def add_file_log(
         agent_type: AgentType,
         author_role: AuthorRole,
     ) -> None:
-        """Log a file status update"""
+        """Log a file status update."""
         try:
             log_id = uuid4()
             log_entry = FileLog(
@@ -343,7 +343,7 @@ async def add_file_log(
     async def update_batch_entry(
         self, batch_id: str, user_id: str, status: ProcessStatus, file_count: int
     ):
-        """Update batch status"""
+        """Update batch status."""
         try:
             batch = await self.get_batch(user_id, batch_id)
             if not batch: