CMD tool ready

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,21 +1,106 @@
 def add(a, b):
-    return a + b
+    """
+Adds two numbers together.
+
+:param a: The first number to add. Must be a numeric type.
+:type a: int or float
 
+:param b: The second number to add. Must be a numeric type.
+:type b: int or float
 
+:returns: The sum of the two numbers.
+:rtype: int or float
+
+:raises TypeError: If the input parameters are not numeric types.
+:raises ValueError: If the input parameters are not numbers.
+"""
+    return a + b
 
 def multiply(a, b):
+    """
+Description: 
+    This function multiplies two numbers.
+    
+Arguments: 
+    a: First number to be multiplied. It should be an integer or a float.
+    b: Second number to be multiplied. It should be an integer or a float.
+    
+Returns: 
+    The product of the two numbers. It will be an integer or a float depending on the input.
+    
+Raises: 
+    None.
+"""
     return a * b
 
 def subtract(a, b):
+    """
+Description: 
+    This function performs subtraction of two numbers.
+    
+Arguments: 
+    a (int): The first number to be subtracted.
+    b (int): The second number to be subtracted from the first number.
+    
+Returns: 
+    int: Returns the difference of the two numbers.
+    
+Raises: 
+    None
+"""
     return a - b
 
 def divide(a, b):
+    """
+Description:
+This function divides two numbers.
+
+Arguments:
+a (float): The first number to be divided.
+b (float): The second number to be divided.
+
+Returns:
+float: Returns the result of a divided by b.
+
+Raises:
+ValueError: If b is equal to zero, it raises a ValueError with the message "Cannot divide by zero".
+"""
     if b == 0:
-        raise ValueError("Cannot divide by zero")
+        raise ValueError('Cannot divide by zero')
     return a / b
 
-
 def func(*args, **kwargs):
+    """
+    This function is a decorator that wraps another function and returns a wrapper function.
+
+    Arguments:
+    * args: A variable-length argument list (optional).
+    * kwargs: A dictionary of keyword arguments (optional).
+
+    Returns:
+    A wrapper function that calls the original function with the same arguments.
+
+    Raises:
+    None
+    """
+
     def wrapper(*args, **kwargs):
+        """
+    This function acts as a wrapper function that calls another function.
+
+    Arguments:
+    * args: Positional arguments to be passed to the wrapped function.
+             (type: tuple)
+    * kwargs: Keyword arguments to be passed to the wrapped function.
+              (type: dict)
+
+    Returns:
+    The result of calling the wrapped function with the provided arguments.
+            (type: any)
+
+    Raises:
+    Any exceptions raised by the wrapped function will be propagated.
+           (type: any)
+    """
         return func(*args, **kwargs)
     return wrapper