py4web-debug-tools 0.1.2__py3-none-any.whl → 0.2.0.dev0__py3-none-any.whl

py4web_debug/core.py

@@ -19,11 +19,20 @@ class DebugTools:
 
     def enable(
         self,
+        # general settings:
         db: P4WDAL,
-        enabled: bool | None = None,
-        fancy_rendering=True,
-        bar_style: typing.Literal["bootstrap"] = "bootstrap",
-        slow_threshold_ms=10,
+        enabled: bool | None = None,  # OVERWRITES errorpage_enabled and debugbar_enabled
+        set_env_var: bool = True,
+
+        # error screen settings:
+        errorpage_enabled: bool = None,  # value of 'enabled' is used by default
+        errorpage_renderer: typing.Callable = None,
+
+        # debugbar settings:
+        debugbar_enabled: bool = None,  # value of 'enabled' is used by default
+        debugbar_fancy_rendering: bool = True,
+        debugbar_style: typing.Literal["bootstrap"] = "bootstrap",
+        debugbar_slow_threshold_ms: int = 10,
     ):
         """
         By default, on_off looks at PY4WEB_DEBUG_MODE in the env
@@ -38,13 +47,18 @@ class DebugTools:
 
         self.IS_DEBUG = enabled
         if enabled:
-            patch_py4()
-            self.debug_bar = DebugBar(db, fancy_rendering, bar_style, slow_threshold_ms)
+            if errorpage_enabled in (True, None):
+                patch_py4(errorpage_renderer)
 
-            # will change the result of is_debug (hopefully)
-            os.environ["PY4WEB_DEBUG_MODE"] = "1"
+            if debugbar_enabled in (True, None):
+                self.debug_bar = DebugBar(db, debugbar_fancy_rendering, debugbar_style, debugbar_slow_threshold_ms)
+
+            if set_env_var:
+                # will change the result of is_debug (hopefully)
+                os.environ["PY4WEB_DEBUG_MODE"] = "1"
         else:
             self.debug_bar = DummyDebugBar()
 
 
 tools = DebugTools()
+

py4web_debug/internals.py

@@ -30,6 +30,8 @@ def custom_error_page(
     traceback="",
     err_type: str | typing.Type | None = None,
     bare_exception=None,
+
+    renderer=None
 ):
     if err_type and not isinstance(err_type, str):
         err_type = err_type.__name__
@@ -64,6 +66,9 @@ def custom_error_page(
         return json.dumps(context)
     # else - return html error-page
 
+    if renderer:
+        return renderer(context)
+
     templates = {
         "default": "error_default.html",
         "DumpDieError": "dumpdie.html",
@@ -88,44 +93,45 @@ def custom_error_page(
         )
 
 
-def custom_catch_errors(app_name, func):
-    """Catches and logs errors in an action; also sets request.app_name"""
-
-    @functools.wraps(func)
-    def wrapper(*func_args, **func_kwargs):
-        try:
-            request.app_name = app_name
-            ret = func(*func_args, **func_kwargs)
-            if isinstance(ret, dict):
-                response.headers["Content-Type"] = "application/json"
-                ret = dumps(ret)
-            return ret
-        except HTTP as http:
-            response.status = http.status
-            response.headers.update(http.headers)
-            return http.body
-        except bottle.HTTPResponse:
-            raise
-        except Exception as e:
-            snapshot = get_error_snapshot()
-            logging.error(snapshot["traceback"])
-            ticket_uuid = error_logger.log(request.app_name, snapshot) or "unknown"
-            response.status = 500
-
-            raise bottle.HTTPResponse(
-                body=custom_error_page(
-                    500,
-                    button_text=ticket_uuid,
-                    href="/_dashboard/ticket/" + ticket_uuid,
-                    traceback=traceback.format_exc(),
-                    err_type=type(e),
-                    bare_exception=e,
-                ),
-                status=500,
-            )
-
-    return wrapper
-
-
-def patch_py4():
+def patch_py4(renderer=None):
+    def custom_catch_errors(app_name, func):
+        """Catches and logs errors in an action; also sets request.app_name"""
+
+        @functools.wraps(func)
+        def wrapper(*func_args, **func_kwargs):
+            try:
+                request.app_name = app_name
+                ret = func(*func_args, **func_kwargs)
+                if isinstance(ret, dict):
+                    response.headers["Content-Type"] = "application/json"
+                    ret = dumps(ret)
+                return ret
+            except HTTP as http:
+                response.status = http.status
+                response.headers.update(http.headers)
+                return http.body
+            except bottle.HTTPResponse:
+                raise
+            except Exception as e:
+                snapshot = get_error_snapshot()
+                logging.error(snapshot["traceback"])
+                ticket_uuid = error_logger.log(request.app_name, snapshot) or "unknown"
+                response.status = 500
+
+                raise bottle.HTTPResponse(
+                    body=custom_error_page(
+                        500,
+                        button_text=ticket_uuid,
+                        href="/_dashboard/ticket/" + ticket_uuid,
+                        traceback=traceback.format_exc(),
+                        err_type=type(e),
+                        bare_exception=e,
+
+                        renderer=renderer
+                    ),
+                    status=500,
+                )
+
+        return wrapper
+
     action.catch_errors = custom_catch_errors

{py4web_debug_tools-0.1.2.dist-info → py4web_debug_tools-0.2.0.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py4web-debug-tools
-Version: 0.1.2
+Version: 0.2.0.dev0
 Summary: Debug Tools for py4web
 Home-page: https://github.com/trialandsuccess/py4web-debug-tools
 Author: Robin van der Noord

{py4web_debug_tools-0.1.2.dist-info → py4web_debug_tools-0.2.0.dev0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 py4web_debug/__init__.py,sha256=OC9yuI3jIBjwi7KGL4uUNtQbyuzZcq913z31gfgSK7s,108
-py4web_debug/core.py,sha256=LzteofsHOBcoRWM4W5lHlaKTrDfXJ1K_e3qZJcKCflw,1373
+py4web_debug/core.py,sha256=Vydfzbiv0USgdrT_4hB6OtkXd3lNQOFTNRboI1sxejQ,1989
 py4web_debug/debugbar.py,sha256=bzuJ4FX_bYzz0-V8f9A1bjkEmLbj8q00CAerCAu3aMs,7243
 py4web_debug/dumping.py,sha256=AF4UVSyqI43JgxffjeoozQ0az0J5nvpeZVYtWuUlC6s,3496
 py4web_debug/env.py,sha256=CXJX6nmNgGYL0Z9rt8fmQPO1UAydhW-Cv-zWObPlleQ,82
-py4web_debug/internals.py,sha256=8hE659RPLrdxL0EGiWfQkVM7hBEblTyhbw_GOm1gT6Q,3583
+py4web_debug/internals.py,sha256=J8pmil-GzxT2BPs4QSoVos5k27vFIi8nGfujTIX90U0,3844
 py4web_debug/templates/debugbar.html,sha256=gbaBLBJpDIti9QAkDWXRP10_LEvCrQmK1GxFlbsHasA,7169
 py4web_debug/templates/dumpdie.html,sha256=pFjRjs2VBZPo1nyfObCO5kksyQS9q-K4EqPdZNFo9lg,60
 py4web_debug/templates/error_default.html,sha256=OGMvbHWb7xX91GH5Kx9WPXqv93ee7UcII5B-nUu3TYk,868
 py4web_debug/templates/fancy_dumpdie.html,sha256=eaquCyAOM1QU3QMv__fIqgbmyFHOnwd495PMGMVOzo8,532
-py4web_debug_tools-0.1.2.dist-info/METADATA,sha256=BfBSilvd1AyTu_qpOVuwytcQeS9r2FcuhPW0eHjQXxU,2622
-py4web_debug_tools-0.1.2.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-py4web_debug_tools-0.1.2.dist-info/top_level.txt,sha256=sZikb7uiewpax6SbMw-PL1La6xqDq8ZUbN7J9kFKodA,13
-py4web_debug_tools-0.1.2.dist-info/RECORD,,
+py4web_debug_tools-0.2.0.dev0.dist-info/METADATA,sha256=j3kOMOtXp9ftrCYPhqw1NJ4Lwgj7xcy6qn7Upv0V1JA,2627
+py4web_debug_tools-0.2.0.dev0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+py4web_debug_tools-0.2.0.dev0.dist-info/top_level.txt,sha256=sZikb7uiewpax6SbMw-PL1La6xqDq8ZUbN7J9kFKodA,13
+py4web_debug_tools-0.2.0.dev0.dist-info/RECORD,,