py4web-debug-tools 1.2.1__tar.gz → 1.3.0__tar.gz

{py4web_debug_tools-1.2.1 → py4web_debug_tools-1.3.0}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v1.3.0 (2025-04-01)
+
+### Feature
+
+* Add `dbg` helper ([`b7529e3`](https://github.com/trialandsuccess/py4web-debug-tools/commit/b7529e32bcaa88a237fa505d26afe3f013d0bdf2))
+
+## v1.2.2 (2024-11-20)
+
+### Fix
+
+* Replace 'self' with 'patch_py4' for better stability ([`6987942`](https://github.com/trialandsuccess/py4web-debug-tools/commit/6987942347b993cf767166b6f3dac90e75989130))
+
 ## v1.2.1 (2024-11-20)
 
 ### Fix

{py4web_debug_tools-1.2.1 → py4web_debug_tools-1.3.0}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: py4web-debug-tools
-Version: 1.2.1
+Version: 1.3.0
 Summary: Debug Tools for py4web
 Project-URL: Documentation, https://github.com/trialandsuccess/py4web-debug-tools#readme
 Project-URL: Issues, https://github.com/trialandsuccess/py4web-debug-tools/issues
 Project-URL: Source, https://github.com/trialandsuccess/py4web-debug-tools
 Author-email: Robin van der Noord <contact@trialandsuccess.nl>
-License: MIT
+License-Expression: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10

py4web_debug_tools-1.3.0/src/py4web_debug/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.3.0"

{py4web_debug_tools-1.2.1 → py4web_debug_tools-1.3.0}/src/py4web_debug/__init__.py

@@ -2,13 +2,14 @@
 
 from .core import tools
 from .debugbar import catch
-from .dumping import dd, dump
+from .dumping import dbg, dd, dump
 from .env import is_debug
 from .wsgi import wsgi
 
 __all__ = [
     "tools",
     "catch",
+    "dbg",
     "dd",
     "dump",
     "is_debug",

{py4web_debug_tools-1.2.1 → py4web_debug_tools-1.3.0}/src/py4web_debug/dumping.py

@@ -1,5 +1,7 @@
+import ast
 import json
 import sys
+import traceback
 import typing
 
 import pydal.objects
@@ -152,3 +154,40 @@ def dd(*data: typing.Any, fancy: bool = True, api: bool = False) -> None:
         raise FancyDumpDieError(_json)
     else:
         raise DumpDieError(_json)
+
+
+T = typing.TypeVar("T")
+
+
+def dbg(value: T) -> T:
+    """
+    Helper inspired by Rust's `dbg!`.
+
+    Prints out the file, line, variable name, type and value.
+    Also returns the original value.
+    """
+    value_type = type(value).__name__
+
+    frame = traceback.extract_stack()[-2]  # Get caller frame info
+    file_name = frame.filename.split("/")[-1]
+    line_number = frame.lineno
+
+    try:
+        with open(frame.filename, "r") as f:
+            source_code = f.readlines()
+
+        line = source_code[line_number - 1].strip()
+        tree = ast.parse(line)
+
+        var_name = None
+        if isinstance(tree, ast.Module) and isinstance(tree.body[0], ast.Expr):
+            call = tree.body[0].value
+            if isinstance(call, ast.Call) and call.func.id == "dbg":
+                var_name = ast.unparse(call.args[0])  # Extract the first argument as a string
+
+    except Exception:
+        var_name = "?"
+
+    print(f"[{file_name}:{line_number}] {value_type}({var_name}) = {value}", file=sys.stderr)
+
+    return value

{py4web_debug_tools-1.2.1 → py4web_debug_tools-1.3.0}/src/py4web_debug/internals.py

@@ -122,7 +122,8 @@ class patch_py4:
     renderer: T_Renderer | None = None
     logger: T_Logger | typing.Literal[False] | None = None
 
-    def __init__(self, renderer: T_Renderer = None, logger: T_Logger | bool | None = None):
+    def __init__(_, renderer: T_Renderer = None, logger: T_Logger | bool | None = None):
+        # note: don't use self, use patch_py4 instead
         if logger is True:
             # use default logger:
             logger = None
@@ -152,10 +153,10 @@ class patch_py4:
                 except Exception as e:
                     err_code = 500
                     snapshot = get_error_snapshot()
-                    if self.logger is not False:
+                    if patch_py4.logger is not False:
                         # False - don't log
                         # None - default logger
-                        (self.logger or default_error_logger)(snapshot)
+                        (patch_py4.logger or default_error_logger)(snapshot)
 
                     ticket_uuid = error_logger.log(request.app_name, snapshot) or "unknown"
                     response.status = err_code
@@ -182,4 +183,4 @@ class patch_py4:
         # allows swapping renderer on the fly with tools.set_renderer():
         patch_py4.renderer = renderer
         _logger = getattr(patch_py4, "logger", None) or logger
-        patch_py4.logger = staticmethod(_logger) if _logger else None
+        patch_py4.logger = staticmethod(_logger) if callable(_logger) else _logger

py4web_debug_tools-1.2.1/src/py4web_debug/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.2.1"