updated methods in decorators.py, and added examples.py.

Author: Jakar510

.idea/runConfigurations/examples.xml

@@ -25,4 +25,5 @@ def get_size(obj, seen=None):
         size += get_size(obj.__dict__, seen)
     elif hasattr(obj, '__iter__') and not isinstance(obj, (str, bytes, bytearray)):
         size += sum([get_size(i, seen) for i in obj])
-    return size
+    return size
+

src/PyDebug/__init__.py

@@ -1,3 +1,3 @@
 
 
-version = '1.1.0'
+version = '1.2.0'

src/PyDebug/__version__.py

@@ -1,5 +1,9 @@
 import tkinter as tk
 
+__all__ = ['AllNamedColors', 'runTkColors']
+
+
+
 class AllNamedColors(object):
     all_widgets = []
     COLORS = [
@@ -108,5 +112,6 @@ def runTkColors():
     Colors = AllNamedColors()
     Colors.run()
 
+
 if __name__ == '__main__':
-    runTkColors()
+    runTkColors()

src/PyDebug/colors.py

@@ -8,20 +8,23 @@ def IsAttributePrivate(attr_name: str) -> bool:
     return private_or_special_function_searcher.search(attr_name) is not None
 
 
-def ObjectToDict(Object: any, MethodsToSkip: list or tuple = (), *, ShowAll: bool = False) -> dict:
+def ObjectToDict(Object: any, Skip: list or tuple = (), *, ShowAll: bool = False, IncludeCallable: bool = False) -> dict:
     """
         Returns a dictionary of the public attributes of the given object provided;
         Filter out private or special functions (_private, __SuperPrivate, __special__).
 
-    :param ShowAll:
-    :param MethodsToSkip:
-    :param Object:
+    :param IncludeCallable: doesn't include functions by default.
+    :param ShowAll: remove all filters and show entire object.
+    :param Skip:  list of names to skip. i.e. certain method names when IncludeCallable is True.
+    :param Object: the thing being inspected.
     :return:
     """
     temp = {}
     for key in dir(Object):
-        if key in MethodsToSkip: continue
+        if key in Skip: continue
         if ShowAll or IsAttributePrivate(key):
             temp[key] = getattr(Object, key)
+            if IncludeCallable and callable(temp[key]):
+                del temp[key]
     return temp
 

src/PyDebug/converters.py

@@ -9,9 +9,9 @@
 
 __all__ = ['debug', 'class_method_debug', 'check_time', 'debugTkinterEvent', 'pprint_debug']
 
+DEFAULT_TAG = '\n_______________________________  "{0}"  _______________________________'
 
-
-def class_method_debug(cls: str or type, tag: str = '\n________________________________________________________________'):
+def class_method_debug(cls: str or type, tag: str = DEFAULT_TAG):
     """
         Print the function signature and return value
 
@@ -38,7 +38,7 @@ def wrapper_debug(*args, **kwargs):
 
             signature = ", ".join(args_repr + kwargs_repr)  # 3
 
-            print(f"{tag} \n{cls}.{func.__name__}({signature})")
+            print(f"{tag.format(f'{func.__module__}.{func.__qualname__}')} \n{cls}.{func.__name__}(\n{signature}\n)")
             result = func(*args, **kwargs)
             print(f"{func.__name__}  returned  {result!r}\n")  # 4
 
@@ -48,7 +48,7 @@ def wrapper_debug(*args, **kwargs):
 
 
 
-def debug(func: callable, tag: str = '\n________________________________________________________________'):
+def debug(func: callable, tag: str = DEFAULT_TAG):
     """
         Print the function signature and return value
 
@@ -65,7 +65,7 @@ def wrapper_debug(*args, **kwargs):
 
         signature = ", ".join(args_repr + kwargs_repr)  # 3
 
-        print(f"{tag} \n{func.__name__}({signature})")
+        print(f"{tag.format(f'{func.__module__}.{func.__qualname__}')} \n{func.__qualname__}(\n{signature}\n)")
         result = func(*args, **kwargs)
         print(f"{func.__name__}  returned  {result!r}\n")  # 4
 
@@ -74,7 +74,7 @@ def wrapper_debug(*args, **kwargs):
 
 
 
-def pprint_debug(func: callable, tag: str = '\n________________________________________________________________'):
+def pprint_debug(func: callable, tag: str = DEFAULT_TAG):
     """
         Print the function signature and return value
 
@@ -84,9 +84,8 @@ def pprint_debug(func: callable, tag: str = '\n_________________________________
     """
     @functools.wraps(func)
     def wrapper_debug(*args, **kwargs):
-        signature = getPPrintStr({'args': kwargs, 'kwargs': args, })
-
-        print(f"{tag} \n{func.__name__}({signature})")
+        signature = getPPrintStr({'kwargs': kwargs, 'args': args, })
+        print(f"{tag.format(f'{func.__module__}.{func.__qualname__}')} \n{func.__qualname__}(\n{signature}\n)")
         result = func(*args, **kwargs)
         print(f"{func.__name__}  returned  {result!r}\n")
 
@@ -95,7 +94,7 @@ def wrapper_debug(*args, **kwargs):
 
 
 
-def check_time(*, cls: str or type = None, print_signature: bool = True, tag: str = '\n_______________________________check_time_______________________________'):
+def check_time(*, cls: str or type = None, print_signature: bool = True, tag: str = DEFAULT_TAG):
     """
         Print the function signature and return value
 
@@ -135,10 +134,10 @@ def timed(*args, **kwargs):
 
 
 
-def debugTkinterEvent(func: callable, tag: str = '_______________________________TkinterEvent_______________________________'):
+def debugTkinterEvent(func: callable, tag: str = DEFAULT_TAG):
     @functools.wraps(func)
     def wrapper_debug(self, event: Event, *args, **kwargs):
-        PRINT(f'{tag}\n{func.__class__}.{func.__name__}.{Event.__class__}', event.__dict__)
+        PRINT(f'{tag.format("TkinterEvent")}\n{func.__class__}.{func.__name__}.{Event.__class__}', event.__dict__)
 
         result = func(self, event, *args, **kwargs)
 

src/PyDebug/decorators.py

@@ -0,0 +1,28 @@
+import tkinter as tk
+from PyDebug import *
+
+if __name__ == '__main__':
+
+    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
+
+    t = test()
+
+    t.run()
+
+    t.pp_run()
+
+    evt = tk.Event()
+    evt.widget = None
+    evt.x = None
+    evt.y = None
+    t.tk_run(evt)
+