Skip to content

Define __repr__, not __str__ for transforms. #11173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Define __repr__, not __str__ for transforms. #11173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions lib/matplotlib/projections/polar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def __init__(self, axis=None, use_rmin=True,
self._use_rmin = use_rmin
self._apply_theta_transforms = _apply_theta_transforms

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
" use_rmin={},\n"
Expand Down Expand Up @@ -100,7 +100,7 @@ def __init__(self, scale_transform, limits):
self.set_children(scale_transform, limits)
self._mtx = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -138,7 +138,7 @@ def __init__(self, axis=None, use_rmin=True,
self._use_rmin = use_rmin
self._apply_theta_transforms = _apply_theta_transforms

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
" use_rmin={},\n"
Expand Down Expand Up @@ -483,7 +483,7 @@ def __init__(self, axes, pad, mode):
self.mode = mode
self.pad = pad

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{},\n"
Expand Down Expand Up @@ -778,7 +778,7 @@ def __init__(self, center, viewLim, originLim, **kwargs):
self._originLim = originLim
self.set_children(viewLim, originLim)

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{},\n"
Expand Down
8 changes: 4 additions & 4 deletions lib/matplotlib/scale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def transform_non_affine(self, a):
out[a <= 0] = -1000
return out

def __str__(self):
def __repr__(self):
return "{}({!r})".format(
type(self).__name__, "clip" if self._clip else "mask")

Expand All @@ -124,7 +124,7 @@ class InvertedLogTransformBase(Transform):
def transform_non_affine(self, a):
return ma.power(self.base, a)

def __str__(self):
def __repr__(self):
return "{}()".format(type(self).__name__)


Expand Down Expand Up @@ -470,7 +470,7 @@ def transform_non_affine(self, a):
def inverted(self):
return LogisticTransform(self._nonpos)

def __str__(self):
def __repr__(self):
return "{}({!r})".format(type(self).__name__,
"clip" if self._clip else "mask")

Expand All @@ -492,7 +492,7 @@ def transform_non_affine(self, a):
def inverted(self):
return LogitTransform(self._nonpos)

def __str__(self):
def __repr__(self):
return "{}({!r})".format(type(self).__name__, self._nonpos)


Expand Down
7 changes: 5 additions & 2 deletions lib/matplotlib/tests/test_scale.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,15 @@ def test_logscale_invert_transform():
assert isinstance(Log10Transform().inverted(), InvertedLog10Transform)


def test_logscale_transform_repr():
@pytest.mark.parametrize('scale', ['log', 'symlog'])
def test_scale_transform_repr_1(scale):
# check that repr of log transform succeeds
fig, ax = plt.subplots()
ax.set_yscale('log')
ax.set_yscale(scale)
s = repr(ax.transData)


def test_scale_transform_repr_2():
# check that repr of log transform returns correct string
s = repr(Log10Transform(nonpos='clip'))
assert s == "Log10Transform({!r})".format('clip')
Expand Down
35 changes: 14 additions & 21 deletions lib/matplotlib/transforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def __init__(self, shorthand_name=None):
self._shorthand_name = shorthand_name or ''

if DEBUG:
def __str__(self):
def __repr__(self):
# either just return the name of this TransformNode, or its repr
return self._shorthand_name or repr(self)

Expand Down Expand Up @@ -1045,16 +1045,14 @@ def __init__(self, bbox, transform, **kwargs):
self.set_children(bbox, transform)
self._points = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
.format(type(self).__name__,
_indent_str(self._bbox),
_indent_str(self._transform)))

__repr__ = __str__

def get_points(self):
if self._invalid:
p = self._bbox.get_points()
Expand Down Expand Up @@ -1132,16 +1130,14 @@ def __init__(self, bbox, x0=None, y0=None, x1=None, y1=None, **kwargs):
mask = [val is None for val in fp]
self._locked_points = np.ma.array(fp, float, mask=mask).reshape((2, 2))

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
.format(type(self).__name__,
_indent_str(self._bbox),
_indent_str(self._locked_points)))

__repr__ = __str__

def get_points(self):
if self._invalid:
points = self._bbox.get_points()
Expand Down Expand Up @@ -1621,9 +1617,6 @@ def inverted(self):
"""
raise NotImplementedError()

def __repr__(self):
return str(self)


class TransformWrapper(Transform):
"""
Expand Down Expand Up @@ -1662,7 +1655,7 @@ def _init(self, child):
def __eq__(self, other):
return self._child.__eq__(other)

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{})"
.format(type(self).__name__,
Expand Down Expand Up @@ -1891,7 +1884,7 @@ def __init__(self, matrix=None, **kwargs):
self._mtx = matrix
self._invalid = 0

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{})"
.format(type(self).__name__,
Expand Down Expand Up @@ -2099,7 +2092,7 @@ def frozen(self):
return self
frozen.__doc__ = Affine2DBase.frozen.__doc__

def __str__(self):
def __repr__(self):
return ("{}()"
.format(type(self).__name__))

Expand Down Expand Up @@ -2200,7 +2193,7 @@ def frozen(self):
return blended_transform_factory(self._x.frozen(), self._y.frozen())
frozen.__doc__ = Transform.frozen.__doc__

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -2309,7 +2302,7 @@ def contains_branch_seperately(self, transform):
# Note, this is an exact copy of BlendedTransform.contains_branch_seperately
return self._x.contains_branch(transform), self._y.contains_branch(transform)

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -2429,7 +2422,7 @@ def _get_is_separable(self):
return self._a.is_separable and self._b.is_separable
is_separable = property(_get_is_separable)

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -2521,7 +2514,7 @@ def _iter_break_from_left_to_right(self):
for left, right in self._b._iter_break_from_left_to_right():
yield self._a + left, right

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -2589,7 +2582,7 @@ def __init__(self, boxin, boxout, **kwargs):
self._mtx = None
self._inverted = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{},\n"
"{})"
Expand Down Expand Up @@ -2637,7 +2630,7 @@ def __init__(self, boxout, **kwargs):
self._mtx = None
self._inverted = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{})"
.format(type(self).__name__,
Expand Down Expand Up @@ -2696,7 +2689,7 @@ def __init__(self, boxin, **kwargs):
self._mtx = None
self._inverted = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{})"
.format(type(self).__name__,
Expand Down Expand Up @@ -2732,7 +2725,7 @@ def __init__(self, xt, yt, scale_trans, **kwargs):
self._mtx = None
self._inverted = None

def __str__(self):
def __repr__(self):
return ("{}(\n"
"{})"
.format(type(self).__name__,
Expand Down