Merge branch 'egginfo-files' into 'master'

Support egg-info files

Closes #43

See merge request python-devs/importlib_metadata!57

Author: warsaw

importlib_metadata/_hooks.py

@@ -18,6 +18,7 @@
     from pathlib2 import Path
 
     FileNotFoundError = IOError, OSError
+    NotADirectoryError = IOError, OSError
     __metaclass__ = type
 
 
@@ -45,14 +46,12 @@ def find_spec(*args, **kwargs):
     find_module = find_spec
 
 
-@install
-class MetadataPathFinder(NullFinder):
+class MetadataPathBaseFinder(NullFinder):
     """A degenerate finder for distribution packages on the file system.
 
     This finder supplies only a find_distributions() method for versions
     of Python that do not have a PathFinder find_distributions().
     """
-    search_template = r'{pattern}(-.*)?\.(dist|egg)-info'
 
     def find_distributions(self, name=None, path=None):
         """Return an iterable of all Distribution instances capable of
@@ -76,21 +75,34 @@ def _search_paths(cls, pattern, paths):
             for path in map(Path, paths)
             )
 
+    @classmethod
+    def _predicate(cls, pattern, root, item):
+        return re.match(pattern, str(item.name), flags=re.IGNORECASE)
+
     @classmethod
     def _search_path(cls, root, pattern):
         if not root.is_dir():
             return ()
         normalized = pattern.replace('-', '_')
+        matcher = cls.search_template.format(pattern=normalized)
+        return (item for item in root.iterdir()
+                if cls._predicate(matcher, root, item))
+
+
+@install
+class MetadataPathFinder(MetadataPathBaseFinder):
+    search_template = r'{pattern}(-.*)?\.(dist|egg)-info'
+
+
+@install
+class MetadataPathEggInfoFileFinder(MetadataPathBaseFinder):
+    search_template = r'{pattern}(-.*)?\.egg-info'
+
+    @classmethod
+    def _predicate(cls, pattern, root, item):
         return (
-            item
-            for item in root.iterdir()
-            if item.is_dir()
-            and re.match(
-                cls.search_template.format(pattern=normalized),
-                str(item.name),
-                flags=re.IGNORECASE,
-                )
-            )
+            (root / item).is_file() and
+            re.match(pattern, str(item.name), flags=re.IGNORECASE))
 
 
 class PathDistribution(Distribution):
@@ -99,7 +111,7 @@ def __init__(self, path):
         self._path = path
 
     def read_text(self, filename):
-        with suppress(FileNotFoundError):
+        with suppress(FileNotFoundError, NotADirectoryError):
             with self._path.joinpath(filename).open(encoding='utf-8') as fp:
                 return fp.read()
         return None

importlib_metadata/api.py

@@ -195,7 +195,14 @@ def metadata(self):
         The returned object will have keys that name the various bits of
         metadata.  See PEP 566 for details.
         """
-        text = self.read_text('METADATA') or self.read_text('PKG-INFO')
+        text = (
+            self.read_text('METADATA')
+            or self.read_text('PKG-INFO')
+            # This last clause is here to support old egg-info files.  Its
+            # effect is to just end up using the PathDistribution's self._path
+            # (which points to the egg-info file) attribute unchanged.
+            or self.read_text('')
+            )
         return _email_message_from_string(text)
 
     @property
@@ -246,7 +253,7 @@ def _read_dist_info_reqs(self):
 
     def _read_egg_info_reqs(self):
         source = self.read_text('requires.txt')
-        return self._deps_from_requires_text(source)
+        return source and self._deps_from_requires_text(source)
 
     @classmethod
     def _deps_from_requires_text(cls, source):

importlib_metadata/tests/fixtures.py

@@ -127,6 +127,27 @@ def setUp(self):
         build_files(EggInfoPkg.files, prefix=self.site_dir)
 
 
+class EggInfoFile(SiteDir):
+    files = {
+        "egginfo_file.egg-info": """
+            Metadata-Version: 1.0
+            Name: egginfo_file
+            Version: 0.1
+            Summary: An example package
+            Home-page: www.example.com
+            Author: Eric Haffa-Vee
+            Author-email: [email protected]
+            License: UNKNOWN
+            Description: UNKNOWN
+            Platform: UNKNOWN
+            """,
+        }
+
+    def setUp(self):
+        super(EggInfoFile, self).setUp()
+        build_files(EggInfoFile.files, prefix=self.site_dir)
+
+
 class LocalPackage:
     def setUp(self):
         self.fixtures = ExitStack()
@@ -136,15 +157,15 @@ def setUp(self):
 
 
 def build_files(file_defs, prefix=pathlib.Path()):
-    """
-    Build a set of files/directories, as described by the
-    file_defs dictionary.
-    Each key/value pair in the dictionary is interpreted as
-    a filename/contents
-    pair. If the contents value is a dictionary, a directory
-    is created, and the
-    dictionary interpreted as the files within it, recursively.
+    """Build a set of files/directories, as described by the
+
+    file_defs dictionary.  Each key/value pair in the dictionary is
+    interpreted as a filename/contents pair.  If the contents value is a
+    dictionary, a directory is created, and the dictionary interpreted
+    as the files within it, recursively.
+
     For example:
+
     {"README.txt": "A README file",
      "foo": {
         "__init__.py": "",

importlib_metadata/tests/test_api.py

@@ -16,7 +16,12 @@
     from __builtin__ import unicode as text
 
 
-class APITests(fixtures.EggInfoPkg, fixtures.DistInfoPkg, unittest.TestCase):
+class APITests(
+        fixtures.EggInfoPkg,
+        fixtures.DistInfoPkg,
+        fixtures.EggInfoFile,
+        unittest.TestCase):
+
     version_pattern = r'\d+\.\d+(\.\d)?'
 
     def test_retrieves_version_of_self(self):
@@ -100,6 +105,14 @@ def test_files_dist_info(self):
     def test_files_egg_info(self):
         self._test_files(importlib_metadata.files('egginfo-pkg'))
 
+    def test_version_egg_info_file(self):
+        version = importlib_metadata.version('egginfo-file')
+        self.assertEqual(version, '0.1')
+
+    def test_requires_egg_info_file(self):
+        requirements = importlib_metadata.requires('egginfo-file')
+        self.assertIsNone(requirements)
+
     def test_requires(self):
         deps = importlib_metadata.requires('egginfo-pkg')
         assert any(

tox.ini

@@ -10,7 +10,7 @@ skip_missing_interpreters = True
 install_command =
     python -c 'import subprocess, sys; pip_inst_cmd = sys.executable, "-m", "pip", "install"; subprocess.check_call(pip_inst_cmd + ("pip<19.1", )); subprocess.check_call(pip_inst_cmd + tuple(sys.argv[1:]))' {opts} {packages}
 commands =
-    nocov: python -m unittest discover
+    nocov: python -m unittest discover {posargs}
     cov,diffcov: python -m coverage run {[coverage]rc} -m unittest discover {posargs}
     cov,diffcov: python -m coverage combine {[coverage]rc}
     cov: python -m coverage html {[coverage]rc}