-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
test_formatters.py
531 lines (427 loc) · 13.9 KB
/
test_formatters.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
"""Tests for the Formatters."""
from math import pi
try:
import numpy
except:
numpy = None
import pytest
from IPython import get_ipython
from traitlets.config import Config
from IPython.core.formatters import (
PlainTextFormatter, HTMLFormatter, PDFFormatter, _mod_name_key,
DisplayFormatter, JSONFormatter,
)
from IPython.utils.io import capture_output
class A(object):
def __repr__(self):
return 'A()'
class B(A):
def __repr__(self):
return 'B()'
class C:
pass
class BadRepr(object):
def __repr__(self):
raise ValueError("bad repr")
class BadPretty(object):
_repr_pretty_ = None
class GoodPretty(object):
def _repr_pretty_(self, pp, cycle):
pp.text('foo')
def __repr__(self):
return 'GoodPretty()'
def foo_printer(obj, pp, cycle):
pp.text('foo')
def test_pretty():
f = PlainTextFormatter()
f.for_type(A, foo_printer)
assert f(A()) == "foo"
assert f(B()) == "B()"
assert f(GoodPretty()) == "foo"
# Just don't raise an exception for the following:
f(BadPretty())
f.pprint = False
assert f(A()) == "A()"
assert f(B()) == "B()"
assert f(GoodPretty()) == "GoodPretty()"
def test_deferred():
f = PlainTextFormatter()
def test_precision():
"""test various values for float_precision."""
f = PlainTextFormatter()
assert f(pi) == repr(pi)
f.float_precision = 0
if numpy:
po = numpy.get_printoptions()
assert po["precision"] == 0
assert f(pi) == "3"
f.float_precision = 2
if numpy:
po = numpy.get_printoptions()
assert po["precision"] == 2
assert f(pi) == "3.14"
f.float_precision = "%g"
if numpy:
po = numpy.get_printoptions()
assert po["precision"] == 2
assert f(pi) == "3.14159"
f.float_precision = "%e"
assert f(pi) == "3.141593e+00"
f.float_precision = ""
if numpy:
po = numpy.get_printoptions()
assert po["precision"] == 8
assert f(pi) == repr(pi)
def test_bad_precision():
"""test various invalid values for float_precision."""
f = PlainTextFormatter()
def set_fp(p):
f.float_precision = p
pytest.raises(ValueError, set_fp, "%")
pytest.raises(ValueError, set_fp, "%.3f%i")
pytest.raises(ValueError, set_fp, "foo")
pytest.raises(ValueError, set_fp, -1)
def test_for_type():
f = PlainTextFormatter()
# initial return, None
assert f.for_type(C, foo_printer) is None
# no func queries
assert f.for_type(C) is foo_printer
# shouldn't change anything
assert f.for_type(C) is foo_printer
# None should do the same
assert f.for_type(C, None) is foo_printer
assert f.for_type(C, None) is foo_printer
def test_for_type_string():
f = PlainTextFormatter()
type_str = '%s.%s' % (C.__module__, 'C')
# initial return, None
assert f.for_type(type_str, foo_printer) is None
# no func queries
assert f.for_type(type_str) is foo_printer
assert _mod_name_key(C) in f.deferred_printers
assert f.for_type(C) is foo_printer
assert _mod_name_key(C) not in f.deferred_printers
assert C in f.type_printers
def test_for_type_by_name():
f = PlainTextFormatter()
mod = C.__module__
# initial return, None
assert f.for_type_by_name(mod, "C", foo_printer) is None
# no func queries
assert f.for_type_by_name(mod, "C") is foo_printer
# shouldn't change anything
assert f.for_type_by_name(mod, "C") is foo_printer
# None should do the same
assert f.for_type_by_name(mod, "C", None) is foo_printer
assert f.for_type_by_name(mod, "C", None) is foo_printer
def test_lookup():
f = PlainTextFormatter()
f.for_type(C, foo_printer)
assert f.lookup(C()) is foo_printer
with pytest.raises(KeyError):
f.lookup(A())
def test_lookup_string():
f = PlainTextFormatter()
type_str = '%s.%s' % (C.__module__, 'C')
f.for_type(type_str, foo_printer)
assert f.lookup(C()) is foo_printer
# should move from deferred to imported dict
assert _mod_name_key(C) not in f.deferred_printers
assert C in f.type_printers
def test_lookup_by_type():
f = PlainTextFormatter()
f.for_type(C, foo_printer)
assert f.lookup_by_type(C) is foo_printer
with pytest.raises(KeyError):
f.lookup_by_type(A)
def test_lookup_by_type_string():
f = PlainTextFormatter()
type_str = '%s.%s' % (C.__module__, 'C')
f.for_type(type_str, foo_printer)
# verify insertion
assert _mod_name_key(C) in f.deferred_printers
assert C not in f.type_printers
assert f.lookup_by_type(type_str) is foo_printer
# lookup by string doesn't cause import
assert _mod_name_key(C) in f.deferred_printers
assert C not in f.type_printers
assert f.lookup_by_type(C) is foo_printer
# should move from deferred to imported dict
assert _mod_name_key(C) not in f.deferred_printers
assert C in f.type_printers
def test_in_formatter():
f = PlainTextFormatter()
f.for_type(C, foo_printer)
type_str = '%s.%s' % (C.__module__, 'C')
assert C in f
assert type_str in f
def test_string_in_formatter():
f = PlainTextFormatter()
type_str = '%s.%s' % (C.__module__, 'C')
f.for_type(type_str, foo_printer)
assert type_str in f
assert C in f
def test_pop():
f = PlainTextFormatter()
f.for_type(C, foo_printer)
assert f.lookup_by_type(C) is foo_printer
assert f.pop(C, None) is foo_printer
f.for_type(C, foo_printer)
assert f.pop(C) is foo_printer
with pytest.raises(KeyError):
f.lookup_by_type(C)
with pytest.raises(KeyError):
f.pop(C)
with pytest.raises(KeyError):
f.pop(A)
assert f.pop(A, None) is None
def test_pop_string():
f = PlainTextFormatter()
type_str = '%s.%s' % (C.__module__, 'C')
with pytest.raises(KeyError):
f.pop(type_str)
f.for_type(type_str, foo_printer)
f.pop(type_str)
with pytest.raises(KeyError):
f.lookup_by_type(C)
with pytest.raises(KeyError):
f.pop(type_str)
f.for_type(C, foo_printer)
assert f.pop(type_str, None) is foo_printer
with pytest.raises(KeyError):
f.lookup_by_type(C)
with pytest.raises(KeyError):
f.pop(type_str)
assert f.pop(type_str, None) is None
def test_error_method():
f = HTMLFormatter()
class BadHTML(object):
def _repr_html_(self):
raise ValueError("Bad HTML")
bad = BadHTML()
with capture_output() as captured:
result = f(bad)
assert result is None
assert "Traceback" in captured.stdout
assert "Bad HTML" in captured.stdout
assert "_repr_html_" in captured.stdout
def test_nowarn_notimplemented():
f = HTMLFormatter()
class HTMLNotImplemented(object):
def _repr_html_(self):
raise NotImplementedError
h = HTMLNotImplemented()
with capture_output() as captured:
result = f(h)
assert result is None
assert "" == captured.stderr
assert "" == captured.stdout
def test_warn_error_for_type():
f = HTMLFormatter()
f.for_type(int, lambda i: name_error)
with capture_output() as captured:
result = f(5)
assert result is None
assert "Traceback" in captured.stdout
assert "NameError" in captured.stdout
assert "name_error" in captured.stdout
def test_error_pretty_method():
f = PlainTextFormatter()
class BadPretty(object):
def _repr_pretty_(self):
return "hello"
bad = BadPretty()
with capture_output() as captured:
result = f(bad)
assert result is None
assert "Traceback" in captured.stdout
assert "_repr_pretty_" in captured.stdout
assert "given" in captured.stdout
assert "argument" in captured.stdout
def test_bad_repr_traceback():
f = PlainTextFormatter()
bad = BadRepr()
with capture_output() as captured:
result = f(bad)
# catches error, returns None
assert result is None
assert "Traceback" in captured.stdout
assert "__repr__" in captured.stdout
assert "ValueError" in captured.stdout
class MakePDF(object):
def _repr_pdf_(self):
return 'PDF'
def test_pdf_formatter():
pdf = MakePDF()
f = PDFFormatter()
assert f(pdf) == "PDF"
def test_print_method_bound():
f = HTMLFormatter()
class MyHTML(object):
def _repr_html_(self):
return "hello"
with capture_output() as captured:
result = f(MyHTML)
assert result is None
assert "FormatterWarning" not in captured.stderr
with capture_output() as captured:
result = f(MyHTML())
assert result == "hello"
assert captured.stderr == ""
def test_print_method_weird():
class TextMagicHat(object):
def __getattr__(self, key):
return key
f = HTMLFormatter()
text_hat = TextMagicHat()
assert text_hat._repr_html_ == "_repr_html_"
with capture_output() as captured:
result = f(text_hat)
assert result is None
assert "FormatterWarning" not in captured.stderr
class CallableMagicHat(object):
def __getattr__(self, key):
return lambda : key
call_hat = CallableMagicHat()
with capture_output() as captured:
result = f(call_hat)
assert result is None
class BadReprArgs(object):
def _repr_html_(self, extra, args):
return "html"
bad = BadReprArgs()
with capture_output() as captured:
result = f(bad)
assert result is None
assert "FormatterWarning" not in captured.stderr
def test_format_config():
"""config objects don't pretend to support fancy reprs with lazy attrs"""
f = HTMLFormatter()
cfg = Config()
with capture_output() as captured:
result = f(cfg)
assert result is None
assert captured.stderr == ""
with capture_output() as captured:
result = f(Config)
assert result is None
assert captured.stderr == ""
def test_pretty_max_seq_length():
f = PlainTextFormatter(max_seq_length=1)
lis = list(range(3))
text = f(lis)
assert text == "[0, ...]"
f.max_seq_length = 0
text = f(lis)
assert text == "[0, 1, 2]"
text = f(list(range(1024)))
lines = text.splitlines()
assert len(lines) == 1024
def test_ipython_display_formatter():
"""Objects with _ipython_display_ defined bypass other formatters"""
f = get_ipython().display_formatter
catcher = []
class SelfDisplaying(object):
def _ipython_display_(self):
catcher.append(self)
class NotSelfDisplaying(object):
def __repr__(self):
return "NotSelfDisplaying"
def _ipython_display_(self):
raise NotImplementedError
save_enabled = f.ipython_display_formatter.enabled
f.ipython_display_formatter.enabled = True
yes = SelfDisplaying()
no = NotSelfDisplaying()
d, md = f.format(no)
assert d == {"text/plain": repr(no)}
assert md == {}
assert catcher == []
d, md = f.format(yes)
assert d == {}
assert md == {}
assert catcher == [yes]
f.ipython_display_formatter.enabled = save_enabled
def test_repr_mime():
class HasReprMime(object):
def _repr_mimebundle_(self, include=None, exclude=None):
return {
'application/json+test.v2': {
'x': 'y'
},
'plain/text' : '<HasReprMime>',
'image/png' : 'i-overwrite'
}
def _repr_png_(self):
return 'should-be-overwritten'
def _repr_html_(self):
return '<b>hi!</b>'
f = get_ipython().display_formatter
html_f = f.formatters['text/html']
save_enabled = html_f.enabled
html_f.enabled = True
obj = HasReprMime()
d, md = f.format(obj)
html_f.enabled = save_enabled
assert sorted(d) == [
"application/json+test.v2",
"image/png",
"plain/text",
"text/html",
"text/plain",
]
assert md == {}
d, md = f.format(obj, include={"image/png"})
assert list(d.keys()) == [
"image/png"
], "Include should filter out even things from repr_mimebundle"
assert d["image/png"] == "i-overwrite", "_repr_mimebundle_ take precedence"
def test_pass_correct_include_exclude():
class Tester(object):
def __init__(self, include=None, exclude=None):
self.include = include
self.exclude = exclude
def _repr_mimebundle_(self, include, exclude, **kwargs):
if include and (include != self.include):
raise ValueError('include got modified: display() may be broken.')
if exclude and (exclude != self.exclude):
raise ValueError('exclude got modified: display() may be broken.')
return None
include = {'a', 'b', 'c'}
exclude = {'c', 'e' , 'f'}
f = get_ipython().display_formatter
f.format(Tester(include=include, exclude=exclude), include=include, exclude=exclude)
f.format(Tester(exclude=exclude), exclude=exclude)
f.format(Tester(include=include), include=include)
def test_repr_mime_meta():
class HasReprMimeMeta(object):
def _repr_mimebundle_(self, include=None, exclude=None):
data = {
'image/png': 'base64-image-data',
}
metadata = {
'image/png': {
'width': 5,
'height': 10,
}
}
return (data, metadata)
f = get_ipython().display_formatter
obj = HasReprMimeMeta()
d, md = f.format(obj)
assert sorted(d) == ["image/png", "text/plain"]
assert md == {
"image/png": {
"width": 5,
"height": 10,
}
}
def test_repr_mime_failure():
class BadReprMime(object):
def _repr_mimebundle_(self, include=None, exclude=None):
raise RuntimeError
f = get_ipython().display_formatter
obj = BadReprMime()
d, md = f.format(obj)
assert "text/plain" in d