pretty-debugger 0.1.0__tar.gz

pretty_debugger-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PyCrow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pretty_debugger-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: pretty_debugger
+Version: 0.1.0
+Summary: A Python package for easy and convenient debugging
+Author: PyCrow
+License: MIT
+Project-URL: Homepage, https://github.com/PyCrow/pretty_debugger/
+Project-URL: Bug Tracker, https://github.com/PyCrow/pretty_debugger/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+Wraps a function to log its execution, including all args, kwargs,
+execution result, and errors.
+
+Wrapper does not make any changes that affect the result of
+code execution or errors.
+
+Usage:
+```python
+import logging
+from pretty_debugger import pretty_wrapper
+
+logger = logging.getLogger(__name__)
+
+@pretty_wrapper(logger)
+def foo(bar):
+    return f"Hello, {bar}"
+
+foo("world")
+```
+
+Corresponding output:
+```
+┯
+├─►foo(
+│    bar=world,
+│  )
+┊  └► Hello, world  (0.0000s)
+┷
+```
+
+Output when using nested wrapped functions:
+```
+┯
+├─►foobar(
+│    some_arg=0,
+│  )
+┊  ├─►plus_one(
+┊  │    some_arg=0,
+┊  │  )
+┊  ┊  └► 1  (1.0011s)
+┊  ├─►exception_func(
+┊  │    this_is_kwarg=True,
+┊  │  )
+┊  ┊  └X <Exception('SOME TEST EXCEPTION')>  (0.0000s)
+┊  └X <Exception('SOME TEST EXCEPTION')>  (1.0022s)
+┷
+```
+
+Param `logger`: Logger object must contain the 'level' attribute,
+    the 'log' method, and HAVE THE 'utf-8' ENCODING.
+
+Param `debug_level`: Custom debug level. If not specified, the
+    logger debug level or WARNING level is used, whichever is higher.
+
+Param `round_exec_time`: Round the execution time to N after the decimal point
+
+Returns: Wrapped function
+
+---
+
+Zero-dependency: Package does not require installation of additional libraries

pretty_debugger-0.1.0/README.md

@@ -0,0 +1,61 @@
+Wraps a function to log its execution, including all args, kwargs,
+execution result, and errors.
+
+Wrapper does not make any changes that affect the result of
+code execution or errors.
+
+Usage:
+```python
+import logging
+from pretty_debugger import pretty_wrapper
+
+logger = logging.getLogger(__name__)
+
+@pretty_wrapper(logger)
+def foo(bar):
+    return f"Hello, {bar}"
+
+foo("world")
+```
+
+Corresponding output:
+```
+┯
+├─►foo(
+│    bar=world,
+│  )
+┊  └► Hello, world  (0.0000s)
+┷
+```
+
+Output when using nested wrapped functions:
+```
+┯
+├─►foobar(
+│    some_arg=0,
+│  )
+┊  ├─►plus_one(
+┊  │    some_arg=0,
+┊  │  )
+┊  ┊  └► 1  (1.0011s)
+┊  ├─►exception_func(
+┊  │    this_is_kwarg=True,
+┊  │  )
+┊  ┊  └X <Exception('SOME TEST EXCEPTION')>  (0.0000s)
+┊  └X <Exception('SOME TEST EXCEPTION')>  (1.0022s)
+┷
+```
+
+Param `logger`: Logger object must contain the 'level' attribute,
+    the 'log' method, and HAVE THE 'utf-8' ENCODING.
+
+Param `debug_level`: Custom debug level. If not specified, the
+    logger debug level or WARNING level is used, whichever is higher.
+
+Param `round_exec_time`: Round the execution time to N after the decimal point
+
+Returns: Wrapped function
+
+---
+
+Zero-dependency: Package does not require installation of additional libraries

pretty_debugger-0.1.0/pretty_debugger/__init__.py

@@ -0,0 +1,6 @@
+from .wrapper import pretty_wrapper
+
+__all__ = ["pretty_wrapper"]
+
+__title__ = "pretty_debugger"
+__version__ = "0.1.0"

pretty_debugger-0.1.0/pretty_debugger/cache.py

@@ -0,0 +1,30 @@
+class PrettyCache:
+    _instance = None
+
+    @classmethod
+    def __new__(cls, *args, **kwargs):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(self):
+        self.__level = 0
+
+    @property
+    def level(self):
+        return self.__level
+    @level.setter
+    def level(self, level):
+        self.__level = level
+
+    @staticmethod
+    def is_logger(logger) -> bool:
+        """ Checks if 'logger' has logging functionality:
+        1. 'level' attribute
+        2. 'log' method
+        """
+        return (
+            hasattr(logger, 'level')
+            and hasattr(logger, 'log')
+            and callable(logger.log)
+        )

pretty_debugger-0.1.0/pretty_debugger/utils.py

@@ -0,0 +1,16 @@
+from logging import makeLogRecord
+
+
+non_expo = lambda n, round_to: f"%.{round_to}f" % n
+
+
+log = lambda logger, level, msg, *args: logger.handle(
+    makeLogRecord({
+        'args': args,
+        'levelname': "PRETTY",
+        'levelno': level,
+        'lineno': 0,
+        'msg': msg,
+        'name': "PRETTY",  # Logger name
+    })
+)

pretty_debugger-0.1.0/pretty_debugger/wrapper.py

