Merge branch 'bugfix/97-entry-point-repr' into 'master'

jaraco · jaraco · commit 031c7f0e4994 · 2019-12-01T15:53:13.000Z
Fix EntryPoint.__repr__ on PyPy 2 Closes #97 See merge request python-devs/importlib_metadata!100
diff --git a/importlib_metadata/__init__.py b/importlib_metadata/__init__.py
@@ -27,6 +27,7 @@
     ModuleNotFoundError,
     MetaPathFinder,
     email_message_from_string,
+    PyPy_repr,
     )
 from importlib import import_module
 from itertools import starmap
@@ -53,7 +54,9 @@ class PackageNotFoundError(ModuleNotFoundError):
     """The package was not found."""
 
 
-class EntryPoint(collections.namedtuple('EntryPointBase', 'name value group')):
+class EntryPoint(
+        PyPy_repr,
+        collections.namedtuple('EntryPointBase', 'name value group')):
     """An entry point as defined by Python packaging conventions.
 
     See `the packaging docs on entry points
diff --git a/importlib_metadata/_compat.py b/importlib_metadata/_compat.py
@@ -113,3 +113,25 @@ def py2_message_from_string(text):  # nocoverpy3
 
 # https://bitbucket.org/pypy/pypy/issues/3021/ioopen-directory-leaks-a-file-descriptor
 PYPY_OPEN_BUG = getattr(sys, 'pypy_version_info', (9, 9, 9))[:3] <= (7, 1, 1)
+
+
+class PyPy_repr:
+    """
+    Override repr for EntryPoint objects on PyPy2 to avoid __iter__ access.
+    Ref #97.
+    """
+    affected = (
+        hasattr(sys, 'pypy_version_info') and
+        sys.version_info < (3,)
+        )
+
+    def __compat_repr__(self):  # pragma: nocover
+        def make_param(name):
+            value = getattr(self, name)
+            return '{name}={value!r}'.format(**locals())
+        params = ', '.join(map(make_param, self._fields))
+        return 'EntryPoint({params})'.format(**locals())
+
+    if affected:  # pragma: nocover
+        __repr__ = __compat_repr__
+    del affected
diff --git a/importlib_metadata/docs/changelog.rst b/importlib_metadata/docs/changelog.rst
@@ -7,6 +7,7 @@ v1.1.0
 
 * Dropped support for Python 3.4.
 * EntryPoints are now pickleable. Closes #96.
+* Fixed ``repr(EntryPoint)`` on PyPy 2. Closes #97.
 
 v1.0.0
 ======
diff --git a/importlib_metadata/tests/test_main.py b/importlib_metadata/tests/test_main.py
@@ -2,6 +2,7 @@
 from __future__ import unicode_literals
 
 import re
+import json
 import pickle
 import textwrap
 import unittest
@@ -193,7 +194,31 @@ def test_egg(self):
 
 
 class TestEntryPoints(unittest.TestCase):
+    def __init__(self, *args):
+        super(TestEntryPoints, self).__init__(*args)
+        self.ep = importlib_metadata.EntryPoint('name', 'value', 'group')
+
     def test_entry_point_pickleable(self):
-        ep = importlib_metadata.EntryPoint('name', 'value', 'group')
-        revived = pickle.loads(pickle.dumps(ep))
-        assert revived == ep
+        revived = pickle.loads(pickle.dumps(self.ep))
+        assert revived == self.ep
+
+    def test_immutable(self):
+        """EntryPoints should be immutable"""
+        with self.assertRaises(AttributeError):
+            self.ep.name = 'badactor'
+
+    def test_repr(self):
+        assert 'EntryPoint' in repr(self.ep)
+        assert 'name=' in repr(self.ep)
+        assert "'name'" in repr(self.ep)
+
+    def test_hashable(self):
+        """EntryPoints should be hashable"""
+        hash(self.ep)
+
+    def test_json_dump(self):
+        """
+        json should not expect to be able to dump an EntryPoint
+        """
+        with self.assertRaises(Exception):
+            json.dumps(self.ep)
