Python code coverage for Lib/packaging/command/install_distinfo.py

#	count	content
1	n/a	"""Create the PEP 376-compliant .dist-info directory."""
2	n/a
3	n/a	# Forked from the former install_egg_info command by Josip Djolonga
4	n/a
5	n/a	import os
6	n/a	import csv
7	n/a	import hashlib
8	n/a	from shutil import rmtree
9	n/a
10	n/a	from packaging import logger
11	n/a	from packaging.command.cmd import Command
12	n/a
13	n/a
14	n/a	class install_distinfo(Command):
15	n/a
16	n/a	description = 'create a .dist-info directory for the distribution'
17	n/a
18	n/a	user_options = [
19	n/a	('install-dir=', None,
20	n/a	"directory where the the .dist-info directory will be created"),
21	n/a	('installer=', None,
22	n/a	"the name of the installer"),
23	n/a	('requested', None,
24	n/a	"generate a REQUESTED file"),
25	n/a	('no-requested', None,
26	n/a	"do not generate a REQUESTED file"),
27	n/a	('no-record', None,
28	n/a	"do not generate a RECORD file"),
29	n/a	('no-resources', None,
30	n/a	"do not generate a RESOURCES file"),
31	n/a	]
32	n/a
33	n/a	boolean_options = ['requested', 'no-record', 'no-resources']
34	n/a
35	n/a	negative_opt = {'no-requested': 'requested'}
36	n/a
37	n/a	def initialize_options(self):
38	n/a	self.install_dir = None
39	n/a	self.installer = None
40	n/a	self.requested = None
41	n/a	self.no_record = None
42	n/a	self.no_resources = None
43	n/a	self.outfiles = []
44	n/a
45	n/a	def finalize_options(self):
46	n/a	self.set_undefined_options('install_dist',
47	n/a	'installer', 'requested', 'no_record')
48	n/a
49	n/a	self.set_undefined_options('install_lib', 'install_dir')
50	n/a
51	n/a	if self.installer is None:
52	n/a	# FIXME distutils or packaging?
53	n/a	# + document default in the option help text above and in install
54	n/a	self.installer = 'distutils'
55	n/a	if self.requested is None:
56	n/a	self.requested = True
57	n/a	if self.no_record is None:
58	n/a	self.no_record = False
59	n/a	if self.no_resources is None:
60	n/a	self.no_resources = False
61	n/a
62	n/a	metadata = self.distribution.metadata
63	n/a
64	n/a	basename = metadata.get_fullname(filesafe=True) + ".dist-info"
65	n/a
66	n/a	self.install_dir = os.path.join(self.install_dir, basename)
67	n/a
68	n/a	def run(self):
69	n/a	target = self.install_dir
70	n/a
71	n/a	if os.path.isdir(target) and not os.path.islink(target):
72	n/a	if not self.dry_run:
73	n/a	rmtree(target)
74	n/a	elif os.path.exists(target):
75	n/a	self.execute(os.unlink, (self.install_dir,),
76	n/a	"removing " + target)
77	n/a
78	n/a	self.execute(os.makedirs, (target,), "creating " + target)
79	n/a
80	n/a	metadata_path = os.path.join(self.install_dir, 'METADATA')
81	n/a	self.execute(self.distribution.metadata.write, (metadata_path,),
82	n/a	"creating " + metadata_path)
83	n/a	self.outfiles.append(metadata_path)
84	n/a
85	n/a	installer_path = os.path.join(self.install_dir, 'INSTALLER')
86	n/a	logger.info('creating %s', installer_path)
87	n/a	if not self.dry_run:
88	n/a	with open(installer_path, 'w') as f:
89	n/a	f.write(self.installer)
90	n/a	self.outfiles.append(installer_path)
91	n/a
92	n/a	if self.requested:
93	n/a	requested_path = os.path.join(self.install_dir, 'REQUESTED')
94	n/a	logger.info('creating %s', requested_path)
95	n/a	if not self.dry_run:
96	n/a	open(requested_path, 'wb').close()
97	n/a	self.outfiles.append(requested_path)
98	n/a
99	n/a	if not self.no_resources:
100	n/a	install_data = self.get_finalized_command('install_data')
101	n/a	if install_data.get_resources_out() != []:
102	n/a	resources_path = os.path.join(self.install_dir,
103	n/a	'RESOURCES')
104	n/a	logger.info('creating %s', resources_path)
105	n/a	if not self.dry_run:
106	n/a	with open(resources_path, 'w') as f:
107	n/a	writer = csv.writer(f, delimiter=',',
108	n/a	lineterminator='\n',
109	n/a	quotechar='"')
110	n/a	for row in install_data.get_resources_out():
111	n/a	writer.writerow(row)
112	n/a
113	n/a	self.outfiles.append(resources_path)
114	n/a
115	n/a	if not self.no_record:
116	n/a	record_path = os.path.join(self.install_dir, 'RECORD')
117	n/a	logger.info('creating %s', record_path)
118	n/a	if not self.dry_run:
119	n/a	with open(record_path, 'w', encoding='utf-8') as f:
120	n/a	writer = csv.writer(f, delimiter=',',
121	n/a	lineterminator='\n',
122	n/a	quotechar='"')
123	n/a
124	n/a	install = self.get_finalized_command('install_dist')
125	n/a
126	n/a	for fpath in install.get_outputs():
127	n/a	if fpath.endswith('.pyc') or fpath.endswith('.pyo'):
128	n/a	# do not put size and md5 hash, as in PEP-376
129	n/a	writer.writerow((fpath, '', ''))
130	n/a	else:
131	n/a	size = os.path.getsize(fpath)
132	n/a	with open(fpath, 'rb') as fp:
133	n/a	hash = hashlib.md5()
134	n/a	hash.update(fp.read())
135	n/a	md5sum = hash.hexdigest()
136	n/a	writer.writerow((fpath, md5sum, size))
137	n/a
138	n/a	# add the RECORD file itself
139	n/a	writer.writerow((record_path, '', ''))
140	n/a	self.outfiles.append(record_path)
141	n/a
142	n/a	def get_outputs(self):
143	n/a	return self.outfiles