Python code coverage: Lib/packaging/command/bdist

#	count	content
1	n/a	"""Create a Microsoft Installer (.msi) binary distribution."""
2	n/a
3	n/a	# Copyright (C) 2005, 2006 Martin von LÃ¶wis
4	n/a	# Licensed to PSF under a Contributor Agreement.
5	n/a
6	n/a	import sys
7	n/a	import os
8	n/a	import msilib
9	n/a
10	n/a	from shutil import rmtree
11	n/a	from sysconfig import get_python_version
12	n/a	from packaging.command.cmd import Command
13	n/a	from packaging.version import NormalizedVersion
14	n/a	from packaging.errors import PackagingOptionError
15	n/a	from packaging import logger as log
16	n/a	from packaging.util import get_platform
17	n/a	from msilib import schema, sequence, text
18	n/a	from msilib import Directory, Feature, Dialog, add_data
19	n/a
20	n/a	class MSIVersion(NormalizedVersion):
21	n/a	"""
22	n/a	MSI ProductVersion must be strictly numeric.
23	n/a	MSIVersion disallows prerelease and postrelease versions.
24	n/a	"""
25	n/a	def __init__(self, args, *kwargs):
26	n/a	super(MSIVersion, self).__init__(args, *kwargs)
27	n/a	if not self.is_final:
28	n/a	raise ValueError("ProductVersion must be strictly numeric")
29	n/a
30	n/a	class PyDialog(Dialog):
31	n/a	"""Dialog class with a fixed layout: controls at the top, then a ruler,
32	n/a	then a list of buttons: back, next, cancel. Optionally a bitmap at the
33	n/a	left."""
34	n/a	def __init__(self, args, *kw):
35	n/a	"""Dialog(database, name, x, y, w, h, attributes, title, first,
36	n/a	default, cancel, bitmap=true)"""
37	n/a	super(PyDialog, self).__init__(*args)
38	n/a	ruler = self.h - 36
39	n/a	#if kw.get("bitmap", True):
40	n/a	# self.bitmap("Bitmap", 0, 0, bmwidth, ruler, "PythonWin")
41	n/a	self.line("BottomLine", 0, ruler, self.w, 0)
42	n/a
43	n/a	def title(self, title):
44	n/a	"Set the title text of the dialog at the top."
45	n/a	# name, x, y, w, h, flags=Visible\|Enabled\|Transparent\|NoPrefix,
46	n/a	# text, in VerdanaBold10
47	n/a	self.text("Title", 15, 10, 320, 60, 0x30003,
48	n/a	r"{\VerdanaBold10}%s" % title)
49	n/a
50	n/a	def back(self, title, next, name = "Back", active = 1):
51	n/a	"""Add a back button with a given title, the tab-next button,
52	n/a	its name in the Control table, possibly initially disabled.
53	n/a
54	n/a	Return the button, so that events can be associated"""
55	n/a	if active:
56	n/a	flags = 3 # Visible\|Enabled
57	n/a	else:
58	n/a	flags = 1 # Visible
59	n/a	return self.pushbutton(name, 180, self.h-27 , 56, 17, flags, title, next)
60	n/a
61	n/a	def cancel(self, title, next, name = "Cancel", active = 1):
62	n/a	"""Add a cancel button with a given title, the tab-next button,
63	n/a	its name in the Control table, possibly initially disabled.
64	n/a
65	n/a	Return the button, so that events can be associated"""
66	n/a	if active:
67	n/a	flags = 3 # Visible\|Enabled
68	n/a	else:
69	n/a	flags = 1 # Visible
70	n/a	return self.pushbutton(name, 304, self.h-27, 56, 17, flags, title, next)
71	n/a
72	n/a	def next(self, title, next, name = "Next", active = 1):
73	n/a	"""Add a Next button with a given title, the tab-next button,
74	n/a	its name in the Control table, possibly initially disabled.
75	n/a
76	n/a	Return the button, so that events can be associated"""
77	n/a	if active:
78	n/a	flags = 3 # Visible\|Enabled
79	n/a	else:
80	n/a	flags = 1 # Visible
81	n/a	return self.pushbutton(name, 236, self.h-27, 56, 17, flags, title, next)
82	n/a
83	n/a	def xbutton(self, name, title, next, xpos):
84	n/a	"""Add a button with a given title, the tab-next button,
85	n/a	its name in the Control table, giving its x position; the
86	n/a	y-position is aligned with the other buttons.
87	n/a
88	n/a	Return the button, so that events can be associated"""
89	n/a	return self.pushbutton(name, int(self.w*xpos - 28), self.h-27, 56, 17, 3, title, next)
90	n/a
91	n/a	class bdist_msi(Command):
92	n/a
93	n/a	description = "create a Microsoft Installer (.msi) binary distribution"
94	n/a
95	n/a	user_options = [('bdist-dir=', None,
96	n/a	"temporary directory for creating the distribution"),
97	n/a	('plat-name=', 'p',
98	n/a	"platform name to embed in generated filenames "
99	n/a	"(default: %s)" % get_platform()),
100	n/a	('keep-temp', 'k',
101	n/a	"keep the pseudo-installation tree around after " +
102	n/a	"creating the distribution archive"),
103	n/a	('target-version=', None,
104	n/a	"require a specific python version" +
105	n/a	" on the target system"),
106	n/a	('no-target-compile', 'c',
107	n/a	"do not compile .py to .pyc on the target system"),
108	n/a	('no-target-optimize', 'o',
109	n/a	"do not compile .py to .pyo (optimized)"
110	n/a	"on the target system"),
111	n/a	('dist-dir=', 'd',
112	n/a	"directory to put final built distributions in"),
113	n/a	('skip-build', None,
114	n/a	"skip rebuilding everything (for testing/debugging)"),
115	n/a	('install-script=', None,
116	n/a	"basename of installation script to be run after"
117	n/a	"installation or before deinstallation"),
118	n/a	('pre-install-script=', None,
119	n/a	"Fully qualified filename of a script to be run before "
120	n/a	"any files are installed. This script need not be in the "
121	n/a	"distribution"),
122	n/a	]
123	n/a
124	n/a	boolean_options = ['keep-temp', 'no-target-compile', 'no-target-optimize',
125	n/a	'skip-build']
126	n/a
127	n/a	all_versions = ['2.0', '2.1', '2.2', '2.3', '2.4',
128	n/a	'2.5', '2.6', '2.7', '2.8', '2.9',
129	n/a	'3.0', '3.1', '3.2', '3.3', '3.4',
130	n/a	'3.5', '3.6', '3.7', '3.8', '3.9']
131	n/a	other_version = 'X'
132	n/a
133	n/a	def initialize_options(self):
134	n/a	self.bdist_dir = None
135	n/a	self.plat_name = None
136	n/a	self.keep_temp = False
137	n/a	self.no_target_compile = False
138	n/a	self.no_target_optimize = False
139	n/a	self.target_version = None
140	n/a	self.dist_dir = None
141	n/a	self.skip_build = None
142	n/a	self.install_script = None
143	n/a	self.pre_install_script = None
144	n/a	self.versions = None
145	n/a
146	n/a	def finalize_options(self):
147	n/a	self.set_undefined_options('bdist', 'skip_build')
148	n/a
149	n/a	if self.bdist_dir is None:
150	n/a	bdist_base = self.get_finalized_command('bdist').bdist_base
151	n/a	self.bdist_dir = os.path.join(bdist_base, 'msi')
152	n/a
153	n/a	short_version = get_python_version()
154	n/a	if (not self.target_version) and self.distribution.has_ext_modules():
155	n/a	self.target_version = short_version
156	n/a
157	n/a	if self.target_version:
158	n/a	self.versions = [self.target_version]
159	n/a	if not self.skip_build and self.distribution.has_ext_modules()\
160	n/a	and self.target_version != short_version:
161	n/a	raise PackagingOptionError("target version can only be %s, or the '--skip-build'" \
162	n/a	" option must be specified" % (short_version,))
163	n/a	else:
164	n/a	self.versions = list(self.all_versions)
165	n/a
166	n/a	self.set_undefined_options('bdist', 'dist_dir', 'plat_name')
167	n/a
168	n/a	if self.pre_install_script:
169	n/a	raise PackagingOptionError("the pre-install-script feature is not yet implemented")
170	n/a
171	n/a	if self.install_script:
172	n/a	for script in self.distribution.scripts:
173	n/a	if self.install_script == os.path.basename(script):
174	n/a	break
175	n/a	else:
176	n/a	raise PackagingOptionError("install_script '%s' not found in scripts" % \
177	n/a	self.install_script)
178	n/a	self.install_script_key = None
179	n/a
180	n/a
181	n/a	def run(self):
182	n/a	if not self.skip_build:
183	n/a	self.run_command('build')
184	n/a
185	n/a	install = self.reinitialize_command('install_dist',
186	n/a	reinit_subcommands=True)
187	n/a	install.prefix = self.bdist_dir
188	n/a	install.skip_build = self.skip_build
189	n/a	install.warn_dir = False
190	n/a
191	n/a	install_lib = self.reinitialize_command('install_lib')
192	n/a	# we do not want to include pyc or pyo files
193	n/a	install_lib.compile = False
194	n/a	install_lib.optimize = 0
195	n/a
196	n/a	if self.distribution.has_ext_modules():
197	n/a	# If we are building an installer for a Python version other
198	n/a	# than the one we are currently running, then we need to ensure
199	n/a	# our build_lib reflects the other Python version rather than ours.
200	n/a	# Note that for target_version!=sys.version, we must have skipped the
201	n/a	# build step, so there is no issue with enforcing the build of this
202	n/a	# version.
203	n/a	target_version = self.target_version
204	n/a	if not target_version:
205	n/a	assert self.skip_build, "Should have already checked this"
206	n/a	target_version = '%s.%s' % sys.version_info[:2]
207	n/a	plat_specifier = ".%s-%s" % (self.plat_name, target_version)
208	n/a	build = self.get_finalized_command('build')
209	n/a	build.build_lib = os.path.join(build.build_base,
210	n/a	'lib' + plat_specifier)
211	n/a
212	n/a	log.info("installing to %s", self.bdist_dir)
213	n/a	install.ensure_finalized()
214	n/a
215	n/a	# avoid warning of 'install_lib' about installing
216	n/a	# into a directory not in sys.path
217	n/a	sys.path.insert(0, os.path.join(self.bdist_dir, 'PURELIB'))
218	n/a
219	n/a	install.run()
220	n/a
221	n/a	del sys.path[0]
222	n/a
223	n/a	self.mkpath(self.dist_dir)
224	n/a	fullname = self.distribution.get_fullname()
225	n/a	installer_name = self.get_installer_filename(fullname)
226	n/a	installer_name = os.path.abspath(installer_name)
227	n/a	if os.path.exists(installer_name): os.unlink(installer_name)
228	n/a
229	n/a	metadata = self.distribution.metadata
230	n/a	author = metadata.author
231	n/a	if not author:
232	n/a	author = metadata.maintainer
233	n/a	if not author:
234	n/a	author = "UNKNOWN"
235	n/a	version = MSIVersion(metadata.get_version())
236	n/a	# Prefix ProductName with Python x.y, so that
237	n/a	# it sorts together with the other Python packages
238	n/a	# in Add-Remove-Programs (APR)
239	n/a	fullname = self.distribution.get_fullname()
240	n/a	if self.target_version:
241	n/a	product_name = "Python %s %s" % (self.target_version, fullname)
242	n/a	else:
243	n/a	product_name = "Python %s" % (fullname)
244	n/a	self.db = msilib.init_database(installer_name, schema,
245	n/a	product_name, msilib.gen_uuid(),
246	n/a	str(version), author)
247	n/a	msilib.add_tables(self.db, sequence)
248	n/a	props = [('DistVersion', version)]
249	n/a	email = metadata.author_email or metadata.maintainer_email
250	n/a	if email:
251	n/a	props.append(("ARPCONTACT", email))
252	n/a	if metadata.url:
253	n/a	props.append(("ARPURLINFOABOUT", metadata.url))
254	n/a	if props:
255	n/a	add_data(self.db, 'Property', props)
256	n/a
257	n/a	self.add_find_python()
258	n/a	self.add_files()
259	n/a	self.add_scripts()
260	n/a	self.add_ui()
261	n/a	self.db.Commit()
262	n/a
263	n/a	if hasattr(self.distribution, 'dist_files'):
264	n/a	tup = 'bdist_msi', self.target_version or 'any', fullname
265	n/a	self.distribution.dist_files.append(tup)
266	n/a
267	n/a	if not self.keep_temp:
268	n/a	log.info("removing temporary build directory %s", self.bdist_dir)
269	n/a	if not self.dry_run:
270	n/a	rmtree(self.bdist_dir)
271	n/a
272	n/a	def add_files(self):
273	n/a	db = self.db
274	n/a	cab = msilib.CAB("distfiles")
275	n/a	rootdir = os.path.abspath(self.bdist_dir)
276	n/a
277	n/a	root = Directory(db, cab, None, rootdir, "TARGETDIR", "SourceDir")
278	n/a	f = Feature(db, "Python", "Python", "Everything",
279	n/a	0, 1, directory="TARGETDIR")
280	n/a
281	n/a	items = [(f, root, '')]
282	n/a	for version in self.versions + [self.other_version]:
283	n/a	target = "TARGETDIR" + version
284	n/a	name = default = "Python" + version
285	n/a	desc = "Everything"
286	n/a	if version is self.other_version:
287	n/a	title = "Python from another location"
288	n/a	level = 2
289	n/a	else:
290	n/a	title = "Python %s from registry" % version
291	n/a	level = 1
292	n/a	f = Feature(db, name, title, desc, 1, level, directory=target)
293	n/a	dir = Directory(db, cab, root, rootdir, target, default)
294	n/a	items.append((f, dir, version))
295	n/a	db.Commit()
296	n/a
297	n/a	seen = {}
298	n/a	for feature, dir, version in items:
299	n/a	todo = [dir]
300	n/a	while todo:
301	n/a	dir = todo.pop()
302	n/a	for file in os.listdir(dir.absolute):
303	n/a	afile = os.path.join(dir.absolute, file)
304	n/a	if os.path.isdir(afile):
305	n/a	short = "%s\|%s" % (dir.make_short(file), file)
306	n/a	default = file + version
307	n/a	newdir = Directory(db, cab, dir, file, default, short)
308	n/a	todo.append(newdir)
309	n/a	else:
310	n/a	if not dir.component:
311	n/a	dir.start_component(dir.logical, feature, 0)
312	n/a	if afile not in seen:
313	n/a	key = seen[afile] = dir.add_file(file)
314	n/a	if file==self.install_script:
315	n/a	if self.install_script_key:
316	n/a	raise PackagingOptionError(
317	n/a	"Multiple files with name %s" % file)
318	n/a	self.install_script_key = '[#%s]' % key
319	n/a	else:
320	n/a	key = seen[afile]
321	n/a	add_data(self.db, "DuplicateFile",
322	n/a	[(key + version, dir.component, key, None, dir.logical)])
323	n/a	db.Commit()
324	n/a	cab.commit(db)
325	n/a
326	n/a	def add_find_python(self):
327	n/a	"""Adds code to the installer to compute the location of Python.
328	n/a
329	n/a	Properties PYTHON.MACHINE.X.Y and PYTHON.USER.X.Y will be set from the
330	n/a	registry for each version of Python.
331	n/a
332	n/a	Properties TARGETDIRX.Y will be set from PYTHON.USER.X.Y if defined,
333	n/a	else from PYTHON.MACHINE.X.Y.
334	n/a
335	n/a	Properties PYTHONX.Y will be set to TARGETDIRX.Y\\python.exe"""
336	n/a
337	n/a	start = 402
338	n/a	for ver in self.versions:
339	n/a	install_path = r"SOFTWARE\Python\PythonCore\%s\InstallPath" % ver
340	n/a	machine_reg = "python.machine." + ver
341	n/a	user_reg = "python.user." + ver
342	n/a	machine_prop = "PYTHON.MACHINE." + ver
343	n/a	user_prop = "PYTHON.USER." + ver
344	n/a	machine_action = "PythonFromMachine" + ver
345	n/a	user_action = "PythonFromUser" + ver
346	n/a	exe_action = "PythonExe" + ver
347	n/a	target_dir_prop = "TARGETDIR" + ver
348	n/a	exe_prop = "PYTHON" + ver
349	n/a	if msilib.Win64:
350	n/a	# type: msidbLocatorTypeRawValue + msidbLocatorType64bit
351	n/a	Type = 2+16
352	n/a	else:
353	n/a	Type = 2
354	n/a	add_data(self.db, "RegLocator",
355	n/a	[(machine_reg, 2, install_path, None, Type),
356	n/a	(user_reg, 1, install_path, None, Type)])
357	n/a	add_data(self.db, "AppSearch",
358	n/a	[(machine_prop, machine_reg),
359	n/a	(user_prop, user_reg)])
360	n/a	add_data(self.db, "CustomAction",
361	n/a	[(machine_action, 51+256, target_dir_prop, "[" + machine_prop + "]"),
362	n/a	(user_action, 51+256, target_dir_prop, "[" + user_prop + "]"),
363	n/a	(exe_action, 51+256, exe_prop, "[" + target_dir_prop + "]\\python.exe"),
364	n/a	])
365	n/a	add_data(self.db, "InstallExecuteSequence",
366	n/a	[(machine_action, machine_prop, start),
367	n/a	(user_action, user_prop, start + 1),
368	n/a	(exe_action, None, start + 2),
369	n/a	])
370	n/a	add_data(self.db, "InstallUISequence",
371	n/a	[(machine_action, machine_prop, start),
372	n/a	(user_action, user_prop, start + 1),
373	n/a	(exe_action, None, start + 2),
374	n/a	])
375	n/a	add_data(self.db, "Condition",
376	n/a	[("Python" + ver, 0, "NOT TARGETDIR" + ver)])
377	n/a	start += 4
378	n/a	assert start < 500
379	n/a
380	n/a	def add_scripts(self):
381	n/a	if self.install_script:
382	n/a	start = 6800
383	n/a	for ver in self.versions + [self.other_version]:
384	n/a	install_action = "install_script." + ver
385	n/a	exe_prop = "PYTHON" + ver
386	n/a	add_data(self.db, "CustomAction",
387	n/a	[(install_action, 50, exe_prop, self.install_script_key)])
388	n/a	add_data(self.db, "InstallExecuteSequence",
389	n/a	[(install_action, "&Python%s=3" % ver, start)])
390	n/a	start += 1
391	n/a	# XXX pre-install scripts are currently refused in finalize_options()
392	n/a	# but if this feature is completed, it will also need to add
393	n/a	# entries for each version as the above code does
394	n/a	if self.pre_install_script:
395	n/a	scriptfn = os.path.join(self.bdist_dir, "preinstall.bat")
396	n/a	with open(scriptfn, "w") as f:
397	n/a	# The batch file will be executed with [PYTHON], so that %1
398	n/a	# is the path to the Python interpreter; %0 will be the path
399	n/a	# of the batch file.
400	n/a	# rem ="""
401	n/a	# %1 %0
402	n/a	# exit
403	n/a	# """
404	n/a	# <actual script>
405	n/a	f.write('rem ="""\n%1 %0\nexit\n"""\n')
406	n/a	with open(self.pre_install_script) as fp:
407	n/a	f.write(fp.read())
408	n/a	add_data(self.db, "Binary",
409	n/a	[("PreInstall", msilib.Binary(scriptfn)),
410	n/a	])
411	n/a	add_data(self.db, "CustomAction",
412	n/a	[("PreInstall", 2, "PreInstall", None),
413	n/a	])
414	n/a	add_data(self.db, "InstallExecuteSequence",
415	n/a	[("PreInstall", "NOT Installed", 450),
416	n/a	])
417	n/a
418	n/a	def add_ui(self):
419	n/a	db = self.db
420	n/a	x = y = 50
421	n/a	w = 370
422	n/a	h = 300
423	n/a	title = "[ProductName] Setup"
424	n/a
425	n/a	# see "Dialog Style Bits"
426	n/a	modal = 3 # visible \| modal
427	n/a	modeless = 1 # visible
428	n/a
429	n/a	# UI customization properties
430	n/a	add_data(db, "Property",
431	n/a	# See "DefaultUIFont Property"
432	n/a	[("DefaultUIFont", "DlgFont8"),
433	n/a	# See "ErrorDialog Style Bit"
434	n/a	("ErrorDialog", "ErrorDlg"),
435	n/a	("Progress1", "Install"), # modified in maintenance type dlg
436	n/a	("Progress2", "installs"),
437	n/a	("MaintenanceForm_Action", "Repair"),
438	n/a	# possible values: ALL, JUSTME
439	n/a	("WhichUsers", "ALL")
440	n/a	])
441	n/a
442	n/a	# Fonts, see "TextStyle Table"
443	n/a	add_data(db, "TextStyle",
444	n/a	[("DlgFont8", "Tahoma", 9, None, 0),
445	n/a	("DlgFontBold8", "Tahoma", 8, None, 1), #bold
446	n/a	("VerdanaBold10", "Verdana", 10, None, 1),
447	n/a	("VerdanaRed9", "Verdana", 9, 255, 0),
448	n/a	])
449	n/a
450	n/a	# UI Sequences, see "InstallUISequence Table", "Using a Sequence Table"
451	n/a	# Numbers indicate sequence; see sequence.py for how these action integrate
452	n/a	add_data(db, "InstallUISequence",
453	n/a	[("PrepareDlg", "Not Privileged or Windows9x or Installed", 140),
454	n/a	("WhichUsersDlg", "Privileged and not Windows9x and not Installed", 141),
455	n/a	# In the user interface, assume all-users installation if privileged.
456	n/a	("SelectFeaturesDlg", "Not Installed", 1230),
457	n/a	# XXX no support for resume installations yet
458	n/a	#("ResumeDlg", "Installed AND (RESUME OR Preselected)", 1240),
459	n/a	("MaintenanceTypeDlg", "Installed AND NOT RESUME AND NOT Preselected", 1250),
460	n/a	("ProgressDlg", None, 1280)])
461	n/a
462	n/a	add_data(db, 'ActionText', text.ActionText)
463	n/a	add_data(db, 'UIText', text.UIText)
464	n/a	#####################################################################
465	n/a	# Standard dialogs: FatalError, UserExit, ExitDialog
466	n/a	fatal=PyDialog(db, "FatalError", x, y, w, h, modal, title,
467	n/a	"Finish", "Finish", "Finish")
468	n/a	fatal.title("[ProductName] Installer ended prematurely")
469	n/a	fatal.back("< Back", "Finish", active = 0)
470	n/a	fatal.cancel("Cancel", "Back", active = 0)
471	n/a	fatal.text("Description1", 15, 70, 320, 80, 0x30003,
472	n/a	"[ProductName] setup ended prematurely because of an error. Your system has not been modified. To install this program at a later time, please run the installation again.")
473	n/a	fatal.text("Description2", 15, 155, 320, 20, 0x30003,
474	n/a	"Click the Finish button to exit the Installer.")
475	n/a	c=fatal.next("Finish", "Cancel", name="Finish")
476	n/a	c.event("EndDialog", "Exit")
477	n/a
478	n/a	user_exit=PyDialog(db, "UserExit", x, y, w, h, modal, title,
479	n/a	"Finish", "Finish", "Finish")
480	n/a	user_exit.title("[ProductName] Installer was interrupted")
481	n/a	user_exit.back("< Back", "Finish", active = 0)
482	n/a	user_exit.cancel("Cancel", "Back", active = 0)
483	n/a	user_exit.text("Description1", 15, 70, 320, 80, 0x30003,
484	n/a	"[ProductName] setup was interrupted. Your system has not been modified. "
485	n/a	"To install this program at a later time, please run the installation again.")
486	n/a	user_exit.text("Description2", 15, 155, 320, 20, 0x30003,
487	n/a	"Click the Finish button to exit the Installer.")
488	n/a	c = user_exit.next("Finish", "Cancel", name="Finish")
489	n/a	c.event("EndDialog", "Exit")
490	n/a
491	n/a	exit_dialog = PyDialog(db, "ExitDialog", x, y, w, h, modal, title,
492	n/a	"Finish", "Finish", "Finish")
493	n/a	exit_dialog.title("Completing the [ProductName] Installer")
494	n/a	exit_dialog.back("< Back", "Finish", active = 0)
495	n/a	exit_dialog.cancel("Cancel", "Back", active = 0)
496	n/a	exit_dialog.text("Description", 15, 235, 320, 20, 0x30003,
497	n/a	"Click the Finish button to exit the Installer.")
498	n/a	c = exit_dialog.next("Finish", "Cancel", name="Finish")
499	n/a	c.event("EndDialog", "Return")
500	n/a

