Skip to content

Issue with iterability of axes arguments [backport to 1.4.x] #3196

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

Merged
mdboom merged 3 commits into from
Dec 3, 2014
Merged

Issue with iterability of axes arguments [backport to 1.4.x] #3196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dab0fcf
Fixes a bug that caused the use of _as_mpl_axes to crash if one of th…
astrofrog Nov 26, 2014
0b0e311
PEP8 fixes
astrofrog Nov 26, 2014
9f2b532
Call to iterable(v) is redundant - can just try and convert to a tupl…
astrofrog Nov 27, 2014
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
8 changes: 7 additions & 1 deletion lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,8 +785,14 @@ def fixitems(items):
# to tuples for the key
ret = []
for k, v in items:
if iterable(v):
# some objects can define __getitem__ without being
# iterable and in those cases the conversion to tuples
# will fail. So instead of using the iterable(v) function
# we simply try and convert to a tuple, and proceed if not.
try:
v = tuple(v)
except Exception:
pass
ret.append((k, v))
return tuple(ret)

Expand Down
31 changes: 31 additions & 0 deletions lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

from nose.tools import assert_equal, assert_true, assert_raises
from matplotlib.testing.decorators import image_comparison, cleanup
from matplotlib.axes import Axes
import matplotlib.pyplot as plt


Expand Down Expand Up @@ -110,6 +111,36 @@ def test_too_many_figures():
assert len(w) == 1


def test_iterability_axes_argument():

# This is a regression test for matplotlib/matplotlib#3196. If one of the
# arguments returned by _as_mpl_axes defines __getitem__ but is not
# iterable, this would raise an execption. This is because we check
# whether the arguments are iterable, and if so we try and convert them
# to a tuple. However, the ``iterable`` function returns True if
# __getitem__ is present, but some classes can define __getitem__ without
# being iterable. The tuple conversion is now done in a try...except in
# case it fails.

class MyAxes(Axes):
def __init__(self, *args, **kwargs):
kwargs.pop('myclass', None)
return Axes.__init__(self, *args, **kwargs)

class MyClass(object):

def __getitem__(self, item):
if item != 'a':
raise ValueError("item should be a")

def _as_mpl_axes(self):
return MyAxes, {'myclass': self}

fig = plt.figure()
ax = fig.add_subplot(1, 1, 1, projection=MyClass())
plt.close(fig)


if __name__ == "__main__":
import nose
nose.runmodule(argv=['-s', '--with-doctest'], exit=False)