blob: c44c75c8b3f4ba05312793bbdd0bceccfa6ab460 [file] [log] [blame]
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001"""Redo the builtin repr() (representation) but with limits on most sizes."""
Guido van Rossumbabe2bf1992-01-22 22:21:31 +00002
Raymond Hettinger98a5f3f2010-09-13 21:36:00 +00003__all__ = ["Repr", "repr", "recursive_repr"]
Skip Montanaro0de65802001-02-15 22:15:14 +00004
Georg Brandl1a3284e2007-12-02 09:40:06 +00005import builtins
Raymond Hettingerba6cd362004-05-21 10:00:15 +00006from itertools import islice
Raymond Hettinger98a5f3f2010-09-13 21:36:00 +00007try:
8 from _thread import get_ident
9except AttributeError:
10 from _dummy_thread import get_ident
11
12def recursive_repr(fillvalue='...'):
13 'Decorator to make a repr function return fillvalue for a recursive call'
14
15 def decorating_function(user_function):
16 repr_running = set()
17
18 def wrapper(self):
19 key = id(self), get_ident()
20 if key in repr_running:
21 return fillvalue
22 repr_running.add(key)
23 try:
24 result = user_function(self)
25 finally:
26 repr_running.discard(key)
27 return result
28
29 # Can't use functools.wraps() here because of bootstrap issues
30 wrapper.__module__ = getattr(user_function, '__module__')
31 wrapper.__doc__ = getattr(user_function, '__doc__')
32 wrapper.__name__ = getattr(user_function, '__name__')
33 return wrapper
34
35 return decorating_function
Walter Dörwald70a6b492004-02-12 17:35:32 +000036
Guido van Rossumbabe2bf1992-01-22 22:21:31 +000037class Repr:
Raymond Hettingerba6cd362004-05-21 10:00:15 +000038
Tim Peters0c9886d2001-01-15 01:18:21 +000039 def __init__(self):
40 self.maxlevel = 6
41 self.maxtuple = 6
42 self.maxlist = 6
Tim Peters6ee04802003-02-05 18:29:34 +000043 self.maxarray = 5
Tim Peters0c9886d2001-01-15 01:18:21 +000044 self.maxdict = 4
Raymond Hettingerba6cd362004-05-21 10:00:15 +000045 self.maxset = 6
46 self.maxfrozenset = 6
Raymond Hettinger1453e4a2004-05-21 23:01:18 +000047 self.maxdeque = 6
Tim Peters0c9886d2001-01-15 01:18:21 +000048 self.maxstring = 30
49 self.maxlong = 40
Guido van Rossuma48a3b42006-04-20 16:07:39 +000050 self.maxother = 30
Raymond Hettingerba6cd362004-05-21 10:00:15 +000051
Tim Peters0c9886d2001-01-15 01:18:21 +000052 def repr(self, x):
53 return self.repr1(x, self.maxlevel)
Raymond Hettingerba6cd362004-05-21 10:00:15 +000054
Tim Peters0c9886d2001-01-15 01:18:21 +000055 def repr1(self, x, level):
Guido van Rossuma995c912001-08-09 18:56:27 +000056 typename = type(x).__name__
Tim Peters0c9886d2001-01-15 01:18:21 +000057 if ' ' in typename:
Eric S. Raymond6b71e742001-02-09 08:56:30 +000058 parts = typename.split()
59 typename = '_'.join(parts)
Tim Peters0c9886d2001-01-15 01:18:21 +000060 if hasattr(self, 'repr_' + typename):
61 return getattr(self, 'repr_' + typename)(x, level)
62 else:
Guido van Rossuma48a3b42006-04-20 16:07:39 +000063 return self.repr_instance(x, level)
Raymond Hettingerba6cd362004-05-21 10:00:15 +000064
Raymond Hettinger1453e4a2004-05-21 23:01:18 +000065 def _repr_iterable(self, x, level, left, right, maxiter, trail=''):
Raymond Hettingerba6cd362004-05-21 10:00:15 +000066 n = len(x)
67 if level <= 0 and n:
68 s = '...'
69 else:
70 newlevel = level - 1
71 repr1 = self.repr1
72 pieces = [repr1(elem, newlevel) for elem in islice(x, maxiter)]
73 if n > maxiter: pieces.append('...')
74 s = ', '.join(pieces)
Raymond Hettinger1453e4a2004-05-21 23:01:18 +000075 if n == 1 and trail: right = trail + right
Raymond Hettingerba6cd362004-05-21 10:00:15 +000076 return '%s%s%s' % (left, s, right)
77
Tim Peters0c9886d2001-01-15 01:18:21 +000078 def repr_tuple(self, x, level):
Guido van Rossumcd16bf62007-06-13 18:07:49 +000079 return self._repr_iterable(x, level, '(', ')', self.maxtuple, ',')
Raymond Hettingerba6cd362004-05-21 10:00:15 +000080
Tim Peters0c9886d2001-01-15 01:18:21 +000081 def repr_list(self, x, level):
Raymond Hettingerba6cd362004-05-21 10:00:15 +000082 return self._repr_iterable(x, level, '[', ']', self.maxlist)
Tim Peters6ee04802003-02-05 18:29:34 +000083
84 def repr_array(self, x, level):
Tim Peters6ee04802003-02-05 18:29:34 +000085 header = "array('%s', [" % x.typecode
Raymond Hettingerba6cd362004-05-21 10:00:15 +000086 return self._repr_iterable(x, level, header, '])', self.maxarray)
87
88 def repr_set(self, x, level):
Thomas Wouters1b7f8912007-09-19 03:06:30 +000089 x = _possibly_sorted(x)
Raymond Hettingerba6cd362004-05-21 10:00:15 +000090 return self._repr_iterable(x, level, 'set([', '])', self.maxset)
91
92 def repr_frozenset(self, x, level):
Thomas Wouters1b7f8912007-09-19 03:06:30 +000093 x = _possibly_sorted(x)
Raymond Hettingerba6cd362004-05-21 10:00:15 +000094 return self._repr_iterable(x, level, 'frozenset([', '])',
95 self.maxfrozenset)
Tim Peters6ee04802003-02-05 18:29:34 +000096
Raymond Hettinger1453e4a2004-05-21 23:01:18 +000097 def repr_deque(self, x, level):
98 return self._repr_iterable(x, level, 'deque([', '])', self.maxdeque)
99
Tim Petersa427a2b2001-10-29 22:25:45 +0000100 def repr_dict(self, x, level):
Tim Peters0c9886d2001-01-15 01:18:21 +0000101 n = len(x)
102 if n == 0: return '{}'
103 if level <= 0: return '{...}'
Raymond Hettingerba6cd362004-05-21 10:00:15 +0000104 newlevel = level - 1
105 repr1 = self.repr1
106 pieces = []
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000107 for key in islice(_possibly_sorted(x), self.maxdict):
Raymond Hettingerba6cd362004-05-21 10:00:15 +0000108 keyrepr = repr1(key, newlevel)
109 valrepr = repr1(x[key], newlevel)
110 pieces.append('%s: %s' % (keyrepr, valrepr))
111 if n > self.maxdict: pieces.append('...')
112 s = ', '.join(pieces)
113 return '{%s}' % (s,)
114
Tim Peters6d6c1a32001-08-02 04:15:00 +0000115 def repr_str(self, x, level):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000116 s = builtins.repr(x[:self.maxstring])
Tim Peters0c9886d2001-01-15 01:18:21 +0000117 if len(s) > self.maxstring:
Guido van Rossum54e54c62001-09-04 19:14:14 +0000118 i = max(0, (self.maxstring-3)//2)
Tim Peters0c9886d2001-01-15 01:18:21 +0000119 j = max(0, self.maxstring-3-i)
Georg Brandl1a3284e2007-12-02 09:40:06 +0000120 s = builtins.repr(x[:i] + x[len(x)-j:])
Tim Peters0c9886d2001-01-15 01:18:21 +0000121 s = s[:i] + '...' + s[len(s)-j:]
122 return s
Raymond Hettingerba6cd362004-05-21 10:00:15 +0000123
Guido van Rossum4c9695a2007-01-15 00:14:39 +0000124 def repr_int(self, x, level):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000125 s = builtins.repr(x) # XXX Hope this isn't too slow...
Tim Peters0c9886d2001-01-15 01:18:21 +0000126 if len(s) > self.maxlong:
Guido van Rossum54e54c62001-09-04 19:14:14 +0000127 i = max(0, (self.maxlong-3)//2)
Tim Peters0c9886d2001-01-15 01:18:21 +0000128 j = max(0, self.maxlong-3-i)
129 s = s[:i] + '...' + s[len(s)-j:]
130 return s
Raymond Hettingerba6cd362004-05-21 10:00:15 +0000131
Tim Peters0c9886d2001-01-15 01:18:21 +0000132 def repr_instance(self, x, level):
133 try:
Georg Brandl1a3284e2007-12-02 09:40:06 +0000134 s = builtins.repr(x)
Tim Peters0c9886d2001-01-15 01:18:21 +0000135 # Bugs in x.__repr__() can cause arbitrary
136 # exceptions -- then make up something
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000137 except Exception:
Fred Drake83a64302004-07-01 20:28:47 +0000138 return '<%s instance at %x>' % (x.__class__.__name__, id(x))
Guido van Rossuma48a3b42006-04-20 16:07:39 +0000139 if len(s) > self.maxother:
140 i = max(0, (self.maxother-3)//2)
141 j = max(0, self.maxother-3-i)
Tim Peters0c9886d2001-01-15 01:18:21 +0000142 s = s[:i] + '...' + s[len(s)-j:]
143 return s
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000144
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000145
146def _possibly_sorted(x):
147 # Since not all sequences of items can be sorted and comparison
148 # functions may raise arbitrary exceptions, return an unsorted
149 # sequence in that case.
150 try:
151 return sorted(x)
152 except Exception:
153 return list(x)
154
Guido van Rossum7bc817d1993-12-17 15:25:27 +0000155aRepr = Repr()
Guido van Rossumbabe2bf1992-01-22 22:21:31 +0000156repr = aRepr.repr