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

{py4web_debug_tools-1.1.4 → py4web_debug_tools-1.2.1}/.gitignore

@@ -4,4 +4,5 @@ apps
 build
 dist
 *.egg-info
-.idea
+.idea
+.env

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

@@ -2,6 +2,16 @@
 
 <!--next-version-placeholder-->
 
+## v1.2.1 (2024-11-20)
+
+### Fix
+
+* Allow logger to be set to False in case you're using py4webs default logger (PY4WEB_ERRORLOG=:stderr) ([`43639f3`](https://github.com/trialandsuccess/py4web-debug-tools/commit/43639f377d92b2f8b96bbdb31f61251fde95f831))
+
+## v1.2.0 (2023-11-06)
+### Feature
+* Allow custom `error_logger` for tools.enable ([`a8301bc`](https://github.com/trialandsuccess/py4web-debug-tools/commit/a8301bc1762984fc5af420075acdc09e97bcc378))
+
 ## v1.1.4 (2023-07-19)
 
 

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

@@ -1,12 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: py4web-debug-tools
-Version: 1.1.4
+Version: 1.2.1
 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-Expression: MIT
+License: MIT
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10

{py4web_debug_tools-1.1.4 → py4web_debug_tools-1.2.1}/pyproject.toml

@@ -110,7 +110,9 @@ exclude = ["venv", ".bak"]
 [tool.ruff]
 target-version = "py311"
 line-length = 120
+extend-exclude = ["*.bak/", "venv*/"]
 
+[tool.ruff.lint]
 select = [
     "F", # pyflake error
     "E", # pycodestyle error
@@ -129,8 +131,6 @@ unfixable = [
     # Don't touch unused imports
     "F401",
 ]
-extend-exclude = ["*.bak/", "venv*/"]
-
 ignore = [
     "RUF013" # implicit Optional
 ]

py4web_debug_tools-1.2.1/src/py4web_debug/__about__.py

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

{py4web_debug_tools-1.1.4 → py4web_debug_tools-1.2.1}/src/py4web_debug/core.py

@@ -7,7 +7,7 @@ from py4web import DAL as P4WDAL
 
 from .debugbar import DebugBar, DummyDebugBar
 from .env import is_debug
-from .internals import T_Renderer, patch_py4
+from .internals import T_Logger, T_Renderer, patch_py4
 
 
 @dataclass
@@ -45,6 +45,8 @@ class DebugTools:
         # error screen settings:
         errorpage_enabled: bool = None,  # value of 'enabled' is used by default
         errorpage_renderer: T_Renderer = None,
+        # can be set to False to disable (e.g. when using PY4WEB_ERRORLOG: ":stderr"):
+        error_logger: T_Logger | typing.Literal[False] | None = None,
         # debugbar settings:
         debugbar_enabled: bool = None,  # value of 'enabled' is used by default
         debugbar_fancy_rendering: bool = True,
@@ -53,8 +55,6 @@ class DebugTools:
     ) -> None:
         """
         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()
@@ -73,7 +73,7 @@ class DebugTools:
 
         if enabled:
             if self.config.errorpage.enabled:
-                patch_py4(errorpage_renderer)
+                patch_py4(errorpage_renderer, error_logger)
 
             if self.config.debugbar.enabled:
                 if not db:

{py4web_debug_tools-1.1.4 → py4web_debug_tools-1.2.1}/src/py4web_debug/debugbar.py

@@ -160,8 +160,7 @@ def convert_for_debugbar(value: typing.Any) -> str:
     return _prune_long_values(value)
 
 
-class DummyDebugBar(TypedFixture):
-    ...
+class DummyDebugBar(TypedFixture): ...
 
 
 class DebugBar(TypedFixture):

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

@@ -10,35 +10,25 @@ from .env import is_debug
 
 
 class PossiblyAsDict(typing.Protocol):
-    def as_dict(self) -> dict[str, typing.Any]:
-        ...
+    def as_dict(self) -> dict[str, typing.Any]: ...
 
-    def asdict(self) -> dict[str, typing.Any]:
-        ...
+    def asdict(self) -> dict[str, typing.Any]: ...
 
-    def _asdict(self) -> dict[str, typing.Any]:
-        ...
+    def _asdict(self) -> dict[str, typing.Any]: ...
 
-    def _as_dict(self) -> dict[str, typing.Any]:
-        ...
+    def _as_dict(self) -> dict[str, typing.Any]: ...
 
-    def to_dict(self) -> dict[str, typing.Any]:
-        ...
+    def to_dict(self) -> dict[str, typing.Any]: ...
 
-    def todict(self) -> dict[str, typing.Any]:
-        ...
+    def todict(self) -> dict[str, typing.Any]: ...
 
-    def _todict(self) -> dict[str, typing.Any]:
-        ...
+    def _todict(self) -> dict[str, typing.Any]: ...
 
-    def _to_dict(self) -> dict[str, typing.Any]:
-        ...
+    def _to_dict(self) -> dict[str, typing.Any]: ...
 
-    def __json__(self) -> dict[str, typing.Any]:
-        ...
+    def __json__(self) -> dict[str, typing.Any]: ...
 
-    def as_list(self) -> list[typing.Any]:
-        ...
+    def as_list(self) -> list[typing.Any]: ...
 
 
 class DDJsonEncoder(ConfigurableJsonEncoder):

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

@@ -22,6 +22,8 @@ from py4web.core import (
 from typing_extensions import NotRequired
 from yatl import XML
 
+from .types import ErrorSnapshot
+
 
 class ContextDict(typing.TypedDict):
     code: int
@@ -48,7 +50,7 @@ def custom_error_page(
     message: str = None,
     traceback: str = "",
     err_type: str | typing.Type[Exception] | None = None,
-    bare_exception: Exception | str = None,
+    bare_exception: typing.Optional[Exception | str] = None,
     renderer: T_Renderer = None,
 ) -> str:
     if err_type and not isinstance(err_type, str):
@@ -108,11 +110,23 @@ def custom_error_page(
     return typing.cast(str, result)
 
 
+def default_error_logger(snapshot: ErrorSnapshot) -> None:
+    logging.error(snapshot["traceback"])
+
+
+T_Logger = typing.Callable[[ErrorSnapshot], None]
+
+
 class patch_py4:
     # THIS IS ONLY CALLED ONCE, WHEN tools.enable IS CALLED OR py4web_debug.wsgi IS USED!
     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):
+        if logger is True:
+            # use default logger:
+            logger = None
 
-    def __init__(self, renderer: T_Renderer = None):
         def custom_catch_errors(app_name: str, func: AnyFunc) -> typing.Callable[..., str]:
             """Catches and logs errors in an action; also sets request.app_name"""
 
@@ -136,14 +150,19 @@ class patch_py4:
                 except bottle.HTTPResponse:
                     raise
                 except Exception as e:
+                    err_code = 500
                     snapshot = get_error_snapshot()
-                    logging.error(snapshot["traceback"])
+                    if self.logger is not False:
+                        # False - don't log
+                        # None - default logger
+                        (self.logger or default_error_logger)(snapshot)
+
                     ticket_uuid = error_logger.log(request.app_name, snapshot) or "unknown"
-                    response.status = 500
+                    response.status = err_code
 
                     raise bottle.HTTPResponse(
                         body=custom_error_page(
-                            500,
+                            err_code,
                             button_text=ticket_uuid,
                             href=f"/_dashboard/ticket/{ticket_uuid}",
                             traceback=tb.format_exc(),
@@ -162,3 +181,5 @@ 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

py4web_debug_tools-1.2.1/src/py4web_debug/types.py

@@ -0,0 +1,50 @@
+from typing import TypedDict
+
+
+class SystemInfo(TypedDict):
+    machine: str
+    node: str
+    platform: str
+    processor: str
+    python_branch: str
+    python_build: tuple[str, str]
+    python_compiler: str
+    python_implementation: str
+    python_revision: str
+    python_version: str
+    python_version_tuple: tuple[str, str, str]
+    release: str
+    system: str
+    uname: tuple[str, str, str, str, str]
+
+
+class OsEnviron(TypedDict):
+    SHELL: str
+    SESSION_MANAGER: str
+    QT_ACCESSIBILITY: str
+    # ... (other key-value pairs)
+
+
+class StackFrame(TypedDict):
+    file: str
+    func: str
+    lnum: int
+    code: list[str]
+
+
+class Traceback(TypedDict):
+    file: str
+    func: str
+    lnum: int
+    code: list[str]
+
+
+class ErrorSnapshot(TypedDict):
+    timestamp: str
+    python_version: str
+    platform_info: SystemInfo
+    os_environ: OsEnviron
+    traceback: str
+    exception_type: str
+    exception_value: str
+    stackframes: list[StackFrame]

py4web_debug_tools-1.1.4/src/py4web_debug/__about__.py

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