1

n/a

"""Create a Microsoft Installer (.msi) binary distribution."""

2

n/a

3

n/a

4

n/a

# Licensed to PSF under a Contributor Agreement.

5

n/a

6

n/a

import sys

7

n/a

import os

8

n/a

import msilib

9

n/a

10

n/a

from shutil import rmtree

11

n/a

from sysconfig import get_python_version

12

n/a

from packaging.command.cmd import Command

13

n/a

from packaging.version import NormalizedVersion

14

n/a

from packaging.errors import PackagingOptionError

15

n/a

from packaging import logger as log

16

n/a

from packaging.util import get_platform

17

n/a

from msilib import schema, sequence, text

18

n/a

from msilib import Directory, Feature, Dialog, add_data

19

n/a

20

n/a

class MSIVersion(NormalizedVersion):

21

n/a

"""

22

n/a

MSI ProductVersion must be strictly numeric.

23

n/a

MSIVersion disallows prerelease and postrelease versions.

24

n/a

"""

25

n/a

def __init__(self, *args, **kwargs):

26

n/a

super(MSIVersion, self).__init__(*args, **kwargs)

27

n/a

if not self.is_final:

28

n/a

raise ValueError("ProductVersion must be strictly numeric")

29

n/a

30

n/a

class PyDialog(Dialog):

