py4web-debug-tools 1.2.0__tar.gz → 1.2.2__tar.gz

{py4web_debug_tools-1.2.0 → py4web_debug_tools-1.2.2}/.gitignore

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

{py4web_debug_tools-1.2.0 → py4web_debug_tools-1.2.2}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## 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
+
+* 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))

{py4web_debug_tools-1.2.0 → py4web_debug_tools-1.2.2}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: py4web-debug-tools
-Version: 1.2.0
+Version: 1.2.2
 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.2.0 → py4web_debug_tools-1.2.2}/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.2/src/py4web_debug/__about__.py

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

{py4web_debug_tools-1.2.0 → py4web_debug_tools-1.2.2}/src/py4web_debug/core.py

@@ -45,7 +45,8 @@ class DebugTools:
         # error screen settings:
         errorpage_enabled: bool = None,  # value of 'enabled' is used by default
         errorpage_renderer: T_Renderer = None,
-        error_logger: T_Logger = 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,

{py4web_debug_tools-1.2.0 → py4web_debug_tools-1.2.2}/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.2.0 → py4web_debug_tools-1.2.2}/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.2.0 → py4web_debug_tools-1.2.2}/src/py4web_debug/internals.py

@@ -120,9 +120,14 @@ 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 | None = None
+    logger: T_Logger | typing.Literal[False] | 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
 
-    def __init__(self, renderer: T_Renderer = None, logger: T_Logger = 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"""
 
@@ -148,7 +153,10 @@ class patch_py4:
                 except Exception as e:
                     err_code = 500
                     snapshot = get_error_snapshot()
-                    (self.logger or default_error_logger)(snapshot)
+                    if patch_py4.logger is not False:
+                        # False - don't log
+                        # None - default logger
+                        (patch_py4.logger or default_error_logger)(snapshot)
 
                     ticket_uuid = error_logger.log(request.app_name, snapshot) or "unknown"
                     response.status = err_code
@@ -175,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.0/src/py4web_debug/__about__.py

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