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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py4web-debug-tools
-Version: 0.1.1
+Version: 0.2.0.dev0
 Summary: Debug Tools for py4web
 Home-page: https://github.com/trialandsuccess/py4web-debug-tools
 Author: Robin van der Noord
@@ -9,7 +9,8 @@ Requires-Python: >3.10.0
 Description-Content-Type: text/markdown
 
 # py4web debug tools
-Tooling to improve the developer experience when working with py4web.  
+
+Tooling to improve the developer experience when working with py4web.
 
 There are two main tools and some helpers that this package provides.
 
@@ -19,9 +20,16 @@ There are two main tools and some helpers that this package provides.
 ## In this package:
 
 - `tools`:
-    - `enable(db: DAL, enabled: bool)`: activate or disable the debug tools (add the custom error screen and create the Debug Bar
-      Fixture).  
-      The first argument (DAL) is required for the debug bar to collect queries.
+    - `enable(db: DAL, enabled?: bool, fancy_rendering?: bool, bar_style?: "bootstrap", slow_threshold_ms?: int)`:  
+      activate or disable the debug tools (add the custom error screen and create the Debug Bar Fixture).  
+      The first argument (DAL) is required for the debug bar to collect queries.  
+      `enabled` can be used to dynamically turn on/off the debug features.  
+      `fancy_rendering`: This will render the `data` section of the debug bar using `json-browse`, which
+      includes `jQuery`. If this clashes with the other JS on a page, this can be set to False to simply show a `<pre>`
+      block with data.  
+      `bar_style`: only bootstrap is supported at this moment.  
+      `slow_threshold_ms`: amount of milliseconds an SQL query has to take before it is considered a 'slow query' in the
+      debug bar.
     - `debug_bar`: this Fixture can be used on py4web actions to enable the bar for that page.
 - `catch(*)`: Data and a stacktrace of where `catch()` is called can be found in the catch tab of the debug bar.
 - `dump(*)`: convert objects to JSON, with a more capable converter than the default json.dumps (e.g. it works better

{py4web-debug-tools-0.1.1 → py4web-debug-tools-0.2.0.dev0}/README.md

@@ -1,5 +1,6 @@
 # py4web debug tools
-Tooling to improve the developer experience when working with py4web.  
+
+Tooling to improve the developer experience when working with py4web.
 
 There are two main tools and some helpers that this package provides.
 
@@ -9,9 +10,16 @@ There are two main tools and some helpers that this package provides.
 ## In this package:
 
 - `tools`:
-    - `enable(db: DAL, enabled: bool)`: activate or disable the debug tools (add the custom error screen and create the Debug Bar
-      Fixture).  
-      The first argument (DAL) is required for the debug bar to collect queries.
+    - `enable(db: DAL, enabled?: bool, fancy_rendering?: bool, bar_style?: "bootstrap", slow_threshold_ms?: int)`:  
+      activate or disable the debug tools (add the custom error screen and create the Debug Bar Fixture).  
+      The first argument (DAL) is required for the debug bar to collect queries.  
+      `enabled` can be used to dynamically turn on/off the debug features.  
+      `fancy_rendering`: This will render the `data` section of the debug bar using `json-browse`, which
+      includes `jQuery`. If this clashes with the other JS on a page, this can be set to False to simply show a `<pre>`
+      block with data.  
+      `bar_style`: only bootstrap is supported at this moment.  
+      `slow_threshold_ms`: amount of milliseconds an SQL query has to take before it is considered a 'slow query' in the
+      debug bar.
     - `debug_bar`: this Fixture can be used on py4web actions to enable the bar for that page.
 - `catch(*)`: Data and a stacktrace of where `catch()` is called can be found in the catch tab of the debug bar.
 - `dump(*)`: convert objects to JSON, with a more capable converter than the default json.dumps (e.g. it works better

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.1 → py4web-debug-tools-0.2.0.dev0}/py4web_debug/debugbar.py

@@ -133,7 +133,7 @@ def debugbar_template(fixture: Fixture, debug_data: dict, fancy=True):
 T = typing.TypeVar("T")
 
 
-def _prune_long_values(value: T) -> T:
+def _prune_long_values(value: T) -> T | str:
     """
     Find the end values in nested dicts and lists and prune them if they are too long,
     Usually (tm) returns the same type as the input (except when the input is long bytes)
@@ -146,7 +146,7 @@ def _prune_long_values(value: T) -> T:
         for key, item in value.items():
             value[key] = _prune_long_values(item)
     elif isinstance(value, str | bytes) and len(value) > 50:
-        value = "[pruned due to length]"
+        return "[pruned due to length]"
 
     return value
 

{py4web-debug-tools-0.1.1 → py4web-debug-tools-0.2.0.dev0}/py4web_debug/dumping.py

@@ -104,7 +104,7 @@ class ApiDumpDieError(Exception):
     pass
 
 
-def dd(*data, fancy=True, api=False) -> typing.NoReturn:
+def dd(*data, fancy=True, api=False):
     """
     Dump and Die:
     Show args as JSON an halt the rest of the request

{py4web-debug-tools-0.1.1 → py4web-debug-tools-0.2.0.dev0}/py4web_debug/internals.py

@@ -5,6 +5,7 @@ import logging
 import os
 import re
 import traceback
+import typing
 
 import ombott as bottle
 import yatl
@@ -27,12 +28,17 @@ def custom_error_page(
     color=None,
     message=None,
     traceback="",
-    err_type=None,
+    err_type: str | typing.Type | None = None,
     bare_exception=None,
+
+    renderer=None
 ):
-    if not isinstance(err_type, str):
+    if err_type and not isinstance(err_type, str):
         err_type = err_type.__name__
 
+    # make sure the name is a string (but it probably already is:)
+    err_type_name = str(err_type)
+
     if hasattr(Template, "_on_success"):
         # reset here on error, because on_error might not be called!
         Template.on_success = Template._on_success
@@ -60,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",
@@ -67,7 +76,7 @@ def custom_error_page(
         "ApiDumpDieError": None,
     }
 
-    _tmpl = templates.get(err_type, templates["default"])
+    _tmpl = templates.get(err_type_name, templates["default"])
 
     if _tmpl is None:
         # just bare exception
@@ -84,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.1 → 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.1
+Version: 0.2.0.dev0
 Summary: Debug Tools for py4web
 Home-page: https://github.com/trialandsuccess/py4web-debug-tools
 Author: Robin van der Noord
@@ -9,7 +9,8 @@ Requires-Python: >3.10.0
 Description-Content-Type: text/markdown
 
 # py4web debug tools
-Tooling to improve the developer experience when working with py4web.  
+
+Tooling to improve the developer experience when working with py4web.
 
 There are two main tools and some helpers that this package provides.
 
@@ -19,9 +20,16 @@ There are two main tools and some helpers that this package provides.
 ## In this package:
 
 - `tools`:
-    - `enable(db: DAL, enabled: bool)`: activate or disable the debug tools (add the custom error screen and create the Debug Bar
-      Fixture).  
-      The first argument (DAL) is required for the debug bar to collect queries.
+    - `enable(db: DAL, enabled?: bool, fancy_rendering?: bool, bar_style?: "bootstrap", slow_threshold_ms?: int)`:  
+      activate or disable the debug tools (add the custom error screen and create the Debug Bar Fixture).  
+      The first argument (DAL) is required for the debug bar to collect queries.  
+      `enabled` can be used to dynamically turn on/off the debug features.  
+      `fancy_rendering`: This will render the `data` section of the debug bar using `json-browse`, which
+      includes `jQuery`. If this clashes with the other JS on a page, this can be set to False to simply show a `<pre>`
+      block with data.  
+      `bar_style`: only bootstrap is supported at this moment.  
+      `slow_threshold_ms`: amount of milliseconds an SQL query has to take before it is considered a 'slow query' in the
+      debug bar.
     - `debug_bar`: this Fixture can be used on py4web actions to enable the bar for that page.
 - `catch(*)`: Data and a stacktrace of where `catch()` is called can be found in the catch tab of the debug bar.
 - `dump(*)`: convert objects to JSON, with a more capable converter than the default json.dumps (e.g. it works better

{py4web-debug-tools-0.1.1 → 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.1",
+    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.1/py4web_debug/core.py

@@ -1,49 +0,0 @@
-# Transforms janky 'internals' into easy to work with tool
-import os
-
-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,
-        fancy_rendering=True,
-        bar_style="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 = os.getenv("PY4WEB_DEBUG_MODE", False)
-
-        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()