updated methods in decorators.py. added chains.py and base.py.

Author: Jakar510

src/PyDebug/__init__.py

@@ -6,6 +6,7 @@
 from .colors import *
 from .__version__ import *
 
+import PyDebug.chains as Chains
 
 def get_size(obj, seen=None):
     """Recursively finds size of objects"""

src/PyDebug/__version__.py

@@ -1,3 +1,3 @@
 
 
-version = '1.4.0'
+version = '1.4.5'

src/PyDebug/base.py

@@ -0,0 +1,40 @@
+from .console import getPPrintStr
+
+
+
+
+DEFAULT_TAG = '\n______________________________________________________________\n"{0}"'
+
+def GetFuncModule(func: callable) -> str:
+    return func.__module__
+
+
+
+def GetFunctionName(func: callable) -> str:
+    if hasattr(func, '__qualname__'):
+        return func.__qualname__
+    elif hasattr(func, '__module__'):
+        return f"{func.__module__}.{func.__qualname__}"
+    else:
+        return func.__name__
+
+
+
+def print_signature(func: callable, tag: str, *args, **kwargs):
+    assert ('{0}' in tag)
+    name = GetFunctionName(func)
+    print(tag.format(f'{name}'))
+
+    if args or kwargs:
+        # try: args_repr = [repr(a) for a in args]  # 1
+        # except: args_repr = [str(a) for a in args]  # 1
+        #
+        # kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]  # 2
+        #
+        # signature = ", ".join(args_repr + kwargs_repr)  # 3
+        #
+        # print(f"{name}(\n{signature}\n)")
+        signature = getPPrintStr({'kwargs': kwargs, 'args': args, })
+        print(f"{name}(\n      {signature}\n   )")
+        result = func(*args, **kwargs)
+        print(f"{name}  returned: \n{getPPrintStr(result)}\n")

src/PyDebug/chains.py

@@ -0,0 +1,67 @@
+import functools
+from .base import GetFunctionName, DEFAULT_TAG
+
+from .console import getPPrintStr
+
+
+
+
+__all__ = ['top_debug', 'sub_level', ]
+
+def print_chain_signature(func: callable, tag: str, level: int or str, signature: bool, *args, **kwargs):
+    assert ('{0}' in tag)
+    name = GetFunctionName(func)
+    print(tag.format(f'{level}'))
+
+    if signature and (args or kwargs):
+        signature = getPPrintStr({ 'kwargs': kwargs, 'args': args, })
+        print(f"{name}(\n      {signature}\n   )")
+        result = func(*args, **kwargs)
+        print(f"{name}  returned: \n{getPPrintStr(result)}\n")
+
+def top_debug(func: callable, tag: str = DEFAULT_TAG):
+    """
+        Print the function signature and return value
+
+    :param func: callable function to be debugged.
+    :param tag: a unique string to identify the output in the console window.
+    :return:
+    """
+    name = GetFunctionName(func)
+
+    @functools.wraps(func)
+    def wrapper_debug(*args, **kwargs):
+        print(tag.format(name))
+        signature = getPPrintStr({ 'kwargs': kwargs, 'args': args, })
+        print(f"{name}(\n      {signature}\n   )")
+        result = func(*args, **kwargs)
+        print(f"{name}  returned: \n{getPPrintStr(result)}\n")
+
+        return result
+    return wrapper_debug
+
+def sub_level(level: str or str, *, tag: str = '-------------- level: {0}', signature: bool = True):
+    """
+        Print the function signature [Optional] and return value.
+
+    :param signature: for sub-level method chains, prints it's signature. defaults to true.
+    :param level: the call stack level. f() -> g() -> h() -> etc.
+    :param tag: a unique string to identify the output in the console window. must have one '{0}' for str.format() support.
+    :return:
+    """
+    def sub(func: callable):
+        """
+        :param func: callable function to be debugged.
+        :return:
+        """
+        name = GetFunctionName(func)
+
+        @functools.wraps(func)
+        def wrapper_debug(*args, **kwargs):
+            print_chain_signature(func, tag, level, signature, *args, **kwargs)
+            result = func(*args, **kwargs)
+            print(f"{name}  returned  {result!r}\n")
+
+            return result
+        return wrapper_debug
+    return sub

src/PyDebug/decorators.py

@@ -1,42 +1,13 @@
 import functools
 import time
 from tkinter import Event
-
+from .base import *
 from .console import getPPrintStr, pp
 
 
 
-
 __all__ = ['debug', 'class_method_debug', 'check_time', 'debugTkinterEvent', 'pprint_debug']
 
-DEFAULT_TAG = '\n______________________________________________________________\n"{0}"'
-
-def GetFuncModule(func: callable) -> str:
-    return func.__module__
-def GetFunctionName(func: callable) -> str:
-    if hasattr(func, '__qualname__'):
-        return func.__qualname__
-    elif hasattr(func, '__module__'):
-        return f"{func.__module__}.{func.__qualname__}"
-    else:
-        return func.__name__
-
-
-
-def _print_signature(func, tag, *args, **kwargs):
-    name = GetFunctionName(func)
-    print(tag.format(f'{name}'))
-
-    if args or kwargs:
-        try: args_repr = [repr(a) for a in args]  # 1
-        except: args_repr = [str(a) for a in args]  # 1
-
-        kwargs_repr = [f"{k}={v!r}" for k, v in kwargs.items()]  # 2
-
-        signature = ", ".join(args_repr + kwargs_repr)  # 3
-
-        print(f"{name}(\n{signature}\n)")
-
 
 def class_method_debug(cls: str or type, tag: str = DEFAULT_TAG):
     """
@@ -57,6 +28,7 @@ def debug_inner(func: callable = None):
         :return:
         """
         name = f"{cls}.{func.__name__}"
+
         @functools.wraps(func)
         def wrapper_debug(*args, **kwargs):
             print(tag.format(name))
@@ -87,9 +59,10 @@ def debug(func: callable, tag: str = DEFAULT_TAG):
     :return:
     """
     name = GetFunctionName(func)
+
     @functools.wraps(func)
     def wrapper_debug(*args, **kwargs):
-        _print_signature(func, tag, *args, **kwargs)
+        print_signature(func, tag, *args, **kwargs)
         result = func(*args, **kwargs)
         print(f"{name}  returned  {result!r}\n")  # 4
 
@@ -107,6 +80,7 @@ def pprint_debug(func: callable, tag: str = DEFAULT_TAG):
     :return:
     """
     name = GetFunctionName(func)
+
     @functools.wraps(func)
     def wrapper_debug(*args, **kwargs):
         print(tag.format(name))
@@ -134,6 +108,7 @@ def check_cls_time(*, cls: str or type = None, print_signature: bool = True, tag
 
     def timeit(func: callable):
         name = GetFunctionName(func)
+
         @functools.wraps(func)
         def timed(*args, **kwargs):
             print(tag.format(name))
@@ -163,9 +138,10 @@ def timed(*args, **kwargs):
 
 def check_time(func: callable, tag: str = DEFAULT_TAG):
     name = GetFunctionName(func)
+
     @functools.wraps(func)
     def timed(*args, **kwargs):
-        _print_signature(func, tag, *args, **kwargs)
+        print_signature(func, tag, *args, **kwargs)
 
         start_time = time.time()
         result = func(*args, **kwargs)
@@ -179,6 +155,7 @@ def timed(*args, **kwargs):
 
 def debugTkinterEvent(func: callable, tag: str = DEFAULT_TAG):
     name = GetFunctionName(func)
+
     @functools.wraps(func)
     def wrapper_debug(self, event: Event, *args, **kwargs):
         print(tag.format(f'{name}'))