31

n/a

"""Dialog class with a fixed layout: controls at the top, then a ruler,

32

n/a

then a list of buttons: back, next, cancel. Optionally a bitmap at the

33

n/a

left."""

34

n/a

def __init__(self, *args, **kw):

35

n/a

"""Dialog(database, name, x, y, w, h, attributes, title, first,

36

n/a

default, cancel, bitmap=true)"""

37

n/a

super(PyDialog, self).__init__(*args)

38

n/a

ruler = self.h - 36

39

n/a

#if kw.get("bitmap", True):

40

n/a

# self.bitmap("Bitmap", 0, 0, bmwidth, ruler, "PythonWin")

41

n/a

self.line("BottomLine", 0, ruler, self.w, 0)

42

n/a

43

n/a

def title(self, title):

44

n/a

"Set the title text of the dialog at the top."

45

n/a

# name, x, y, w, h, flags=Visible|Enabled|Transparent|NoPrefix,

46

n/a

# text, in VerdanaBold10

47

n/a

self.text("Title", 15, 10, 320, 60, 0x30003,

48

n/a

r"{\VerdanaBold10}%s" % title)

49

n/a

50

n/a

def back(self, title, next, name = "Back", active = 1):

51

n/a

"""Add a back button with a given title, the tab-next button,

52

n/a

its name in the Control table, possibly initially disabled.

53

n/a

54

n/a

Return the button, so that events can be associated"""

