How do I print functions as they are called?

by

You can do this with a trace function (props to Spacedman for improving the original version of this to trace returns and use some nice indenting):

def tracefunc(frame, event, arg, indent=[0]):
      if event == "call":
          indent[0] += 2
          print("-" * indent[0] + "> call function", frame.f_code.co_name)
      elif event == "return":
          print("<" + "-" * indent[0], "exit function", frame.f_code.co_name)
          indent[0] -= 2
      return tracefunc

import sys
sys.setprofile(tracefunc)

main()   # or whatever kicks off your script

Note that a function’s code object usually has the same name as the associated function, but not always, since functions can be created dynamically. Unfortunately, Python doesn’t track the function objects on the stack (I’ve sometimes fantasized about submitting a patch for this). Still, this is certainly “good enough” in most cases.

If this becomes an issue, you could extract the “real” function name from the source code—Python does track the filename and line number—or ask the garbage collector find out which function object refers to the code object. There could be more than one function sharing the code object, but any of their names might be good enough.

Coming back to revisit this four years later, it behooves me to mention that in Python 2.6 and later, you can get better performance by using sys.setprofile() rather than sys.settrace(). The same trace function can be used; it’s just that the profile function is called only when a function is entered or exited, so what’s inside the function executes at full speed.

More Related Contents:

  1. Using lambda function in python
  2. Check if input is empty
  3. How to make function decorators and chain them together?
  4. Creating a singleton in Python
  5. urllib2.HTTPError: HTTP Error 403: Forbidden
  6. How to set sys.stdout encoding in Python 3?
  7. How to retrieve the values of dynamic html content using Python
  8. How can I obtain the element-wise logical NOT of a pandas Series?
  9. Dead simple example of using Multiprocessing Queue, Pool and Locking
  10. How to implement custom indentation when pretty-printing with the JSON module?
  11. Unsupported operand type(s) for +: ‘int’ and ‘str’ [duplicate]
  12. how to convert xls to xlsx
  13. PySerial non-blocking read loop
  14. Python ‘requests’ library – define specific DNS?
  15. Python Assignment Operator Precedence – (a, b) = a[b] = {}, 5
  16. How to check if a user is logged in (how to properly use user.is_authenticated)?
  17. TypeError: ‘builtin_function_or_method’ object is not subscriptable
  18. How to avoid console window with .pyw file containing os.system call?
  19. Return multiple columns from pandas apply()
  20. How to format axis number format to thousands with a comma
  21. What is first class function in Python
  22. ImportError: No module named pandas
  23. not all arguments converted during string formatting.. NO % variables
  24. How to get an expression between balanced parentheses
  25. How to merge two json string in Python?
  26. Using Python, find anagrams for a list of words
  27. Printing Unicode in eclipse Pydev console and in Idle
  28. ModX in event.state in tkinter?
  29. Python: Inheritance versus Composition
  30. How to add a Python import path using a .pth file

Leave a Comment