CLI testing complete

testing/logs_2024_01_07_16_08_04.log

@@ -0,0 +1,23 @@
+2024-01-07 16:08:04,077:INFO:Logs generated at "testing\logs_2024_01_07_16_08_04.log". For detailed logs check the file.
+2024-01-07 16:08:04,078:INFO:Docstrings generation started for "testing/*.py" files
+2024-01-07 16:08:04,078:INFO:Working on "testing\*.py"
+2024-01-07 16:08:04,093:INFO:Working on "testing\test.py"
+2024-01-07 16:08:07,627:INFO:Docstring generated for def add
+2024-01-07 16:08:07,629:INFO:==================================================
+2024-01-07 16:08:07,631:INFO:Docstrings generation completed for "testing\.*py". Time Taken: 0:00:03.552157
+2024-01-07 16:08:07,632:INFO:>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+2024-01-07 16:08:07,632:INFO:Working on "testing\pack\*.py"
+2024-01-07 16:08:07,635:INFO:Working on "testing\pack\DBQueries.py"
+2024-01-07 16:08:13,942:INFO:Docstring generated for def insert_to_database
+2024-01-07 16:08:18,222:INFO:Docstring generated for def fetch_data_from_database
+2024-01-07 16:08:25,204:INFO:Docstring generated for def update_data_in_database
+2024-01-07 16:08:25,206:INFO:==================================================
+2024-01-07 16:08:25,207:INFO:Working on "testing\pack\functools.py"
+2024-01-07 16:08:30,500:INFO:Docstring generated for def get_access_token
+2024-01-07 16:08:34,476:INFO:Docstring generated for def request_inference
+2024-01-07 16:08:40,210:INFO:Docstring generated for def update_file
+2024-01-07 16:08:45,481:INFO:Docstring generated for def issue_api_key
+2024-01-07 16:08:50,504:INFO:Docstring generated for def signup
+2024-01-07 16:08:50,507:INFO:==================================================
+2024-01-07 16:08:50,508:INFO:Docstrings generation completed for "testing\pack\.*py". Time Taken: 0:00:42.875458
+2024-01-07 16:08:50,508:INFO:>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

testing/pack/DBQueries.py

@@ -9,31 +9,17 @@ class DBQueries:
 
     @classmethod
     def insert_to_database(cls, table_name: str, data: Union[Tuple, List[Tuple]], cols: List[str]=None):
-        """
-    This method is used to insert data into a specified table in the database.
+        """Wrapper method to insert data to the database.
 
     Args:
-    table_name (str): The name of the table into which data will be inserted.
-    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.
-    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.
+        table_name (str): Name of the table in the database.
+        data (Union[Tuple, List[Tuple]]): Data to be inserted in the table. It can be a single tuple or a list of tuples.
+        cols (List[str], optional): List of columns in the table. If not provided, all columns will be used.
 
     Raises:
-    None
-
-    Returns:
-    None
-
-    """
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n        This method is used to insert data into a specified table in the database.\n\n        Args:\n        table_name (str): The name of the table into which data will be inserted.\n        data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n        cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n        Raises:\n        None\n\n        Returns:\n        None\n\n        '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples, where each tuple represents a row of data.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n    '
-        '\n    This method is used to insert data into a specified table in the database.\n\n    Args:\n    table_name (str): The name of the table into which data will be inserted.\n    data (Union[Tuple, List[Tuple]]): The data to be inserted into the table. This can be a tuple or a list of tuples.\n    cols (List[str], optional): A list of column names in the table. If not provided, the method will assume that all columns are included. Defaults to None.\n\n    Raises:\n    None\n\n    Returns:\n    None\n    '
+        ValidationError: If data is not a tuple or a list of tuples.
+        InternalServerError: If an error occurs while inserting data to the database.
+"""
         con = DBConnection.get_client()
         cursor = con.cursor()
         QUERY = f"INSERT INTO {{table_name}} ({','.join(cols)}) VALUES ".format(table_name=table_name)
@@ -47,38 +33,16 @@ class DBQueries:
 
     @classmethod
     def fetch_data_from_database(cls, table_name: str, cols_to_fetch: Union[str, List[str]], where_clause: str=None):
-        """
-    This method is a class method that fetches data from a specified table in the database based on the provided column names and,
-    optionally, a WHERE clause.
+        """Method to fetch data from database using a SQL query.
 
     Args:
-    - table_name: A string representing the name of the table from which to fetch data.
-    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,
-    it will be treated as a comma-separated list of column names.
-    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.
+        table_name: str. Name of the table to fetch data from.
+        cols_to_fetch: Union[str, List[str]]. Columns to fetch from the table.
+        where_clause: str. Optional. Where clause to filter the data.
 
     Returns:
-    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,
-    and contains the values of the fetched columns in the order specified.
-
-    Raises:
-    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which
-    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.
-
+        List. List of tuples containing the fetched data.
 """
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n    '
-        '\n    This method is a class method that fetches data from a specified table in the database based on the provided column names and,\n    optionally, a WHERE clause.\n\n    Args:\n    - table_name: A string representing the name of the table from which to fetch data.\n    - cols_to_fetch: A string or a list of strings representing the column(s) to fetch from the table. If a single string,\n    it will be treated as a comma-separated list of column names.\n    - where_clause: An optional string representing a WHERE clause to filter the fetched data. Defaults to None.\n\n    Returns:\n    - cursor.fetchall(): A list of tuples representing the fetched data. Each tuple corresponds to a row in the result set,\n    and contains the values of the fetched columns in the order specified.\n\n    Raises:\n    - No exceptions are explicitly raised by this method. However, underlying database operations may raise exceptions, which\n    are not handled or propagated by this method. It is the responsibility of the caller to handle any exceptions that may occur.\n    '
         con = DBConnection.get_client()
         cursor = con.cursor()
         if isinstance(cols_to_fetch, str):
@@ -92,21 +56,25 @@ class DBQueries:
 
     @classmethod
     def update_data_in_database(cls, table_name: str, cols_to_update: Union[str, List[str]], where_clause: str=None, new_values: Union[str, List[str]]=None):
-        """
-    This method updates the data in a specified table in the database.
-
-    Args:
-        table_name (str): The name of the table in which the data needs to be updated.
-        cols_to_update (Union[str, List[str]]): The column(s) to be updated. If a single string, it should end with '=%s'. If a list, it should contain strings, each ending with '=%s'.
-        where_clause (str, optional): The WHERE clause of the SQL query. Defaults to None.
-        new_values (Union[str, List[str]], optional): The new values to be updated in the columns. If a single string, it should be a list of new values. If a list, it should contain the new values for each column. Defaults to None.
+        """Updates the values of the columns in the table defined by `table_name`
+       where the condition defined by `where_clause` is met.
 
-    Returns:
-        bool: Returns True if the data is successfully updated in the database.
+       Args:
+           table_name: str. Name of the table.
+           cols_to_update: Union[str, List[str]]. Column/s to be updated. If a
+                           single column is to be updated, pass it as a string.
+                           If multiple columns are to be updated, pass them as a
+                           list of strings.
+           where_clause: str. Conditions to be met by the rows to be updated.
+                          If no condition is to be imposed, pass it as None.
+           new_values: Union[str, List[str]]. New values to be set in the
+                        columns. If a single column is to be updated, pass the
+                        new value as a string. If multiple columns are to be
+                        updated, pass the new values as a list of strings.
 
-    Raises:
-        Exception: If the database connection fails or the query execution fails.
-    """
+       Returns:
+           bool. True if update was successful, False otherwise.
+"""
         con = DBConnection.get_client()
         cursor = con.cursor()
         if isinstance(cols_to_update, str):

testing/pack/functools.py

@@ -3,21 +3,14 @@ import requests
 BASE_URL = 'https://caffeinecrew-techdocs.hf.space'
 
 def get_access_token(data, return_refresh_token=False):
-    """
-    This function sends a POST request to the specified URL to get an access token.
-    
-    Arguments:
-    data (dict): A dictionary containing the credentials required for authentication.
-    return_refresh_token (bool, optional): A flag to indicate if the refresh token should be returned. Defaults to False.
-    
+    """Authenticates and returns the access token.
+
+    Args:
+        data: dict. User login credentials.
+
     Returns:
-    str or tuple: If return_refresh_token is False, the function returns the access token as a string. If return_refresh_token is True, the function returns a tuple containing the access token and the refresh token.
-    
-    Raises:
-    Exception: If an error occurs during the execution of the function, an Exception is raised.
-    """
-    '\n    This function sends a POST request to the specified URL to get an access token.\n    \n    Arguments:\n    data (dict): A dictionary containing the credentials required for authentication.\n    return_refresh_token (bool, optional): A flag to indicate if the refresh token should be returned. Defaults to False.\n    \n    Returns:\n    str or tuple: If return_refresh_token is False, the function returns the access token as a string. If return_refresh_token is True, the function returns a tuple containing the access token and the refresh token.\n    \n    Raises:\n    Exception: If an error occurs during the execution of the function, an Exception is raised.\n    '
-    '\n    This function sends a POST request to the specified URL to get an access token.\n    \n    Arguments:\n    data (dict): A dictionary containing the credentials required for authentication.\n    return_refresh_token (bool, optional): A flag to indicate if the refresh token should be returned. Defaults to False.\n    \n    Returns:\n    str or tuple: If return_refresh_token is False, the function returns the access token as a string. If return_refresh_token is True, the function returns a tuple containing the access token and the refresh token.\n    \n    Raises:\n    Exception: If an error occurs during the execution of the function, an Exception is raised.\n    '
+        str. The access token.
+"""
     try:
         url = BASE_URL + '/auth/login'
         headers = {'accept': 'application/json'}
@@ -33,25 +26,18 @@ def get_access_token(data, return_refresh_token=False):
         return None
 
 def request_inference(config, code_block, max_retries=1):
-    """
-Usage: request_inference(config, code_block, max_retries=1)
-
-Purpose:
-This function sends a POST request to the API server to perform code inference.
+    """Request for inference from an external model.
 
-Arguments:
-- config (dict): A dictionary containing the necessary authentication details like 'access_token', 'api_key' and 'username'.
-- code_block (str): The code block that needs to be inferenced.
-- max_retries (int, optional): The maximum number of times the function should retry in case of an error. Defaults to 1.
+    Args:
+        config: Config. Configuration dictionary with model credentials,
+                api key, and access token.
+        code_block: str. Code block for which inference is requested.
+        max_retries: int, optional. Number of retries to be made in case
+                 of failure. Defaults to 1.
 
-Returns:
-- str: The docstring of the inferenced code block.
-
-Raises:
-- Exception: If the maximum number of retries (specified by max_retries) is reached and the API server still returns an error.
+    Returns:
+        str: Docstring generated from the model.
 """