55

n/a

if active:

56

n/a

flags = 3 # Visible|Enabled

57

n/a

else:

58

n/a

flags = 1 # Visible

59

n/a

return self.pushbutton(name, 180, self.h-27 , 56, 17, flags, title, next)

60

n/a

61

n/a

def cancel(self, title, next, name = "Cancel", active = 1):

62

n/a

"""Add a cancel button with a given title, the tab-next button,

63

n/a

its name in the Control table, possibly initially disabled.

64

n/a

65

n/a

Return the button, so that events can be associated"""

66

n/a

if active:

67

n/a

flags = 3 # Visible|Enabled

68

n/a

else:

69

n/a

flags = 1 # Visible

70

n/a

return self.pushbutton(name, 304, self.h-27, 56, 17, flags, title, next)

71

n/a

72

n/a

def next(self, title, next, name = "Next", active = 1):

73

n/a

"""Add a Next button with a given title, the tab-next button,

74

n/a

its name in the Control table, possibly initially disabled.

75

n/a

76

n/a

Return the button, so that events can be associated"""

77

n/a

if active:

78

n/a

flags = 3 # Visible|Enabled

79

n/a

else:

80

n/a

flags = 1 # Visible

81

n/a

return self.pushbutton(name, 236, self.h-27, 56, 17, flags, title, next)

82

n/a

83

n/a

def xbutton(self, name, title, next, xpos):

84

n/a

"""Add a button with a given title, the tab-next button,

85

n/a

its name in the Control table, giving its x position; the

86

n/a

y-position is aligned with the other buttons.

87

n/a

88

n/a

Return the button, so that events can be associated"""

89

n/a

return self.pushbutton(name, int(self.w*xpos - 28), self.h-27, 56, 17, 3, title, next)

90

n/a

91

n/a

class bdist_msi(Command):

92

n/a

93

n/a

description = "create a Microsoft Installer (.msi) binary distribution"

94

n/a

95

n/a

user_options = [('bdist-dir=', None,

96

n/a

"temporary directory for creating the distribution"),

97

n/a

('plat-name=', 'p',

98

n/a

"platform name to embed in generated filenames "

99

n/a

"(default: %s)" % get_platform()),

100

n/a

('keep-temp', 'k',

101

n/a

"keep the pseudo-installation tree around after " +

102

n/a

"creating the distribution archive"),

103

n/a

('target-version=', None,

104

n/a

"require a specific python version" +

105

n/a

" on the target system"),

106

n/a

('no-target-compile', 'c',

107

n/a

"do not compile .py to .pyc on the target system"),

108

n/a

('no-target-optimize', 'o',

109

n/a

"do not compile .py to .pyo (optimized)"

110

n/a

"on the target system"),

111

n/a

('dist-dir=', 'd',

112

n/a

"directory to put final built distributions in"),

113

n/a

('skip-build', None,

114

n/a

"skip rebuilding everything (for testing/debugging)"),

115

n/a

('install-script=', None,

116

n/a

"basename of installation script to be run after"

117

n/a

"installation or before deinstallation"),

118

n/a

('pre-install-script=', None,

119

n/a

"Fully qualified filename of a script to be run before "

120

n/a

"any files are installed. This script need not be in the "

121

n/a

"distribution"),

122

n/a

]

123

n/a

124

n/a

boolean_options = ['keep-temp', 'no-target-compile', 'no-target-optimize',

125

n/a

'skip-build']

126

n/a

127

n/a

all_versions = ['2.0', '2.1', '2.2', '2.3', '2.4',

128

n/a

'2.5', '2.6', '2.7', '2.8', '2.9',

129

n/a

'3.0', '3.1', '3.2', '3.3', '3.4',

130

n/a

'3.5', '3.6', '3.7', '3.8', '3.9']

131

n/a

other_version = 'X'

132

n/a

133

n/a

def initialize_options(self):

134

n/a

self.bdist_dir = None

135

n/a

self.plat_name = None

136

n/a

self.keep_temp = False

137

n/a

self.no_target_compile = False

138

n/a

self.no_target_optimize = False

139

n/a

self.target_version = None

140

n/a

self.dist_dir = None

141

n/a

self.skip_build = None

142

n/a

self.install_script = None

143

n/a

self.pre_install_script = None

144

n/a

self.versions = None

145

n/a

146

n/a

def finalize_options(self):

147

n/a

self.set_undefined_options('bdist', 'skip_build')

148

n/a

149

n/a

if self.bdist_dir is None:

150

n/a

bdist_base = self.get_finalized_command('bdist').bdist_base

151

n/a

self.bdist_dir = os.path.join(bdist_base, 'msi')

152

n/a

153

n/a

short_version = get_python_version()

154

n/a

if (not self.target_version) and self.distribution.has_ext_modules():

155

n/a

self.target_version = short_version

156

n/a

157

n/a

if self.target_version:

158

n/a

self.versions = [self.target_version]

159

n/a

if not self.skip_build and self.distribution.has_ext_modules()\

160

n/a

and self.target_version != short_version:

161

n/a

raise PackagingOptionError("target version can only be %s, or the '--skip-build'" \

162

n/a

" option must be specified" % (short_version,))

163

n/a

else:

164

n/a

self.versions = list(self.all_versions)

165

n/a

166

n/a

self.set_undefined_options('bdist', 'dist_dir', 'plat_name')

