pusher-debug 1.2.1

tools to assist with debug

pusher_debug

pusher_debug.tracing

Tools to aid in adding print statements to trace program flow:

• ObjWatch from the objwatch library
• DetailWrapper, a "wrapper" to use with Objwatch that provides more details on function calls and returns, and can be subclassed easily to provide distinct id strings for different instances of selected classes.
• fn_name, fn_entry, and fn_exit, to provide manual logging of details of function you enter (caller, parameters, return value, annotations)

pusher_debug.monkeypatching

Tools to aid in monkeypatching. Two decorators:

@add_new_class(ExistingClass)
class MyClass: ...

will (in the module where ExistingClass is defined)

1. Create orig_ExistingClass, as a backup of ExistingClass
2. Create new_ExistingClass, as a backup of MyClass
3. Make ExistingClass be new_ExistingClass (fixing __name__ and __qualname__ between new_ExistingClass and orig_ExistingClass as well)
   Then restore_class(ExistingClass) will restore the original, and restore_new_class(ExistingClass) will put back the new version again.

@add_to_class(ExistingClass)
def fn():...

will (in ExistingClass) add a method fn. If fn already exists, the the original is backed up as orig_fn. new_fn is created and names are fixed as for @add_new_class.

@add_to_class can be combined with one of @classmethod, @staticmethod, or @property (and if property, then fn in the local namespace will be the property, so you can then do

@add_to_class(ExistingClass)
@fn@setter
def fn():...

1. Create ExistingClass.orig_fn, as a backup of ExistingClass.fn
2. Create ExistingClass.new_fn, as a backup of fn
3. Make fn (or new_fn) be ExistingClass.fn and ExistingClass.new_fn (fixing __name__ and __qualname__ between versions of ExistingClass.fn
4. Specifically deals with special issues for @classmethod, @staticmethod, and @property
5. Specifically deals with condition that ExistingClass.fn was actually defined in a parent class of ExistingClass, so we don't want to change the parent class (copy fn to ExistingClass [not just ExistingClass.fn = ParentClass.fn)
6. Specifically deals with condition that ExistingClass.fn is a builtin, and can't be copied in the same way (or modified at all, even __name__)

You should know that monkeypatching will wreack havoc with mypy, since it does stuff you shouldn't do. (It's for debugging !)

For examples, use help(...), and/or download the source package and look at the tests. Seeing all the # test: ignore[] stuff in the test program gives you an idea of how much mypy hates this.

The library can be built with hatchling build, tested with tests/test_tools.py -v, and should pass mypy (including having annotations for objwatch).