home *** CD-ROM | disk | FTP | other *** search
/ Enter 2004 April / enter-2004-04.iso / files / EVE_1424_100181.exe / pprint.py < prev    next >
Encoding:
Python Source  |  2004-04-20  |  9.2 KB  |  267 lines

  1. #  Author:      Fred L. Drake, Jr.
  2. #               fdrake@acm.org
  3. #
  4. #  This is a simple little module I wrote to make life easier.  I didn't
  5. #  see anything quite like it in the library, though I may have overlooked
  6. #  something.  I wrote this when I was trying to read some heavily nested
  7. #  tuples with fairly non-descriptive content.  This is modeled very much
  8. #  after Lisp/Scheme - style pretty-printing of lists.  If you find it
  9. #  useful, thank small children who sleep at night.
  10.  
  11. """Support to pretty-print lists, tuples, & dictionaries recursively.
  12.  
  13. Very simple, but useful, especially in debugging data structures.
  14.  
  15. Classes
  16. -------
  17.  
  18. PrettyPrinter()
  19.     Handle pretty-printing operations onto a stream using a configured
  20.     set of formatting parameters.
  21.  
  22. Functions
  23. ---------
  24.  
  25. pformat()
  26.     Format a Python object into a pretty-printed representation.
  27.  
  28. pprint()
  29.     Pretty-print a Python object to a stream [default is sys.sydout].
  30.  
  31. saferepr()
  32.     Generate a 'standard' repr()-like value, but protect against recursive
  33.     data structures.
  34.  
  35. """
  36.  
  37. from types import DictType, ListType, TupleType, StringType
  38. import sys
  39.  
  40. try:
  41.     from cStringIO import StringIO
  42. except ImportError:
  43.     from StringIO import StringIO
  44.  
  45. __all__ = ["pprint","pformat","isreadable","isrecursive","saferepr",
  46.            "PrettyPrinter"]
  47.  
  48. def pprint(object, stream=None):
  49.     """Pretty-print a Python object to a stream [default is sys.sydout]."""
  50.     printer = PrettyPrinter(stream=stream)
  51.     printer.pprint(object)
  52.  
  53. def pformat(object):
  54.     """Format a Python object into a pretty-printed representation."""
  55.     return PrettyPrinter().pformat(object)
  56.  
  57. def saferepr(object):
  58.     """Version of repr() which can handle recursive data structures."""
  59.     return _safe_repr(object, {})[0]
  60.  
  61. def isreadable(object):
  62.     """Determine if saferepr(object) is readable by eval()."""
  63.     return _safe_repr(object, {})[1]
  64.  
  65. def isrecursive(object):
  66.     """Determine if object requires a recursive representation."""
  67.     return _safe_repr(object, {})[2]
  68.  
  69. class PrettyPrinter:
  70.     def __init__(self, indent=1, width=80, depth=None, stream=None):
  71.         """Handle pretty printing operations onto a stream using a set of
  72.         configured parameters.
  73.  
  74.         indent
  75.             Number of spaces to indent for each level of nesting.
  76.  
  77.         width
  78.             Attempted maximum number of columns in the output.
  79.  
  80.         depth
  81.             The maximum depth to print out nested structures.
  82.  
  83.         stream
  84.             The desired output stream.  If omitted (or false), the standard
  85.             output stream available at construction will be used.
  86.  
  87.         """
  88.         indent = int(indent)
  89.         width = int(width)
  90.         assert indent >= 0
  91.         assert depth is None or depth > 0, "depth must be > 0"
  92.         assert width
  93.         self.__depth = depth
  94.         self.__indent_per_level = indent
  95.         self.__width = width
  96.         if stream:
  97.             self.__stream = stream
  98.         else:
  99.             self.__stream = sys.stdout
  100.  
  101.     def pprint(self, object):
  102.         self.__stream.write(self.pformat(object) + "\n")
  103.  
  104.     def pformat(self, object):
  105.         sio = StringIO()
  106.         self.__format(object, sio, 0, 0, {}, 0)
  107.         return sio.getvalue()
  108.  
  109.     def isrecursive(self, object):
  110.         self.__recursive = 0
  111.         self.pformat(object)
  112.         return self.__recursive
  113.  
  114.     def isreadable(self, object):
  115.         self.__recursive = 0
  116.         self.__readable = 1
  117.         self.pformat(object)
  118.         return self.__readable and not self.__recursive
  119.  
  120.     def __format(self, object, stream, indent, allowance, context, level):
  121.         level = level + 1
  122.         if context.has_key(id(object)):
  123.             object = _Recursion(object)
  124.             self.__recursive = 1
  125.         rep = self.__repr(object, context, level - 1)
  126.         objid = id(object)
  127.         context[objid] = 1
  128.         typ = type(object)
  129.         sepLines = len(rep) > (self.__width - 1 - indent - allowance)
  130.  
  131.         if sepLines and typ in (ListType, TupleType):
  132.             #  Pretty-print the sequence.
  133.             stream.write((typ is ListType) and '[' or '(')
  134.             if self.__indent_per_level > 1:
  135.                 stream.write((self.__indent_per_level - 1) * ' ')
  136.             length = len(object)
  137.             if length:
  138.                 indent = indent + self.__indent_per_level
  139.                 self.__format(object[0], stream, indent, allowance + 1,
  140.                               context, level)
  141.                 if length > 1:
  142.                     for ent in object[1:]:
  143.                         stream.write(',\n' + ' '*indent)
  144.                         self.__format(ent, stream, indent,
  145.                                       allowance + 1, context, level)
  146.                 indent = indent - self.__indent_per_level
  147.             if typ is TupleType and length == 1:
  148.                 stream.write(',')
  149.             stream.write(((typ is ListType) and ']') or ')')
  150.  
  151.         elif sepLines and typ is DictType:
  152.             stream.write('{')
  153.             if self.__indent_per_level > 1:
  154.                 stream.write((self.__indent_per_level - 1) * ' ')
  155.             length = len(object)
  156.             if length:
  157.                 indent = indent + self.__indent_per_level
  158.                 items  = object.items()
  159.                 items.sort()
  160.                 key, ent = items[0]
  161.                 rep = self.__repr(key, context, level) + ': '
  162.                 stream.write(rep)
  163.                 self.__format(ent, stream, indent + len(rep),
  164.                               allowance + 1, context, level)
  165.                 if len(items) > 1:
  166.                     for key, ent in items[1:]:
  167.                         rep = self.__repr(key, context, level) + ': '
  168.                         stream.write(',\n' + ' '*indent + rep)
  169.                         self.__format(ent, stream, indent + len(rep),
  170.                                       allowance + 1, context, level)
  171.                 indent = indent - self.__indent_per_level
  172.             stream.write('}')
  173.  
  174.         else:
  175.             stream.write(rep)
  176.  
  177.         del context[objid]
  178.  
  179.     def __repr(self, object, context, level):
  180.         repr, readable, recursive = _safe_repr(object, context,
  181.                                                self.__depth, level)
  182.         if not readable:
  183.             self.__readable = 0
  184.         if recursive:
  185.             self.__recursive = 1
  186.         return repr
  187.  
  188. # Return triple (repr_string, isreadable, isrecursive).
  189.  
  190. _have_module = sys.modules.has_key
  191.  
  192. def _safe_repr(object, context, maxlevels=None, level=0):
  193.     level += 1
  194.     typ = type(object)
  195.     if not (typ in (DictType, ListType, TupleType, StringType) and object):
  196.         rep = `object`
  197.         return rep, (rep and (rep[0] != '<')), 0
  198.     elif typ is StringType:
  199.         if not _have_module('locale'):
  200.             return `object`, 1, 0
  201.         if "'" in object and '"' not in object:
  202.             closure = '"'
  203.             quotes = {'"': '\\"'}
  204.         else:
  205.             closure = "'"
  206.             quotes = {"'": "\\'"}
  207.         sio = StringIO()
  208.         for char in object:
  209.             if char.isalpha():
  210.                 sio.write(char)
  211.             else:
  212.                 sio.write(quotes.get(char, `char`[1:-1]))
  213.         return closure + sio.getvalue() + closure, 1, 0
  214.  
  215.     if context.has_key(id(object)):
  216.         return `_Recursion(object)`, 0, 1
  217.     objid = id(object)
  218.     context[objid] = 1
  219.  
  220.     readable = 1
  221.     recursive = 0
  222.     startchar, endchar = {ListType:  "[]",
  223.                           TupleType: "()",
  224.                           DictType:  "{}"}[typ]
  225.     if maxlevels and level > maxlevels:
  226.         with_commas = "..."
  227.         readable = 0
  228.  
  229.     elif typ is DictType:
  230.         components = []
  231.         for k, v in object.iteritems():
  232.             krepr, kreadable, krecur = _safe_repr(k, context, maxlevels,
  233.                                                   level)
  234.             vrepr, vreadable, vrecur = _safe_repr(v, context, maxlevels,
  235.                                                   level)
  236.             components.append("%s: %s" % (krepr, vrepr))
  237.             readable = readable and kreadable and vreadable
  238.             recursive = recursive or krecur or vrecur
  239.         with_commas = ", ".join(components)
  240.  
  241.     else: # list or tuple
  242.         assert typ in (ListType, TupleType)
  243.         components = []
  244.         for element in object:
  245.             subrepr, subreadable, subrecur = _safe_repr(
  246.                   element, context, maxlevels, level)
  247.             components.append(subrepr)
  248.             readable = readable and subreadable
  249.             recursive = recursive or subrecur
  250.         if len(components) == 1 and typ is TupleType:
  251.             components[0] += ","
  252.         with_commas = ", ".join(components)
  253.  
  254.     s = "%s%s%s" % (startchar, with_commas, endchar)
  255.     del context[objid]
  256.     return s, readable and not recursive, recursive
  257.  
  258. class _Recursion:
  259.     # represent a recursive relationship; really only used for the __repr__()
  260.     # method...
  261.     def __init__(self, object):
  262.         self.__repr = "<Recursion on %s with id=%s>" \
  263.                       % (type(object).__name__, id(object))
  264.  
  265.     def __repr__(self):
  266.         return self.__repr
  267.