Add logger to CLI

techdocs/pyproject.toml

@@ -1,13 +1,14 @@
 [build-system]
 requires = [
     "setuptools >= 65",
-    "wheel >= 0.38"
+    "wheel >= 0.38",
+    "tqdm >= 4.66.1"
 ]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "techdocs"
-version = "0.1.5"
+version = "0.2.0"
 description = "Code documentation generation CLI App"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -21,7 +22,7 @@ scripts = {techdocs = "techdocs.cli:main"}
 
 
 [tool.setuptools]
-packages = ["techdocs"]
+packages = ["techdocs", "techdocs.utils"]
 
 [tool.setuptools.package-data]
 "*" = ["*.json"]

techdocs/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = techdocs
-version = 0.1.5
+version = 0.2.0
 
 [options]
 packages = techdocs

techdocs/setup.py

@@ -4,7 +4,7 @@ import glob
 
 setup(
 	name='techdocs',
-	version='0.1.5',
+	version='0.2.0',
     # To provide executable scripts, use entry points in preference to the
     # "scripts" keyword. Entry points provide cross-platform support and allow
     # pip to create the appropriate form of executable for the target platform.

techdocs/techdocs/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.5"
+__version__ = "0.2.0"

techdocs/techdocs/cli.py

@@ -10,7 +10,7 @@ def main(log_info: bool = False):
         👋 Hi there! Welcome to techdocs. Here are some cool things you can do:
 
 
-        💫 try out a demo with or new GUI 🚀 and explore how to use the CLI:
+        💫 try out a demo with our new GUI 🚀 and explore how to use the CLI:
 
         ➡️     https://techdocs.streamlit.app/
 

techdocs/techdocs/ops.py

@@ -13,6 +13,7 @@ from .utils.parse import *
 parser = argparse.ArgumentParser(
         description='Code documentation generation',
         epilog="Thanks for using Techdocs")
+parser.add_argument('--version', action='version', version=f'{techdocs.__version__}')
 subparsers = parser.add_subparsers(help='subcommands')
 
 

techdocs/techdocs/utils/LoggingManager.py

@@ -0,0 +1,81 @@
+import logging
+import datetime
+import os
+import sys
+import glob
+import tqdm
+from typing import List
+import re
+
+class LoggingManager:
+    def __init__(self, init_root: str):
+        self.logger = logging.getLogger(__name__)
+        self.logger.propagate = False
+        self.logger.setLevel(logging.INFO)
+        self.formatter = logging.Formatter("%(asctime)s:%(levelname)s:%(message)s")
+
+        self.logs_addr = re.sub(r"\s|:|-", "_", datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
+        self.logs_addr = os.path.join(init_root, f"logs_{self.logs_addr}.log")
+        self.file_handler = logging.FileHandler(self.logs_addr)
+        self.file_handler.setFormatter(self.formatter)
+        self.logger.addHandler(self.file_handler)
+
+        self.stream_handler = logging.StreamHandler(sys.stdout)
+        self.stream_handler.setFormatter(self.formatter)
+        self.logger.addHandler(self.stream_handler)
+
+        self.logger.info(f'Logs generated at "{self.logs_addr}". For detailed logs check the file.')
+        self.logger.info(f'Docstrings generation started for "{init_root}/*.py" files')
+
+    @property
+    def LOGGER(self):
+        return self.logger
+    
+    @LOGGER.setter
+    def get_logger(self):
+        raise NotImplementedError("Cannot set logger")
+    
+    @property
+    def set_log_handlers(self):
+        raise NotImplementedError("Cannot access applied log handlers")
+    
+    @set_log_handlers.setter
+    def set_log_handlers(self, handlers: List[logging.Handler]):
+        self.logger.handlers = []
+        self.logger.handlers = handlers
+    
+    
+    def log_curr_state(self, root: str):
+        self.set_log_handlers = [self.file_handler]
+        self.logger.info(f'Working on "{root}\\*.py"')
+
+        start = datetime.datetime.now()
+        files = glob.glob(os.path.join(root + "/*.py"))
+
+        for file in tqdm.tqdm(files, desc=f"Working on {root}"):
+            self.set_log_handlers = [self.file_handler]
+            self.logger.info(f'Working on "{file}"')
+            yield file
+            logging.info(f'Docstrings generated for "{file}". Time Taken: {datetime.datetime.now() - start}')
+            self.line_breaks(dir=False, file=True)
+        
+        self.set_log_handlers = [self.file_handler]
+        self.logger.info(f'Docstrings generation completed for "{root}\\.*py". Time Taken: {datetime.datetime.now() - start}')
+        self.line_breaks(dir=True, file=False)
+    
+
+    def line_breaks(self, dir: bool, file: bool):
+        if not dir ^ file:
+            raise ValueError("Both dir and file cannot be True or False")
+
+        if dir:
+            self.logger.info(">"*50)
+        if file:
+            self.logger.info("="*50)
+
+        
+
+
+    
+
+    

techdocs/techdocs/utils/parse.py

@@ -1,8 +1,11 @@
 import ast
 import os
 import threading
+import time
+import glob
 
 from .functools import *
+from .LoggingManager import LoggingManager
 
 
 # Function to extract and print the outermost nested function with line number
@@ -15,7 +18,10 @@ def extract_outermost_function(node, config):
             try:
                 docstr = response.split('"""')
                 docstring = ast.Expr(value=ast.Str(s=docstr[1]))
-                print(f"Docstring generated for def {node.name}")
+                # print(f"Docstring generated for def {node.name}")
+                logging_manager = config.get("logging_manager")
+                logging_manager.set_log_handlers = [logging_manager.file_handler]
+                logging_manager.LOGGER.info(f"Docstring generated for def {node.name}")
                 node.body.insert(0, docstring)
             except IndexError:
                 pass    
@@ -26,16 +32,15 @@ def extract_outermost_function(node, config):
 
 # Function to traverse directories recursively and extract functions from Python files
 def extract_functions_from_directory(config):
+    logging_manager = LoggingManager(config["dir"])
+    config.update({"logging_manager": logging_manager})
     for root, dirnames, files in os.walk(config["dir"]):
-        for file in files:
-            if file.endswith(".py"):
-                file_path = os.path.join(root, file)
-                print(file_path)
-                with open(file_path, "r",errors='ignore') as file:
-                    content = file.read()
-                parsed = ast.parse(content)
-                extract_outermost_function(parsed, config)
-                docstr_code = ast.unparse(parsed)
-
-                write_thread = threading.Thread(target=update_file, args=(file_path, docstr_code))
-                write_thread.start()
+        for _file in logging_manager.log_curr_state(root):
+            file_path = _file
+            with open(file_path, "r",errors='ignore') as file:
+                content = file.read()
+            parsed = ast.parse(content)
+            extract_outermost_function(parsed, config)
+            docstr_code = ast.unparse(parsed)
+            write_thread = threading.Thread(target=update_file, args=(file_path, docstr_code))
+            write_thread.start()

testing/DBQueries.py

@@ -1,51 +0,0 @@
-import pydantic
-from bson.objectid import ObjectId
-pydantic.json.ENCODERS_BY_TYPE[ObjectId] = str
-from typing import Union, Tuple, List
-from backend.utils import DBConnection
-from backend.core.Exceptions import *
-
-class DBQueries:
-
-    @classmethod
-    def insert_to_database(cls, table_name: str, data: Union[Tuple, List[Tuple]], cols: List[str]=None):
-        con = DBConnection.get_client()
-        cursor = con.cursor()
-        QUERY = f"INSERT INTO {{table_name}} ({','.join(cols)}) VALUES ".format(table_name=table_name)
-        if isinstance(data, list):
-            QUERY += '(' + ','.join(['%s' for _ in range(len(data[0]))]) + ')'
-            cursor.executemany(QUERY, data)
-        else:
-            QUERY += '(' + ','.join(['%s' for _ in range(len(data))]) + ')'
-            cursor.execute(QUERY, data)
-        con.commit()
-
-    @classmethod
-    def fetch_data_from_database(cls, table_name: str, cols_to_fetch: Union[str, List[str]], where_clause: str=None):
-        con = DBConnection.get_client()
-        cursor = con.cursor()
-        if isinstance(cols_to_fetch, str):
-            cols_to_fetch = [cols_to_fetch]
-        cols_to_fetch = ', '.join(cols_to_fetch)
-        QUERY = 'SELECT {cols} FROM {table_name}'.format(cols=cols_to_fetch, table_name=table_name)
-        if where_clause:
-            QUERY = QUERY + ' WHERE ' + where_clause
-        cursor.execute(QUERY)
-        return cursor.fetchall()
-
-    @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):
-        con = DBConnection.get_client()
-        cursor = con.cursor()
-        if isinstance(cols_to_update, str):
-            cols_to_update = cols_to_update + '=%s'
-        else:
-            cols_to_update = '=%s, '.join(cols_to_update)
-        if isinstance(new_values, str):
-            new_values = [new_values]
-        QUERY = 'UPDATE {table_name} SET {cols}'.format(table_name=table_name, cols=cols_to_update)
-        if where_clause:
-            QUERY = QUERY + ' WHERE ' + where_clause
-        cursor.execute(QUERY, new_values)
-        con.commit()
-        return True

testing/pack/DBQueries.py

@@ -0,0 +1,123 @@
+import pydantic
+from bson.objectid import ObjectId
+pydantic.json.ENCODERS_BY_TYPE[ObjectId] = str
+from typing import Union, Tuple, List
+from backend.utils import DBConnection
+from backend.core.Exceptions import *
+
+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.
+
+    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.
+
+    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    '
+        con = DBConnection.get_client()
+        cursor = con.cursor()
+        QUERY = f"INSERT INTO {{table_name}} ({','.join(cols)}) VALUES ".format(table_name=table_name)
+        if isinstance(data, list):
+            QUERY += '(' + ','.join(['%s' for _ in range(len(data[0]))]) + ')'
+            cursor.executemany(QUERY, data)
+        else:
+            QUERY += '(' + ','.join(['%s' for _ in range(len(data))]) + ')'
+            cursor.execute(QUERY, data)
+        con.commit()
+
+    @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.
+
+    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.
+
+    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.
+
+"""
+        '\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):
+            cols_to_fetch = [cols_to_fetch]
+        cols_to_fetch = ', '.join(cols_to_fetch)
+        QUERY = 'SELECT {cols} FROM {table_name}'.format(cols=cols_to_fetch, table_name=table_name)
+        if where_clause:
+            QUERY = QUERY + ' WHERE ' + where_clause
+        cursor.execute(QUERY)
+        return cursor.fetchall()
+
+    @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.
+
+    Returns:
+        bool: Returns True if the data is successfully updated in the database.
+
+    Raises:
+        Exception: If the database connection fails or the query execution fails.
+    """
+        con = DBConnection.get_client()
+        cursor = con.cursor()
+        if isinstance(cols_to_update, str):
+            cols_to_update = cols_to_update + '=%s'
+        else:
+            cols_to_update = '=%s, '.join(cols_to_update)
+        if isinstance(new_values, str):
+            new_values = [new_values]
+        QUERY = 'UPDATE {table_name} SET {cols}'.format(table_name=table_name, cols=cols_to_update)
+        if where_clause:
+            QUERY = QUERY + ' WHERE ' + where_clause
+        cursor.execute(QUERY, new_values)
+        con.commit()
+        return True

testing/pack/functools.py

@@ -0,0 +1,143 @@
+import json
+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.
+    
+    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    '
+    try:
+        url = BASE_URL + '/auth/login'
+        headers = {'accept': 'application/json'}
+        data = json.dumps(data)
+        response = requests.post(url, data=data, headers=headers)
+        access_token = response.json()['access_token']
+        if return_refresh_token:
+            refresh_token = response.json()['refresh_token']
+            return (access_token, refresh_token)
+        return access_token
+    except Exception as e:
+        print('Invlaid Credentials')
+        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.
+
+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.
+
+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.
+"""
+    "\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'
+    headers = {'accept': 'application/json', 'Authorization': f"Bearer {config['access_token']}"}
+    code_input = code_block
+    response = requests.post(url=url, headers=headers, data=json.dumps({'code_block': code_input, 'api_key': config['api_key']}))
+    if response.status_code == 200:
+        return response.json()['docstr']
+    else:
+        data = {'username': config['username'], 'password': config['password']}
+        print('Encountered error retrying...')
+        config.update({'access_token': get_access_token(data)})
+        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.
+
+    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
+
+    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    '
+    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.
+
+    Returns:
+    None, Prints the new API key to the console.
+
+    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    "
+    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']}))
+        if response.status_code != 200:
+            raise Exception('API Key Generation Failed')
+        print(f"$ API_KEY:{response.json()['api_key']}")
+    except Exception as e:
+        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.
+
+    Returns:
+    None
+
+    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    '
+    try:
+        headers = {'accept': 'application/json'}
+        response = requests.post(url=BASE_URL + '/auth/signup', headers=headers, data=json.dumps(config))
+        if response.status_code == 226:
+            raise Exception('username or email already exists')
+        elif response.status_code != 200:
+            raise Exception('Something went wrong, please try again later')
+        print('Signed up successfully, please issue a new `API_KEY` to continue')
+    except Exception as e:
+        print(e)

testing/test.py

@@ -1,18 +1,33 @@
 def add(a, b):
-    return a + b
+    """
+    This function adds two integers.
 
-def multiply(a, b):
-    return a * b
+    Arguments:
+    a (int): The first integer to be added.
+    b (int): The second integer to be added.
 
-def subtract(a, b):
-    return a - b
-
-def divide(a, b):
-    if b == 0:
-        raise ValueError('Cannot divide by zero')
-    return a / b
-
-def func(*args, **kwargs):
-    def wrapper(*args, **kwargs):
-        return func(*args, **kwargs)
-    return wrapper
+    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    '
+    return a + b