test_pretty.py
502 lines
| 13.5 KiB
| text/x-python
|
PythonLexer
Min RK
|
r20662 | # coding: utf-8 | ||
MinRK
|
r18024 | """Tests for IPython.lib.pretty.""" | ||
# Copyright (c) IPython Development Team. | ||||
Walter Doerwald
|
r6295 | # Distributed under the terms of the Modified BSD License. | ||
Frazer McLean
|
r21375 | from collections import Counter, defaultdict, deque, OrderedDict | ||
Min RK
|
r24372 | import os | ||
Lumir Balhar
|
r27061 | import pytest | ||
Matthias Bussonnier
|
r23706 | import types | ||
import string | ||||
Lumir Balhar
|
r27061 | import sys | ||
Matthias Bussonnier
|
r23706 | import unittest | ||
Frazer McLean
|
r21375 | |||
Matthias Bussonnier
|
r26183 | import pytest | ||
Walter Doerwald
|
r6295 | |||
from IPython.lib import pretty | ||||
Lumir Balhar
|
r27061 | from IPython.testing.decorators import skip_iptest_but_not_pytest | ||
Remi Rampin
|
r18420 | |||
Paul Ivanov
|
r22960 | from io import StringIO | ||
Walter Doerwald
|
r6295 | |||
class MyList(object): | ||||
def __init__(self, content): | ||||
self.content = content | ||||
def _repr_pretty_(self, p, cycle): | ||||
if cycle: | ||||
p.text("MyList(...)") | ||||
else: | ||||
with p.group(3, "MyList(", ")"): | ||||
for (i, child) in enumerate(self.content): | ||||
if i: | ||||
p.text(",") | ||||
p.breakable() | ||||
else: | ||||
p.breakable("") | ||||
p.pretty(child) | ||||
Walter Doerwald
|
r6313 | class MyDict(dict): | ||
def _repr_pretty_(self, p, cycle): | ||||
p.text("MyDict(...)") | ||||
Thomas Kluyver
|
r16238 | class MyObj(object): | ||
def somemethod(self): | ||||
pass | ||||
Walter Doerwald
|
r6313 | |||
Robert Kern
|
r7831 | class Dummy1(object): | ||
def _repr_pretty_(self, p, cycle): | ||||
p.text("Dummy1(...)") | ||||
class Dummy2(Dummy1): | ||||
_repr_pretty_ = None | ||||
MinRK
|
r10789 | class NoModule(object): | ||
pass | ||||
NoModule.__module__ = None | ||||
Alex Rudy
|
r11875 | class Breaking(object): | ||
def _repr_pretty_(self, p, cycle): | ||||
with p.group(4,"TG: ",":"): | ||||
p.text("Breaking(") | ||||
p.break_() | ||||
p.text(")") | ||||
Alex Rudy
|
r11876 | class BreakingRepr(object): | ||
def __repr__(self): | ||||
return "Breaking(\n)" | ||||
MinRK
|
r13425 | class BadRepr(object): | ||
def __repr__(self): | ||||
return 1/0 | ||||
Alex Rudy
|
r11876 | |||
Robert Kern
|
r7831 | |||
Walter Doerwald
|
r6295 | def test_indentation(): | ||
"""Test correct indentation in groups""" | ||||
count = 40 | ||||
gotoutput = pretty.pretty(MyList(range(count))) | ||||
expectedoutput = "MyList(\n" + ",\n".join(" %d" % i for i in range(count)) + ")" | ||||
Matthias Bussonnier
|
r26718 | assert gotoutput == expectedoutput | ||
Walter Doerwald
|
r6313 | |||
def test_dispatch(): | ||||
""" | ||||
Test correct dispatching: The _repr_pretty_ method for MyDict | ||||
must be found before the registered printer for dict. | ||||
""" | ||||
gotoutput = pretty.pretty(MyDict()) | ||||
expectedoutput = "MyDict(...)" | ||||
Matthias Bussonnier
|
r26718 | assert gotoutput == expectedoutput | ||
Robert Kern
|
r7831 | |||
def test_callability_checking(): | ||||
""" | ||||
Test that the _repr_pretty_ method is tested for callability and skipped if | ||||
not. | ||||
""" | ||||
gotoutput = pretty.pretty(Dummy2()) | ||||
expectedoutput = "Dummy1(...)" | ||||
Matthias Bussonnier
|
r26718 | assert gotoutput == expectedoutput | ||
Bradley M. Froehle
|
r8888 | |||
Robert Kern
|
r10234 | |||
Matthias Bussonnier
|
r26183 | @pytest.mark.parametrize( | ||
"obj,expected_output", | ||||
zip( | ||||
[ | ||||
set(), | ||||
frozenset(), | ||||
set([1]), | ||||
frozenset([1]), | ||||
set([1, 2]), | ||||
frozenset([1, 2]), | ||||
set([-1, -2, -3]), | ||||
], | ||||
[ | ||||
"set()", | ||||
"frozenset()", | ||||
"{1}", | ||||
"frozenset({1})", | ||||
"{1, 2}", | ||||
"frozenset({1, 2})", | ||||
"{-3, -2, -1}", | ||||
], | ||||
), | ||||
) | ||||
@skip_iptest_but_not_pytest | ||||
def test_sets(obj, expected_output): | ||||
Robert Kern
|
r10234 | """ | ||
Test that set and frozenset use Python 3 formatting. | ||||
""" | ||||
Matthias Bussonnier
|
r26183 | got_output = pretty.pretty(obj) | ||
Matthias Bussonnier
|
r26718 | assert got_output == expected_output | ||
Robert Kern
|
r10234 | |||
Bradley M. Froehle
|
r8888 | def test_pprint_heap_allocated_type(): | ||
""" | ||||
Test that pprint works for heap allocated types. | ||||
""" | ||||
Lumir Balhar
|
r27061 | module_name = "xxlimited" if sys.version_info < (3, 10) else "xxlimited_35" | ||
xxlimited = pytest.importorskip(module_name) | ||||
Bradley M. Froehle
|
r8888 | output = pretty.pretty(xxlimited.Null) | ||
Matthias Bussonnier
|
r26718 | assert output == "xxlimited.Null" | ||
MinRK
|
r10789 | |||
def test_pprint_nomod(): | ||||
""" | ||||
Test that pprint works for classes with no __module__. | ||||
""" | ||||
output = pretty.pretty(NoModule) | ||||
Matthias Bussonnier
|
r26718 | assert output == "NoModule" | ||
Alex Rudy
|
r11875 | def test_pprint_break(): | ||
""" | ||||
Test that p.break_ produces expected output | ||||
""" | ||||
output = pretty.pretty(Breaking()) | ||||
expected = "TG: Breaking(\n ):" | ||||
Matthias Bussonnier
|
r26718 | assert output == expected | ||
Alex Rudy
|
r11876 | |||
def test_pprint_break_repr(): | ||||
""" | ||||
Test that p.break_ is used in repr | ||||
""" | ||||
Eric Wieser
|
r25434 | output = pretty.pretty([[BreakingRepr()]]) | ||
expected = "[[Breaking(\n )]]" | ||||
Matthias Bussonnier
|
r26718 | assert output == expected | ||
Eric Wieser
|
r25434 | |||
output = pretty.pretty([[BreakingRepr()]*2]) | ||||
expected = "[[Breaking(\n ),\n Breaking(\n )]]" | ||||
Matthias Bussonnier
|
r26718 | assert output == expected | ||
MinRK
|
r13425 | |||
def test_bad_repr(): | ||||
MinRK
|
r18024 | """Don't catch bad repr errors""" | ||
Samuel Gaist
|
r26915 | with pytest.raises(ZeroDivisionError): | ||
Matthias Bussonnier
|
r22837 | pretty.pretty(BadRepr()) | ||
MinRK
|
r13434 | |||
class BadException(Exception): | ||||
def __str__(self): | ||||
return -1 | ||||
class ReallyBadRepr(object): | ||||
__module__ = 1 | ||||
@property | ||||
def __class__(self): | ||||
raise ValueError("I am horrible") | ||||
Samuel Gaist
|
r26915 | |||
MinRK
|
r13434 | def __repr__(self): | ||
raise BadException() | ||||
def test_really_bad_repr(): | ||||
Samuel Gaist
|
r26915 | with pytest.raises(BadException): | ||
Matthias Bussonnier
|
r22837 | pretty.pretty(ReallyBadRepr()) | ||
Thomas Kluyver
|
r14996 | |||
class SA(object): | ||||
pass | ||||
class SB(SA): | ||||
pass | ||||
Matthias Bussonnier
|
r23706 | class TestsPretty(unittest.TestCase): | ||
def test_super_repr(self): | ||||
# "<super: module_name.SA, None>" | ||||
output = pretty.pretty(super(SA)) | ||||
self.assertRegex(output, r"<super: \S+.SA, None>") | ||||
# "<super: module_name.SA, <module_name.SB at 0x...>>" | ||||
sb = SB() | ||||
output = pretty.pretty(super(SA, sb)) | ||||
self.assertRegex(output, r"<super: \S+.SA,\s+<\S+.SB at 0x\S+>>") | ||||
def test_long_list(self): | ||||
lis = list(range(10000)) | ||||
p = pretty.pretty(lis) | ||||
last2 = p.rsplit('\n', 2)[-2:] | ||||
self.assertEqual(last2, [' 999,', ' ...]']) | ||||
def test_long_set(self): | ||||
s = set(range(10000)) | ||||
p = pretty.pretty(s) | ||||
last2 = p.rsplit('\n', 2)[-2:] | ||||
self.assertEqual(last2, [' 999,', ' ...}']) | ||||
def test_long_tuple(self): | ||||
tup = tuple(range(10000)) | ||||
p = pretty.pretty(tup) | ||||
last2 = p.rsplit('\n', 2)[-2:] | ||||
self.assertEqual(last2, [' 999,', ' ...)']) | ||||
def test_long_dict(self): | ||||
d = { n:n for n in range(10000) } | ||||
p = pretty.pretty(d) | ||||
last2 = p.rsplit('\n', 2)[-2:] | ||||
self.assertEqual(last2, [' 999: 999,', ' ...}']) | ||||
def test_unbound_method(self): | ||||
output = pretty.pretty(MyObj.somemethod) | ||||
self.assertIn('MyObj.somemethod', output) | ||||
Remi Rampin
|
r18403 | |||
class MetaClass(type): | ||||
def __new__(cls, name): | ||||
return type.__new__(cls, name, (object,), {'name': name}) | ||||
def __repr__(self): | ||||
return "[CUSTOM REPR FOR CLASS %s]" % self.name | ||||
ClassWithMeta = MetaClass('ClassWithMeta') | ||||
def test_metaclass_repr(): | ||||
output = pretty.pretty(ClassWithMeta) | ||||
Matthias Bussonnier
|
r26718 | assert output == "[CUSTOM REPR FOR CLASS ClassWithMeta]" | ||
Remi Rampin
|
r18420 | |||
Min RK
|
r20662 | def test_unicode_repr(): | ||
Thomas Kluyver
|
r20727 | u = u"üniçodé" | ||
Paul Ivanov
|
r22960 | ustr = u | ||
Samuel Gaist
|
r26915 | |||
Min RK
|
r20662 | class C(object): | ||
def __repr__(self): | ||||
return ustr | ||||
Samuel Gaist
|
r26915 | |||
Min RK
|
r20662 | c = C() | ||
p = pretty.pretty(c) | ||||
Matthias Bussonnier
|
r26718 | assert p == u | ||
Min RK
|
r20662 | p = pretty.pretty([c]) | ||
Matthias Bussonnier
|
r26718 | assert p == u"[%s]" % u | ||
Min RK
|
r20662 | |||
Remi Rampin
|
r18420 | def test_basic_class(): | ||
def type_pprint_wrapper(obj, p, cycle): | ||||
if obj is MyObj: | ||||
type_pprint_wrapper.called = True | ||||
return pretty._type_pprint(obj, p, cycle) | ||||
type_pprint_wrapper.called = False | ||||
stream = StringIO() | ||||
printer = pretty.RepresentationPrinter(stream) | ||||
printer.type_pprinters[type] = type_pprint_wrapper | ||||
printer.pretty(MyObj) | ||||
printer.flush() | ||||
output = stream.getvalue() | ||||
Matthias Bussonnier
|
r26718 | assert output == "%s.MyObj" % __name__ | ||
Samuel Gaist
|
r26915 | assert type_pprint_wrapper.called is True | ||
Frazer McLean
|
r21375 | |||
Matthias Bussonnier
|
r26718 | # TODO : pytest.mark.parametrise once nose is gone. | ||
Frazer McLean
|
r21375 | def test_collections_defaultdict(): | ||
# Create defaultdicts with cycles | ||||
a = defaultdict() | ||||
a.default_factory = a | ||||
b = defaultdict(list) | ||||
b['key'] = b | ||||
# Dictionary order cannot be relied on, test against single keys. | ||||
cases = [ | ||||
(defaultdict(list), 'defaultdict(list, {})'), | ||||
(defaultdict(list, {'key': '-' * 50}), | ||||
"defaultdict(list,\n" | ||||
" {'key': '--------------------------------------------------'})"), | ||||
(a, 'defaultdict(defaultdict(...), {})'), | ||||
(b, "defaultdict(list, {'key': defaultdict(...)})"), | ||||
] | ||||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
Frazer McLean
|
r21375 | |||
Matthias Bussonnier
|
r26718 | # TODO : pytest.mark.parametrise once nose is gone. | ||
Frazer McLean
|
r21375 | def test_collections_ordereddict(): | ||
# Create OrderedDict with cycle | ||||
a = OrderedDict() | ||||
a['key'] = a | ||||
cases = [ | ||||
(OrderedDict(), 'OrderedDict()'), | ||||
(OrderedDict((i, i) for i in range(1000, 1010)), | ||||
'OrderedDict([(1000, 1000),\n' | ||||
' (1001, 1001),\n' | ||||
' (1002, 1002),\n' | ||||
' (1003, 1003),\n' | ||||
' (1004, 1004),\n' | ||||
' (1005, 1005),\n' | ||||
' (1006, 1006),\n' | ||||
' (1007, 1007),\n' | ||||
' (1008, 1008),\n' | ||||
' (1009, 1009)])'), | ||||
(a, "OrderedDict([('key', OrderedDict(...))])"), | ||||
] | ||||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
Frazer McLean
|
r21375 | |||
Matthias Bussonnier
|
r26718 | # TODO : pytest.mark.parametrise once nose is gone. | ||
Frazer McLean
|
r21375 | def test_collections_deque(): | ||
# Create deque with cycle | ||||
a = deque() | ||||
a.append(a) | ||||
cases = [ | ||||
(deque(), 'deque([])'), | ||||
(deque(i for i in range(1000, 1020)), | ||||
'deque([1000,\n' | ||||
' 1001,\n' | ||||
' 1002,\n' | ||||
' 1003,\n' | ||||
' 1004,\n' | ||||
' 1005,\n' | ||||
' 1006,\n' | ||||
' 1007,\n' | ||||
' 1008,\n' | ||||
' 1009,\n' | ||||
' 1010,\n' | ||||
' 1011,\n' | ||||
' 1012,\n' | ||||
' 1013,\n' | ||||
' 1014,\n' | ||||
' 1015,\n' | ||||
' 1016,\n' | ||||
' 1017,\n' | ||||
' 1018,\n' | ||||
' 1019])'), | ||||
(a, 'deque([deque(...)])'), | ||||
] | ||||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
Frazer McLean
|
r21375 | |||
Matthias Bussonnier
|
r26718 | |||
# TODO : pytest.mark.parametrise once nose is gone. | ||||
Frazer McLean
|
r21375 | def test_collections_counter(): | ||
Min RK
|
r21769 | class MyCounter(Counter): | ||
pass | ||||
Frazer McLean
|
r21375 | cases = [ | ||
(Counter(), 'Counter()'), | ||||
(Counter(a=1), "Counter({'a': 1})"), | ||||
Min RK
|
r21769 | (MyCounter(a=1), "MyCounter({'a': 1})"), | ||
Frazer McLean
|
r21375 | ] | ||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
Danilo J. S. Bellini
|
r22748 | |||
Matthias Bussonnier
|
r26718 | # TODO : pytest.mark.parametrise once nose is gone. | ||
Danilo J. S. Bellini
|
r22748 | def test_mappingproxy(): | ||
MP = types.MappingProxyType | ||||
underlying_dict = {} | ||||
mp_recursive = MP(underlying_dict) | ||||
underlying_dict[2] = mp_recursive | ||||
underlying_dict[3] = underlying_dict | ||||
cases = [ | ||||
(MP({}), "mappingproxy({})"), | ||||
(MP({None: MP({})}), "mappingproxy({None: mappingproxy({})})"), | ||||
(MP({k: k.upper() for k in string.ascii_lowercase}), | ||||
"mappingproxy({'a': 'A',\n" | ||||
" 'b': 'B',\n" | ||||
" 'c': 'C',\n" | ||||
" 'd': 'D',\n" | ||||
" 'e': 'E',\n" | ||||
" 'f': 'F',\n" | ||||
" 'g': 'G',\n" | ||||
" 'h': 'H',\n" | ||||
" 'i': 'I',\n" | ||||
" 'j': 'J',\n" | ||||
" 'k': 'K',\n" | ||||
" 'l': 'L',\n" | ||||
" 'm': 'M',\n" | ||||
" 'n': 'N',\n" | ||||
" 'o': 'O',\n" | ||||
" 'p': 'P',\n" | ||||
" 'q': 'Q',\n" | ||||
" 'r': 'R',\n" | ||||
" 's': 'S',\n" | ||||
" 't': 'T',\n" | ||||
" 'u': 'U',\n" | ||||
" 'v': 'V',\n" | ||||
" 'w': 'W',\n" | ||||
" 'x': 'X',\n" | ||||
" 'y': 'Y',\n" | ||||
" 'z': 'Z'})"), | ||||
(mp_recursive, "mappingproxy({2: {...}, 3: {2: {...}, 3: {...}}})"), | ||||
(underlying_dict, | ||||
"{2: mappingproxy({2: {...}, 3: {...}}), 3: {...}}"), | ||||
] | ||||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
madhu94
|
r24026 | |||
Min RK
|
r24372 | |||
Matthias Bussonnier
|
r26718 | # TODO : pytest.mark.parametrise once nose is gone. | ||
Eric Wieser
|
r25623 | def test_simplenamespace(): | ||
SN = types.SimpleNamespace | ||||
sn_recursive = SN() | ||||
sn_recursive.first = sn_recursive | ||||
sn_recursive.second = sn_recursive | ||||
cases = [ | ||||
(SN(), "namespace()"), | ||||
(SN(x=SN()), "namespace(x=namespace())"), | ||||
(SN(a_long_name=[SN(s=string.ascii_lowercase)]*3, a_short_name=None), | ||||
"namespace(a_long_name=[namespace(s='abcdefghijklmnopqrstuvwxyz'),\n" | ||||
" namespace(s='abcdefghijklmnopqrstuvwxyz'),\n" | ||||
" namespace(s='abcdefghijklmnopqrstuvwxyz')],\n" | ||||
" a_short_name=None)"), | ||||
(sn_recursive, "namespace(first=namespace(...), second=namespace(...))"), | ||||
] | ||||
for obj, expected in cases: | ||||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(obj) == expected | ||
Eric Wieser
|
r25623 | |||
Min RK
|
r24372 | def test_pretty_environ(): | ||
dict_repr = pretty.pretty(dict(os.environ)) | ||||
# reindent to align with 'environ' prefix | ||||
dict_indented = dict_repr.replace('\n', '\n' + (' ' * len('environ'))) | ||||
env_repr = pretty.pretty(os.environ) | ||||
Matthias Bussonnier
|
r26718 | assert env_repr == "environ" + dict_indented | ||
Min RK
|
r24372 | |||
madhu94
|
r24026 | def test_function_pretty(): | ||
"Test pretty print of function" | ||||
Thomas Kluyver
|
r24031 | # posixpath is a pure python module, its interface is consistent | ||
madhu94
|
r24026 | # across Python distributions | ||
Thomas Kluyver
|
r24031 | import posixpath | ||
Matthias Bussonnier
|
r26718 | |||
assert pretty.pretty(posixpath.join) == "<function posixpath.join(a, *p)>" | ||||
madhu94
|
r24026 | # custom function | ||
def meaning_of_life(question=None): | ||||
if question: | ||||
return 42 | ||||
return "Don't panic" | ||||
Samuel Gaist
|
r26915 | assert "meaning_of_life(question=None)" in pretty.pretty(meaning_of_life) | ||
Thomas Kluyver
|
r24108 | |||
class OrderedCounter(Counter, OrderedDict): | ||||
'Counter that remembers the order elements are first encountered' | ||||
def __repr__(self): | ||||
return '%s(%r)' % (self.__class__.__name__, OrderedDict(self)) | ||||
def __reduce__(self): | ||||
return self.__class__, (OrderedDict(self),) | ||||
Thomas Kluyver
|
r24109 | class MySet(set): # Override repr of a basic type | ||
def __repr__(self): | ||||
return 'mine' | ||||
Thomas Kluyver
|
r24108 | def test_custom_repr(): | ||
"""A custom repr should override a pretty printer for a parent type""" | ||||
oc = OrderedCounter("abracadabra") | ||||
Samuel Gaist
|
r26915 | assert "OrderedCounter(OrderedDict" in pretty.pretty(oc) | ||
Thomas Kluyver
|
r24109 | |||
Matthias Bussonnier
|
r26718 | assert pretty.pretty(MySet()) == "mine" | ||