-    "\nUsage: request_inference(config, code_block, max_retries=1)\n\nPurpose:\nThis function sends a POST request to the API server to perform code inference.\n\nArguments:\n- config (dict): A dictionary containing the necessary authentication details like 'access_token', 'api_key' and 'username'.\n- code_block (str): The code block that needs to be inferenced.\n- max_retries (int, optional): The maximum number of times the function should retry in case of an error. Defaults to 1.\n\nReturns:\n- str: The docstring of the inferenced code block.\n\nRaises:\n- Exception: If the maximum number of retries (specified by max_retries) is reached and the API server still returns an error.\n"
-    "\nUsage: request_inference(config, code_block, max_retries=1)\n\nPurpose:\nThis function sends a POST request to the API server to perform code inference.\n\nArguments:\n- config (dict): A dictionary containing the necessary authentication details like 'access_token', 'api_key' and 'username'.\n- code_block (str): The code block that needs to be inferenced.\n- max_retries (int, optional): The maximum number of times the function should retry in case of an error. Defaults to 1.\n\nReturns:\n- str: The docstring of the inferenced code block.\n\nRaises:\n- Exception: If the maximum number of retries (specified by max_retries) is reached and the API server still returns an error.\n"
     if max_retries == 0:
         return None
     url = BASE_URL + '/api/inference'
@@ -67,43 +53,30 @@ Raises:
         return request_inference(config, code_block, max_retries=max_retries - 1)
 
 def update_file(file_path, docstr_code):
-    """
-    This function updates the docstring of a Python file.
+    """insert a single record or iterable of records to the database.
 
-    Arguments:
-    file_path (str): The path of the Python file to be updated.
-    docstr_code (str): The new docstring to be written to the file.
-
-    Returns:
-    None
+        Args:
+            db_name (str): name of the database
+            coll_name (str): name of the collection
+            data (dict): data to be inserted
 
