Refactor: Move process_query to top and prefix helper functions with an underscore

Author: filipchristiansen

src/process_query.py

@@ -11,78 +11,6 @@
 templates = Jinja2Templates(directory="templates")
 
 
-def print_query(url: str, max_file_size: int, pattern_type: str, pattern: str) -> None:
-    """
-    Print a formatted summary of the query details, including the URL, file size,
-    and pattern information, for easier debugging or logging.
-
-    Parameters
-    ----------
-    url : str
-        The URL associated with the query.
-    max_file_size : int
-        The maximum file size allowed for the query, in bytes.
-    pattern_type : str
-        Specifies the type of pattern to use, either "include" or "exclude".
-    pattern : str
-        The actual pattern string to include or exclude in the query.
-    """
-    print(f"{Colors.WHITE}{url:<20}{Colors.END}", end="")
-    if int(max_file_size / 1024) != 50:
-        print(f" | {Colors.YELLOW}Size: {int(max_file_size/1024)}kb{Colors.END}", end="")
-    if pattern_type == "include" and pattern != "":
-        print(f" | {Colors.YELLOW}Include {pattern}{Colors.END}", end="")
-    elif pattern_type == "exclude" and pattern != "":
-        print(f" | {Colors.YELLOW}Exclude {pattern}{Colors.END}", end="")
-
-
-def print_error(url: str, e: Exception, max_file_size: int, pattern_type: str, pattern: str) -> None:
-    """
-    Print a formatted error message including the URL, file size, pattern details, and the exception encountered,
-    for debugging or logging purposes.
-
-    Parameters
-    ----------
-    url : str
-        The URL associated with the query that caused the error.
-    e : Exception
-        The exception raised during the query or process.
-    max_file_size : int
-        The maximum file size allowed for the query, in bytes.
-    pattern_type : str
-        Specifies the type of pattern to use, either "include" or "exclude".
-    pattern : str
-        The actual pattern string to include or exclude in the query.
-    """
-    print(f"{Colors.BROWN}WARN{Colors.END}: {Colors.RED}<-  {Colors.END}", end="")
-    print_query(url, max_file_size, pattern_type, pattern)
-    print(f" | {Colors.RED}{e}{Colors.END}")
-
-
-def print_success(url: str, max_file_size: int, pattern_type: str, pattern: str, summary: str) -> None:
-    """
-    Print a formatted success message, including the URL, file size, pattern details, and a summary with estimated
-    tokens, for debugging or logging purposes.
-
-    Parameters
-    ----------
-    url : str
-        The URL associated with the successful query.
-    max_file_size : int
-        The maximum file size allowed for the query, in bytes.
-    pattern_type : str
-        Specifies the type of pattern to use, either "include" or "exclude".
-    pattern : str
-        The actual pattern string to include or exclude in the query.
-    summary : str
-        A summary of the query result, including details like estimated tokens.
-    """
-    estimated_tokens = summary[summary.index("Estimated tokens:") + len("Estimated ") :]
-    print(f"{Colors.GREEN}INFO{Colors.END}: {Colors.GREEN}<-  {Colors.END}", end="")
-    print_query(url, max_file_size, pattern_type, pattern)
-    print(f" | {Colors.PURPLE}{estimated_tokens}{Colors.END}")
-
-
 async def process_query(
     request: Request,
     input_text: str,
@@ -149,7 +77,7 @@ async def process_query(
     except Exception as e:
         # hack to print error message when query is not defined
         if "query" in locals() and query is not None and isinstance(query, dict):
-            print_error(query["url"], e, max_file_size, pattern_type, pattern)
+            _print_error(query["url"], e, max_file_size, pattern_type, pattern)
         else:
             print(f"{Colors.BROWN}WARN{Colors.END}: {Colors.RED}<-  {Colors.END}", end="")
             print(f"{Colors.RED}{e}{Colors.END}")
@@ -173,7 +101,7 @@ async def process_query(
             "download full ingest to see more)\n" + content[:MAX_DISPLAY_SIZE]
         )
 
-    print_success(
+    _print_success(
         url=query["url"],
         max_file_size=max_file_size,
         pattern_type=pattern_type,
@@ -197,3 +125,75 @@ async def process_query(
             "pattern": pattern,
         },
     )
+
+
+def _print_query(url: str, max_file_size: int, pattern_type: str, pattern: str) -> None:
+    """
+    Print a formatted summary of the query details, including the URL, file size,
+    and pattern information, for easier debugging or logging.
+
+    Parameters
+    ----------
+    url : str
+        The URL associated with the query.
+    max_file_size : int
+        The maximum file size allowed for the query, in bytes.
+    pattern_type : str
+        Specifies the type of pattern to use, either "include" or "exclude".
+    pattern : str
+        The actual pattern string to include or exclude in the query.
+    """
+    print(f"{Colors.WHITE}{url:<20}{Colors.END}", end="")
+    if int(max_file_size / 1024) != 50:
+        print(f" | {Colors.YELLOW}Size: {int(max_file_size/1024)}kb{Colors.END}", end="")
+    if pattern_type == "include" and pattern != "":
+        print(f" | {Colors.YELLOW}Include {pattern}{Colors.END}", end="")
+    elif pattern_type == "exclude" and pattern != "":
+        print(f" | {Colors.YELLOW}Exclude {pattern}{Colors.END}", end="")
+
+
+def _print_error(url: str, e: Exception, max_file_size: int, pattern_type: str, pattern: str) -> None:
+    """
+    Print a formatted error message including the URL, file size, pattern details, and the exception encountered,
+    for debugging or logging purposes.
+
+    Parameters
+    ----------
+    url : str
+        The URL associated with the query that caused the error.
+    e : Exception
+        The exception raised during the query or process.
+    max_file_size : int
+        The maximum file size allowed for the query, in bytes.
+    pattern_type : str
+        Specifies the type of pattern to use, either "include" or "exclude".
+    pattern : str
+        The actual pattern string to include or exclude in the query.
+    """
+    print(f"{Colors.BROWN}WARN{Colors.END}: {Colors.RED}<-  {Colors.END}", end="")
+    _print_query(url, max_file_size, pattern_type, pattern)
+    print(f" | {Colors.RED}{e}{Colors.END}")
+
+
+def _print_success(url: str, max_file_size: int, pattern_type: str, pattern: str, summary: str) -> None:
+    """
+    Print a formatted success message, including the URL, file size, pattern details, and a summary with estimated
+    tokens, for debugging or logging purposes.
+
+    Parameters
+    ----------
+    url : str
+        The URL associated with the successful query.
+    max_file_size : int
+        The maximum file size allowed for the query, in bytes.
+    pattern_type : str
+        Specifies the type of pattern to use, either "include" or "exclude".
+    pattern : str
+        The actual pattern string to include or exclude in the query.
+    summary : str
+        A summary of the query result, including details like estimated tokens.
+    """
+    estimated_tokens = summary[summary.index("Estimated tokens:") + len("Estimated ") :]
+    print(f"{Colors.GREEN}INFO{Colors.END}: {Colors.GREEN}<-  {Colors.END}", end="")
+    _print_query(url, max_file_size, pattern_type, pattern)
+    print(f" | {Colors.PURPLE}{estimated_tokens}{Colors.END}")