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

#	count	content
1	n/a	"""Prepare the build.
2	n/a
3	n/a	This module provides config, a (mostly) empty command class
4	n/a	that exists mainly to be sub-classed by specific module distributions and
5	n/a	applications. The idea is that while every "config" command is different,
6	n/a	at least they're all named the same, and users always see "config" in the
7	n/a	list of standard commands. Also, this is a good place to put common
8	n/a	configure-like tasks: "try to compile this C code", or "figure out where
9	n/a	this header file lives".
10	n/a	"""
11	n/a
12	n/a	import os
13	n/a	import re
14	n/a
15	n/a	from packaging.command.cmd import Command
16	n/a	from packaging.errors import PackagingExecError
17	n/a	from packaging.compiler import customize_compiler
18	n/a	from packaging import logger
19	n/a
20	n/a	LANG_EXT = {'c': '.c', 'c++': '.cxx'}
21	n/a
22	n/a	class config(Command):
23	n/a
24	n/a	description = "prepare the build"
25	n/a
26	n/a	user_options = [
27	n/a	('compiler=', None,
28	n/a	"specify the compiler type"),
29	n/a	('cc=', None,
30	n/a	"specify the compiler executable"),
31	n/a	('include-dirs=', 'I',
32	n/a	"list of directories to search for header files"),
33	n/a	('define=', 'D',
34	n/a	"C preprocessor macros to define"),
35	n/a	('undef=', 'U',
36	n/a	"C preprocessor macros to undefine"),
37	n/a	('libraries=', 'l',
38	n/a	"external C libraries to link with"),
39	n/a	('library-dirs=', 'L',
40	n/a	"directories to search for external C libraries"),
41	n/a
42	n/a	('noisy', None,
43	n/a	"show every action (compile, link, run, ...) taken"),
44	n/a	('dump-source', None,
45	n/a	"dump generated source files before attempting to compile them"),
46	n/a	]
47	n/a
48	n/a
49	n/a	# The three standard command methods: since the "config" command
50	n/a	# does nothing by default, these are empty.
51	n/a
52	n/a	def initialize_options(self):
53	n/a	self.compiler = None
54	n/a	self.cc = None
55	n/a	self.include_dirs = None
56	n/a	self.libraries = None
57	n/a	self.library_dirs = None
58	n/a
59	n/a	# maximal output for now
60	n/a	self.noisy = True
61	n/a	self.dump_source = True
62	n/a
63	n/a	# list of temporary files generated along-the-way that we have
64	n/a	# to clean at some point
65	n/a	self.temp_files = []
66	n/a
67	n/a	def finalize_options(self):
68	n/a	if self.include_dirs is None:
69	n/a	self.include_dirs = self.distribution.include_dirs or []
70	n/a	elif isinstance(self.include_dirs, str):
71	n/a	self.include_dirs = self.include_dirs.split(os.pathsep)
72	n/a
73	n/a	if self.libraries is None:
74	n/a	self.libraries = []
75	n/a	elif isinstance(self.libraries, str):
76	n/a	self.libraries = [self.libraries]
77	n/a
78	n/a	if self.library_dirs is None:
79	n/a	self.library_dirs = []
80	n/a	elif isinstance(self.library_dirs, str):
81	n/a	self.library_dirs = self.library_dirs.split(os.pathsep)
82	n/a
83	n/a	def run(self):
84	n/a	pass
85	n/a
86	n/a
87	n/a	# Utility methods for actual "config" commands. The interfaces are
88	n/a	# loosely based on Autoconf macros of similar names. Sub-classes
89	n/a	# may use these freely.
90	n/a
91	n/a	def _check_compiler(self):
92	n/a	"""Check that 'self.compiler' really is a CCompiler object;
93	n/a	if not, make it one.
94	n/a	"""
95	n/a	# We do this late, and only on-demand, because this is an expensive
96	n/a	# import.
97	n/a	from packaging.compiler.ccompiler import CCompiler
98	n/a	from packaging.compiler import new_compiler
99	n/a	if not isinstance(self.compiler, CCompiler):
100	n/a	self.compiler = new_compiler(compiler=self.compiler,
101	n/a	dry_run=self.dry_run, force=True)
102	n/a	customize_compiler(self.compiler)
103	n/a	if self.include_dirs:
104	n/a	self.compiler.set_include_dirs(self.include_dirs)
105	n/a	if self.libraries:
106	n/a	self.compiler.set_libraries(self.libraries)
107	n/a	if self.library_dirs:
108	n/a	self.compiler.set_library_dirs(self.library_dirs)
109	n/a
110	n/a
111	n/a	def _gen_temp_sourcefile(self, body, headers, lang):
112	n/a	filename = "_configtest" + LANG_EXT[lang]
113	n/a	with open(filename, "w") as file:
114	n/a	if headers:
115	n/a	for header in headers:
116	n/a	file.write("#include <%s>\n" % header)
117	n/a	file.write("\n")
118	n/a	file.write(body)
119	n/a	if body[-1] != "\n":
120	n/a	file.write("\n")
121	n/a	return filename
122	n/a
123	n/a	def _preprocess(self, body, headers, include_dirs, lang):
124	n/a	src = self._gen_temp_sourcefile(body, headers, lang)
125	n/a	out = "_configtest.i"
126	n/a	self.temp_files.extend((src, out))
127	n/a	self.compiler.preprocess(src, out, include_dirs=include_dirs)
128	n/a	return src, out
129	n/a
130	n/a	def _compile(self, body, headers, include_dirs, lang):
131	n/a	src = self._gen_temp_sourcefile(body, headers, lang)
132	n/a	if self.dump_source:
133	n/a	dump_file(src, "compiling '%s':" % src)
134	n/a	obj = self.compiler.object_filenames([src])[0]
135	n/a	self.temp_files.extend((src, obj))
136	n/a	self.compiler.compile([src], include_dirs=include_dirs)
137	n/a	return src, obj
138	n/a
139	n/a	def _link(self, body, headers, include_dirs, libraries, library_dirs,
140	n/a	lang):
141	n/a	src, obj = self._compile(body, headers, include_dirs, lang)
142	n/a	prog = os.path.splitext(os.path.basename(src))[0]
143	n/a	self.compiler.link_executable([obj], prog,
144	n/a	libraries=libraries,
145	n/a	library_dirs=library_dirs,
146	n/a	target_lang=lang)
147	n/a
148	n/a	if self.compiler.exe_extension is not None:
149	n/a	prog = prog + self.compiler.exe_extension
150	n/a	self.temp_files.append(prog)
151	n/a
152	n/a	return src, obj, prog
153	n/a
154	n/a	def _clean(self, *filenames):
155	n/a	if not filenames:
156	n/a	filenames = self.temp_files
157	n/a	self.temp_files = []
158	n/a	logger.info("removing: %s", ' '.join(filenames))
159	n/a	for filename in filenames:
160	n/a	try:
161	n/a	os.remove(filename)
162	n/a	except OSError:
163	n/a	pass
164	n/a
165	n/a
166	n/a	# XXX these ignore the dry-run flag: what to do, what to do? even if
167	n/a	# you want a dry-run build, you still need some sort of configuration
168	n/a	# info. My inclination is to make it up to the real config command to
169	n/a	# consult 'dry_run', and assume a default (minimal) configuration if
170	n/a	# true. The problem with trying to do it here is that you'd have to
171	n/a	# return either true or false from all the 'try' methods, neither of
172	n/a	# which is correct.
173	n/a
174	n/a	# XXX need access to the header search path and maybe default macros.
175	n/a
176	n/a	def try_cpp(self, body=None, headers=None, include_dirs=None, lang="c"):
177	n/a	"""Construct a source file from 'body' (a string containing lines
178	n/a	of C/C++ code) and 'headers' (a list of header files to include)
179	n/a	and run it through the preprocessor. Return true if the
180	n/a	preprocessor succeeded, false if there were any errors.
181	n/a	('body' probably isn't of much use, but what the heck.)
182	n/a	"""
183	n/a	from packaging.compiler.ccompiler import CompileError
184	n/a	self._check_compiler()
185	n/a	ok = True
186	n/a	try:
187	n/a	self._preprocess(body, headers, include_dirs, lang)
188	n/a	except CompileError:
189	n/a	ok = False
190	n/a
191	n/a	self._clean()
192	n/a	return ok
193	n/a
194	n/a	def search_cpp(self, pattern, body=None, headers=None, include_dirs=None,
195	n/a	lang="c"):
196	n/a	"""Construct a source file (just like 'try_cpp()'), run it through
197	n/a	the preprocessor, and return true if any line of the output matches
198	n/a	'pattern'. 'pattern' should either be a compiled regex object or a
199	n/a	string containing a regex. If both 'body' and 'headers' are None,
200	n/a	preprocesses an empty file -- which can be useful to determine the
201	n/a	symbols the preprocessor and compiler set by default.
202	n/a	"""
203	n/a	self._check_compiler()
204	n/a	src, out = self._preprocess(body, headers, include_dirs, lang)
205	n/a
206	n/a	if isinstance(pattern, str):
207	n/a	pattern = re.compile(pattern)
208	n/a
209	n/a	with open(out) as file:
210	n/a	match = False
211	n/a	while True:
212	n/a	line = file.readline()
213	n/a	if line == '':
214	n/a	break
215	n/a	if pattern.search(line):
216	n/a	match = True
217	n/a	break
218	n/a
219	n/a	self._clean()
220	n/a	return match
221	n/a
222	n/a	def try_compile(self, body, headers=None, include_dirs=None, lang="c"):
223	n/a	"""Try to compile a source file built from 'body' and 'headers'.
224	n/a	Return true on success, false otherwise.
225	n/a	"""
226	n/a	from packaging.compiler.ccompiler import CompileError
227	n/a	self._check_compiler()
228	n/a	try:
229	n/a	self._compile(body, headers, include_dirs, lang)
230	n/a	ok = True
231	n/a	except CompileError:
232	n/a	ok = False
233	n/a
234	n/a	logger.info(ok and "success!" or "failure.")
235	n/a	self._clean()
236	n/a	return ok
237	n/a
238	n/a	def try_link(self, body, headers=None, include_dirs=None, libraries=None,
239	n/a	library_dirs=None, lang="c"):
240	n/a	"""Try to compile and link a source file, built from 'body' and
241	n/a	'headers', to executable form. Return true on success, false
242	n/a	otherwise.
243	n/a	"""
244	n/a	from packaging.compiler.ccompiler import CompileError, LinkError
245	n/a	self._check_compiler()
246	n/a	try:
247	n/a	self._link(body, headers, include_dirs,
248	n/a	libraries, library_dirs, lang)
249	n/a	ok = True
250	n/a	except (CompileError, LinkError):
251	n/a	ok = False
252	n/a
253	n/a	logger.info(ok and "success!" or "failure.")
254	n/a	self._clean()
255	n/a	return ok
256	n/a
257	n/a	def try_run(self, body, headers=None, include_dirs=None, libraries=None,
258	n/a	library_dirs=None, lang="c"):
259	n/a	"""Try to compile, link to an executable, and run a program
260	n/a	built from 'body' and 'headers'. Return true on success, false
261	n/a	otherwise.
262	n/a	"""
263	n/a	from packaging.compiler.ccompiler import CompileError, LinkError
264	n/a	self._check_compiler()
265	n/a	try:
266	n/a	src, obj, exe = self._link(body, headers, include_dirs,
267	n/a	libraries, library_dirs, lang)
268	n/a	self.spawn([exe])
269	n/a	ok = True
270	n/a	except (CompileError, LinkError, PackagingExecError):
271	n/a	ok = False
272	n/a
273	n/a	logger.info(ok and "success!" or "failure.")
274	n/a	self._clean()
275	n/a	return ok
276	n/a
277	n/a
278	n/a	# -- High-level methods --------------------------------------------
279	n/a	# (these are the ones that are actually likely to be useful
280	n/a	# when implementing a real-world config command!)
281	n/a
282	n/a	def check_func(self, func, headers=None, include_dirs=None,
283	n/a	libraries=None, library_dirs=None, decl=False, call=False):
284	n/a
285	n/a	"""Determine if function 'func' is available by constructing a
286	n/a	source file that refers to 'func', and compiles and links it.
287	n/a	If everything succeeds, returns true; otherwise returns false.
288	n/a
289	n/a	The constructed source file starts out by including the header
290	n/a	files listed in 'headers'. If 'decl' is true, it then declares
291	n/a	'func' (as "int func()"); you probably shouldn't supply 'headers'
292	n/a	and set 'decl' true in the same call, or you might get errors about
293	n/a	a conflicting declarations for 'func'. Finally, the constructed
294	n/a	'main()' function either references 'func' or (if 'call' is true)
295	n/a	calls it. 'libraries' and 'library_dirs' are used when
296	n/a	linking.
297	n/a	"""
298	n/a
299	n/a	self._check_compiler()
300	n/a	body = []
301	n/a	if decl:
302	n/a	body.append("int %s ();" % func)
303	n/a	body.append("int main () {")
304	n/a	if call:
305	n/a	body.append(" %s();" % func)
306	n/a	else:
307	n/a	body.append(" %s;" % func)
308	n/a	body.append("}")
309	n/a	body = "\n".join(body) + "\n"
310	n/a
311	n/a	return self.try_link(body, headers, include_dirs,
312	n/a	libraries, library_dirs)
313	n/a
314	n/a	def check_lib(self, library, library_dirs=None, headers=None,
315	n/a	include_dirs=None, other_libraries=[]):
316	n/a	"""Determine if 'library' is available to be linked against,
317	n/a	without actually checking that any particular symbols are provided
318	n/a	by it. 'headers' will be used in constructing the source file to
319	n/a	be compiled, but the only effect of this is to check if all the
320	n/a	header files listed are available. Any libraries listed in
321	n/a	'other_libraries' will be included in the link, in case 'library'
322	n/a	has symbols that depend on other libraries.
323	n/a	"""
324	n/a	self._check_compiler()
325	n/a	return self.try_link("int main (void) { }",
326	n/a	headers, include_dirs,
327	n/a	[library]+other_libraries, library_dirs)
328	n/a
329	n/a	def check_header(self, header, include_dirs=None, library_dirs=None,
330	n/a	lang="c"):
331	n/a	"""Determine if the system header file named by 'header_file'
332	n/a	exists and can be found by the preprocessor; return true if so,
333	n/a	false otherwise.
334	n/a	"""
335	n/a	return self.try_cpp(body="/* No body */", headers=[header],
336	n/a	include_dirs=include_dirs)
337	n/a
338	n/a
339	n/a	def dump_file(filename, head=None):
340	n/a	"""Dumps a file content into log.info.
341	n/a
342	n/a	If head is not None, will be dumped before the file content.
343	n/a	"""
344	n/a	if head is None:
345	n/a	logger.info(filename)
346	n/a	else:
347	n/a	logger.info(head)
348	n/a	with open(filename) as file:
349	n/a	logger.info(file.read())