fix some lint errors

Author: gkorland

api/analyzers/source_analyzer.py

@@ -38,7 +38,7 @@ def supported_types(self) -> list[str]:
         """
         """
         return list(analyzers.keys())
-    
+
     def create_entity_hierarchy(self, entity: Entity, file: File, analyzer: AbstractAnalyzer, graph: Graph):
         types = analyzer.get_entity_types()
         stack = list(entity.node.children)

api/auto_complete.py

@@ -1,6 +1,6 @@
 from .graph import Graph
 
 def prefix_search(repo: str, prefix: str) -> str:
+    """ Returns a list of all entities in the repository that start with the given prefix. """
     g = Graph(repo)
     return g.prefix_search(prefix)
-

api/git_utils/git_utils.py

@@ -1,8 +1,7 @@
-import os
 import json
 import logging
 
-from pygit2 import Commit, Diff
+from pygit2 import Diff
 from ..info import *
 from pygit2.repository import Repository
 from pygit2.enums import DeltaStatus, CheckoutStrategy
@@ -16,6 +15,7 @@
 logging.basicConfig(level=logging.DEBUG, format='%(filename)s - %(asctime)s - %(levelname)s - %(message)s')
 
 def GitRepoName(repo_name):
+    """ Returns the git repository name """
     return "{" + repo_name + "}_git"
 
 def is_ignored(file_path: str, ignore_list: List[str]) -> bool:
@@ -32,7 +32,11 @@ def is_ignored(file_path: str, ignore_list: List[str]) -> bool:
 
     return any(file_path.startswith(ignore) for ignore in ignore_list)
 
