updates

Author: Jakar510

.idea/PyDebug.iml

@@ -7,6 +7,7 @@
 data_files = [
         'PyDebug/*.py'
         ]
+
 setup(
         name='PyDebug',
         version=version,
@@ -18,30 +19,29 @@
         description='A set of helpers for debugging Python 3.x.',
         install_requires=[],
         classifiers=[
-            # How mature is this project? Common values are
-            #   3 - Alpha
-            #   4 - Beta
-            #   5 - Production/Stable
-            'Development Status :: 3 - Alpha',
-
-            # Indicate who your project is intended for
-            'Intended Audience :: Developers',
-            'Topic :: Software Development :: Build Tools',
-
-            # Pick your license as you wish
-            'License :: Free To Use But Restricted',
-
-            # Support platforms
-            'Operating System :: MacOS',
-            'Operating System :: Microsoft :: Windows',
-            'Operating System :: POSIX',
-
-            'Programming Language :: Python :: 3',
-        ],
+                # How mature is this project? Common values are
+                #   3 - Alpha
+                #   4 - Beta
+                #   5 - Production/Stable
+                'Development Status :: 3 - Alpha',
+
+                # Indicate who your project is intended for
+                'Intended Audience :: Developers',
+                'Topic :: Software Development :: Build Tools',
+
+                # Pick your license as you wish
+                'License :: Free To Use But Restricted',
+
+                # Support platforms
+                'Operating System :: MacOS',
+                'Operating System :: Microsoft :: Windows',
+                'Operating System :: POSIX',
+
+                'Programming Language :: Python :: 3',
+                ],
         keywords='switch switch-case case',
-        package_dir={'PyDebug': 'src/PyDebug'},
+        package_dir={ 'PyDebug': 'src/PyDebug' },
         package_data={
                 'PyDebug': data_files,
-            },
+                },
         )
-

.idea/misc.xml

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

setup.py

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

src/PyDebug/__init__.py

@@ -4,6 +4,9 @@
 
 
 DEFAULT_TAG = '\n______________________________________________________________\n"{0}"'
+END_TAG = '\n=============================================================\n'
+
+
 
 def GetFuncModule(func: callable) -> str:
     return func.__module__

src/PyDebug/__version__.py

@@ -1,55 +1,97 @@
 import functools
-from .base import GetFunctionName, DEFAULT_TAG
+from itertools import count
+
+from .base import GetFunctionName, DEFAULT_TAG, END_TAG
 
 from .console import getPPrintStr
 
+__all__ = ['chain', 'sub']
+
+
+class _AutoCounter(object):
+    _counter: count
+    def __init__(self, *, start: int = 0, step: int = 1):
+        self._value = start
+        self.reset(start=start, step=step)
+    def __call__(self, *args, **kwargs) -> int:
+        self._value = self._next()
+        return self._value
+    @property
+    def value(self) -> int:
+        return self._value
+    def reset(self, *, start: int = 0, step: int = 1):
+        self._counter = count(start=start, step=step)
+        self._next = self._counter.__next__
 
 
+_counter = _AutoCounter()
 
-__all__ = ['top_debug', 'sub_level', ]
 
-def print_chain_signature(func: callable, tag: str, level: int or str, signature: bool, *args, **kwargs):
+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}'))
+    print(tag.format(f'{level} --> {name}'))
 
     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):
+
+
+def chain(start_tag: str = DEFAULT_TAG, end_tag: str = END_TAG, start: int = 1):
     """
         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.
+    :param end_tag: a unique string to identify the ENDING of the chain in the console window.
+    :param start_tag: a unique string to identify the START of the chain in the console window.
     :return:
     """
-    name = GetFunctionName(func)
+    _counter.reset(start=start)
+    def top(func: callable):
+        """
+        :param func: callable function to be debugged.
+        :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")
+        @functools.wraps(func)
+        def wrapper_debug(*args, **kwargs):
+            print(start_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")
+            print(end_tag)
 
-        return result
-    return wrapper_debug
+            return result
+        return wrapper_debug
+    return top
+
+# class callback(object):
+#     def __init__(self, func: callable, name: str, tag: str, signature: bool ):
+#         self._signature = signature
+#         self._tag = tag
+#         self._name = name
+#         self._func = func
+#     def __call__(self, *args, **kwargs):
+#         _print_chain_signature(self._func, self._tag, _counter(), self._signature, *args, **kwargs)
+#         result = self._func(*args, **kwargs)
+#         print(f"{self._name}  returned  {result!r}\n")
+#         return result
 
-def sub_level(level: str or str, *, tag: str = '-------------- level: {0}', signature: bool = True):
+def sub(*, tag: str = '-------------- level: {0}', signature: bool = False):
     """
         Print the function signature [Optional] and return value.
 
-    :param signature: for sub-level method chains, prints it's signature. defaults to true.
+    :param signature: for sub-level method chains, prints it's signature. defaults to False.
     :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):
+
+    def wrapped(func: callable):
         """
         :param func: callable function to be debugged.
         :return:
@@ -58,10 +100,10 @@ def sub(func: callable):
 
         @functools.wraps(func)
         def wrapper_debug(*args, **kwargs):
-            print_chain_signature(func, tag, level, signature, *args, **kwargs)
+            # return callback(func, name, tag, signature)
+            _print_chain_signature(func, tag, _counter(), signature, *args, **kwargs)
             result = func(*args, **kwargs)
             print(f"{name}  returned  {result!r}\n")
-
             return result
         return wrapper_debug
-    return sub
+    return wrapped

src/PyDebug/base.py

@@ -1,16 +1,22 @@
 import logging
 import pprint
+import traceback
 
 pp = pprint.PrettyPrinter(indent=4)
 
-__all__ = ['PRINT', 'getPPrintStr', 'pp']
+__all__ = ['PRINT', 'getPPrintStr', 'print_exception']
 
 def PRINT(title: str, Object: any, logger: logging.Logger = None):
     print(f"\n ---------------- {title} ---------------- \n\r")
     pp.pprint(Object)
     if logger: logger.debug(f' ---------------- {title} ---------------- \n{pp.pformat(Object)}')
 
 
+
 def getPPrintStr(Object: any) -> str:
     return f'{pp.pformat(Object)}'
 
+
+
+def print_exception(e: Exception):
+    traceback.print_exception(type(e), e, e.__traceback__)

src/PyDebug/chains.py

@@ -1,3 +1,4 @@
+import time
 import tkinter as tk
 from PyDebug import *
 
@@ -7,17 +8,36 @@ class test(object):
         @pprint_debug
         def pp_run(self, *args, **kwargs):
             pass
+
         @debug
         def run(self, *args, **kwargs):
             pass
+
         @debugTkinterEvent
         def tk_run(self, event: tk.Event):
             pass
 
+        @check_time
+        def timed(self, *args, **kwargs):
+            time.sleep(1)
+
+        @Chains.chain()
+        def root(self, *args, **kwargs):
+            self.sub1(*args, **kwargs)
+        @Chains.sub()
+        def sub1(self, *args, **kwargs):
+            self.sub2(*args, **kwargs)
+
+        @Chains.sub()
+        def sub2(self, *args, **kwargs):
+            pass
+
+
+
     t = test()
 
     t.run()
-
+    t.timed()
     t.pp_run()
 
     evt = tk.Event()
@@ -26,3 +46,4 @@ def tk_run(self, event: tk.Event):
     evt.y = None
     t.tk_run(evt)
 
+    t.root()