Write .dist-info directory for local installs instead of .egg-info

Following PEP 376

@dholth, let me know if you see any obvious problems with this. Thanks!

flit/common.py

@@ -1,3 +1,4 @@
+import hashlib
 from importlib.machinery import SourceFileLoader
 from pathlib import Path
 
@@ -62,6 +63,11 @@ def parse_entry_point(ep: str):
 
     return mod, func
 
+def hash_file(path, algorithm='sha256'):
+    with Path(path).open('rb') as f:
+        h = hashlib.new(algorithm, f.read())
+    return h.hexdigest()
+
 class Metadata:
 
     home_page = None
@@ -136,3 +142,9 @@ def write_metadata_file(self, fp):
 
         if self.description is not None:
             fp.write('\n' + self.description + '\n')
+
+def make_metadata(module, ini_info):
+    md_dict = {'name': module.name, 'provides': [module.name]}
+    md_dict.update(get_info_from_module(module))
+    md_dict.update(ini_info['metadata'])
+    return Metadata(md_dict)

flit/install.py

@@ -2,6 +2,7 @@
 """
 import logging
 import os
+import csv
 import pathlib
 import shutil
 import site
@@ -50,6 +51,8 @@ def __init__(self, ini_path, user=True, symlink=False):
         self.ini_info = inifile.read_pkg_ini(ini_path)
         self.module = common.Module(self.ini_info['module'],
                                     ini_path.parent)
+        self.metadata = common.make_metadata(self.module, self.ini_info)
+
         self.user = user
         self.symlink = symlink
         self.installed_files = []
@@ -117,25 +120,40 @@ def install(self):
         self.write_dist_info(dirs['purelib'])
 
     def write_dist_info(self, site_pkgs):
-        # Record metadata about installed files to give pip a fighting chance of
-        # uninstalling it correctly.
-        module_info = common.get_info_from_module(self.module)
-        dist_name = self.ini_info['metadata'].get('name', self.module.name)
-        egg_info = pathlib.Path(site_pkgs) / '{}-{}.egg-info'.format(
-                                       dist_name, module_info['version'])
+        """Write dist-info folder, according to PEP 376"""
+        dist_info = pathlib.Path(site_pkgs) / '{}-{}.dist-info'.format(
+                                       self.metadata.name, self.metadata.version)
         try:
-            egg_info.mkdir()
+            dist_info.mkdir()
         except FileExistsError:
-            shutil.rmtree(str(egg_info))
-            egg_info.mkdir()
+            shutil.rmtree(str(dist_info))
+            dist_info.mkdir()
+
+        with (dist_info / 'METADATA').open('w', encoding='utf-8') as f:
+            self.metadata.write_metadata_file(f)
+        self.installed_files.append(dist_info / 'METADATA')
+
+        with (dist_info / 'INSTALLER').open('w') as f:
+            f.write('flit')
+        self.installed_files.append(dist_info / 'INSTALLER')
 
-        # Not sure what this is for, but it's easy to do, and perhaps it will
-        # placate the heathen gods of packaging.
-        with (egg_info / 'top_level.txt').open('w') as f:
-            f.write(self.module.name)
-        self.installed_files.append(egg_info / 'top_level.txt')
+        # We only handle explicitly requested installations
+        with (dist_info / 'REQUESTED').open('w'): pass
+        self.installed_files.append(dist_info / 'REQUESTED')
 
-        with (egg_info / 'installed-files.txt').open('w') as f:
+        with (dist_info / 'RECORD').open('w', encoding='utf-8') as f:
+            cf = csv.writer(f)
             for path in self.installed_files:
-                rel = os.path.relpath(str(path), str(egg_info))
-                f.write(rel + '\n')
+                path = pathlib.Path(path)
+                if path.is_symlink() or path.suffix in {'.pyc', '.pyo'}:
+                    hash, size = '', ''
+                else:
+                    hash = 'sha256=' + common.hash_file(path)
+                    size = path.stat().st_size
+                try:
+                    path = path.relative_to(site_pkgs)
+                except ValueError:
+                    pass
+                cf.writerow((path, hash, size))
+
+            cf.writerow(((dist_info / 'RECORD').relative_to(site_pkgs), '', ''))

flit/wheel.py

@@ -1,5 +1,4 @@
 import configparser
-import hashlib
 import logging
 import os
 import shutil
@@ -29,10 +28,7 @@ def __init__(self, ini_path, upload=None, verify_metadata=None):
         self.upload=upload
         self.verify_metadata=verify_metadata
 
-        md_dict = {'name': self.module.name, 'provides': [self.module.name]}
-        md_dict.update(common.get_info_from_module(self.module))
-        md_dict.update(self.ini_info['metadata'])
-        self.metadata = common.Metadata(md_dict)
+        self.metadata = common.make_metadata(self.module, self.ini_info)
 
         self.dist_version = self.metadata.name + '-' + self.metadata.version
         self.wheel_file = None
@@ -92,11 +88,9 @@ def write_record(self):
             for f in files:
                 relfile = os.path.join(reldir, f)
                 file = os.path.join(dirpath, f)
-                h = hashlib.sha256()
-                with open(file, 'rb') as fp:
-                    h.update(fp.read())
+                hash = common.hash_file(file)
                 size = os.stat(file).st_size
-                records.append((relfile, h.hexdigest(), size))
+                records.append((relfile, hash, size))
 
         with (self.dist_info / 'RECORD').open('w') as f:
             for path, hash, size in records:

tests/test_install.py

@@ -27,16 +27,21 @@ def tearDown(self):
     def test_install_module(self):
         Installer(samples_dir / 'module1-pkg.ini').install()
         assert_isfile(self.tmpdir / 'site-packages' / 'module1.py')
-        assert_isdir(self.tmpdir / 'site-packages' / 'module1-0.1.egg-info')
+        assert_isdir(self.tmpdir / 'site-packages' / 'module1-0.1.dist-info')
 
     def test_install_package(self):
         Installer(samples_dir / 'package1-pkg.ini').install()
         assert_isdir(self.tmpdir / 'site-packages' / 'package1')
-        assert_isdir(self.tmpdir / 'site-packages' / 'package1-0.1.egg-info')
+        assert_isdir(self.tmpdir / 'site-packages' / 'package1-0.1.dist-info')
         assert_isfile(self.tmpdir / 'scripts' / 'pkg_script')
 
     def test_symlink_package(self):
         Installer(samples_dir / 'package1-pkg.ini', symlink=True).install()
         assert_islink(self.tmpdir / 'site-packages' / 'package1',
                       to=str(samples_dir / 'package1'))
         assert_isfile(self.tmpdir / 'scripts' / 'pkg_script')
+
+    def test_dist_name(self):
+        Installer(samples_dir / 'altdistname.ini').install()
+        assert_isdir(self.tmpdir / 'site-packages' / 'package1')
+        assert_isdir(self.tmpdir / 'site-packages' / 'packagedist1-0.1.dist-info')