summaryrefslogtreecommitdiff
path: root/Lib/packaging/command/install_distinfo.py
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/packaging/command/install_distinfo.py')
-rw-r--r--Lib/packaging/command/install_distinfo.py143
1 files changed, 143 insertions, 0 deletions
diff --git a/Lib/packaging/command/install_distinfo.py b/Lib/packaging/command/install_distinfo.py
new file mode 100644
index 0000000000..b49729f5af
--- /dev/null
+++ b/Lib/packaging/command/install_distinfo.py
@@ -0,0 +1,143 @@
+"""Create the PEP 376-compliant .dist-info directory."""
+
+# Forked from the former install_egg_info command by Josip Djolonga
+
+import os
+import csv
+import hashlib
+from shutil import rmtree
+
+from packaging import logger
+from packaging.command.cmd import Command
+
+
+class install_distinfo(Command):
+
+ description = 'create a .dist-info directory for the distribution'
+
+ user_options = [
+ ('install-dir=', None,
+ "directory where the the .dist-info directory will be created"),
+ ('installer=', None,
+ "the name of the installer"),
+ ('requested', None,
+ "generate a REQUESTED file"),
+ ('no-requested', None,
+ "do not generate a REQUESTED file"),
+ ('no-record', None,
+ "do not generate a RECORD file"),
+ ('no-resources', None,
+ "do not generate a RESOURCES file"),
+ ]
+
+ boolean_options = ['requested', 'no-record', 'no-resources']
+
+ negative_opt = {'no-requested': 'requested'}
+
+ def initialize_options(self):
+ self.install_dir = None
+ self.installer = None
+ self.requested = None
+ self.no_record = None
+ self.no_resources = None
+ self.outfiles = []
+
+ def finalize_options(self):
+ self.set_undefined_options('install_dist',
+ 'installer', 'requested', 'no_record')
+
+ self.set_undefined_options('install_lib', 'install_dir')
+
+ if self.installer is None:
+ # FIXME distutils or packaging?
+ # + document default in the option help text above and in install
+ self.installer = 'distutils'
+ if self.requested is None:
+ self.requested = True
+ if self.no_record is None:
+ self.no_record = False
+ if self.no_resources is None:
+ self.no_resources = False
+
+ metadata = self.distribution.metadata
+
+ basename = metadata.get_fullname(filesafe=True) + ".dist-info"
+
+ self.install_dir = os.path.join(self.install_dir, basename)
+
+ def run(self):
+ target = self.install_dir
+
+ if os.path.isdir(target) and not os.path.islink(target):
+ if not self.dry_run:
+ rmtree(target)
+ elif os.path.exists(target):
+ self.execute(os.unlink, (self.install_dir,),
+ "removing " + target)
+
+ self.execute(os.makedirs, (target,), "creating " + target)
+
+ metadata_path = os.path.join(self.install_dir, 'METADATA')
+ self.execute(self.distribution.metadata.write, (metadata_path,),
+ "creating " + metadata_path)
+ self.outfiles.append(metadata_path)
+
+ installer_path = os.path.join(self.install_dir, 'INSTALLER')
+ logger.info('creating %s', installer_path)
+ if not self.dry_run:
+ with open(installer_path, 'w') as f:
+ f.write(self.installer)
+ self.outfiles.append(installer_path)
+
+ if self.requested:
+ requested_path = os.path.join(self.install_dir, 'REQUESTED')
+ logger.info('creating %s', requested_path)
+ if not self.dry_run:
+ open(requested_path, 'wb').close()
+ self.outfiles.append(requested_path)
+
+ if not self.no_resources:
+ install_data = self.get_finalized_command('install_data')
+ if install_data.get_resources_out() != []:
+ resources_path = os.path.join(self.install_dir,
+ 'RESOURCES')
+ logger.info('creating %s', resources_path)
+ if not self.dry_run:
+ with open(resources_path, 'w') as f:
+ writer = csv.writer(f, delimiter=',',
+ lineterminator='\n',
+ quotechar='"')
+ for row in install_data.get_resources_out():
+ writer.writerow(row)
+
+ self.outfiles.append(resources_path)
+
+ if not self.no_record:
+ record_path = os.path.join(self.install_dir, 'RECORD')
+ logger.info('creating %s', record_path)
+ if not self.dry_run:
+ with open(record_path, 'w', encoding='utf-8') as f:
+ writer = csv.writer(f, delimiter=',',
+ lineterminator='\n',
+ quotechar='"')
+
+ install = self.get_finalized_command('install_dist')
+
+ for fpath in install.get_outputs():
+ if fpath.endswith('.pyc') or fpath.endswith('.pyo'):
+ # do not put size and md5 hash, as in PEP-376
+ writer.writerow((fpath, '', ''))
+ else:
+ size = os.path.getsize(fpath)
+ with open(fpath, 'rb') as fp:
+ hash = hashlib.md5()
+ hash.update(fp.read())
+ md5sum = hash.hexdigest()
+ writer.writerow((fpath, md5sum, size))
+
+ # add the RECORD file itself
+ writer.writerow((record_path, '', ''))
+ self.outfiles.append(record_path)
+
+ def get_outputs(self):
+ return self.outfiles