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

#	count	content
1	n/a	"""Main build command, which calls the other build_* commands."""
2	n/a
3	n/a	import sys
4	n/a	import os
5	n/a
6	n/a	from packaging.util import get_platform
7	n/a	from packaging.command.cmd import Command
8	n/a	from packaging.errors import PackagingOptionError
9	n/a	from packaging.compiler import show_compilers
10	n/a
11	n/a
12	n/a	class build(Command):
13	n/a
14	n/a	description = "build everything needed to install"
15	n/a
16	n/a	user_options = [
17	n/a	('build-base=', 'b',
18	n/a	"base directory for build library"),
19	n/a	('build-purelib=', None,
20	n/a	"build directory for platform-neutral distributions"),
21	n/a	('build-platlib=', None,
22	n/a	"build directory for platform-specific distributions"),
23	n/a	('build-lib=', None,
24	n/a	"build directory for all distribution (defaults to either " +
25	n/a	"build-purelib or build-platlib"),
26	n/a	('build-scripts=', None,
27	n/a	"build directory for scripts"),
28	n/a	('build-temp=', 't',
29	n/a	"temporary build directory"),
30	n/a	('plat-name=', 'p',
31	n/a	"platform name to build for, if supported "
32	n/a	"(default: %s)" % get_platform()),
33	n/a	('compiler=', 'c',
34	n/a	"specify the compiler type"),
35	n/a	('debug', 'g',
36	n/a	"compile extensions and libraries with debugging information"),
37	n/a	('force', 'f',
38	n/a	"forcibly build everything (ignore file timestamps)"),
39	n/a	('executable=', 'e',
40	n/a	"specify final destination interpreter path (build.py)"),
41	n/a	('use-2to3', None,
42	n/a	"use 2to3 to make source python 3.x compatible"),
43	n/a	('convert-2to3-doctests', None,
44	n/a	"use 2to3 to convert doctests in separate text files"),
45	n/a	('use-2to3-fixers', None,
46	n/a	"list additional fixers opted for during 2to3 conversion"),
47	n/a	]
48	n/a
49	n/a	boolean_options = ['debug', 'force']
50	n/a
51	n/a	help_options = [
52	n/a	('help-compiler', None,
53	n/a	"list available compilers", show_compilers),
54	n/a	]
55	n/a
56	n/a	def initialize_options(self):
57	n/a	self.build_base = 'build'
58	n/a	# these are decided only after 'build_base' has its final value
59	n/a	# (unless overridden by the user or client)
60	n/a	self.build_purelib = None
61	n/a	self.build_platlib = None
62	n/a	self.build_lib = None
63	n/a	self.build_temp = None
64	n/a	self.build_scripts = None
65	n/a	self.compiler = None
66	n/a	self.plat_name = None
67	n/a	self.debug = None
68	n/a	self.force = False
69	n/a	self.executable = None
70	n/a	self.use_2to3 = False
71	n/a	self.convert_2to3_doctests = None
72	n/a	self.use_2to3_fixers = None
73	n/a
74	n/a	def finalize_options(self):
75	n/a	if self.plat_name is None:
76	n/a	self.plat_name = get_platform()
77	n/a	else:
78	n/a	# plat-name only supported for windows (other platforms are
79	n/a	# supported via ./configure flags, if at all). Avoid misleading
80	n/a	# other platforms.
81	n/a	if os.name != 'nt':
82	n/a	raise PackagingOptionError(
83	n/a	"--plat-name only supported on Windows (try "
84	n/a	"using './configure --help' on your platform)")
85	n/a	pyversion = '%s.%s' % sys.version_info[:2]
86	n/a	plat_specifier = ".%s-%s" % (self.plat_name, pyversion)
87	n/a
88	n/a	# Make it so Python 2.x and Python 2.x with --with-pydebug don't
89	n/a	# share the same build directories. Doing so confuses the build
90	n/a	# process for C modules
91	n/a	if hasattr(sys, 'gettotalrefcount'):
92	n/a	plat_specifier += '-pydebug'
93	n/a
94	n/a	# 'build_purelib' and 'build_platlib' just default to 'lib' and
95	n/a	# 'lib.<plat>' under the base build directory. We only use one of
96	n/a	# them for a given distribution, though --
97	n/a	if self.build_purelib is None:
98	n/a	self.build_purelib = os.path.join(self.build_base, 'lib')
99	n/a	if self.build_platlib is None:
100	n/a	self.build_platlib = os.path.join(self.build_base,
101	n/a	'lib' + plat_specifier)
102	n/a
103	n/a	# 'build_lib' is the actual directory that we will use for this
104	n/a	# particular module distribution -- if user didn't supply it, pick
105	n/a	# one of 'build_purelib' or 'build_platlib'.
106	n/a	if self.build_lib is None:
107	n/a	if self.distribution.ext_modules:
108	n/a	self.build_lib = self.build_platlib
109	n/a	else:
110	n/a	self.build_lib = self.build_purelib
111	n/a
112	n/a	# 'build_temp' -- temporary directory for compiler turds,
113	n/a	# "build/temp.<plat>"
114	n/a	if self.build_temp is None:
115	n/a	self.build_temp = os.path.join(self.build_base,
116	n/a	'temp' + plat_specifier)
117	n/a	if self.build_scripts is None:
118	n/a	self.build_scripts = os.path.join(self.build_base,
119	n/a	'scripts-' + pyversion)
120	n/a
121	n/a	if self.executable is None:
122	n/a	self.executable = os.path.normpath(sys.executable)
123	n/a
124	n/a	def run(self):
125	n/a	# Run all relevant sub-commands. This will be some subset of:
126	n/a	# - build_py - pure Python modules
127	n/a	# - build_clib - standalone C libraries
128	n/a	# - build_ext - Python extension modules
129	n/a	# - build_scripts - Python scripts
130	n/a	for cmd_name in self.get_sub_commands():
131	n/a	self.run_command(cmd_name)
132	n/a
133	n/a	# -- Predicates for the sub-command list ---------------------------
134	n/a
135	n/a	def has_pure_modules(self):
136	n/a	return self.distribution.has_pure_modules()
137	n/a
138	n/a	def has_c_libraries(self):
139	n/a	return self.distribution.has_c_libraries()
140	n/a
141	n/a	def has_ext_modules(self):
142	n/a	return self.distribution.has_ext_modules()
143	n/a
144	n/a	def has_scripts(self):
145	n/a	return self.distribution.has_scripts()
146	n/a
147	n/a	sub_commands = [('build_py', has_pure_modules),
148	n/a	('build_clib', has_c_libraries),
149	n/a	('build_ext', has_ext_modules),
150	n/a	('build_scripts', has_scripts),
151	n/a	]