@@ -0,0 +1,90 @@
+import inspect
+from logging import Logger, WARNING
+from time import time
+
+from .cache import PrettyCache
+from .utils import log, non_expo
+
+
+def pretty_wrapper(
+        logger: Logger,
+        debug_level: int = None,
+        round_exec_time: int = 4,
+):
+    """
+    Wraps a function to log its execution, including all args, kwargs,
+    execution result, and errors.
+
+    Wrapper does not make any changes that affect the result of
+    code execution or errors.
+
+    :param logger: Logger object must contain the 'level' attribute,
+        the 'log' method, and HAVE THE 'utf-8' ENCODING.
+
+    :param debug_level: Custom debug level. If not specified, the
+        logger debug level or WARNING level is used, whichever is higher.
+
+    :param round_exec_time: Round the execution time to N after the decimal point
+
+    :returns: Wrapped function
+    """
+    # Validate logger
+    if not PrettyCache.is_logger(logger):
+        raise TypeError("Logger object must contain a 'level' attribute"
+                        " and a 'log' method.")
+    if debug_level is None:
+        debug_level = max(logger.level, WARNING)
+
+    def _wrapper(func):
+        cache = PrettyCache()
+
+        sep = '  '
+
+        def _logged_function(*args, **kwargs):
+            nonlocal logger, debug_level
+
+            get_prefix = lambda: f"┊{sep}" * cache.level
+            prefix = get_prefix()
+
+            # Start line
+            if cache.level == 0:
+                log(logger, debug_level, "┯")
+
+            # Print args and kwargs
+            if not args and not kwargs:
+                log(logger, debug_level, f"{prefix}├─►{func.__name__}()")
+            else:
+                log(logger, debug_level, f"{prefix}├─►{func.__name__}(")
+                args_kwargs = dict(zip(
+                    list(inspect.signature(func).parameters.keys()),
+                    args
+                ))
+                args_kwargs.update(kwargs)
+                for k, v in args_kwargs.items():
+                    log(logger, debug_level, f"{prefix}│{sep * 2}{k}={v},")
+                log(logger, debug_level, f"{prefix}│{sep})")
+            cache.level += 1
+
+            # Execution
+            start_time = time()
+            msg = "<pretty_wrapper: UNHANDLED EXCEPTION OCCURRED>"  # var to avoid NameError
+            try:
+                result = func(*args, **kwargs)
+            except Exception as e:
+                msg = f"X <{repr(e)}>"
+                raise
+            else:
+                msg = f"► {result}"
+            finally:
+                stop_time = non_expo(time() - start_time, round_exec_time)
+                log(logger, debug_level, f"{get_prefix()}└{msg}  ({stop_time}s)")
+
+                cache.level -= 1
+
+                # Finish line
+                if cache.level == 0:
+                    log(logger, debug_level, "┷")
+
+            return result
+        return _logged_function
+    return _wrapper

pretty_debugger-0.1.0/pretty_debugger.egg-info/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: pretty_debugger
+Version: 0.1.0
+Summary: A Python package for easy and convenient debugging
+Author: PyCrow
+License: MIT
+Project-URL: Homepage, https://github.com/PyCrow/pretty_debugger/
+Project-URL: Bug Tracker, https://github.com/PyCrow/pretty_debugger/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+Wraps a function to log its execution, including all args, kwargs,
+execution result, and errors.
+
+Wrapper does not make any changes that affect the result of
+code execution or errors.
+
+Usage:
+```python
+import logging
+from pretty_debugger import pretty_wrapper
+
+logger = logging.getLogger(__name__)
+
+@pretty_wrapper(logger)
+def foo(bar):
+    return f"Hello, {bar}"
+
+foo("world")
+```
+
+Corresponding output:
+```
+┯
+├─►foo(
+│    bar=world,
+│  )
+┊  └► Hello, world  (0.0000s)
+┷
+```
+
+Output when using nested wrapped functions:
+```
+┯
+├─►foobar(
+│    some_arg=0,
+│  )
+┊  ├─►plus_one(
+┊  │    some_arg=0,
+┊  │  )
+┊  ┊  └► 1  (1.0011s)
+┊  ├─►exception_func(
+┊  │    this_is_kwarg=True,
+┊  │  )
+┊  ┊  └X <Exception('SOME TEST EXCEPTION')>  (0.0000s)
+┊  └X <Exception('SOME TEST EXCEPTION')>  (1.0022s)
+┷
+```
+
+Param `logger`: Logger object must contain the 'level' attribute,
+    the 'log' method, and HAVE THE 'utf-8' ENCODING.
+
+Param `debug_level`: Custom debug level. If not specified, the
+    logger debug level or WARNING level is used, whichever is higher.
+
+Param `round_exec_time`: Round the execution time to N after the decimal point
+
+Returns: Wrapped function
+
+---
+
+Zero-dependency: Package does not require installation of additional libraries

pretty_debugger-0.1.0/pretty_debugger.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+pretty_debugger/__init__.py
+pretty_debugger/cache.py
+pretty_debugger/utils.py
+pretty_debugger/wrapper.py
+pretty_debugger.egg-info/PKG-INFO
+pretty_debugger.egg-info/SOURCES.txt
+pretty_debugger.egg-info/dependency_links.txt
+pretty_debugger.egg-info/top_level.txt

pretty_debugger-0.1.0/pretty_debugger.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pretty_debugger-0.1.0/pretty_debugger.egg-info/top_level.txt

@@ -0,0 +1 @@
+pretty_debugger

pretty_debugger-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pretty_debugger"
+version = "0.1.0"
+authors = [
+  { name = "PyCrow" },
+]
+description = "A Python package for easy and convenient debugging"
+readme = "README.md"
+requires-python = ">=3.7"
+license = { text = "MIT" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Logging",
+]
+dependencies = []
+
+[project.urls]
+"Homepage" = "https://github.com/PyCrow/pretty_debugger/"
+"Bug Tracker" = "https://github.com/PyCrow/pretty_debugger/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pretty_debugger*"]

pretty_debugger-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+