167

n/a

168

n/a

if self.pre_install_script:

169

n/a

raise PackagingOptionError("the pre-install-script feature is not yet implemented")

170

n/a

171

n/a

if self.install_script:

172

n/a

for script in self.distribution.scripts:

173

n/a

if self.install_script == os.path.basename(script):

174

n/a

break

175

n/a

else:

176

n/a

raise PackagingOptionError("install_script '%s' not found in scripts" % \

177

n/a

self.install_script)

178

n/a

self.install_script_key = None

179

n/a

180

n/a

181

n/a

def run(self):

182

n/a

if not self.skip_build:

183

n/a

self.run_command('build')

184

n/a

185

n/a

install = self.reinitialize_command('install_dist',

186

n/a

reinit_subcommands=True)

187

n/a

install.prefix = self.bdist_dir

188

n/a

install.skip_build = self.skip_build

189

n/a

install.warn_dir = False

190

n/a

191

n/a

install_lib = self.reinitialize_command('install_lib')

192

n/a

# we do not want to include pyc or pyo files

193

n/a

install_lib.compile = False

194

n/a

install_lib.optimize = 0

195

n/a

196

n/a

if self.distribution.has_ext_modules():

197

n/a

# If we are building an installer for a Python version other

198

n/a

# than the one we are currently running, then we need to ensure

199

n/a

# our build_lib reflects the other Python version rather than ours.

200

n/a

# Note that for target_version!=sys.version, we must have skipped the

201

n/a

# build step, so there is no issue with enforcing the build of this

202

n/a

# version.

203

n/a

target_version = self.target_version

204

n/a

if not target_version:

205

n/a

assert self.skip_build, "Should have already checked this"

206

n/a

target_version = '%s.%s' % sys.version_info[:2]

207

n/a

plat_specifier = ".%s-%s" % (self.plat_name, target_version)

208

n/a

build = self.get_finalized_command('build')

209

n/a

build.build_lib = os.path.join(build.build_base,

210

n/a

'lib' + plat_specifier)

211

n/a

212

n/a

log.info("installing to %s", self.bdist_dir)

213

n/a

install.ensure_finalized()

214

n/a

215

n/a

# avoid warning of 'install_lib' about installing

216

n/a

# into a directory not in sys.path

217

n/a

sys.path.insert(0, os.path.join(self.bdist_dir, 'PURELIB'))

218

n/a

219

n/a

install.run()

220

n/a

221

n/a

del sys.path[0]

222

n/a

223

n/a

self.mkpath(self.dist_dir)

224

n/a

fullname = self.distribution.get_fullname()

225

n/a

installer_name = self.get_installer_filename(fullname)

226

n/a

installer_name = os.path.abspath(installer_name)

227

n/a

if os.path.exists(installer_name): os.unlink(installer_name)

228

n/a

229

n/a

metadata = self.distribution.metadata

230

n/a

author = metadata.author

231

n/a

if not author:

232

n/a

author = metadata.maintainer

233

n/a

if not author:

234

n/a

author = "UNKNOWN"

235

n/a

version = MSIVersion(metadata.get_version())

236

n/a

# Prefix ProductName with Python x.y, so that

237

n/a

# it sorts together with the other Python packages

238

n/a

# in Add-Remove-Programs (APR)

239

n/a

fullname = self.distribution.get_fullname()

240

n/a

if self.target_version:

241

n/a

product_name = "Python %s %s" % (self.target_version, fullname)

242

n/a

else:

243

n/a

product_name = "Python %s" % (fullname)

244

n/a

self.db = msilib.init_database(installer_name, schema,

245

n/a

product_name, msilib.gen_uuid(),

246

n/a

str(version), author)

247

n/a

msilib.add_tables(self.db, sequence)

248

n/a

props = [('DistVersion', version)]

249

n/a

email = metadata.author_email or metadata.maintainer_email

250

n/a

if email:

251

n/a

props.append(("ARPCONTACT", email))

252

n/a

if metadata.url:

253

n/a

props.append(("ARPURLINFOABOUT", metadata.url))

254

n/a

if props:

255

n/a

add_data(self.db, 'Property', props)

256

n/a

257

n/a

self.add_find_python()

258

n/a

self.add_files()

259

n/a

self.add_scripts()

260

n/a

self.add_ui()

261

n/a

self.db.Commit()

262

n/a

263

n/a

if hasattr(self.distribution, 'dist_files'):

264

n/a

tup = 'bdist_msi', self.target_version or 'any', fullname

265

n/a

self.distribution.dist_files.append(tup)

266

n/a

267

n/a

if not self.keep_temp:

268

n/a

log.info("removing temporary build directory %s", self.bdist_dir)

269

n/a

if not self.dry_run:

270

n/a

rmtree(self.bdist_dir)

271

n/a

272

n/a

def add_files(self):

273

n/a

db = self.db

274

n/a

cab = msilib.CAB("distfiles")

275

n/a

rootdir = os.path.abspath(self.bdist_dir)

276

n/a

277

n/a

root = Directory(db, cab, None, rootdir, "TARGETDIR", "SourceDir")

278

n/a

f = Feature(db, "Python", "Python", "Everything",

279

n/a

0, 1, directory="TARGETDIR")

280

n/a

281

n/a

items = [(f, root, '')]

282

n/a

for version in self.versions + [self.other_version]:

283

n/a

target = "TARGETDIR" + version

284

n/a

name = default = "Python" + version

285

n/a

desc = "Everything"

286

n/a

if version is self.other_version:

287

n/a

title = "Python from another location"

288

n/a

level = 2

289

n/a

else:

290

n/a

title = "Python %s from registry" % version

291

n/a

level = 1

292

n/a

f = Feature(db, name, title, desc, 1, level, directory=target)

293

n/a

dir = Directory(db, cab, root, rootdir, target, default)

294

n/a

items.append((f, dir, version))

295

n/a

db.Commit()

296

n/a

297

n/a

seen = {}

298

n/a

for feature, dir, version in items:

299

n/a

todo = [dir]

300

n/a

while todo:

301

n/a

dir = todo.pop()

302

n/a

for file in os.listdir(dir.absolute):

303

n/a

afile = os.path.join(dir.absolute, file)

304

n/a

if os.path.isdir(afile):

305

n/a

short = "%s|%s" % (dir.make_short(file), file)

306

n/a

default = file + version

307

n/a

newdir = Directory(db, cab, dir, file, default, short)

308

n/a

todo.append(newdir)

309

n/a

else:

310

n/a

if not dir.component:

311

n/a

dir.start_component(dir.logical, feature, 0)

312

n/a

if afile not in seen:

313

n/a

key = seen[afile] = dir.add_file(file)

314

n/a

if file==self.install_script:

315

n/a

if self.install_script_key:

316

n/a

raise PackagingOptionError(

317

n/a

"Multiple files with name %s" % file)

318

n/a

self.install_script_key = '[#%s]' % key

319

n/a

else:

320

n/a

key = seen[afile]

321

n/a

add_data(self.db, "DuplicateFile",

322

n/a

[(key + version, dir.component, key, None, dir.logical)])

323

n/a

db.Commit()

324

n/a

cab.commit(db)

325

n/a

326

n/a

def add_find_python(self):

327

n/a

"""Adds code to the installer to compute the location of Python.

328

n/a

329

n/a

Properties PYTHON.MACHINE.X.Y and PYTHON.USER.X.Y will be set from the

330

n/a

registry for each version of Python.

331

n/a

332

n/a

Properties TARGETDIRX.Y will be set from PYTHON.USER.X.Y if defined,

333

n/a

else from PYTHON.MACHINE.X.Y.

334

n/a

335

n/a

Properties PYTHONX.Y will be set to TARGETDIRX.Y\\python.exe"""

336

n/a

337

n/a

start = 402

338

n/a

for ver in self.versions:

339

n/a

install_path = r"SOFTWARE\Python\PythonCore\%s\InstallPath" % ver

340

n/a

machine_reg = "python.machine." + ver

341

n/a

user_reg = "python.user." + ver

342

n/a

machine_prop = "PYTHON.MACHINE." + ver

343

n/a

user_prop = "PYTHON.USER." + ver

344

n/a

machine_action = "PythonFromMachine" + ver

345

n/a

user_action = "PythonFromUser" + ver

346

n/a