-def classify_changes(diff: Diff, repo: Repository, supported_types: list[str], ignore_list: List[str]) -> tuple[list[Path], list[Path], list[Path]]:
+def classify_changes(
+    diff: Diff,
+    repo: Repository,
+    supported_types: list[str],
+    ignore_list: List[str]) -> tuple[list[Path], list[Path], list[Path]]:
     """
     Classifies changes into added, deleted, and modified files.
 
@@ -48,17 +52,17 @@ def classify_changes(diff: Diff, repo: Repository, supported_types: list[str], i
 
     for change in diff.deltas:
         if change.status == DeltaStatus.ADDED and not is_ignored(change.new_file.path, ignore_list):
-            logging.debug(f"new file: {change.new_file}")
+            logging.debug("new file: %s", change.new_file)
             file_path = Path(f"{repo.workdir}/{change.new_file.path}")
             if file_path.suffix in supported_types:
                 added.append(file_path)
         if change.status == DeltaStatus.DELETED and not is_ignored(change.old_file.path, ignore_list):
-            logging.debug(f"deleted file: {change.old_file.path}")
+            logging.debug("deleted file: %s", change.old_file.path)
             file_path = Path(f"{repo.workdir}/{change.old_file.path}")
             if file_path.suffix in supported_types:
                 deleted.append(file_path)
         if change.status == DeltaStatus.MODIFIED and not is_ignored(change.new_file.path, ignore_list):
-            logging.debug(f"change file: {change.new_file.path}")
+            logging.debug("change file: %s", change.new_file.path)
             file_path = Path(f"{repo.workdir}/{change.new_file.path}")
             if file_path.suffix in supported_types:
                 modified.append(file_path)
@@ -83,7 +87,7 @@ def build_commit_graph(path: str, analyzer: SourceAnalyzer, repo_name: str, igno
         ignore_list = []
 
     # Copy the graph into a temporary graph
-    logging.info(f"Cloning source graph {repo_name} -> {repo_name}_tmp")
+    logging.info("Cloning source graph %s -> %s_tmp", repo_name, repo_name)
     # Will be deleted at the end of this function
     g = Graph(repo_name).clone(repo_name + "_tmp")
     g.enable_backlog()

api/index.py

@@ -1,12 +1,17 @@
+""" Main API module for CodeGraph. """
 import os
-from api import *
 from pathlib import Path
 from functools import wraps
 from dotenv import load_dotenv
+from flask import Flask, request, jsonify
 
+from api.analyzers.source_analyzer import SourceAnalyzer
+from api.git_utils import git_utils
+from api.graph import Graph, get_repos, graph_exists
+from api.info import get_repo_info
+from api.llm import ask
 from api.project import Project
 from .auto_complete import prefix_search
-from flask import Flask, request, jsonify
 
 # Load environment variables from .env file
 load_dotenv()
@@ -17,13 +22,13 @@
                     format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 logger = logging.getLogger(__name__)
 
-# Function to verify the token
 SECRET_TOKEN = os.getenv('SECRET_TOKEN')
 def verify_token(token):
+    """ Verify the token provided in the request """
     return token == SECRET_TOKEN or (token is None and SECRET_TOKEN is None)
 
-# Decorator to protect routes with token authentication
 def token_required(f):
+    """ Decorator to protect routes with token authentication """
     @wraps(f)
     def decorated_function(*args, **kwargs):
         token = request.headers.get('Authorization')  # Get token from header
@@ -34,8 +39,8 @@ def decorated_function(*args, **kwargs):
 
 app = Flask(__name__)
 
-# Decorator to protect routes with public access
 def public_access(f):
+    """ Decorator to protect routes with public access """
     @wraps(f)
     def decorated_function(*args, **kwargs):
         public = os.environ.get("CODE_GRAPH_PUBLIC", "0")  # Get public access setting
@@ -65,7 +70,7 @@ def graph_entities():
         return jsonify({"status": "Missing 'repo' parameter"}), 400
 
     if not graph_exists(repo):
-        logging.error(f"Missing project {repo}")
+        logging.error("Missing project %s", repo)
         return jsonify({"status": f"Missing project {repo}"}), 400
 
     try:
@@ -75,7 +80,7 @@ def graph_entities():
         # Retrieve a sub-graph of up to 500 entities
         sub_graph = g.get_sub_graph(500)
 
-        logging.info(f"Successfully retrieved sub-graph for repo: {repo}")
+        logging.info("Successfully retrieved sub-graph for repo: %s", repo)
         response = {
             'status': 'success',
             'entities': sub_graph
@@ -84,7 +89,7 @@ def graph_entities():
         return jsonify(response), 200
 
     except Exception as e:
-        logging.error(f"Error retrieving sub-graph for repo '{repo}': {e}")
+        logging.error("Error retrieving sub-graph for repo '%s': %s", repo, e)
         return jsonify({"status": "Internal server error"}), 500
 
 
@@ -118,7 +123,7 @@ def get_neighbors():
 
     # Validate repo exists
     if not graph_exists(repo):
-        logging.error(f"Missing project {repo}")
+        logging.error("Missing project %s", repo)
         return jsonify({"status": f"Missing project {repo}"}), 400
 
     # Initialize the graph with the provided repository
@@ -128,7 +133,7 @@ def get_neighbors():
     neighbors = g.get_neighbors(node_ids)
 
     # Log and return the neighbors
-    logging.info(f"Successfully retrieved neighbors for node IDs {node_ids} in repo '{repo}'.")
+    logging.info("Successfully retrieved neighbors for node IDs %s in repo '%s'.", node_ids, repo)
 
     response = {
         'status': 'success',
@@ -153,12 +158,12 @@ def auto_complete():
     # Validate that 'repo' is provided
     repo = data.get('repo')
     if repo is None:
-        return jsonify({'status': f'Missing mandatory parameter "repo"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "repo"'}), 400
 
     # Validate that 'prefix' is provided
     prefix = data.get('prefix')
     if prefix is None:
-        return jsonify({'status': f'Missing mandatory parameter "prefix"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "prefix"'}), 400
 
     # Validate repo exists
     if not graph_exists(repo):
@@ -219,7 +224,7 @@ def repo_info():
     # Validate the 'repo' parameter
     repo = data.get('repo')
     if repo is None:
-        return jsonify({'status': f'Missing mandatory parameter "repo"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "repo"'}), 400
 
     # Initialize the graph with the provided repository name
     g = Graph(repo)
@@ -231,7 +236,7 @@ def repo_info():
     if stats is None or info is None:
         return jsonify({'status': f'Missing repository "{repo}"'}), 400
 
-    stats |= info 
+    stats |= info
 
     # Create a response
     response = {
@@ -265,24 +270,24 @@ def find_paths():
     # Validate 'repo' parameter
     repo = data.get('repo')
     if repo is None:
-        return jsonify({'status': f'Missing mandatory parameter "repo"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "repo"'}), 400
 
     # Validate 'src' parameter
     src = data.get('src')
     if src is None:
-        return jsonify({'status': f'Missing mandatory parameter "src"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "src"'}), 400
     if not isinstance(src, int):
         return jsonify({'status': "src node id must be int"}), 400
 
     # Validate 'dest' parameter
     dest = data.get('dest')
     if dest is None:
-        return jsonify({'status': f'Missing mandatory parameter "dest"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "dest"'}), 400
     if not isinstance(dest, int):
         return jsonify({'status': "dest node id must be int"}), 400
 
     if not graph_exists(repo):
-        logging.error(f"Missing project {repo}")
+        logging.error("Missing project %s", repo)
         return jsonify({"status": f"Missing project {repo}"}), 400
 
     # Initialize graph with provided repo and credentials
@@ -299,18 +304,20 @@ def find_paths():
 @app.route('/chat', methods=['POST'])
 @token_required  # Apply token authentication decorator
 def chat():
+    """ Endpoint to chat with the CodeGraph language model. """
+
     # Get JSON data from the request
     data = request.get_json()
 
     # Validate 'repo' parameter
     repo = data.get('repo')
     if repo is None:
-        return jsonify({'status': f'Missing mandatory parameter "repo"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "repo"'}), 400
 
     # Get optional 'label' and 'relation' parameters
     msg = data.get('msg')
     if msg is None:
-        return jsonify({'status': f'Missing mandatory parameter "msg"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "msg"'}), 400
 
     answer = ask(repo, msg)
 
@@ -348,7 +355,7 @@ def analyze_folder():
 
     # Validate path exists and is a directory
     if not os.path.isdir(path):
-        logging.error(f"Path '{path}' does not exist or is not a directory")
+        logging.error("Path '%s' does not exist or is not a directory", path)
         return jsonify({"status": "Invalid path: must be an existing directory"}), 400
 
     # Validate ignore list contains valid paths
@@ -392,8 +399,8 @@ def analyze_repo():
     data = request.get_json()
     url = data.get('repo_url')
     if url is None:
-        return jsonify({'status': f'Missing mandatory parameter "url"'}), 400
-    logger.debug(f'Received repo_url: {url}')
+        return jsonify({'status': 'Missing mandatory parameter "url"'}), 400
+    logger.debug('Received repo_url: %s', url)
 
     ignore = data.get('ignore', [])
 
@@ -425,12 +432,12 @@ def switch_commit():
     # Validate that 'repo' is provided
     repo = data.get('repo')
     if repo is None:
-        return jsonify({'status': f'Missing mandatory parameter "repo"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "repo"'}), 400
 
     # Validate that 'commit' is provided
     commit = data.get('commit')
     if commit is None:
-        return jsonify({'status': f'Missing mandatory parameter "commit"'}), 400
+        return jsonify({'status': 'Missing mandatory parameter "commit"'}), 400
 
     # Attempt to switch the repository to the specified commit
     git_utils.switch_commit(repo, commit)
@@ -440,4 +447,4 @@ def switch_commit():
         'status': 'success'
     }
 
-    return jsonify(response), 200
+    return jsonify(response), 200