##// END OF EJS Templates
fixed failing test
Randolf Scholz -
Show More
@@ -1,945 +1,954 b''
1 """
1 """
2 Python advanced pretty printer. This pretty printer is intended to
2 Python advanced pretty printer. This pretty printer is intended to
3 replace the old `pprint` python module which does not allow developers
3 replace the old `pprint` python module which does not allow developers
4 to provide their own pretty print callbacks.
4 to provide their own pretty print callbacks.
5
5
6 This module is based on ruby's `prettyprint.rb` library by `Tanaka Akira`.
6 This module is based on ruby's `prettyprint.rb` library by `Tanaka Akira`.
7
7
8
8
9 Example Usage
9 Example Usage
10 -------------
10 -------------
11
11
12 To directly print the representation of an object use `pprint`::
12 To directly print the representation of an object use `pprint`::
13
13
14 from pretty import pprint
14 from pretty import pprint
15 pprint(complex_object)
15 pprint(complex_object)
16
16
17 To get a string of the output use `pretty`::
17 To get a string of the output use `pretty`::
18
18
19 from pretty import pretty
19 from pretty import pretty
20 string = pretty(complex_object)
20 string = pretty(complex_object)
21
21
22
22
23 Extending
23 Extending
24 ---------
24 ---------
25
25
26 The pretty library allows developers to add pretty printing rules for their
26 The pretty library allows developers to add pretty printing rules for their
27 own objects. This process is straightforward. All you have to do is to
27 own objects. This process is straightforward. All you have to do is to
28 add a `_repr_pretty_` method to your object and call the methods on the
28 add a `_repr_pretty_` method to your object and call the methods on the
29 pretty printer passed::
29 pretty printer passed::
30
30
31 class MyObject(object):
31 class MyObject(object):
32
32
33 def _repr_pretty_(self, p, cycle):
33 def _repr_pretty_(self, p, cycle):
34 ...
34 ...
35
35
36 Here's an example for a class with a simple constructor::
36 Here's an example for a class with a simple constructor::
37
37
38 class MySimpleObject:
38 class MySimpleObject:
39
39
40 def __init__(self, a, b, *, c=None):
40 def __init__(self, a, b, *, c=None):
41 self.a = a
41 self.a = a
42 self.b = b
42 self.b = b
43 self.c = c
43 self.c = c
44
44
45 def _repr_pretty_(self, p, cycle):
45 def _repr_pretty_(self, p, cycle):
46 ctor = CallExpression.factory(self.__class__.__name__)
46 ctor = CallExpression.factory(self.__class__.__name__)
47 if self.c is None:
47 if self.c is None:
48 p.pretty(ctor(a, b))
48 p.pretty(ctor(a, b))
49 else:
49 else:
50 p.pretty(ctor(a, b, c=c))
50 p.pretty(ctor(a, b, c=c))
51
51
52 Here is an example implementation of a `_repr_pretty_` method for a list
52 Here is an example implementation of a `_repr_pretty_` method for a list
53 subclass::
53 subclass::
54
54
55 class MyList(list):
55 class MyList(list):
56
56
57 def _repr_pretty_(self, p, cycle):
57 def _repr_pretty_(self, p, cycle):
58 if cycle:
58 if cycle:
59 p.text('MyList(...)')
59 p.text('MyList(...)')
60 else:
60 else:
61 with p.group(8, 'MyList([', '])'):
61 with p.group(8, 'MyList([', '])'):
62 for idx, item in enumerate(self):
62 for idx, item in enumerate(self):
63 if idx:
63 if idx:
64 p.text(',')
64 p.text(',')
65 p.breakable()
65 p.breakable()
66 p.pretty(item)
66 p.pretty(item)
67
67
68 The `cycle` parameter is `True` if pretty detected a cycle. You *have* to
68 The `cycle` parameter is `True` if pretty detected a cycle. You *have* to
69 react to that or the result is an infinite loop. `p.text()` just adds
69 react to that or the result is an infinite loop. `p.text()` just adds
70 non breaking text to the output, `p.breakable()` either adds a whitespace
70 non breaking text to the output, `p.breakable()` either adds a whitespace
71 or breaks here. If you pass it an argument it's used instead of the
71 or breaks here. If you pass it an argument it's used instead of the
72 default space. `p.pretty` prettyprints another object using the pretty print
72 default space. `p.pretty` prettyprints another object using the pretty print
73 method.
73 method.
74
74
75 The first parameter to the `group` function specifies the extra indentation
75 The first parameter to the `group` function specifies the extra indentation
76 of the next line. In this example the next item will either be on the same
76 of the next line. In this example the next item will either be on the same
77 line (if the items are short enough) or aligned with the right edge of the
77 line (if the items are short enough) or aligned with the right edge of the
78 opening bracket of `MyList`.
78 opening bracket of `MyList`.
79
79
80 If you just want to indent something you can use the group function
80 If you just want to indent something you can use the group function
81 without open / close parameters. You can also use this code::
81 without open / close parameters. You can also use this code::
82
82
83 with p.indent(2):
83 with p.indent(2):
84 ...
84 ...
85
85
86 Inheritance diagram:
86 Inheritance diagram:
87
87
88 .. inheritance-diagram:: IPython.lib.pretty
88 .. inheritance-diagram:: IPython.lib.pretty
89 :parts: 3
89 :parts: 3
90
90
91 :copyright: 2007 by Armin Ronacher.
91 :copyright: 2007 by Armin Ronacher.
92 Portions (c) 2009 by Robert Kern.
92 Portions (c) 2009 by Robert Kern.
93 :license: BSD License.
93 :license: BSD License.
94 """
94 """
95
95
96 from contextlib import contextmanager
96 from contextlib import contextmanager
97 import datetime
97 import datetime
98 import os
98 import os
99 import re
99 import re
100 import sys
100 import sys
101 import types
101 import types
102 from collections import deque
102 from collections import deque
103 from inspect import signature
103 from inspect import signature
104 from io import StringIO
104 from io import StringIO
105 from warnings import warn
105 from warnings import warn
106
106
107 from IPython.utils.decorators import undoc
107 from IPython.utils.decorators import undoc
108 from IPython.utils.py3compat import PYPY
108 from IPython.utils.py3compat import PYPY
109
109
110 from typing import Dict
110 from typing import Dict
111
111
112 __all__ = ['pretty', 'pprint', 'PrettyPrinter', 'RepresentationPrinter',
112 __all__ = ['pretty', 'pprint', 'PrettyPrinter', 'RepresentationPrinter',
113 'for_type', 'for_type_by_name', 'RawText', 'RawStringLiteral', 'CallExpression']
113 'for_type', 'for_type_by_name', 'RawText', 'RawStringLiteral', 'CallExpression']
114
114
115
115
116 MAX_SEQ_LENGTH = 1000
116 MAX_SEQ_LENGTH = 1000
117 _re_pattern_type = type(re.compile(''))
117 _re_pattern_type = type(re.compile(''))
118
118
119 def _safe_getattr(obj, attr, default=None):
119 def _safe_getattr(obj, attr, default=None):
120 """Safe version of getattr.
120 """Safe version of getattr.
121
121
122 Same as getattr, but will return ``default`` on any Exception,
122 Same as getattr, but will return ``default`` on any Exception,
123 rather than raising.
123 rather than raising.
124 """
124 """
125 try:
125 try:
126 return getattr(obj, attr, default)
126 return getattr(obj, attr, default)
127 except Exception:
127 except Exception:
128 return default
128 return default
129
129
130 @undoc
130 @undoc
131 class CUnicodeIO(StringIO):
131 class CUnicodeIO(StringIO):
132 def __init__(self, *args, **kwargs):
132 def __init__(self, *args, **kwargs):
133 super().__init__(*args, **kwargs)
133 super().__init__(*args, **kwargs)
134 warn(("CUnicodeIO is deprecated since IPython 6.0. "
134 warn(("CUnicodeIO is deprecated since IPython 6.0. "
135 "Please use io.StringIO instead."),
135 "Please use io.StringIO instead."),
136 DeprecationWarning, stacklevel=2)
136 DeprecationWarning, stacklevel=2)
137
137
138 def _sorted_for_pprint(items):
138 def _sorted_for_pprint(items):
139 """
139 """
140 Sort the given items for pretty printing. Since some predictable
140 Sort the given items for pretty printing. Since some predictable
141 sorting is better than no sorting at all, we sort on the string
141 sorting is better than no sorting at all, we sort on the string
142 representation if normal sorting fails.
142 representation if normal sorting fails.
143 """
143 """
144 items = list(items)
144 items = list(items)
145 try:
145 try:
146 return sorted(items)
146 return sorted(items)
147 except Exception:
147 except Exception:
148 try:
148 try:
149 return sorted(items, key=str)
149 return sorted(items, key=str)
150 except Exception:
150 except Exception:
151 return items
151 return items
152
152
153 def pretty(obj, verbose=False, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
153 def pretty(obj, verbose=False, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
154 """
154 """
155 Pretty print the object's representation.
155 Pretty print the object's representation.
156 """
156 """
157 stream = StringIO()
157 stream = StringIO()
158 printer = RepresentationPrinter(stream, verbose, max_width, newline, max_seq_length=max_seq_length)
158 printer = RepresentationPrinter(stream, verbose, max_width, newline, max_seq_length=max_seq_length)
159 printer.pretty(obj)
159 printer.pretty(obj)
160 printer.flush()
160 printer.flush()
161 return stream.getvalue()
161 return stream.getvalue()
162
162
163
163
164 def pprint(obj, verbose=False, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
164 def pprint(obj, verbose=False, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
165 """
165 """
166 Like `pretty` but print to stdout.
166 Like `pretty` but print to stdout.
167 """
167 """
168 printer = RepresentationPrinter(sys.stdout, verbose, max_width, newline, max_seq_length=max_seq_length)
168 printer = RepresentationPrinter(sys.stdout, verbose, max_width, newline, max_seq_length=max_seq_length)
169 printer.pretty(obj)
169 printer.pretty(obj)
170 printer.flush()
170 printer.flush()
171 sys.stdout.write(newline)
171 sys.stdout.write(newline)
172 sys.stdout.flush()
172 sys.stdout.flush()
173
173
174 class _PrettyPrinterBase(object):
174 class _PrettyPrinterBase(object):
175
175
176 @contextmanager
176 @contextmanager
177 def indent(self, indent):
177 def indent(self, indent):
178 """with statement support for indenting/dedenting."""
178 """with statement support for indenting/dedenting."""
179 self.indentation += indent
179 self.indentation += indent
180 try:
180 try:
181 yield
181 yield
182 finally:
182 finally:
183 self.indentation -= indent
183 self.indentation -= indent
184
184
185 @contextmanager
185 @contextmanager
186 def group(self, indent=0, open='', close=''):
186 def group(self, indent=0, open='', close=''):
187 """like begin_group / end_group but for the with statement."""
187 """like begin_group / end_group but for the with statement."""
188 self.begin_group(indent, open)
188 self.begin_group(indent, open)
189 try:
189 try:
190 yield
190 yield
191 finally:
191 finally:
192 self.end_group(indent, close)
192 self.end_group(indent, close)
193
193
194 class PrettyPrinter(_PrettyPrinterBase):
194 class PrettyPrinter(_PrettyPrinterBase):
195 """
195 """
196 Baseclass for the `RepresentationPrinter` prettyprinter that is used to
196 Baseclass for the `RepresentationPrinter` prettyprinter that is used to
197 generate pretty reprs of objects. Contrary to the `RepresentationPrinter`
197 generate pretty reprs of objects. Contrary to the `RepresentationPrinter`
198 this printer knows nothing about the default pprinters or the `_repr_pretty_`
198 this printer knows nothing about the default pprinters or the `_repr_pretty_`
199 callback method.
199 callback method.
200 """
200 """
201
201
202 def __init__(self, output, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
202 def __init__(self, output, max_width=79, newline='\n', max_seq_length=MAX_SEQ_LENGTH):
203 self.output = output
203 self.output = output
204 self.max_width = max_width
204 self.max_width = max_width
205 self.newline = newline
205 self.newline = newline
206 self.max_seq_length = max_seq_length
206 self.max_seq_length = max_seq_length
207 self.output_width = 0
207 self.output_width = 0
208 self.buffer_width = 0
208 self.buffer_width = 0
209 self.buffer = deque()
209 self.buffer = deque()
210
210
211 root_group = Group(0)
211 root_group = Group(0)
212 self.group_stack = [root_group]
212 self.group_stack = [root_group]
213 self.group_queue = GroupQueue(root_group)
213 self.group_queue = GroupQueue(root_group)
214 self.indentation = 0
214 self.indentation = 0
215
215
216 def _break_one_group(self, group):
216 def _break_one_group(self, group):
217 while group.breakables:
217 while group.breakables:
218 x = self.buffer.popleft()
218 x = self.buffer.popleft()
219 self.output_width = x.output(self.output, self.output_width)
219 self.output_width = x.output(self.output, self.output_width)
220 self.buffer_width -= x.width
220 self.buffer_width -= x.width
221 while self.buffer and isinstance(self.buffer[0], Text):
221 while self.buffer and isinstance(self.buffer[0], Text):
222 x = self.buffer.popleft()
222 x = self.buffer.popleft()
223 self.output_width = x.output(self.output, self.output_width)
223 self.output_width = x.output(self.output, self.output_width)
224 self.buffer_width -= x.width
224 self.buffer_width -= x.width
225
225
226 def _break_outer_groups(self):
226 def _break_outer_groups(self):
227 while self.max_width < self.output_width + self.buffer_width:
227 while self.max_width < self.output_width + self.buffer_width:
228 group = self.group_queue.deq()
228 group = self.group_queue.deq()
229 if not group:
229 if not group:
230 return
230 return
231 self._break_one_group(group)
231 self._break_one_group(group)
232
232
233 def text(self, obj):
233 def text(self, obj):
234 """Add literal text to the output."""
234 """Add literal text to the output."""
235 width = len(obj)
235 width = len(obj)
236 if self.buffer:
236 if self.buffer:
237 text = self.buffer[-1]
237 text = self.buffer[-1]
238 if not isinstance(text, Text):
238 if not isinstance(text, Text):
239 text = Text()
239 text = Text()
240 self.buffer.append(text)
240 self.buffer.append(text)
241 text.add(obj, width)
241 text.add(obj, width)
242 self.buffer_width += width
242 self.buffer_width += width
243 self._break_outer_groups()
243 self._break_outer_groups()
244 else:
244 else:
245 self.output.write(obj)
245 self.output.write(obj)
246 self.output_width += width
246 self.output_width += width
247
247
248 def breakable(self, sep=' '):
248 def breakable(self, sep=' '):
249 """
249 """
250 Add a breakable separator to the output. This does not mean that it
250 Add a breakable separator to the output. This does not mean that it
251 will automatically break here. If no breaking on this position takes
251 will automatically break here. If no breaking on this position takes
252 place the `sep` is inserted which default to one space.
252 place the `sep` is inserted which default to one space.
253 """
253 """
254 width = len(sep)
254 width = len(sep)
255 group = self.group_stack[-1]
255 group = self.group_stack[-1]
256 if group.want_break:
256 if group.want_break:
257 self.flush()
257 self.flush()
258 self.output.write(self.newline)
258 self.output.write(self.newline)
259 self.output.write(' ' * self.indentation)
259 self.output.write(' ' * self.indentation)
260 self.output_width = self.indentation
260 self.output_width = self.indentation
261 self.buffer_width = 0
261 self.buffer_width = 0
262 else:
262 else:
263 self.buffer.append(Breakable(sep, width, self))
263 self.buffer.append(Breakable(sep, width, self))
264 self.buffer_width += width
264 self.buffer_width += width
265 self._break_outer_groups()
265 self._break_outer_groups()
266
266
267 def break_(self):
267 def break_(self):
268 """
268 """
269 Explicitly insert a newline into the output, maintaining correct indentation.
269 Explicitly insert a newline into the output, maintaining correct indentation.
270 """
270 """
271 group = self.group_queue.deq()
271 group = self.group_queue.deq()
272 if group:
272 if group:
273 self._break_one_group(group)
273 self._break_one_group(group)
274 self.flush()
274 self.flush()
275 self.output.write(self.newline)
275 self.output.write(self.newline)
276 self.output.write(' ' * self.indentation)
276 self.output.write(' ' * self.indentation)
277 self.output_width = self.indentation
277 self.output_width = self.indentation
278 self.buffer_width = 0
278 self.buffer_width = 0
279
279
280
280
281 def begin_group(self, indent=0, open=''):
281 def begin_group(self, indent=0, open=''):
282 """
282 """
283 Begin a group.
283 Begin a group.
284 The first parameter specifies the indentation for the next line (usually
284 The first parameter specifies the indentation for the next line (usually
285 the width of the opening text), the second the opening text. All
285 the width of the opening text), the second the opening text. All
286 parameters are optional.
286 parameters are optional.
287 """
287 """
288 if open:
288 if open:
289 self.text(open)
289 self.text(open)
290 group = Group(self.group_stack[-1].depth + 1)
290 group = Group(self.group_stack[-1].depth + 1)
291 self.group_stack.append(group)
291 self.group_stack.append(group)
292 self.group_queue.enq(group)
292 self.group_queue.enq(group)
293 self.indentation += indent
293 self.indentation += indent
294
294
295 def _enumerate(self, seq):
295 def _enumerate(self, seq):
296 """like enumerate, but with an upper limit on the number of items"""
296 """like enumerate, but with an upper limit on the number of items"""
297 for idx, x in enumerate(seq):
297 for idx, x in enumerate(seq):
298 if self.max_seq_length and idx >= self.max_seq_length:
298 if self.max_seq_length and idx >= self.max_seq_length:
299 self.text(',')
299 self.text(',')
300 self.breakable()
300 self.breakable()
301 self.text('...')
301 self.text('...')
302 return
302 return
303 yield idx, x
303 yield idx, x
304
304
305 def end_group(self, dedent=0, close=''):
305 def end_group(self, dedent=0, close=''):
306 """End a group. See `begin_group` for more details."""
306 """End a group. See `begin_group` for more details."""
307 self.indentation -= dedent
307 self.indentation -= dedent
308 group = self.group_stack.pop()
308 group = self.group_stack.pop()
309 if not group.breakables:
309 if not group.breakables:
310 self.group_queue.remove(group)
310 self.group_queue.remove(group)
311 if close:
311 if close:
312 self.text(close)
312 self.text(close)
313
313
314 def flush(self):
314 def flush(self):
315 """Flush data that is left in the buffer."""
315 """Flush data that is left in the buffer."""
316 for data in self.buffer:
316 for data in self.buffer:
317 self.output_width += data.output(self.output, self.output_width)
317 self.output_width += data.output(self.output, self.output_width)
318 self.buffer.clear()
318 self.buffer.clear()
319 self.buffer_width = 0
319 self.buffer_width = 0
320
320
321
321
322 def _get_mro(obj_class):
322 def _get_mro(obj_class):
323 """ Get a reasonable method resolution order of a class and its superclasses
323 """ Get a reasonable method resolution order of a class and its superclasses
324 for both old-style and new-style classes.
324 for both old-style and new-style classes.
325 """
325 """
326 if not hasattr(obj_class, '__mro__'):
326 if not hasattr(obj_class, '__mro__'):
327 # Old-style class. Mix in object to make a fake new-style class.
327 # Old-style class. Mix in object to make a fake new-style class.
328 try:
328 try:
329 obj_class = type(obj_class.__name__, (obj_class, object), {})
329 obj_class = type(obj_class.__name__, (obj_class, object), {})
330 except TypeError:
330 except TypeError:
331 # Old-style extension type that does not descend from object.
331 # Old-style extension type that does not descend from object.
332 # FIXME: try to construct a more thorough MRO.
332 # FIXME: try to construct a more thorough MRO.
333 mro = [obj_class]
333 mro = [obj_class]
334 else:
334 else:
335 mro = obj_class.__mro__[1:-1]
335 mro = obj_class.__mro__[1:-1]
336 else:
336 else:
337 mro = obj_class.__mro__
337 mro = obj_class.__mro__
338 return mro
338 return mro
339
339
340
340
341 class RepresentationPrinter(PrettyPrinter):
341 class RepresentationPrinter(PrettyPrinter):
342 """
342 """
343 Special pretty printer that has a `pretty` method that calls the pretty
343 Special pretty printer that has a `pretty` method that calls the pretty
344 printer for a python object.
344 printer for a python object.
345
345
346 This class stores processing data on `self` so you must *never* use
346 This class stores processing data on `self` so you must *never* use
347 this class in a threaded environment. Always lock it or reinstanciate
347 this class in a threaded environment. Always lock it or reinstanciate
348 it.
348 it.
349
349
350 Instances also have a verbose flag callbacks can access to control their
350 Instances also have a verbose flag callbacks can access to control their
351 output. For example the default instance repr prints all attributes and
351 output. For example the default instance repr prints all attributes and
352 methods that are not prefixed by an underscore if the printer is in
352 methods that are not prefixed by an underscore if the printer is in
353 verbose mode.
353 verbose mode.
354 """
354 """
355
355
356 def __init__(self, output, verbose=False, max_width=79, newline='\n',
356 def __init__(self, output, verbose=False, max_width=79, newline='\n',
357 singleton_pprinters=None, type_pprinters=None, deferred_pprinters=None,
357 singleton_pprinters=None, type_pprinters=None, deferred_pprinters=None,
358 max_seq_length=MAX_SEQ_LENGTH):
358 max_seq_length=MAX_SEQ_LENGTH):
359
359
360 PrettyPrinter.__init__(self, output, max_width, newline, max_seq_length=max_seq_length)
360 PrettyPrinter.__init__(self, output, max_width, newline, max_seq_length=max_seq_length)
361 self.verbose = verbose
361 self.verbose = verbose
362 self.stack = []
362 self.stack = []
363 if singleton_pprinters is None:
363 if singleton_pprinters is None:
364 singleton_pprinters = _singleton_pprinters.copy()
364 singleton_pprinters = _singleton_pprinters.copy()
365 self.singleton_pprinters = singleton_pprinters
365 self.singleton_pprinters = singleton_pprinters
366 if type_pprinters is None:
366 if type_pprinters is None:
367 type_pprinters = _type_pprinters.copy()
367 type_pprinters = _type_pprinters.copy()
368 self.type_pprinters = type_pprinters
368 self.type_pprinters = type_pprinters
369 if deferred_pprinters is None:
369 if deferred_pprinters is None:
370 deferred_pprinters = _deferred_type_pprinters.copy()
370 deferred_pprinters = _deferred_type_pprinters.copy()
371 self.deferred_pprinters = deferred_pprinters
371 self.deferred_pprinters = deferred_pprinters
372
372
373 def pretty(self, obj):
373 def pretty(self, obj):
374 """Pretty print the given object."""
374 """Pretty print the given object."""
375 obj_id = id(obj)
375 obj_id = id(obj)
376 cycle = obj_id in self.stack
376 cycle = obj_id in self.stack
377 self.stack.append(obj_id)
377 self.stack.append(obj_id)
378 self.begin_group()
378 self.begin_group()
379 try:
379 try:
380 obj_class = _safe_getattr(obj, '__class__', None) or type(obj)
380 obj_class = _safe_getattr(obj, '__class__', None) or type(obj)
381 # First try to find registered singleton printers for the type.
381 # First try to find registered singleton printers for the type.
382 try:
382 try:
383 printer = self.singleton_pprinters[obj_id]
383 printer = self.singleton_pprinters[obj_id]
384 except (TypeError, KeyError):
384 except (TypeError, KeyError):
385 pass
385 pass
386 else:
386 else:
387 return printer(obj, self, cycle)
387 return printer(obj, self, cycle)
388 # Next walk the mro and check for either:
388 # Next walk the mro and check for either:
389 # 1) a registered printer
389 # 1) a registered printer
390 # 2) a _repr_pretty_ method
390 # 2) a _repr_pretty_ method
391 for cls in _get_mro(obj_class):
391 for cls in _get_mro(obj_class):
392 if cls in self.type_pprinters:
392 if cls in self.type_pprinters:
393 # printer registered in self.type_pprinters
393 # printer registered in self.type_pprinters
394 return self.type_pprinters[cls](obj, self, cycle)
394 return self.type_pprinters[cls](obj, self, cycle)
395 else:
395 else:
396 # deferred printer
396 # deferred printer
397 printer = self._in_deferred_types(cls)
397 printer = self._in_deferred_types(cls)
398 if printer is not None:
398 if printer is not None:
399 return printer(obj, self, cycle)
399 return printer(obj, self, cycle)
400 else:
400 else:
401 # Finally look for special method names.
401 # Finally look for special method names.
402 # Some objects automatically create any requested
402 # Some objects automatically create any requested
403 # attribute. Try to ignore most of them by checking for
403 # attribute. Try to ignore most of them by checking for
404 # callability.
404 # callability.
405 if '_repr_pretty_' in cls.__dict__:
405 if '_repr_pretty_' in cls.__dict__:
406 meth = cls._repr_pretty_
406 meth = cls._repr_pretty_
407 if callable(meth):
407 if callable(meth):
408 return meth(obj, self, cycle)
408 return meth(obj, self, cycle)
409 if cls is not object and callable(getattr(cls, '__repr__', None)):
409 if (
410 cls is not object
411 # check if cls defines __repr__
412 and "__repr__" in cls.__dict__
413 # check if __repr__ is callable.
414 # Note: we need to test getattr(cls, '__repr__')
415 # instead of cls.__dict__['__repr__']
416 # in order to work with descriptors like partialmethod,
417 and callable(getattr(cls, '__repr__', None))
418 ):
410 return _repr_pprint(obj, self, cycle)
419 return _repr_pprint(obj, self, cycle)
411
420
412 return _default_pprint(obj, self, cycle)
421 return _default_pprint(obj, self, cycle)
413 finally:
422 finally:
414 self.end_group()
423 self.end_group()
415 self.stack.pop()
424 self.stack.pop()
416
425
417 def _in_deferred_types(self, cls):
426 def _in_deferred_types(self, cls):
418 """
427 """
419 Check if the given class is specified in the deferred type registry.
428 Check if the given class is specified in the deferred type registry.
420
429
421 Returns the printer from the registry if it exists, and None if the
430 Returns the printer from the registry if it exists, and None if the
422 class is not in the registry. Successful matches will be moved to the
431 class is not in the registry. Successful matches will be moved to the
423 regular type registry for future use.
432 regular type registry for future use.
424 """
433 """
425 mod = _safe_getattr(cls, '__module__', None)
434 mod = _safe_getattr(cls, '__module__', None)
426 name = _safe_getattr(cls, '__name__', None)
435 name = _safe_getattr(cls, '__name__', None)
427 key = (mod, name)
436 key = (mod, name)
428 printer = None
437 printer = None
429 if key in self.deferred_pprinters:
438 if key in self.deferred_pprinters:
430 # Move the printer over to the regular registry.
439 # Move the printer over to the regular registry.
431 printer = self.deferred_pprinters.pop(key)
440 printer = self.deferred_pprinters.pop(key)
432 self.type_pprinters[cls] = printer
441 self.type_pprinters[cls] = printer
433 return printer
442 return printer
434
443
435
444
436 class Printable(object):
445 class Printable(object):
437
446
438 def output(self, stream, output_width):
447 def output(self, stream, output_width):
439 return output_width
448 return output_width
440
449
441
450
442 class Text(Printable):
451 class Text(Printable):
443
452
444 def __init__(self):
453 def __init__(self):
445 self.objs = []
454 self.objs = []
446 self.width = 0
455 self.width = 0
447
456
448 def output(self, stream, output_width):
457 def output(self, stream, output_width):
449 for obj in self.objs:
458 for obj in self.objs:
450 stream.write(obj)
459 stream.write(obj)
451 return output_width + self.width
460 return output_width + self.width
452
461
453 def add(self, obj, width):
462 def add(self, obj, width):
454 self.objs.append(obj)
463 self.objs.append(obj)
455 self.width += width
464 self.width += width
456
465
457
466
458 class Breakable(Printable):
467 class Breakable(Printable):
459
468
460 def __init__(self, seq, width, pretty):
469 def __init__(self, seq, width, pretty):
461 self.obj = seq
470 self.obj = seq
462 self.width = width
471 self.width = width
463 self.pretty = pretty
472 self.pretty = pretty
464 self.indentation = pretty.indentation
473 self.indentation = pretty.indentation
465 self.group = pretty.group_stack[-1]
474 self.group = pretty.group_stack[-1]
466 self.group.breakables.append(self)
475 self.group.breakables.append(self)
467
476
468 def output(self, stream, output_width):
477 def output(self, stream, output_width):
469 self.group.breakables.popleft()
478 self.group.breakables.popleft()
470 if self.group.want_break:
479 if self.group.want_break:
471 stream.write(self.pretty.newline)
480 stream.write(self.pretty.newline)
472 stream.write(' ' * self.indentation)
481 stream.write(' ' * self.indentation)
473 return self.indentation
482 return self.indentation
474 if not self.group.breakables:
483 if not self.group.breakables:
475 self.pretty.group_queue.remove(self.group)
484 self.pretty.group_queue.remove(self.group)
476 stream.write(self.obj)
485 stream.write(self.obj)
477 return output_width + self.width
486 return output_width + self.width
478
487
479
488
480 class Group(Printable):
489 class Group(Printable):
481
490
482 def __init__(self, depth):
491 def __init__(self, depth):
483 self.depth = depth
492 self.depth = depth
484 self.breakables = deque()
493 self.breakables = deque()
485 self.want_break = False
494 self.want_break = False
486
495
487
496
488 class GroupQueue(object):
497 class GroupQueue(object):
489
498
490 def __init__(self, *groups):
499 def __init__(self, *groups):
491 self.queue = []
500 self.queue = []
492 for group in groups:
501 for group in groups:
493 self.enq(group)
502 self.enq(group)
494
503
495 def enq(self, group):
504 def enq(self, group):
496 depth = group.depth
505 depth = group.depth
497 while depth > len(self.queue) - 1:
506 while depth > len(self.queue) - 1:
498 self.queue.append([])
507 self.queue.append([])
499 self.queue[depth].append(group)
508 self.queue[depth].append(group)
500
509
501 def deq(self):
510 def deq(self):
502 for stack in self.queue:
511 for stack in self.queue:
503 for idx, group in enumerate(reversed(stack)):
512 for idx, group in enumerate(reversed(stack)):
504 if group.breakables:
513 if group.breakables:
505 del stack[idx]
514 del stack[idx]
506 group.want_break = True
515 group.want_break = True
507 return group
516 return group
508 for group in stack:
517 for group in stack:
509 group.want_break = True
518 group.want_break = True
510 del stack[:]
519 del stack[:]
511
520
512 def remove(self, group):
521 def remove(self, group):
513 try:
522 try:
514 self.queue[group.depth].remove(group)
523 self.queue[group.depth].remove(group)
515 except ValueError:
524 except ValueError:
516 pass
525 pass
517
526
518
527
519 class RawText:
528 class RawText:
520 """ Object such that ``p.pretty(RawText(value))`` is the same as ``p.text(value)``.
529 """ Object such that ``p.pretty(RawText(value))`` is the same as ``p.text(value)``.
521
530
522 An example usage of this would be to show a list as binary numbers, using
531 An example usage of this would be to show a list as binary numbers, using
523 ``p.pretty([RawText(bin(i)) for i in integers])``.
532 ``p.pretty([RawText(bin(i)) for i in integers])``.
524 """
533 """
525 def __init__(self, value):
534 def __init__(self, value):
526 self.value = value
535 self.value = value
527
536
528 def _repr_pretty_(self, p, cycle):
537 def _repr_pretty_(self, p, cycle):
529 p.text(self.value)
538 p.text(self.value)
530
539
531
540
532 class CallExpression:
541 class CallExpression:
533 """ Object which emits a line-wrapped call expression in the form `__name(*args, **kwargs)` """
542 """ Object which emits a line-wrapped call expression in the form `__name(*args, **kwargs)` """
534 def __init__(__self, __name, *args, **kwargs):
543 def __init__(__self, __name, *args, **kwargs):
535 # dunders are to avoid clashes with kwargs, as python's name manging
544 # dunders are to avoid clashes with kwargs, as python's name manging
536 # will kick in.
545 # will kick in.
537 self = __self
546 self = __self
538 self.name = __name
547 self.name = __name
539 self.args = args
548 self.args = args
540 self.kwargs = kwargs
549 self.kwargs = kwargs
541
550
542 @classmethod
551 @classmethod
543 def factory(cls, name):
552 def factory(cls, name):
544 def inner(*args, **kwargs):
553 def inner(*args, **kwargs):
545 return cls(name, *args, **kwargs)
554 return cls(name, *args, **kwargs)
546 return inner
555 return inner
547
556
548 def _repr_pretty_(self, p, cycle):
557 def _repr_pretty_(self, p, cycle):
549 # dunders are to avoid clashes with kwargs, as python's name manging
558 # dunders are to avoid clashes with kwargs, as python's name manging
550 # will kick in.
559 # will kick in.
551
560
552 started = False
561 started = False
553 def new_item():
562 def new_item():
554 nonlocal started
563 nonlocal started
555 if started:
564 if started:
556 p.text(",")
565 p.text(",")
557 p.breakable()
566 p.breakable()
558 started = True
567 started = True
559
568
560 prefix = self.name + "("
569 prefix = self.name + "("
561 with p.group(len(prefix), prefix, ")"):
570 with p.group(len(prefix), prefix, ")"):
562 for arg in self.args:
571 for arg in self.args:
563 new_item()
572 new_item()
564 p.pretty(arg)
573 p.pretty(arg)
565 for arg_name, arg in self.kwargs.items():
574 for arg_name, arg in self.kwargs.items():
566 new_item()
575 new_item()
567 arg_prefix = arg_name + "="
576 arg_prefix = arg_name + "="
568 with p.group(len(arg_prefix), arg_prefix):
577 with p.group(len(arg_prefix), arg_prefix):
569 p.pretty(arg)
578 p.pretty(arg)
570
579
571
580
572 class RawStringLiteral:
581 class RawStringLiteral:
573 """ Wrapper that shows a string with a `r` prefix """
582 """ Wrapper that shows a string with a `r` prefix """
574 def __init__(self, value):
583 def __init__(self, value):
575 self.value = value
584 self.value = value
576
585
577 def _repr_pretty_(self, p, cycle):
586 def _repr_pretty_(self, p, cycle):
578 base_repr = repr(self.value)
587 base_repr = repr(self.value)
579 if base_repr[:1] in 'uU':
588 if base_repr[:1] in 'uU':
580 base_repr = base_repr[1:]
589 base_repr = base_repr[1:]
581 prefix = 'ur'
590 prefix = 'ur'
582 else:
591 else:
583 prefix = 'r'
592 prefix = 'r'
584 base_repr = prefix + base_repr.replace('\\\\', '\\')
593 base_repr = prefix + base_repr.replace('\\\\', '\\')
585 p.text(base_repr)
594 p.text(base_repr)
586
595
587
596
588 def _default_pprint(obj, p, cycle):
597 def _default_pprint(obj, p, cycle):
589 """
598 """
590 The default print function. Used if an object does not provide one and
599 The default print function. Used if an object does not provide one and
591 it's none of the builtin objects.
600 it's none of the builtin objects.
592 """
601 """
593 klass = _safe_getattr(obj, '__class__', None) or type(obj)
602 klass = _safe_getattr(obj, '__class__', None) or type(obj)
594 if _safe_getattr(klass, '__repr__', None) is not object.__repr__:
603 if _safe_getattr(klass, '__repr__', None) is not object.__repr__:
595 # A user-provided repr. Find newlines and replace them with p.break_()
604 # A user-provided repr. Find newlines and replace them with p.break_()
596 _repr_pprint(obj, p, cycle)
605 _repr_pprint(obj, p, cycle)
597 return
606 return
598 p.begin_group(1, '<')
607 p.begin_group(1, '<')
599 p.pretty(klass)
608 p.pretty(klass)
600 p.text(' at 0x%x' % id(obj))
609 p.text(' at 0x%x' % id(obj))
601 if cycle:
610 if cycle:
602 p.text(' ...')
611 p.text(' ...')
603 elif p.verbose:
612 elif p.verbose:
604 first = True
613 first = True
605 for key in dir(obj):
614 for key in dir(obj):
606 if not key.startswith('_'):
615 if not key.startswith('_'):
607 try:
616 try:
608 value = getattr(obj, key)
617 value = getattr(obj, key)
609 except AttributeError:
618 except AttributeError:
610 continue
619 continue
611 if isinstance(value, types.MethodType):
620 if isinstance(value, types.MethodType):
612 continue
621 continue
613 if not first:
622 if not first:
614 p.text(',')
623 p.text(',')
615 p.breakable()
624 p.breakable()
616 p.text(key)
625 p.text(key)
617 p.text('=')
626 p.text('=')
618 step = len(key) + 1
627 step = len(key) + 1
619 p.indentation += step
628 p.indentation += step
620 p.pretty(value)
629 p.pretty(value)
621 p.indentation -= step
630 p.indentation -= step
622 first = False
631 first = False
623 p.end_group(1, '>')
632 p.end_group(1, '>')
624
633
625
634
626 def _seq_pprinter_factory(start, end):
635 def _seq_pprinter_factory(start, end):
627 """
636 """
628 Factory that returns a pprint function useful for sequences. Used by
637 Factory that returns a pprint function useful for sequences. Used by
629 the default pprint for tuples and lists.
638 the default pprint for tuples and lists.
630 """
639 """
631 def inner(obj, p, cycle):
640 def inner(obj, p, cycle):
632 if cycle:
641 if cycle:
633 return p.text(start + '...' + end)
642 return p.text(start + '...' + end)
634 step = len(start)
643 step = len(start)
635 p.begin_group(step, start)
644 p.begin_group(step, start)
636 for idx, x in p._enumerate(obj):
645 for idx, x in p._enumerate(obj):
637 if idx:
646 if idx:
638 p.text(',')
647 p.text(',')
639 p.breakable()
648 p.breakable()
640 p.pretty(x)
649 p.pretty(x)
641 if len(obj) == 1 and isinstance(obj, tuple):
650 if len(obj) == 1 and isinstance(obj, tuple):
642 # Special case for 1-item tuples.
651 # Special case for 1-item tuples.
643 p.text(',')
652 p.text(',')
644 p.end_group(step, end)
653 p.end_group(step, end)
645 return inner
654 return inner
646
655
647
656
648 def _set_pprinter_factory(start, end):
657 def _set_pprinter_factory(start, end):
649 """
658 """
650 Factory that returns a pprint function useful for sets and frozensets.
659 Factory that returns a pprint function useful for sets and frozensets.
651 """
660 """
652 def inner(obj, p, cycle):
661 def inner(obj, p, cycle):
653 if cycle:
662 if cycle:
654 return p.text(start + '...' + end)
663 return p.text(start + '...' + end)
655 if len(obj) == 0:
664 if len(obj) == 0:
656 # Special case.
665 # Special case.
657 p.text(type(obj).__name__ + '()')
666 p.text(type(obj).__name__ + '()')
658 else:
667 else:
659 step = len(start)
668 step = len(start)
660 p.begin_group(step, start)
669 p.begin_group(step, start)
661 # Like dictionary keys, we will try to sort the items if there aren't too many
670 # Like dictionary keys, we will try to sort the items if there aren't too many
662 if not (p.max_seq_length and len(obj) >= p.max_seq_length):
671 if not (p.max_seq_length and len(obj) >= p.max_seq_length):
663 items = _sorted_for_pprint(obj)
672 items = _sorted_for_pprint(obj)
664 else:
673 else:
665 items = obj
674 items = obj
666 for idx, x in p._enumerate(items):
675 for idx, x in p._enumerate(items):
667 if idx:
676 if idx:
668 p.text(',')
677 p.text(',')
669 p.breakable()
678 p.breakable()
670 p.pretty(x)
679 p.pretty(x)
671 p.end_group(step, end)
680 p.end_group(step, end)
672 return inner
681 return inner
673
682
674
683
675 def _dict_pprinter_factory(start, end):
684 def _dict_pprinter_factory(start, end):
676 """
685 """
677 Factory that returns a pprint function used by the default pprint of
686 Factory that returns a pprint function used by the default pprint of
678 dicts and dict proxies.
687 dicts and dict proxies.
679 """
688 """
680 def inner(obj, p, cycle):
689 def inner(obj, p, cycle):
681 if cycle:
690 if cycle:
682 return p.text('{...}')
691 return p.text('{...}')
683 step = len(start)
692 step = len(start)
684 p.begin_group(step, start)
693 p.begin_group(step, start)
685 keys = obj.keys()
694 keys = obj.keys()
686 for idx, key in p._enumerate(keys):
695 for idx, key in p._enumerate(keys):
687 if idx:
696 if idx:
688 p.text(',')
697 p.text(',')
689 p.breakable()
698 p.breakable()
690 p.pretty(key)
699 p.pretty(key)
691 p.text(': ')
700 p.text(': ')
692 p.pretty(obj[key])
701 p.pretty(obj[key])
693 p.end_group(step, end)
702 p.end_group(step, end)
694 return inner
703 return inner
695
704
696
705
697 def _super_pprint(obj, p, cycle):
706 def _super_pprint(obj, p, cycle):
698 """The pprint for the super type."""
707 """The pprint for the super type."""
699 p.begin_group(8, '<super: ')
708 p.begin_group(8, '<super: ')
700 p.pretty(obj.__thisclass__)
709 p.pretty(obj.__thisclass__)
701 p.text(',')
710 p.text(',')
702 p.breakable()
711 p.breakable()
703 if PYPY: # In PyPy, super() objects don't have __self__ attributes
712 if PYPY: # In PyPy, super() objects don't have __self__ attributes
704 dself = obj.__repr__.__self__
713 dself = obj.__repr__.__self__
705 p.pretty(None if dself is obj else dself)
714 p.pretty(None if dself is obj else dself)
706 else:
715 else:
707 p.pretty(obj.__self__)
716 p.pretty(obj.__self__)
708 p.end_group(8, '>')
717 p.end_group(8, '>')
709
718
710
719
711
720
712 class _ReFlags:
721 class _ReFlags:
713 def __init__(self, value):
722 def __init__(self, value):
714 self.value = value
723 self.value = value
715
724
716 def _repr_pretty_(self, p, cycle):
725 def _repr_pretty_(self, p, cycle):
717 done_one = False
726 done_one = False
718 for flag in ('TEMPLATE', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL',
727 for flag in ('TEMPLATE', 'IGNORECASE', 'LOCALE', 'MULTILINE', 'DOTALL',
719 'UNICODE', 'VERBOSE', 'DEBUG'):
728 'UNICODE', 'VERBOSE', 'DEBUG'):
720 if self.value & getattr(re, flag):
729 if self.value & getattr(re, flag):
721 if done_one:
730 if done_one:
722 p.text('|')
731 p.text('|')
723 p.text('re.' + flag)
732 p.text('re.' + flag)
724 done_one = True
733 done_one = True
725
734
726
735
727 def _re_pattern_pprint(obj, p, cycle):
736 def _re_pattern_pprint(obj, p, cycle):
728 """The pprint function for regular expression patterns."""
737 """The pprint function for regular expression patterns."""
729 re_compile = CallExpression.factory('re.compile')
738 re_compile = CallExpression.factory('re.compile')
730 if obj.flags:
739 if obj.flags:
731 p.pretty(re_compile(RawStringLiteral(obj.pattern), _ReFlags(obj.flags)))
740 p.pretty(re_compile(RawStringLiteral(obj.pattern), _ReFlags(obj.flags)))
732 else:
741 else:
733 p.pretty(re_compile(RawStringLiteral(obj.pattern)))
742 p.pretty(re_compile(RawStringLiteral(obj.pattern)))
734
743
735
744
736 def _types_simplenamespace_pprint(obj, p, cycle):
745 def _types_simplenamespace_pprint(obj, p, cycle):
737 """The pprint function for types.SimpleNamespace."""
746 """The pprint function for types.SimpleNamespace."""
738 namespace = CallExpression.factory('namespace')
747 namespace = CallExpression.factory('namespace')
739 if cycle:
748 if cycle:
740 p.pretty(namespace(RawText("...")))
749 p.pretty(namespace(RawText("...")))
741 else:
750 else:
742 p.pretty(namespace(**obj.__dict__))
751 p.pretty(namespace(**obj.__dict__))
743
752
744
753
745 def _type_pprint(obj, p, cycle):
754 def _type_pprint(obj, p, cycle):
746 """The pprint for classes and types."""
755 """The pprint for classes and types."""
747 # Heap allocated types might not have the module attribute,
756 # Heap allocated types might not have the module attribute,
748 # and others may set it to None.
757 # and others may set it to None.
749
758
750 # Checks for a __repr__ override in the metaclass. Can't compare the
759 # Checks for a __repr__ override in the metaclass. Can't compare the
751 # type(obj).__repr__ directly because in PyPy the representation function
760 # type(obj).__repr__ directly because in PyPy the representation function
752 # inherited from type isn't the same type.__repr__
761 # inherited from type isn't the same type.__repr__
753 if [m for m in _get_mro(type(obj)) if "__repr__" in vars(m)][:1] != [type]:
762 if [m for m in _get_mro(type(obj)) if "__repr__" in vars(m)][:1] != [type]:
754 _repr_pprint(obj, p, cycle)
763 _repr_pprint(obj, p, cycle)
755 return
764 return
756
765
757 mod = _safe_getattr(obj, '__module__', None)
766 mod = _safe_getattr(obj, '__module__', None)
758 try:
767 try:
759 name = obj.__qualname__
768 name = obj.__qualname__
760 if not isinstance(name, str):
769 if not isinstance(name, str):
761 # This can happen if the type implements __qualname__ as a property
770 # This can happen if the type implements __qualname__ as a property
762 # or other descriptor in Python 2.
771 # or other descriptor in Python 2.
763 raise Exception("Try __name__")
772 raise Exception("Try __name__")
764 except Exception:
773 except Exception:
765 name = obj.__name__
774 name = obj.__name__
766 if not isinstance(name, str):
775 if not isinstance(name, str):
767 name = '<unknown type>'
776 name = '<unknown type>'
768
777
769 if mod in (None, '__builtin__', 'builtins', 'exceptions'):
778 if mod in (None, '__builtin__', 'builtins', 'exceptions'):
770 p.text(name)
779 p.text(name)
771 else:
780 else:
772 p.text(mod + '.' + name)
781 p.text(mod + '.' + name)
773
782
774
783
775 def _repr_pprint(obj, p, cycle):
784 def _repr_pprint(obj, p, cycle):
776 """A pprint that just redirects to the normal repr function."""
785 """A pprint that just redirects to the normal repr function."""
777 # Find newlines and replace them with p.break_()
786 # Find newlines and replace them with p.break_()
778 output = repr(obj)
787 output = repr(obj)
779 lines = output.splitlines()
788 lines = output.splitlines()
780 with p.group():
789 with p.group():
781 for idx, output_line in enumerate(lines):
790 for idx, output_line in enumerate(lines):
782 if idx:
791 if idx:
783 p.break_()
792 p.break_()
784 p.text(output_line)
793 p.text(output_line)
785
794
786
795
787 def _function_pprint(obj, p, cycle):
796 def _function_pprint(obj, p, cycle):
788 """Base pprint for all functions and builtin functions."""
797 """Base pprint for all functions and builtin functions."""
789 name = _safe_getattr(obj, '__qualname__', obj.__name__)
798 name = _safe_getattr(obj, '__qualname__', obj.__name__)
790 mod = obj.__module__
799 mod = obj.__module__
791 if mod and mod not in ('__builtin__', 'builtins', 'exceptions'):
800 if mod and mod not in ('__builtin__', 'builtins', 'exceptions'):
792 name = mod + '.' + name
801 name = mod + '.' + name
793 try:
802 try:
794 func_def = name + str(signature(obj))
803 func_def = name + str(signature(obj))
795 except ValueError:
804 except ValueError:
796 func_def = name
805 func_def = name
797 p.text('<function %s>' % func_def)
806 p.text('<function %s>' % func_def)
798
807
799
808
800 def _exception_pprint(obj, p, cycle):
809 def _exception_pprint(obj, p, cycle):
801 """Base pprint for all exceptions."""
810 """Base pprint for all exceptions."""
802 name = getattr(obj.__class__, '__qualname__', obj.__class__.__name__)
811 name = getattr(obj.__class__, '__qualname__', obj.__class__.__name__)
803 if obj.__class__.__module__ not in ('exceptions', 'builtins'):
812 if obj.__class__.__module__ not in ('exceptions', 'builtins'):
804 name = '%s.%s' % (obj.__class__.__module__, name)
813 name = '%s.%s' % (obj.__class__.__module__, name)
805
814
806 p.pretty(CallExpression(name, *getattr(obj, 'args', ())))
815 p.pretty(CallExpression(name, *getattr(obj, 'args', ())))
807
816
808
817
809 #: the exception base
818 #: the exception base
810 _exception_base: type
819 _exception_base: type
811 try:
820 try:
812 _exception_base = BaseException
821 _exception_base = BaseException
813 except NameError:
822 except NameError:
814 _exception_base = Exception
823 _exception_base = Exception
815
824
816
825
817 #: printers for builtin types
826 #: printers for builtin types
818 _type_pprinters = {
827 _type_pprinters = {
819 int: _repr_pprint,
828 int: _repr_pprint,
820 float: _repr_pprint,
829 float: _repr_pprint,
821 str: _repr_pprint,
830 str: _repr_pprint,
822 tuple: _seq_pprinter_factory('(', ')'),
831 tuple: _seq_pprinter_factory('(', ')'),
823 list: _seq_pprinter_factory('[', ']'),
832 list: _seq_pprinter_factory('[', ']'),
824 dict: _dict_pprinter_factory('{', '}'),
833 dict: _dict_pprinter_factory('{', '}'),
825 set: _set_pprinter_factory('{', '}'),
834 set: _set_pprinter_factory('{', '}'),
826 frozenset: _set_pprinter_factory('frozenset({', '})'),
835 frozenset: _set_pprinter_factory('frozenset({', '})'),
827 super: _super_pprint,
836 super: _super_pprint,
828 _re_pattern_type: _re_pattern_pprint,
837 _re_pattern_type: _re_pattern_pprint,
829 type: _type_pprint,
838 type: _type_pprint,
830 types.FunctionType: _function_pprint,
839 types.FunctionType: _function_pprint,
831 types.BuiltinFunctionType: _function_pprint,
840 types.BuiltinFunctionType: _function_pprint,
832 types.MethodType: _repr_pprint,
841 types.MethodType: _repr_pprint,
833 types.SimpleNamespace: _types_simplenamespace_pprint,
842 types.SimpleNamespace: _types_simplenamespace_pprint,
834 datetime.datetime: _repr_pprint,
843 datetime.datetime: _repr_pprint,
835 datetime.timedelta: _repr_pprint,
844 datetime.timedelta: _repr_pprint,
836 _exception_base: _exception_pprint
845 _exception_base: _exception_pprint
837 }
846 }
838
847
839 # render os.environ like a dict
848 # render os.environ like a dict
840 _env_type = type(os.environ)
849 _env_type = type(os.environ)
841 # future-proof in case os.environ becomes a plain dict?
850 # future-proof in case os.environ becomes a plain dict?
842 if _env_type is not dict:
851 if _env_type is not dict:
843 _type_pprinters[_env_type] = _dict_pprinter_factory('environ{', '}')
852 _type_pprinters[_env_type] = _dict_pprinter_factory('environ{', '}')
844
853
845 _type_pprinters[types.MappingProxyType] = _dict_pprinter_factory("mappingproxy({", "})")
854 _type_pprinters[types.MappingProxyType] = _dict_pprinter_factory("mappingproxy({", "})")
846 _type_pprinters[slice] = _repr_pprint
855 _type_pprinters[slice] = _repr_pprint
847
856
848 _type_pprinters[range] = _repr_pprint
857 _type_pprinters[range] = _repr_pprint
849 _type_pprinters[bytes] = _repr_pprint
858 _type_pprinters[bytes] = _repr_pprint
850
859
851 #: printers for types specified by name
860 #: printers for types specified by name
852 _deferred_type_pprinters: Dict = {}
861 _deferred_type_pprinters: Dict = {}
853
862
854
863
855 def for_type(typ, func):
864 def for_type(typ, func):
856 """
865 """
857 Add a pretty printer for a given type.
866 Add a pretty printer for a given type.
858 """
867 """
859 oldfunc = _type_pprinters.get(typ, None)
868 oldfunc = _type_pprinters.get(typ, None)
860 if func is not None:
869 if func is not None:
861 # To support easy restoration of old pprinters, we need to ignore Nones.
870 # To support easy restoration of old pprinters, we need to ignore Nones.
862 _type_pprinters[typ] = func
871 _type_pprinters[typ] = func
863 return oldfunc
872 return oldfunc
864
873
865 def for_type_by_name(type_module, type_name, func):
874 def for_type_by_name(type_module, type_name, func):
866 """
875 """
867 Add a pretty printer for a type specified by the module and name of a type
876 Add a pretty printer for a type specified by the module and name of a type
868 rather than the type object itself.
877 rather than the type object itself.
869 """
878 """
870 key = (type_module, type_name)
879 key = (type_module, type_name)
871 oldfunc = _deferred_type_pprinters.get(key, None)
880 oldfunc = _deferred_type_pprinters.get(key, None)
872 if func is not None:
881 if func is not None:
873 # To support easy restoration of old pprinters, we need to ignore Nones.
882 # To support easy restoration of old pprinters, we need to ignore Nones.
874 _deferred_type_pprinters[key] = func
883 _deferred_type_pprinters[key] = func
875 return oldfunc
884 return oldfunc
876
885
877
886
878 #: printers for the default singletons
887 #: printers for the default singletons
879 _singleton_pprinters = dict.fromkeys(map(id, [None, True, False, Ellipsis,
888 _singleton_pprinters = dict.fromkeys(map(id, [None, True, False, Ellipsis,
880 NotImplemented]), _repr_pprint)
889 NotImplemented]), _repr_pprint)
881
890
882
891
883 def _defaultdict_pprint(obj, p, cycle):
892 def _defaultdict_pprint(obj, p, cycle):
884 cls_ctor = CallExpression.factory(obj.__class__.__name__)
893 cls_ctor = CallExpression.factory(obj.__class__.__name__)
885 if cycle:
894 if cycle:
886 p.pretty(cls_ctor(RawText("...")))
895 p.pretty(cls_ctor(RawText("...")))
887 else:
896 else:
888 p.pretty(cls_ctor(obj.default_factory, dict(obj)))
897 p.pretty(cls_ctor(obj.default_factory, dict(obj)))
889
898
890 def _ordereddict_pprint(obj, p, cycle):
899 def _ordereddict_pprint(obj, p, cycle):
891 cls_ctor = CallExpression.factory(obj.__class__.__name__)
900 cls_ctor = CallExpression.factory(obj.__class__.__name__)
892 if cycle:
901 if cycle:
893 p.pretty(cls_ctor(RawText("...")))
902 p.pretty(cls_ctor(RawText("...")))
894 elif len(obj):
903 elif len(obj):
895 p.pretty(cls_ctor(list(obj.items())))
904 p.pretty(cls_ctor(list(obj.items())))
896 else:
905 else:
897 p.pretty(cls_ctor())
906 p.pretty(cls_ctor())
898
907
899 def _deque_pprint(obj, p, cycle):
908 def _deque_pprint(obj, p, cycle):
900 cls_ctor = CallExpression.factory(obj.__class__.__name__)
909 cls_ctor = CallExpression.factory(obj.__class__.__name__)
901 if cycle:
910 if cycle:
902 p.pretty(cls_ctor(RawText("...")))
911 p.pretty(cls_ctor(RawText("...")))
903 elif obj.maxlen is not None:
912 elif obj.maxlen is not None:
904 p.pretty(cls_ctor(list(obj), maxlen=obj.maxlen))
913 p.pretty(cls_ctor(list(obj), maxlen=obj.maxlen))
905 else:
914 else:
906 p.pretty(cls_ctor(list(obj)))
915 p.pretty(cls_ctor(list(obj)))
907
916
908 def _counter_pprint(obj, p, cycle):
917 def _counter_pprint(obj, p, cycle):
909 cls_ctor = CallExpression.factory(obj.__class__.__name__)
918 cls_ctor = CallExpression.factory(obj.__class__.__name__)
910 if cycle:
919 if cycle:
911 p.pretty(cls_ctor(RawText("...")))
920 p.pretty(cls_ctor(RawText("...")))
912 elif len(obj):
921 elif len(obj):
913 p.pretty(cls_ctor(dict(obj.most_common())))
922 p.pretty(cls_ctor(dict(obj.most_common())))
914 else:
923 else:
915 p.pretty(cls_ctor())
924 p.pretty(cls_ctor())
916
925
917
926
918 def _userlist_pprint(obj, p, cycle):
927 def _userlist_pprint(obj, p, cycle):
919 cls_ctor = CallExpression.factory(obj.__class__.__name__)
928 cls_ctor = CallExpression.factory(obj.__class__.__name__)
920 if cycle:
929 if cycle:
921 p.pretty(cls_ctor(RawText("...")))
930 p.pretty(cls_ctor(RawText("...")))
922 else:
931 else:
923 p.pretty(cls_ctor(obj.data))
932 p.pretty(cls_ctor(obj.data))
924
933
925
934
926 for_type_by_name('collections', 'defaultdict', _defaultdict_pprint)
935 for_type_by_name('collections', 'defaultdict', _defaultdict_pprint)
927 for_type_by_name('collections', 'OrderedDict', _ordereddict_pprint)
936 for_type_by_name('collections', 'OrderedDict', _ordereddict_pprint)
928 for_type_by_name('collections', 'deque', _deque_pprint)
937 for_type_by_name('collections', 'deque', _deque_pprint)
929 for_type_by_name('collections', 'Counter', _counter_pprint)
938 for_type_by_name('collections', 'Counter', _counter_pprint)
930 for_type_by_name("collections", "UserList", _userlist_pprint)
939 for_type_by_name("collections", "UserList", _userlist_pprint)
931
940
932 if __name__ == '__main__':
941 if __name__ == '__main__':
933 from random import randrange
942 from random import randrange
934 class Foo(object):
943 class Foo(object):
935 def __init__(self):
944 def __init__(self):
936 self.foo = 1
945 self.foo = 1
937 self.bar = re.compile(r'\s+')
946 self.bar = re.compile(r'\s+')
938 self.blub = dict.fromkeys(range(30), randrange(1, 40))
947 self.blub = dict.fromkeys(range(30), randrange(1, 40))
939 self.hehe = 23424.234234
948 self.hehe = 23424.234234
940 self.list = ["blub", "blah", self]
949 self.list = ["blub", "blah", self]
941
950
942 def get_foo(self):
951 def get_foo(self):
943 print("foo")
952 print("foo")
944
953
945 pprint(Foo(), verbose=True)
954 pprint(Foo(), verbose=True)
General Comments 0
You need to be logged in to leave comments. Login now