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

#	count	content
1	n/a	"""Create a built (binary) distribution.
2	n/a
3	n/a	If a --formats option was given on the command line, this command will
4	n/a	call the corresponding bdist_* commands; if the option was absent, a
5	n/a	bdist_* command depending on the current platform will be called.
6	n/a	"""
7	n/a
8	n/a	import os
9	n/a
10	n/a	from packaging import util
11	n/a	from packaging.command.cmd import Command
12	n/a	from packaging.errors import PackagingPlatformError, PackagingOptionError
13	n/a
14	n/a
15	n/a	def show_formats():
16	n/a	"""Print list of available formats (arguments to "--format" option).
17	n/a	"""
18	n/a	from packaging.fancy_getopt import FancyGetopt
19	n/a	formats = []
20	n/a	for format in bdist.format_commands:
21	n/a	formats.append(("formats=" + format, None,
22	n/a	bdist.format_command[format][1]))
23	n/a	pretty_printer = FancyGetopt(formats)
24	n/a	pretty_printer.print_help("List of available distribution formats:")
25	n/a
26	n/a
27	n/a	class bdist(Command):
28	n/a
29	n/a	description = "create a built (binary) distribution"
30	n/a
31	n/a	user_options = [('bdist-base=', 'b',
32	n/a	"temporary directory for creating built distributions"),
33	n/a	('plat-name=', 'p',
34	n/a	"platform name to embed in generated filenames "
35	n/a	"(default: %s)" % util.get_platform()),
36	n/a	('formats=', None,
37	n/a	"formats for distribution (comma-separated list)"),
38	n/a	('dist-dir=', 'd',
39	n/a	"directory to put final built distributions in "
40	n/a	"[default: dist]"),
41	n/a	('skip-build', None,
42	n/a	"skip rebuilding everything (for testing/debugging)"),
43	n/a	('owner=', 'u',
44	n/a	"Owner name used when creating a tar file"
45	n/a	" [default: current user]"),
46	n/a	('group=', 'g',
47	n/a	"Group name used when creating a tar file"
48	n/a	" [default: current group]"),
49	n/a	]
50	n/a
51	n/a	boolean_options = ['skip-build']
52	n/a
53	n/a	help_options = [
54	n/a	('help-formats', None,
55	n/a	"lists available distribution formats", show_formats),
56	n/a	]
57	n/a
58	n/a	# This is of course very simplistic. The various UNIX family operating
59	n/a	# systems have their specific formats, but they are out of scope for us;
60	n/a	# bdist_dumb is, well, dumb; it's more a building block for other
61	n/a	# packaging tools than a real end-user binary format.
62	n/a	default_format = {'posix': 'gztar',
63	n/a	'nt': 'zip',
64	n/a	'os2': 'zip'}
65	n/a
66	n/a	# Establish the preferred order (for the --help-formats option).
67	n/a	format_commands = ['gztar', 'bztar', 'tar',
68	n/a	'wininst', 'zip', 'msi']
69	n/a
70	n/a	# And the real information.
71	n/a	format_command = {'gztar': ('bdist_dumb', "gzip'ed tar file"),
72	n/a	'bztar': ('bdist_dumb', "bzip2'ed tar file"),
73	n/a	'tar': ('bdist_dumb', "tar file"),
74	n/a	'wininst': ('bdist_wininst',
75	n/a	"Windows executable installer"),
76	n/a	'zip': ('bdist_dumb', "ZIP file"),
77	n/a	'msi': ('bdist_msi', "Microsoft Installer"),
78	n/a	}
79	n/a
80	n/a	def initialize_options(self):
81	n/a	self.bdist_base = None
82	n/a	self.plat_name = None
83	n/a	self.formats = None
84	n/a	self.dist_dir = None
85	n/a	self.skip_build = False
86	n/a	self.group = None
87	n/a	self.owner = None
88	n/a
89	n/a	def finalize_options(self):
90	n/a	# have to finalize 'plat_name' before 'bdist_base'
91	n/a	if self.plat_name is None:
92	n/a	if self.skip_build:
93	n/a	self.plat_name = util.get_platform()
94	n/a	else:
95	n/a	self.plat_name = self.get_finalized_command('build').plat_name
96	n/a
97	n/a	# 'bdist_base' -- parent of per-built-distribution-format
98	n/a	# temporary directories (eg. we'll probably have
99	n/a	# "build/bdist.<plat>/dumb", etc.)
100	n/a	if self.bdist_base is None:
101	n/a	build_base = self.get_finalized_command('build').build_base
102	n/a	self.bdist_base = os.path.join(build_base,
103	n/a	'bdist.' + self.plat_name)
104	n/a
105	n/a	self.ensure_string_list('formats')
106	n/a	if self.formats is None:
107	n/a	try:
108	n/a	self.formats = [self.default_format[os.name]]
109	n/a	except KeyError:
110	n/a	raise PackagingPlatformError(
111	n/a	"don't know how to create built distributions "
112	n/a	"on platform %s" % os.name)
113	n/a
114	n/a	if self.dist_dir is None:
115	n/a	self.dist_dir = "dist"
116	n/a
117	n/a	def run(self):
118	n/a	# Figure out which sub-commands we need to run.
119	n/a	commands = []
120	n/a	for format in self.formats:
121	n/a	try:
122	n/a	commands.append(self.format_command[format][0])
123	n/a	except KeyError:
124	n/a	raise PackagingOptionError("invalid format '%s'" % format)
125	n/a
126	n/a	# Reinitialize and run each command.
127	n/a	for i in range(len(self.formats)):
128	n/a	cmd_name = commands[i]
129	n/a	sub_cmd = self.reinitialize_command(cmd_name)
130	n/a	sub_cmd.format = self.formats[i]
131	n/a
132	n/a	# passing the owner and group names for tar archiving
133	n/a	if cmd_name == 'bdist_dumb':
134	n/a	sub_cmd.owner = self.owner
135	n/a	sub_cmd.group = self.group
136	n/a
137	n/a	# If we're going to need to run this command again, tell it to
138	n/a	# keep its temporary files around so subsequent runs go faster.
139	n/a	if cmd_name in commands[i+1:]:
140	n/a	sub_cmd.keep_temp = True
141	n/a	self.run_command(cmd_name)