home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / share / doc / diveintopython / examples / apihelper.py next >
Encoding:
Python Source  |  2004-05-05  |  1.7 KB  |  48 lines
  1. """Cheap and simple API helper
  2.  
  3. This program is part of "Dive Into Python", a free Python book for
  4. experienced programmers.  Visit http://diveintopython.org/ for the
  5. latest version.
  6. """
  7.  
  8. __author__ = "Mark Pilgrim (mark@diveintopython.org)"
  9. __version__ = "$Revision: 1.3 $"
  10. __date__ = "$Date: 2004/05/05 21:57:19 $"
  11. __copyright__ = "Copyright (c) 2001 Mark Pilgrim"
  12. __license__ = "Python"
  13.  
  14. # While this is a good example script to teach about introspection,
  15. # in real life it has been superceded by PyDoc, which is part of the
  16. # standard library in Python 2.1 and later.
  17. # 
  18. # Your IDE may already import the "help" function from pydoc
  19. # automatically on startup; if not, do this:
  20. # 
  21. # >>> from pydoc import help
  22. # 
  23. # The help function in this module takes the object itself to get
  24. # help on, but PyDoc can also take a string, like this:
  25. # 
  26. # >>> help("string") # gets help on the string module
  27. # >>> help("apihelper.help") # gets help on the function below
  28. # >>> help() # enters an interactive help mode
  29. # 
  30. # PyDoc can also act as an HTTP server to dynamically produce
  31. # HTML-formatted documentation of any module in your path.
  32. # That's wicked cool.  Read more about PyDoc here:
  33. #   http://www.onlamp.com/pub/a/python/2001/04/18/pydoc.html
  34.  
  35. def info(object, spacing=10, collapse=1):
  36.     """Print methods and doc strings.
  37.  
  38.     Takes module, class, list, dictionary, or string."""
  39.     methodList = [e for e in dir(object) if callable(getattr(object, e))]
  40.     processFunc = collapse and (lambda s: " ".join(s.split())) or (lambda s: s)
  41.     print "\n".join(["%s %s" %
  42.                      (method.ljust(spacing),
  43.                       processFunc(str(getattr(object, method).__doc__)))
  44.                      for method in methodList])
  45.  
  46. if __name__ == "__main__":
  47.     print help.__doc__
  48.