exe_action = "PythonExe" + ver

347

n/a

target_dir_prop = "TARGETDIR" + ver

348

n/a

exe_prop = "PYTHON" + ver

349

n/a

if msilib.Win64:

350

n/a

# type: msidbLocatorTypeRawValue + msidbLocatorType64bit

351

n/a

Type = 2+16

352

n/a

else:

353

n/a

Type = 2

354

n/a

add_data(self.db, "RegLocator",

355

n/a

[(machine_reg, 2, install_path, None, Type),

356

n/a

(user_reg, 1, install_path, None, Type)])

357

n/a

add_data(self.db, "AppSearch",

358

n/a

[(machine_prop, machine_reg),

359

n/a

(user_prop, user_reg)])

360

n/a

add_data(self.db, "CustomAction",

361

n/a

[(machine_action, 51+256, target_dir_prop, "[" + machine_prop + "]"),

362

n/a

(user_action, 51+256, target_dir_prop, "[" + user_prop + "]"),

363

n/a

(exe_action, 51+256, exe_prop, "[" + target_dir_prop + "]\\python.exe"),

364

n/a

])

365

n/a

add_data(self.db, "InstallExecuteSequence",

366

n/a

[(machine_action, machine_prop, start),

367

n/a

(user_action, user_prop, start + 1),

368

n/a

(exe_action, None, start + 2),

369

n/a

])

370

n/a

add_data(self.db, "InstallUISequence",

371

n/a

[(machine_action, machine_prop, start),

372

n/a

(user_action, user_prop, start + 1),

373

n/a

(exe_action, None, start + 2),

374

n/a

])

375

n/a

add_data(self.db, "Condition",

376

n/a

[("Python" + ver, 0, "NOT TARGETDIR" + ver)])

377

n/a

start += 4

378

n/a

assert start < 500

379

n/a

380

n/a

def add_scripts(self):

381

n/a

if self.install_script:

382

n/a

start = 6800

383

n/a

for ver in self.versions + [self.other_version]:

384

n/a

install_action = "install_script." + ver

385

n/a

exe_prop = "PYTHON" + ver

386

n/a

add_data(self.db, "CustomAction",

387

n/a

[(install_action, 50, exe_prop, self.install_script_key)])

388

n/a

add_data(self.db, "InstallExecuteSequence",

389

n/a

[(install_action, "&Python%s=3" % ver, start)])

390

n/a

start += 1

391

n/a

# XXX pre-install scripts are currently refused in finalize_options()

392

n/a

# but if this feature is completed, it will also need to add

393

n/a

# entries for each version as the above code does

394

n/a

if self.pre_install_script:

395

n/a

scriptfn = os.path.join(self.bdist_dir, "preinstall.bat")

396

n/a

with open(scriptfn, "w") as f:

397

n/a

# The batch file will be executed with [PYTHON], so that %1

398

n/a

# is the path to the Python interpreter; %0 will be the path

399

n/a

# of the batch file.

400

n/a

# rem ="""

401

n/a

# %1 %0

402

n/a

# exit

403

n/a

# """

404

n/a

# <actual script>

405

n/a

f.write('rem ="""\n%1 %0\nexit\n"""\n')

406

n/a

with open(self.pre_install_script) as fp:

407

n/a

f.write(fp.read())

408

n/a

add_data(self.db, "Binary",

409

n/a

[("PreInstall", msilib.Binary(scriptfn)),

410

n/a

])

411

n/a

add_data(self.db, "CustomAction",

412

n/a

[("PreInstall", 2, "PreInstall", None),

413

n/a

])

414

n/a

add_data(self.db, "InstallExecuteSequence",

415

n/a

[("PreInstall", "NOT Installed", 450),

416

n/a

])

417

n/a

418

n/a

def add_ui(self):

419

n/a

db = self.db

420

n/a

x = y = 50

421

n/a

w = 370

422

n/a

h = 300

423

n/a

title = "[ProductName] Setup"

424

n/a

425

n/a

# see "Dialog Style Bits"

426

n/a

modal = 3 # visible | modal

427

n/a

modeless = 1 # visible

428

n/a

429

n/a

# UI customization properties

430

n/a

add_data(db, "Property",

431

n/a

# See "DefaultUIFont Property"

432

n/a

[("DefaultUIFont", "DlgFont8"),

433

n/a

# See "ErrorDialog Style Bit"

434

n/a

("ErrorDialog", "ErrorDlg"),

435

n/a

("Progress1", "Install"), # modified in maintenance type dlg

436

n/a

("Progress2", "installs"),

437

n/a

("MaintenanceForm_Action", "Repair"),

438

n/a

# possible values: ALL, JUSTME

439

n/a

("WhichUsers", "ALL")

440

n/a

])

441

n/a

442

n/a

# Fonts, see "TextStyle Table"

443

n/a

add_data(db, "TextStyle",

444

n/a

[("DlgFont8", "Tahoma", 9, None, 0),

445

n/a

("DlgFontBold8", "Tahoma", 8, None, 1), #bold

446

n/a

("VerdanaBold10", "Verdana", 10, None, 1),

447

n/a

("VerdanaRed9", "Verdana", 9, 255, 0),

448

n/a

])

449

n/a

450

n/a

# UI Sequences, see "InstallUISequence Table", "Using a Sequence Table"

451

n/a

# Numbers indicate sequence; see sequence.py for how these action integrate

452

n/a

add_data(db, "InstallUISequence",

453

n/a

[("PrepareDlg", "Not Privileged or Windows9x or Installed", 140),

454

n/a

("WhichUsersDlg", "Privileged and not Windows9x and not Installed", 141),

455

n/a

# In the user interface, assume all-users installation if privileged.

456

n/a

("SelectFeaturesDlg", "Not Installed", 1230),

457

n/a

# XXX no support for resume installations yet

458

n/a

#("ResumeDlg", "Installed AND (RESUME OR Preselected)", 1240),

459

n/a

("MaintenanceTypeDlg", "Installed AND NOT RESUME AND NOT Preselected", 1250),

460

n/a

("ProgressDlg", None, 1280)])

461

n/a

462

n/a

add_data(db, 'ActionText', text.ActionText)

463

n/a

add_data(db, 'UIText', text.UIText)

464

n/a

#####################################################################

465

n/a

# Standard dialogs: FatalError, UserExit, ExitDialog

466

n/a

fatal=PyDialog(db, "FatalError", x, y, w, h, modal, title,

467

n/a

"Finish", "Finish", "Finish")

468

n/a

fatal.title("[ProductName] Installer ended prematurely")

469

n/a

fatal.back("< Back", "Finish", active = 0)

470

n/a

fatal.cancel("Cancel", "Back", active = 0)

471

n/a

fatal.text("Description1", 15, 70, 320, 80, 0x30003,

472

n/a

"[ProductName] setup ended prematurely because of an error. Your system has not been modified. To install this program at a later time, please run the installation again.")

473

n/a

fatal.text("Description2", 15, 155, 320, 20, 0x30003,

474

n/a

"Click the Finish button to exit the Installer.")

475

n/a

c=fatal.next("Finish", "Cancel", name="Finish")

476

n/a

c.event("EndDialog", "Exit")

477

n/a

478

n/a

user_exit=PyDialog(db, "UserExit", x, y, w, h, modal, title,

479

n/a

"Finish", "Finish", "Finish")

480

n/a

user_exit.title("[ProductName] Installer was interrupted")

481

n/a

user_exit.back("< Back", "Finish", active = 0)

482

n/a

user_exit.cancel("Cancel", "Back", active = 0)

483

n/a

user_exit.text("Description1", 15, 70, 320, 80, 0x30003,

484

n/a

"[ProductName] setup was interrupted. Your system has not been modified. "

485

n/a

"To install this program at a later time, please run the installation again.")

486

n/a

user_exit.text("Description2", 15, 155, 320, 20, 0x30003,

487

n/a

"Click the Finish button to exit the Installer.")

488

n/a

c = user_exit.next("Finish", "Cancel", name="Finish")

489

n/a

c.event("EndDialog", "Exit")

490

n/a

491

n/a

exit_dialog = PyDialog(db, "ExitDialog", x, y, w, h, modal, title,

492

n/a

"Finish", "Finish", "Finish")

493

n/a

exit_dialog.title("Completing the [ProductName] Installer")

