Merge pull request #11 from HemanthSai7/dev

TechdocsAPI/backend/router.py

@@ -50,7 +50,6 @@ async def signup(response: UserAuth):
 
 @app.post("/auth/login", summary="Logs in user", response_model=TokenSchema, tags=["Auth Server"])
 async def login(response:LoginCreds):
-    print("login")
     return ops_login(response)
 
 @app.put("/auth/regenerate_api_key",summary="Forget Password",response_model=APIKey,tags=["Auth Server"],dependencies=[Depends(JWTBearer())])

TechdocsAPI/backend/utils/prompt.txt

@@ -1,11 +1,16 @@
-You are an AI Coding Assitant and your task is to generate an elaborate, high quality docstring for the query function given by the user. A docstring consists of the following sections:
-1. Description: Is the description of what the function does.
-    2. Arguments: 
-        1. Argument Name: Description of the argument and its type.
-    3. Returns: Description of the return value of the function if any.
-    4. Raises: Description of the errors that can be raised by the function if any.
-    
-Instruction: {instruction}
+You are an AI Coding Assistant, and your role is to create comprehensive and highly informative docstrings for Python functions entered by the user. A well-structured docstring is essential for helping developers understand and use the function effectively. A standard Python docstring typically consists of the following sections:
+
+1. Description: This section should provide a clear and concise explanation of what the function does.
+
+2. Arguments: In this section, describe the function's parameters (arguments) and their types. Include both mandatory and optional arguments. For each argument, provide a detailed explanation of its purpose and expected data type.
+
+3. Returns: If the function returns a value, explain what that value represents and its data type. If the function doesn't return anything (i.e., it has a None return type), mention that explicitly.
+
+4. Raises: Describe any exceptions or errors that the function may raise during its execution. Specify the conditions under which these exceptions might occur.
+
+Please follow Google docstring style guidelines to generate a docstring for the query function given by the user.
+
+Instructions: {instruction}
         
 Your task is to generate a docstring for the above query.
 Response:

techdocs/requirements.txt

@@ -1 +0,0 @@
-tqdm

techdocs/utils/functools.py

@@ -24,7 +24,7 @@ def get_access_token(data, return_refresh_token=False):
 def request_inference(config, code_block, max_retries=1):
 
     if max_retries == 0:
-        return ""
+        return None
 
     url = BASE_URL+"/api/inference"
     headers={"accept":"application/json", "Authorization": f"Bearer {config['access_token']}"}
@@ -40,7 +40,7 @@ def request_inference(config, code_block, max_retries=1):
         print("Encountered error retrying...")
         config.update({"access_token":get_access_token(data)})
         
-        return request_inference(config,config["access_token"], code_block, max_retries=max_retries-1)
+        return request_inference(config, code_block, max_retries=max_retries-1)
     
 
     

techdocs/utils/parse.py

@@ -1,6 +1,5 @@
 import ast
 import os
-from tqdm import tqdm
 import requests
 
 from utils.functools import *
@@ -12,9 +11,14 @@ def extract_outermost_function(node, config):
     if isinstance(node, ast.FunctionDef):
         function_def = ast.unparse(node)
         response = request_inference(config=config, code_block=function_def)
-        docstr = response['docstr']
-        docstring = ast.Expr(value=ast.Str(s=docstr))
-        node.body.insert(0, docstring)
+        if response is not None:
+            try:
+                docstr = response.split('"""')
+                docstring = ast.Expr(value=ast.Str(s=docstr[1]))
+                print(f"Docstring generated for def {node.name}")
+                node.body.insert(0, docstring)
+            except IndexError:
+                pass    
         
 
     for child in ast.iter_child_nodes(node):
@@ -22,7 +26,7 @@ def extract_outermost_function(node, config):
 
 # Function to traverse directories recursively and extract functions from Python files
 def extract_functions_from_directory(config):
-    for root, _, files in os.walk(config["dir"]):
+    for root, dirnames, files in os.walk(config["dir"]):
         for file in files:
             if file.endswith(".py"):
                 file_path = os.path.join(root, file)

testing/test.py

@@ -1,8 +1,6 @@
 def add(a, b):
     return a + b
 
-
-
 def multiply(a, b):
     return a * b
 
@@ -11,10 +9,9 @@ def subtract(a, b):
 
 def divide(a, b):
     if b == 0:
-        raise ValueError("Cannot divide by zero")
+        raise ValueError('Cannot divide by zero')
     return a / b
 
-
 def func(*args, **kwargs):
     def wrapper(*args, **kwargs):
         return func(*args, **kwargs)