Skip to content

Commit 129600d

Browse files
committed
saferepr: Avoid indirect function calls
The DRY savings they provide are rather small, while they make it harder to type-check, and IMO harder to understand.
1 parent c7aacc9 commit 129600d

File tree

3 files changed

+42
-23
lines changed

3 files changed

+42
-23
lines changed

changelog/5603.trivial.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Simplified internal ``SafeRepr`` class and removed some dead code.

src/_pytest/_io/saferepr.py

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@
22
import reprlib
33

44

5-
def _call_and_format_exception(call, x, *args):
5+
def _format_repr_exception(exc, obj):
6+
exc_name = type(exc).__name__
67
try:
7-
# Try the vanilla repr and make sure that the result is a string
8-
return call(x, *args)
9-
except Exception as exc:
10-
exc_name = type(exc).__name__
11-
try:
12-
exc_info = str(exc)
13-
except Exception:
14-
exc_info = "unknown"
15-
return '<[{}("{}") raised in repr()] {} object at 0x{:x}>'.format(
16-
exc_name, exc_info, x.__class__.__name__, id(x)
17-
)
8+
exc_info = str(exc)
9+
except Exception:
10+
exc_info = "unknown"
11+
return '<[{}("{}") raised in repr()] {} object at 0x{:x}>'.format(
12+
exc_name, exc_info, obj.__class__.__name__, id(obj)
13+
)
14+
15+
16+
def _ellipsize(s, maxsize):
17+
if len(s) > maxsize:
18+
i = max(0, (maxsize - 3) // 2)
19+
j = max(0, maxsize - 3 - i)
20+
return s[:i] + "..." + s[len(s) - j :]
21+
return s
1822

1923

2024
class SafeRepr(reprlib.Repr):
@@ -28,26 +32,29 @@ def __init__(self, maxsize):
2832
self.maxsize = maxsize
2933

3034
def repr(self, x):
31-
return self._callhelper(reprlib.Repr.repr, self, x)
35+
try:
36+
s = super().repr(x)
37+
except Exception as exc:
38+
s = _format_repr_exception(exc, x)
39+
return _ellipsize(s, self.maxsize)
3240

3341
def repr_instance(self, x, level):
34-
return self._callhelper(repr, x)
35-
36-
def _callhelper(self, call, x, *args):
37-
s = _call_and_format_exception(call, x, *args)
38-
if len(s) > self.maxsize:
39-
i = max(0, (self.maxsize - 3) // 2)
40-
j = max(0, self.maxsize - 3 - i)
41-
s = s[:i] + "..." + s[len(s) - j :]
42-
return s
42+
try:
43+
s = repr(x)
44+
except Exception as exc:
45+
s = _format_repr_exception(exc, x)
46+
return _ellipsize(s, self.maxsize)
4347

4448

4549
def safeformat(obj):
4650
"""return a pretty printed string for the given object.
4751
Failing __repr__ functions of user instances will be represented
4852
with a short exception info.
4953
"""
50-
return _call_and_format_exception(pprint.pformat, obj)
54+
try:
55+
return pprint.pformat(obj)
56+
except Exception as exc:
57+
return _format_repr_exception(exc, obj)
5158

5259

5360
def saferepr(obj, maxsize=240):

testing/io/test_saferepr.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,17 @@ class BrokenReprException(Exception):
4545
assert "unknown" in s2
4646

4747

48+
def test_buggy_builtin_repr():
49+
# Simulate a case where a repr for a builtin raises.
50+
# reprlib dispatches by type name, so use "int".
51+
52+
class int:
53+
def __repr__(self):
54+
raise ValueError("Buggy repr!")
55+
56+
assert "Buggy" in saferepr(int())
57+
58+
4859
def test_big_repr():
4960
from _pytest._io.saferepr import SafeRepr
5061

0 commit comments

Comments
 (0)