py4web-debug-tools 0.1.2__tar.gz → 0.2.0.dev0__tar.gz

{py4web-debug-tools-0.1.2 → py4web-debug-tools-0.2.0.dev0}/PKG-INFO

@@ -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.2.0.dev0/py4web_debug/core.py

@@ -0,0 +1,64 @@
+# Transforms janky 'internals' into easy to work with tool
+import os
+import typing
+
+from py4web import DAL as P4WDAL
+
+from .debugbar import DummyDebugBar, DebugBar
+from .env import is_debug
+from .internals import patch_py4
+
+
+class DebugTools:
+    # by default, it is not enabled! This is so you can still import it on production,
+    # but don't actually show any debug info. enable(on_off) can be called with e.g. an ENV variable
+    enabled = False
+    db: P4WDAL
+    debug_bar = DummyDebugBar()
+    IS_DEBUG: bool = is_debug()
+
+    def enable(
+        self,
+        # general settings:
+        db: P4WDAL,
+        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
+
+        @todo: debugbar style (bootstrap/default, bulma, ...)
+        """
+        if enabled is None:
+            enabled = is_debug()
+
+        self.db = db
+        self.enabled = enabled
+
+        self.IS_DEBUG = enabled
+        if enabled:
+            if errorpage_enabled in (True, None):
+                patch_py4(errorpage_renderer)
+
+            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-tools-0.1.2 → py4web-debug-tools-0.2.0.dev0}/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 → py4web-debug-tools-0.2.0.dev0}/py4web_debug_tools.egg-info/PKG-INFO

@@ -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 → py4web-debug-tools-0.2.0.dev0}/setup.py

@@ -7,7 +7,7 @@ dependencies = ["py4web", "yatl", "pydal", "configurable-json"]
 
 setup(
     name="py4web-debug-tools",
-    version="0.1.2",
+    version="0.2.0-dev",
     description="Debug Tools for py4web",
     author="Robin van der Noord",
     author_email="contact@trialandsuccess.nl",

py4web-debug-tools-0.1.2/py4web_debug/core.py

@@ -1,50 +0,0 @@
-# Transforms janky 'internals' into easy to work with tool
-import os
-import typing
-
-from py4web import DAL as P4WDAL
-
-from .debugbar import DummyDebugBar, DebugBar
-from .env import is_debug
-from .internals import patch_py4
-
-
-class DebugTools:
-    # by default, it is not enabled! This is so you can still import it on production,
-    # but don't actually show any debug info. enable(on_off) can be called with e.g. an ENV variable
-    enabled = False
-    db: P4WDAL
-    debug_bar = DummyDebugBar()
-    IS_DEBUG: bool = is_debug()
-
-    def enable(
-        self,
-        db: P4WDAL,
-        enabled: bool | None = None,
-        fancy_rendering=True,
-        bar_style: typing.Literal["bootstrap"] = "bootstrap",
-        slow_threshold_ms=10,
-    ):
-        """
-        By default, on_off looks at PY4WEB_DEBUG_MODE in the env
-
-        @todo: debugbar style (bootstrap/default, bulma, ...)
-        """
-        if enabled is None:
-            enabled = is_debug()
-
-        self.db = db
-        self.enabled = enabled
-
-        self.IS_DEBUG = enabled
-        if enabled:
-            patch_py4()
-            self.debug_bar = DebugBar(db, fancy_rendering, bar_style, slow_threshold_ms)
-
-            # will change the result of is_debug (hopefully)
-            os.environ["PY4WEB_DEBUG_MODE"] = "1"
-        else:
-            self.debug_bar = DummyDebugBar()
-
-
-tools = DebugTools()