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

#	count	content
1	n/a	"""Create an executable installer for Windows."""
2	n/a
3	n/a	import sys
4	n/a	import os
5	n/a
6	n/a	from shutil import rmtree
7	n/a	from sysconfig import get_python_version
8	n/a	from packaging.command.cmd import Command
9	n/a	from packaging.errors import PackagingOptionError, PackagingPlatformError
10	n/a	from packaging import logger
11	n/a	from packaging.util import get_platform
12	n/a
13	n/a
14	n/a	class bdist_wininst(Command):
15	n/a
16	n/a	description = "create an executable installer for Windows"
17	n/a
18	n/a	user_options = [('bdist-dir=', None,
19	n/a	"temporary directory for creating the distribution"),
20	n/a	('plat-name=', 'p',
21	n/a	"platform name to embed in generated filenames "
22	n/a	"(default: %s)" % get_platform()),
23	n/a	('keep-temp', 'k',
24	n/a	"keep the pseudo-installation tree around after " +
25	n/a	"creating the distribution archive"),
26	n/a	('target-version=', None,
27	n/a	"require a specific python version" +
28	n/a	" on the target system"),
29	n/a	('no-target-compile', 'c',
30	n/a	"do not compile .py to .pyc on the target system"),
31	n/a	('no-target-optimize', 'o',
32	n/a	"do not compile .py to .pyo (optimized)"
33	n/a	"on the target system"),
34	n/a	('dist-dir=', 'd',
35	n/a	"directory to put final built distributions in"),
36	n/a	('bitmap=', 'b',
37	n/a	"bitmap to use for the installer instead of python-powered logo"),
38	n/a	('title=', 't',
39	n/a	"title to display on the installer background instead of default"),
40	n/a	('skip-build', None,
41	n/a	"skip rebuilding everything (for testing/debugging)"),
42	n/a	('install-script=', None,
43	n/a	"basename of installation script to be run after"
44	n/a	"installation or before deinstallation"),
45	n/a	('pre-install-script=', None,
46	n/a	"Fully qualified filename of a script to be run before "
47	n/a	"any files are installed. This script need not be in the "
48	n/a	"distribution"),
49	n/a	('user-access-control=', None,
50	n/a	"specify Vista's UAC handling - 'none'/default=no "
51	n/a	"handling, 'auto'=use UAC if target Python installed for "
52	n/a	"all users, 'force'=always use UAC"),
53	n/a	]
54	n/a
55	n/a	boolean_options = ['keep-temp', 'no-target-compile', 'no-target-optimize',
56	n/a	'skip-build']
57	n/a
58	n/a	def initialize_options(self):
59	n/a	self.bdist_dir = None
60	n/a	self.plat_name = None
61	n/a	self.keep_temp = False
62	n/a	self.no_target_compile = False
63	n/a	self.no_target_optimize = False
64	n/a	self.target_version = None
65	n/a	self.dist_dir = None
66	n/a	self.bitmap = None
67	n/a	self.title = None
68	n/a	self.skip_build = None
69	n/a	self.install_script = None
70	n/a	self.pre_install_script = None
71	n/a	self.user_access_control = None
72	n/a
73	n/a
74	n/a	def finalize_options(self):
75	n/a	self.set_undefined_options('bdist', 'skip_build')
76	n/a
77	n/a	if self.bdist_dir is None:
78	n/a	if self.skip_build and self.plat_name:
79	n/a	# If build is skipped and plat_name is overridden, bdist will
80	n/a	# not see the correct 'plat_name' - so set that up manually.
81	n/a	bdist = self.distribution.get_command_obj('bdist')
82	n/a	bdist.plat_name = self.plat_name
83	n/a	# next the command will be initialized using that name
84	n/a	bdist_base = self.get_finalized_command('bdist').bdist_base
85	n/a	self.bdist_dir = os.path.join(bdist_base, 'wininst')
86	n/a
87	n/a	if not self.target_version:
88	n/a	self.target_version = ""
89	n/a
90	n/a	if not self.skip_build and self.distribution.has_ext_modules():
91	n/a	short_version = get_python_version()
92	n/a	if self.target_version and self.target_version != short_version:
93	n/a	raise PackagingOptionError("target version can only be %s, or the '--skip-build'" \
94	n/a	" option must be specified" % (short_version,))
95	n/a	self.target_version = short_version
96	n/a
97	n/a	self.set_undefined_options('bdist', 'dist_dir', 'plat_name')
98	n/a
99	n/a	if self.install_script:
100	n/a	for script in self.distribution.scripts:
101	n/a	if self.install_script == os.path.basename(script):
102	n/a	break
103	n/a	else:
104	n/a	raise PackagingOptionError("install_script '%s' not found in scripts" % \
105	n/a	self.install_script)
106	n/a
107	n/a	def run(self):
108	n/a	if (sys.platform != "win32" and
109	n/a	(self.distribution.has_ext_modules() or
110	n/a	self.distribution.has_c_libraries())):
111	n/a	raise PackagingPlatformError \
112	n/a	("distribution contains extensions and/or C libraries; "
113	n/a	"must be compiled on a Windows 32 platform")
114	n/a
115	n/a	if not self.skip_build:
116	n/a	self.run_command('build')
117	n/a
118	n/a	install = self.reinitialize_command('install', reinit_subcommands=True)
119	n/a	install.root = self.bdist_dir
120	n/a	install.skip_build = self.skip_build
121	n/a	install.warn_dir = False
122	n/a	install.plat_name = self.plat_name
123	n/a
124	n/a	install_lib = self.reinitialize_command('install_lib')
125	n/a	# we do not want to include pyc or pyo files
126	n/a	install_lib.compile = False
127	n/a	install_lib.optimize = 0
128	n/a
129	n/a	if self.distribution.has_ext_modules():
130	n/a	# If we are building an installer for a Python version other
131	n/a	# than the one we are currently running, then we need to ensure
132	n/a	# our build_lib reflects the other Python version rather than ours.
133	n/a	# Note that for target_version!=sys.version, we must have skipped the
134	n/a	# build step, so there is no issue with enforcing the build of this
135	n/a	# version.
136	n/a	target_version = self.target_version
137	n/a	if not target_version:
138	n/a	assert self.skip_build, "Should have already checked this"
139	n/a	target_version = '%s.%s' % sys.version_info[:2]
140	n/a	plat_specifier = ".%s-%s" % (self.plat_name, target_version)
141	n/a	build = self.get_finalized_command('build')
142	n/a	build.build_lib = os.path.join(build.build_base,
143	n/a	'lib' + plat_specifier)
144	n/a
145	n/a	# Use a custom scheme for the zip-file, because we have to decide
146	n/a	# at installation time which scheme to use.
147	n/a	for key in ('purelib', 'platlib', 'headers', 'scripts', 'data'):
148	n/a	value = key.upper()
149	n/a	if key == 'headers':
150	n/a	value = value + '/Include/$dist_name'
151	n/a	setattr(install,
152	n/a	'install_' + key,
153	n/a	value)
154	n/a
155	n/a	logger.info("installing to %s", self.bdist_dir)
156	n/a	install.ensure_finalized()
157	n/a
158	n/a	# avoid warning of 'install_lib' about installing
159	n/a	# into a directory not in sys.path
160	n/a	sys.path.insert(0, os.path.join(self.bdist_dir, 'PURELIB'))
161	n/a
162	n/a	install.run()
163	n/a
164	n/a	del sys.path[0]
165	n/a
166	n/a	# And make an archive relative to the root of the
167	n/a	# pseudo-installation tree.
168	n/a	from tempfile import NamedTemporaryFile
169	n/a	archive_basename = NamedTemporaryFile().name
170	n/a	fullname = self.distribution.get_fullname()
171	n/a	arcname = self.make_archive(archive_basename, "zip",
172	n/a	root_dir=self.bdist_dir)
173	n/a	# create an exe containing the zip-file
174	n/a	self.create_exe(arcname, fullname, self.bitmap)
175	n/a	if self.distribution.has_ext_modules():
176	n/a	pyversion = get_python_version()
177	n/a	else:
178	n/a	pyversion = 'any'
179	n/a	self.distribution.dist_files.append(('bdist_wininst', pyversion,
180	n/a	self.get_installer_filename(fullname)))
181	n/a	# remove the zip-file again
182	n/a	logger.debug("removing temporary file '%s'", arcname)
183	n/a	os.remove(arcname)
184	n/a
185	n/a	if not self.keep_temp:
186	n/a	logger.info('removing %s', self.bdist_dir)
187	n/a	if not self.dry_run:
188	n/a	rmtree(self.bdist_dir)
189	n/a
190	n/a	def get_inidata(self):
191	n/a	# Return data describing the installation.
192	n/a
193	n/a	lines = []
194	n/a	metadata = self.distribution.metadata
195	n/a
196	n/a	# Write the [metadata] section.
197	n/a	lines.append("[metadata]")
198	n/a
199	n/a	# 'info' will be displayed in the installer's dialog box,
200	n/a	# describing the items to be installed.
201	n/a	info = (metadata.long_description or '') + '\n'
202	n/a
203	n/a	# Escape newline characters
204	n/a	def escape(s):
205	n/a	return s.replace("\n", "\\n")
206	n/a
207	n/a	for name in ["author", "author_email", "description", "maintainer",
208	n/a	"maintainer_email", "name", "url", "version"]:
209	n/a	data = getattr(metadata, name, "")
210	n/a	if data:
211	n/a	info = info + ("\n %s: %s" % \
212	n/a	(name.capitalize(), escape(data)))
213	n/a	lines.append("%s=%s" % (name, escape(data)))
214	n/a
215	n/a	# The [setup] section contains entries controlling
216	n/a	# the installer runtime.
217	n/a	lines.append("\n[Setup]")
218	n/a	if self.install_script:
219	n/a	lines.append("install_script=%s" % self.install_script)
220	n/a	lines.append("info=%s" % escape(info))
221	n/a	lines.append("target_compile=%d" % (not self.no_target_compile))
222	n/a	lines.append("target_optimize=%d" % (not self.no_target_optimize))
223	n/a	if self.target_version:
224	n/a	lines.append("target_version=%s" % self.target_version)
225	n/a	if self.user_access_control:
226	n/a	lines.append("user_access_control=%s" % self.user_access_control)
227	n/a
228	n/a	title = self.title or self.distribution.get_fullname()
229	n/a	lines.append("title=%s" % escape(title))
230	n/a	import time
231	n/a	import packaging
232	n/a	build_info = "Built %s with packaging-%s" % \
233	n/a	(time.ctime(time.time()), packaging.__version__)
234	n/a	lines.append("build_info=%s" % build_info)
235	n/a	return "\n".join(lines)
236	n/a
237	n/a	def create_exe(self, arcname, fullname, bitmap=None):
238	n/a	import struct
239	n/a
240	n/a	self.mkpath(self.dist_dir)
241	n/a
242	n/a	cfgdata = self.get_inidata()
243	n/a
244	n/a	installer_name = self.get_installer_filename(fullname)
245	n/a	logger.info("creating %s", installer_name)
246	n/a
247	n/a	if bitmap:
248	n/a	with open(bitmap, "rb") as fp:
249	n/a	bitmapdata = fp.read()
250	n/a	bitmaplen = len(bitmapdata)
251	n/a	else:
252	n/a	bitmaplen = 0
253	n/a
254	n/a	with open(installer_name, "wb") as file:
255	n/a	file.write(self.get_exe_bytes())
256	n/a	if bitmap:
257	n/a	file.write(bitmapdata)
258	n/a
259	n/a	# Convert cfgdata from unicode to ascii, mbcs encoded
260	n/a	if isinstance(cfgdata, str):
261	n/a	cfgdata = cfgdata.encode("mbcs")
262	n/a
263	n/a	# Append the pre-install script
264	n/a	cfgdata = cfgdata + b"\0"
265	n/a	if self.pre_install_script:
266	n/a	# We need to normalize newlines, so we open in text mode and
267	n/a	# convert back to bytes. "latin-1" simply avoids any possible
268	n/a	# failures.
269	n/a	with open(self.pre_install_script, encoding="latin-1") as fp:
270	n/a	script_data = fp.read().encode("latin-1")
271	n/a	cfgdata = cfgdata + script_data + b"\n\0"
272	n/a	else:
273	n/a	# empty pre-install script
274	n/a	cfgdata = cfgdata + b"\0"
275	n/a	file.write(cfgdata)
276	n/a
277	n/a	# The 'magic number' 0x1234567B is used to make sure that the
278	n/a	# binary layout of 'cfgdata' is what the wininst.exe binary
279	n/a	# expects. If the layout changes, increment that number, make
280	n/a	# the corresponding changes to the wininst.exe sources, and
281	n/a	# recompile them.
282	n/a	header = struct.pack("<iii",
283	n/a	0x1234567B, # tag
284	n/a	len(cfgdata), # length
285	n/a	bitmaplen, # number of bytes in bitmap
286	n/a	)
287	n/a	file.write(header)
288	n/a	with open(arcname, "rb") as fp:
289	n/a	file.write(fp.read())
290	n/a
291	n/a	def get_installer_filename(self, fullname):
292	n/a	# Factored out to allow overriding in subclasses
293	n/a	if self.target_version:
294	n/a	# if we create an installer for a specific python version,
295	n/a	# it's better to include this in the name
296	n/a	installer_name = os.path.join(self.dist_dir,
297	n/a	"%s.%s-py%s.exe" %
298	n/a	(fullname, self.plat_name, self.target_version))
299	n/a	else:
300	n/a	installer_name = os.path.join(self.dist_dir,
301	n/a	"%s.%s.exe" % (fullname, self.plat_name))
302	n/a	return installer_name
303	n/a
304	n/a	def get_exe_bytes(self):
305	n/a	from packaging.compiler.msvccompiler import get_build_version
306	n/a	# If a target-version other than the current version has been
307	n/a	# specified, then using the MSVC version from this build is no good.
308	n/a	# Without actually finding and executing the target version and parsing
309	n/a	# its sys.version, we just hard-code our knowledge of old versions.
310	n/a	# NOTE: Possible alternative is to allow "--target-version" to
311	n/a	# specify a Python executable rather than a simple version string.
312	n/a	# We can then execute this program to obtain any info we need, such
313	n/a	# as the real sys.version string for the build.
314	n/a	cur_version = get_python_version()
315	n/a	if self.target_version and self.target_version != cur_version:
316	n/a	# If the target version is later than us, then we assume they
317	n/a	# use what we use
318	n/a	# string compares seem wrong, but are what sysconfig.py itself uses
319	n/a	if self.target_version > cur_version:
320	n/a	bv = get_build_version()
321	n/a	else:
322	n/a	if self.target_version < "2.4":
323	n/a	bv = 6.0
324	n/a	else:
325	n/a	bv = 7.1
326	n/a	else:
327	n/a	# for current version - use authoritative check.
328	n/a	bv = get_build_version()
329	n/a
330	n/a	# wininst-x.y.exe is in the same directory as this file
331	n/a	directory = os.path.dirname(__file__)
332	n/a	# we must use a wininst-x.y.exe built with the same C compiler
333	n/a	# used for python. XXX What about mingw, borland, and so on?
334	n/a
335	n/a	# if plat_name starts with "win" but is not "win32"
336	n/a	# we want to strip "win" and leave the rest (e.g. -amd64)
337	n/a	# for all other cases, we don't want any suffix
338	n/a	if self.plat_name != 'win32' and self.plat_name[:3] == 'win':
339	n/a	sfix = self.plat_name[3:]
340	n/a	else:
341	n/a	sfix = ''
342	n/a
343	n/a	filename = os.path.join(directory, "wininst-%.1f%s.exe" % (bv, sfix))
344	n/a	with open(filename, "rb") as fp:
345	n/a	return fp.read()