494

n/a

exit_dialog.back("< Back", "Finish", active = 0)

495

n/a

exit_dialog.cancel("Cancel", "Back", active = 0)

496

n/a

exit_dialog.text("Description", 15, 235, 320, 20, 0x30003,

497

n/a

"Click the Finish button to exit the Installer.")

498

n/a

c = exit_dialog.next("Finish", "Cancel", name="Finish")

499

n/a

c.event("EndDialog", "Return")

500

n/a

501

n/a

#####################################################################

502

n/a

# Required dialog: FilesInUse, ErrorDlg

503

n/a

inuse = PyDialog(db, "FilesInUse",

504

n/a

x, y, w, h,

505

n/a

19, # KeepModeless|Modal|Visible

506

n/a

title,

507

n/a

"Retry", "Retry", "Retry", bitmap=False)

508

n/a

inuse.text("Title", 15, 6, 200, 15, 0x30003,

509

n/a

r"{\DlgFontBold8}Files in Use")

510

n/a

inuse.text("Description", 20, 23, 280, 20, 0x30003,

511

n/a

"Some files that need to be updated are currently in use.")

512

n/a

inuse.text("Text", 20, 55, 330, 50, 3,

513

n/a

"The following applications are using files that need to be updated by this setup. Close these applications and then click Retry to continue the installation or Cancel to exit it.")

514

n/a

inuse.control("List", "ListBox", 20, 107, 330, 130, 7, "FileInUseProcess",

515

n/a

None, None, None)

516

n/a

c=inuse.back("Exit", "Ignore", name="Exit")

517

n/a

c.event("EndDialog", "Exit")

518

n/a

c=inuse.next("Ignore", "Retry", name="Ignore")

519

n/a

c.event("EndDialog", "Ignore")

520

n/a

c=inuse.cancel("Retry", "Exit", name="Retry")

521

n/a

c.event("EndDialog","Retry")

522

n/a

523

n/a

# See "Error Dialog". See "ICE20" for the required names of the controls.

524

n/a

error = Dialog(db, "ErrorDlg",

525

n/a

50, 10, 330, 101,

526

n/a

65543, # Error|Minimize|Modal|Visible

527

n/a

title,

528

n/a

"ErrorText", None, None)

529

n/a

error.text("ErrorText", 50,9,280,48,3, "")

530

n/a

#error.control("ErrorIcon", "Icon", 15, 9, 24, 24, 5242881, None, "py.ico", None, None)

531

n/a

error.pushbutton("N",120,72,81,21,3,"No",None).event("EndDialog","ErrorNo")

532

n/a

error.pushbutton("Y",240,72,81,21,3,"Yes",None).event("EndDialog","ErrorYes")

533

n/a

error.pushbutton("A",0,72,81,21,3,"Abort",None).event("EndDialog","ErrorAbort")

534

n/a

error.pushbutton("C",42,72,81,21,3,"Cancel",None).event("EndDialog","ErrorCancel")

535

n/a

error.pushbutton("I",81,72,81,21,3,"Ignore",None).event("EndDialog","ErrorIgnore")

536

n/a

error.pushbutton("O",159,72,81,21,3,"Ok",None).event("EndDialog","ErrorOk")

537

n/a

error.pushbutton("R",198,72,81,21,3,"Retry",None).event("EndDialog","ErrorRetry")

538

n/a

539

n/a

#####################################################################

540

n/a

# Global "Query Cancel" dialog

541

n/a

cancel = Dialog(db, "CancelDlg", 50, 10, 260, 85, 3, title,

542

n/a

"No", "No", "No")

543

n/a

cancel.text("Text", 48, 15, 194, 30, 3,

544

n/a

"Are you sure you want to cancel [ProductName] installation?")

545

n/a

#cancel.control("Icon", "Icon", 15, 15, 24, 24, 5242881, None,

546

n/a

# "py.ico", None, None)

547

n/a

c=cancel.pushbutton("Yes", 72, 57, 56, 17, 3, "Yes", "No")

548

n/a

c.event("EndDialog", "Exit")

549

n/a

550

n/a

c=cancel.pushbutton("No", 132, 57, 56, 17, 3, "No", "Yes")

551

n/a

c.event("EndDialog", "Return")

552

n/a

553

n/a

#####################################################################

554

n/a

# Global "Wait for costing" dialog

555

n/a

costing = Dialog(db, "WaitForCostingDlg", 50, 10, 260, 85, modal, title,

556

n/a

"Return", "Return", "Return")

557

n/a

costing.text("Text", 48, 15, 194, 30, 3,

558

n/a

"Please wait while the installer finishes determining your disk space requirements.")

559

n/a

c = costing.pushbutton("Return", 102, 57, 56, 17, 3, "Return", None)

560

n/a

c.event("EndDialog", "Exit")

561

n/a

562

n/a

#####################################################################

563

n/a

# Preparation dialog: no user input except cancellation

564

n/a

prep = PyDialog(db, "PrepareDlg", x, y, w, h, modeless, title,

565

n/a

"Cancel", "Cancel", "Cancel")

566

n/a

prep.text("Description", 15, 70, 320, 40, 0x30003,

567

n/a

"Please wait while the Installer prepares to guide you through the installation.")

568

n/a

prep.title("Welcome to the [ProductName] Installer")

569

n/a

c=prep.text("ActionText", 15, 110, 320, 20, 0x30003, "Pondering...")

570

n/a

c.mapping("ActionText", "Text")

571

n/a

c=prep.text("ActionData", 15, 135, 320, 30, 0x30003, None)

572

n/a

c.mapping("ActionData", "Text")

573

n/a

prep.back("Back", None, active=0)

574

n/a

prep.next("Next", None, active=0)

575

n/a

c=prep.cancel("Cancel", None)

576

n/a

c.event("SpawnDialog", "CancelDlg")

577

n/a

578

n/a

#####################################################################

579

n/a

# Feature (Python directory) selection

580

n/a

seldlg = PyDialog(db, "SelectFeaturesDlg", x, y, w, h, modal, title,

581

n/a

"Next", "Next", "Cancel")

582

n/a

seldlg.title("Select Python Installations")

583

n/a

584

n/a

seldlg.text("Hint", 15, 30, 300, 20, 3,

585

n/a

"Select the Python locations where %s should be installed."

586

n/a

% self.distribution.get_fullname())

587

n/a

588

n/a

seldlg.back("< Back", None, active=0)

589

n/a

c = seldlg.next("Next >", "Cancel")

590

n/a

order = 1

591

n/a

c.event("[TARGETDIR]", "[SourceDir]", ordering=order)

592

n/a

for version in self.versions + [self.other_version]:

593

n/a

order += 1

594

n/a

c.event("[TARGETDIR]", "[TARGETDIR%s]" % version,

595

n/a

"FEATURE_SELECTED AND &Python%s=3" % version,

596

n/a

ordering=order)

597

n/a

c.event("SpawnWaitDialog", "WaitForCostingDlg", ordering=order + 1)

598

n/a

c.event("EndDialog", "Return", ordering=order + 2)

599

n/a

c = seldlg.cancel("Cancel", "Features")

600

n/a

c.event("SpawnDialog", "CancelDlg")

601

n/a

602

n/a

c = seldlg.control("Features", "SelectionTree", 15, 60, 300, 120, 3,

603

n/a

"FEATURE", None, "PathEdit", None)

604

n/a

c.event("[FEATURE_SELECTED]", "1")

605

n/a

ver = self.other_version

606

n/a

install_other_cond = "FEATURE_SELECTED AND &Python%s=3" % ver

607

n/a

dont_install_other_cond = "FEATURE_SELECTED AND &Python%s<>3" % ver

608

n/a

609

n/a

c = seldlg.text("Other", 15, 200, 300, 15, 3,

610

n/a

"Provide an alternate Python location")

611

n/a

c.condition("Enable", install_other_cond)

612

n/a

c.condition("Show", install_other_cond)

613

n/a

c.condition("Disable", dont_install_other_cond)

614

n/a

c.condition("Hide", dont_install_other_cond)

615

n/a

616

n/a

c = seldlg.control("PathEdit", "PathEdit", 15, 215, 300, 16, 1,

617

n/a

"TARGETDIR" + ver, None, "Next", None)

618

n/a

c.condition("Enable", install_other_cond)

619

