t-bug-catcher 0.4.7__tar.gz → 0.4.9__tar.gz

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.4.7
+Version: 0.4.9
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.7
+current_version = 0.4.9
 commit = True
 tag = False
 

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/setup.py

@@ -26,7 +26,7 @@ setup(
     packages=find_packages(include=["t_bug_catcher", "t_bug_catcher.*"]),
     test_suite="tests",
     url="https://www.thoughtful.ai/",
-    version="0.4.7",
+    version="0.4.9",
     zip_safe=False,
     install_requires=install_requirements,
     include_package_data=True,

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher/__init__.py

@@ -3,7 +3,7 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.4.7'
+__version__ = '0.4.9'
 # fmt: on
 
 from .bug_catcher import (

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher/bug_catcher.py

@@ -12,6 +12,7 @@ from .jira import Jira
 from .stack_saver import StackSaver
 from .utils import logger
 from .utils.common import get_frames
+from .validation import PRE_RUN_VALIDATION
 
 
 class Configurator:
@@ -332,3 +333,6 @@ report_error_to_jira = __bug_catcher.report_error_to_jira
 report_error_to_bugsnag = __bug_catcher.report_error_to_bugsnag
 install_sys_hook = __bug_catcher.install_sys_hook
 uninstall_sys_hook = __bug_catcher.uninstall_sys_hook
+
+if CONFIG.STAGE.lower() == "delivery":
+    pre_run_validation = PRE_RUN_VALIDATION

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher/jira.py

@@ -692,6 +692,10 @@ class Jira:
         exc_traceback_info: str = (
             f"Traceback (most recent call last):\n{''.join(traceback.format_tb(exc_traceback))}{exc_info}"
         )
+        if len(exc_traceback_info) > 30000:
+            exc_traceback_info: str = (
+                f"Traceback (most recent call last):\n{''.join(traceback.format_tb(exc_traceback)[-1])}{exc_info}"
+            )
 
         return {
             "version": 1,

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher/stack_saver.py

@@ -13,7 +13,7 @@ import whispers
 
 from .config import CONFIG
 from .utils import logger
-from .utils.common import Encoder, convert_keys_to_primitives
+from .utils.common import Encoder, convert_keys_to_primitives, strip_path
 
 
 class StackSaver:
@@ -23,18 +23,6 @@ class StackSaver:
         """Initializes the StackSaver class."""
         pass
 
-    @staticmethod
-    def strip_path(path: str):
-        """A static method to strip the current working directory path from the input.
-
-        Args:
-            path (str): The path from which to strip the current working directory path.
-
-        Returns:
-            str: The stripped path.
-        """
-        return path.replace(os.getcwd(), "").strip(os.sep)
-
     def serialize_frame_info(self, frame_info: dict) -> dict:
         """A static method to serialize the frame info.
 
@@ -146,7 +134,7 @@ class StackSaver:
 
             for frame in frames:
                 frame_info = {
-                    "filename": self.strip_path(frame.f_code.co_filename),
+                    "filename": strip_path(frame.f_code.co_filename),
                     "function_name": frame.f_code.co_name,
                     "line_number": frame.f_lineno,
                     "line": linecache.getline(frame.f_code.co_filename, frame.f_lineno).strip(),

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher/utils/common.py

@@ -1,4 +1,5 @@
 import copy
+import os
 import traceback
 from datetime import date, datetime
 from json import JSONEncoder
@@ -74,3 +75,15 @@ def convert_keys_to_primitives(data: dict) -> dict:
         else:
             new_dict[str(key)] = value
     return new_dict
+
+
+def strip_path(path: str):
+    """A function to strip the current working directory path from the input.
+
+    Args:
+        path (str): The path from which to strip the current working directory path.
+
+    Returns:
+        str: The stripped path.
+    """
+    return path.replace(os.getcwd(), "").strip(os.sep)

t_bug_catcher-0.4.9/t_bug_catcher/validation.py

@@ -0,0 +1,118 @@
+import ast
+import logging
+import os
+
+from t_bug_catcher.utils.common import strip_path
+
+validation_logger = logging.getLogger("t_bug_catcher")
+
+validation_logger.setLevel(logging.DEBUG)
+console_handler = logging.StreamHandler()
+console_handler.setLevel(logging.DEBUG)
+
+formatter = logging.Formatter("%(levelname)s - %(name)s - %(message)s")
+validation_logger.addHandler(console_handler)
+
+EXCLUDED_DIRS = [".venv", "venv", "site-packages"]
+
+
+class IncorrectTryBlockVisitor(ast.NodeVisitor):
+    """A visitor that checks for incorrect try-except blocks."""
+
+    def __init__(self):
+        """Initializes the IncorrectTryBlockVisitor class."""
+        self.errors = {}
+
+    def visit_Try(self, node):
+        """Visits the try-except block in the AST."""
+        message = (
+            "Error not handled: specify the error type or re-raise exception or "
+            "report it with `t_bug_catcher.report_error()`"
+        )
+        for handler in node.handlers:
+            if isinstance(handler.type, ast.Name) and handler.type.id == "Exception":
+                if not self._contains_raise(handler.body) and not self._contains_correct_error_handling(handler.body):
+                    self.errors[handler.lineno] = message
+            elif handler.type is None:  # 'except:' that catches everything
+                if not any(isinstance(x, ast.Raise) for x in handler.body):
+                    self.errors[handler.lineno] = message
+        self.generic_visit(node)
+
+    @staticmethod
+    def _contains_correct_error_handling(statements):
+        for stmt in statements:
+            if isinstance(stmt, ast.Expr) and isinstance(stmt.value, ast.Call):
+                func = stmt.value.func
+                if (isinstance(func, ast.Name) and func.id == "report_error") or (
+                    isinstance(func, ast.Attribute) and func.attr == "report_error"
+                ):
+                    return True
+        return False
+
+    @staticmethod
+    def _contains_raise(statements):
+        return any(isinstance(stmt, ast.Raise) for stmt in statements)
+
+    def get_errors(self):
+        """Returns the errors found in the try-except blocks."""
+        return self.errors
+
+
+class BroadExceptionWarning:
+    """A class to represent a broad exception warning."""
+
+    def __init__(self, file_path: str, lineno: int, message: str, source_code: str):
+        """Initializes the BroadExceptionWarning class."""
+        self.lineno = lineno
+        self.message = message
+        self.__source_code_lines = source_code.split("\n")
+        self.code_line = self.__source_code_lines[lineno - 1]
+        self.code_lines = "\n".join(self.__source_code_lines[lineno - 3 : lineno + 2])
+        self.file_path = strip_path(file_path)
+
+
+class PreRunValidation:
+    """A class to perform pre-run validation checks."""
+
+    def __init__(self):
+        """Initializes the PreRunValidation class."""
+        self.broad_exception_warnings: list[BroadExceptionWarning] = []
+        self.analyze_project(os.getcwd())
+        self.log_warnings()
+
+    def analyze_project(self, project_dir: str):
+        """Analyzes the project directory for broad exception warnings."""
+        for root, dirs, files in os.walk(project_dir):
+            dirs[:] = [d for d in dirs if d not in EXCLUDED_DIRS]
+            for file in files:
+                if file.endswith(".py"):
+                    file_path = os.path.join(root, file)
+
+                    self.check_broad_exceptions(file_path)
+
+    def check_broad_exceptions(self, filename):
+        """Checks for broad exception warnings in the specified file."""
+        with open(filename, "r", encoding="utf8") as source:
+            source_code = source.read()
+            try:
+                tree = ast.parse(source_code, filename=filename)
+            except SyntaxError:
+                return
+            except Exception as ex:
+                validation_logger.error(f"Unable to validate: {filename} - {ex}")
+                return
+
+        visitor = IncorrectTryBlockVisitor()
+        visitor.visit(tree)
+
+        for line, message in visitor.get_errors().items():
+            be_warn = BroadExceptionWarning(filename, line, message, source_code=source_code)
+            self.broad_exception_warnings.append(be_warn)
+
+    def log_warnings(self):
+        """Logs the broad exception warnings."""
+        for be_warn in self.broad_exception_warnings:
+            validation_logger.warning(f"{be_warn.file_path}:{be_warn.lineno}: {be_warn.message}")
+
+
+PRE_RUN_VALIDATION = PreRunValidation()

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.4.7
+Version: 0.4.9
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.4.7 → t_bug_catcher-0.4.9}/t_bug_catcher.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ t_bug_catcher/config.py
 t_bug_catcher/exceptions.py
 t_bug_catcher/jira.py
 t_bug_catcher/stack_saver.py
+t_bug_catcher/validation.py
 t_bug_catcher/workitems.py
 t_bug_catcher.egg-info/PKG-INFO
 t_bug_catcher.egg-info/SOURCES.txt