-    Raises:
-    FileNotFoundError: If the specified file does not exist.
-    IOError: If there is an error while writing to the file.
-    """
-    '\n    This function performs some operation on the given arguments.\n\n    Arguments:\n    arg1 (int): The first argument. A positive integer.\n    arg2 (float): The second argument. A positive floating point number.\n    arg3 (str): The third argument. A string containing only alphabets.\n    arg4 (bool): The fourth argument. A boolean value.\n\n    Returns:\n    None\n\n    Raises:\n    TypeError: If any argument is not of the expected type.\n    ValueError: If arg1 is less than or equal to zero, or if arg2 is not a positive number, or if arg3 contains any non-alphabetic character, or if arg4 is not a boolean value.\n    '
-    '\n    This function updates the docstring of a Python file.\n\n    Arguments:\n    file_path (str): The path of the Python file to be updated.\n    docstr_code (str): The new docstring to be written to the file.\n\n    Returns:\n    None\n\n    Raises:\n    FileNotFoundError: If the specified file does not exist.\n    IOError: If there is an error while writing to the file.\n    '
+        Returns:
+            An instance of class: pymongo.results.InsertOneResult or 
+            pymongo.results.InsertManyResult
+        """
     with open(file_path, 'w', errors='ignore') as file:
         file.write(docstr_code)
 
 def issue_api_key(config):
-    """
-    This function generates a new API key for the given user.
-
-    Arguments:
-    config: dict, A dictionary containing the user's configuration details.
-        - access_token: str, The user's access token.
-        - username: str, The user's username.
+    """Issues an API key for a valid user
 
-    Returns:
-    None, Prints the new API key to the console.
+    Args:
+        config (dict): Config dictionary containing `username` and `access_token`
+        of the user.
 
     Raises:
-    Exception, If the API key generation fails. The error message will be printed to the console.
-
-    """
-    "\n    This function generates a new API key for the given user.\n\n    Arguments:\n    config: dict, A dictionary containing the user's configuration details.\n        - access_token: str, The user's access token.\n        - username: str, The user's username.\n\n    Returns:\n    None, Prints the new API key to the console.\n\n    Raises:\n    Exception, If the API key generation fails. The error message will be printed to the console.\n\n    "
-    "\n    This function generates a new API key for the given user.\n\n    Arguments:\n    config: A dictionary containing the user's configuration details.\n        - access_token: str, The user's access token.\n        - username: str, The user's username.\n\n    Returns:\n    None, prints the new API key to the console.\n\n    Raises:\n    Exception, If the API key generation fails. The error message will be printed to the console.\n    "
+        Exception: If API key generation fails.
+"""
     try:
         headers = {'accept': 'application/json', 'Authorization': f"Bearer {config['access_token']}"}
         response = requests.put(url=BASE_URL + '/auth/regenerate_api_key', headers=headers, data=json.dumps({'username': config['username']}))
@@ -114,23 +87,17 @@ def issue_api_key(config):
         print(f'$ {e}')
 
 def signup(config):
-    """
-    This function is used to sign up a user with the provided configuration.
-
-    Arguments:
-    config: dict
-        A dictionary containing the user's signup information.
+    """Sends a request to the server to create a new user account.
 
-    Returns:
-    None
+    Args:
+        config (dict): A dictionary containing the following keys:
+            - 'username': The username of the new user.
+            - 'email': The email address of the new user.
+            - 'password': The password of the new user.
 
     Raises:
-    Exception
-        If the username or email already exists.
-        If there's a general error during the sign up process.
-    """
-    "\n    This function is used to sign up a user with the provided configuration.\n\n    Arguments:\n    config: dict\n        A dictionary containing the user's signup information.\n\n    Returns:\n    None\n\n    Raises:\n    Exception\n        If the username or email already exists.\n        If there's a general error during the sign up process.\n    "
-    '\ndef signup(config: dict) -> None:\n    '
+        Exception: If the request fails or the status code is not 200.
+"""
     try:
         headers = {'accept': 'application/json'}
         response = requests.post(url=BASE_URL + '/auth/signup', headers=headers, data=json.dumps(config))

testing/test.py

@@ -1,33 +1,11 @@
 def add(a, b):
-    """
-    This function adds two integers.
+    """Computes and returns the sum of two numbers.
 
-    Arguments:
-    a (int): The first integer to be added.
-    b (int): The second integer to be added.
+Args:
+    a (int): The first number.
+    b (int): The second number.
 
-    Returns:
-    int: The sum of the two integers.
-    """
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two integers.\n\n    Arguments:\n    a (int): The first integer to be added.\n    b (int): The second integer to be added.\n\n    Returns:\n    int: The sum of the two integers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
-    '\n    This function adds two numbers.\n\n    Arguments:\n    a (int): The first number to be added.\n    b (int): The second number to be added.\n\n    Returns:\n    int: The sum of the two numbers.\n    '
+Returns:
+    int: The sum of a and b.
+"""
     return a + b