n/a

c.condition("Show", install_other_cond)

620

n/a

c.condition("Disable", dont_install_other_cond)

621

n/a

c.condition("Hide", dont_install_other_cond)

622

n/a

623

n/a

#####################################################################

624

n/a

# Disk cost

625

n/a

cost = PyDialog(db, "DiskCostDlg", x, y, w, h, modal, title,

626

n/a

"OK", "OK", "OK", bitmap=False)

627

n/a

cost.text("Title", 15, 6, 200, 15, 0x30003,

628

n/a

"{\DlgFontBold8}Disk Space Requirements")

629

n/a

cost.text("Description", 20, 20, 280, 20, 0x30003,

630

n/a

"The disk space required for the installation of the selected features.")

631

n/a

cost.text("Text", 20, 53, 330, 60, 3,

632

n/a

"The highlighted volumes (if any) do not have enough disk space "

633

n/a

"available for the currently selected features. You can either "

634

n/a

"remove some files from the highlighted volumes, or choose to "

635

n/a

"install less features onto local drive(s), or select different "

636

n/a

"destination drive(s).")

637

n/a

cost.control("VolumeList", "VolumeCostList", 20, 100, 330, 150, 393223,

638

n/a

None, "{120}{70}{70}{70}{70}", None, None)

639

n/a

cost.xbutton("OK", "Ok", None, 0.5).event("EndDialog", "Return")

640

n/a

641

n/a

#####################################################################

642

n/a

# WhichUsers Dialog. Only available on NT, and for privileged users.

643

n/a

# This must be run before FindRelatedProducts, because that will

644

n/a

# take into account whether the previous installation was per-user

645

n/a

# or per-machine. We currently don't support going back to this

646

n/a

# dialog after "Next" was selected; to support this, we would need to

647

n/a

# find how to reset the ALLUSERS property, and how to re-run

648

n/a

# FindRelatedProducts.

649

n/a

# On Windows9x, the ALLUSERS property is ignored on the command line

650

n/a

# and in the Property table, but installer fails according to the documentation

651

n/a

# if a dialog attempts to set ALLUSERS.

652

n/a

whichusers = PyDialog(db, "WhichUsersDlg", x, y, w, h, modal, title,

653

n/a

"AdminInstall", "Next", "Cancel")

654

n/a

whichusers.title("Select whether to install [ProductName] for all users of this computer.")

655

n/a

# A radio group with two options: allusers, justme

656

n/a

g = whichusers.radiogroup("AdminInstall", 15, 60, 260, 50, 3,

657

n/a

"WhichUsers", "", "Next")

658

n/a

g.add("ALL", 0, 5, 150, 20, "Install for all users")

659

n/a

g.add("JUSTME", 0, 25, 150, 20, "Install just for me")

660

n/a

661

n/a

whichusers.back("Back", None, active=0)

662

n/a

663

n/a

c = whichusers.next("Next >", "Cancel")

664

n/a

c.event("[ALLUSERS]", "1", 'WhichUsers="ALL"', 1)

665

n/a

c.event("EndDialog", "Return", ordering = 2)

666

n/a

667

n/a

c = whichusers.cancel("Cancel", "AdminInstall")

668

n/a

c.event("SpawnDialog", "CancelDlg")

669

n/a

670

n/a

#####################################################################

671

n/a

# Installation Progress dialog (modeless)

672

n/a

progress = PyDialog(db, "ProgressDlg", x, y, w, h, modeless, title,

673

n/a

"Cancel", "Cancel", "Cancel", bitmap=False)

674

n/a

progress.text("Title", 20, 15, 200, 15, 0x30003,

675

n/a

"{\DlgFontBold8}[Progress1] [ProductName]")

676

n/a

progress.text("Text", 35, 65, 300, 30, 3,

677

n/a

"Please wait while the Installer [Progress2] [ProductName]. "

678

n/a

"This may take several minutes.")

679

n/a

progress.text("StatusLabel", 35, 100, 35, 20, 3, "Status:")

680

n/a

681

n/a

c=progress.text("ActionText", 70, 100, w-70, 20, 3, "Pondering...")

682

n/a

c.mapping("ActionText", "Text")

683

n/a

684

n/a

#c=progress.text("ActionData", 35, 140, 300, 20, 3, None)

685

n/a

#c.mapping("ActionData", "Text")

686

n/a

687

n/a

c=progress.control("ProgressBar", "ProgressBar", 35, 120, 300, 10, 65537,

688

n/a

None, "Progress done", None, None)

689

n/a

c.mapping("SetProgress", "Progress")

690

n/a

691

n/a

progress.back("< Back", "Next", active=False)

692

n/a

progress.next("Next >", "Cancel", active=False)

693

n/a

progress.cancel("Cancel", "Back").event("SpawnDialog", "CancelDlg")

694

n/a

695

n/a

###################################################################

696

n/a

# Maintenance type: repair/uninstall

697

n/a

maint = PyDialog(db, "MaintenanceTypeDlg", x, y, w, h, modal, title,

698

n/a

"Next", "Next", "Cancel")

699

n/a

maint.title("Welcome to the [ProductName] Setup Wizard")

700

n/a

maint.text("BodyText", 15, 63, 330, 42, 3,

701

n/a

"Select whether you want to repair or remove [ProductName].")

702

n/a

g=maint.radiogroup("RepairRadioGroup", 15, 108, 330, 60, 3,

703

n/a

"MaintenanceForm_Action", "", "Next")

704

n/a

#g.add("Change", 0, 0, 200, 17, "&Change [ProductName]")

705

n/a

g.add("Repair", 0, 18, 200, 17, "&Repair [ProductName]")

706

n/a

g.add("Remove", 0, 36, 200, 17, "Re&move [ProductName]")

707

n/a

708

n/a

maint.back("< Back", None, active=False)

709

n/a

c=maint.next("Finish", "Cancel")

710

n/a

# Change installation: Change progress dialog to "Change", then ask

711

n/a

# for feature selection

712

n/a

#c.event("[Progress1]", "Change", 'MaintenanceForm_Action="Change"', 1)

713

n/a

#c.event("[Progress2]", "changes", 'MaintenanceForm_Action="Change"', 2)

714

n/a

715

n/a

# Reinstall: Change progress dialog to "Repair", then invoke reinstall

716

n/a

# Also set list of reinstalled features to "ALL"

717

n/a

c.event("[REINSTALL]", "ALL", 'MaintenanceForm_Action="Repair"', 5)

718

n/a

c.event("[Progress1]", "Repairing", 'MaintenanceForm_Action="Repair"', 6)

719

n/a

c.event("[Progress2]", "repairs", 'MaintenanceForm_Action="Repair"', 7)

720

n/a

c.event("Reinstall", "ALL", 'MaintenanceForm_Action="Repair"', 8)

721

n/a

722

n/a

# Uninstall: Change progress to "Remove", then invoke uninstall

723

n/a

# Also set list of removed features to "ALL"

724

n/a

c.event("[REMOVE]", "ALL", 'MaintenanceForm_Action="Remove"', 11)

725

n/a

c.event("[Progress1]", "Removing", 'MaintenanceForm_Action="Remove"', 12)

726

n/a

c.event("[Progress2]", "removes", 'MaintenanceForm_Action="Remove"', 13)

727

n/a

c.event("Remove", "ALL", 'MaintenanceForm_Action="Remove"', 14)

728

n/a

729

n/a

# Close dialog when maintenance action scheduled

730

n/a

c.event("EndDialog", "Return", 'MaintenanceForm_Action<>"Change"', 20)

731

n/a

#c.event("NewDialog", "SelectFeaturesDlg", 'MaintenanceForm_Action="Change"', 21)

732

n/a

733

n/a

maint.cancel("Cancel", "RepairRadioGroup").event("SpawnDialog", "CancelDlg")

734

n/a

735

n/a

def get_installer_filename(self, fullname):

736

n/a

# Factored out to allow overriding in subclasses

737

n/a

if self.target_version:

738

n/a

base_name = "%s.%s-py%s.msi" % (fullname, self.plat_name,

739

n/a

self.target_version)

740

n/a

else:

741

n/a

base_name = "%s.%s.msi" % (fullname, self.plat_name)

742

n/a

installer_name = os.path.join(self.dist_dir, base_name)

743

n/a

return installer_name

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