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

#	count	content
1	n/a	"""Build pure Python modules (just copy to build directory)."""
2	n/a
3	n/a	import os
4	n/a	import imp
5	n/a	from glob import glob
6	n/a
7	n/a	from packaging import logger
8	n/a	from packaging.command.cmd import Command
9	n/a	from packaging.errors import PackagingOptionError, PackagingFileError
10	n/a	from packaging.util import convert_path
11	n/a	from packaging.compat import Mixin2to3
12	n/a
13	n/a	# marking public APIs
14	n/a	__all__ = ['build_py']
15	n/a
16	n/a
17	n/a	class build_py(Command, Mixin2to3):
18	n/a
19	n/a	description = "build pure Python modules (copy to build directory)"
20	n/a
21	n/a	# The options for controlling byte compilation are two independent sets;
22	n/a	# more info in install_lib or the reST docs
23	n/a
24	n/a	user_options = [
25	n/a	('build-lib=', 'd', "directory to build (copy) to"),
26	n/a	('compile', 'c', "compile .py to .pyc"),
27	n/a	('no-compile', None, "don't compile .py files [default]"),
28	n/a	('optimize=', 'O',
29	n/a	"also compile with optimization: -O1 for \"python -O\", "
30	n/a	"-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
31	n/a	('force', 'f', "forcibly build everything (ignore file timestamps)"),
32	n/a	('use-2to3', None,
33	n/a	"use 2to3 to make source python 3.x compatible"),
34	n/a	('convert-2to3-doctests', None,
35	n/a	"use 2to3 to convert doctests in separate text files"),
36	n/a	('use-2to3-fixers', None,
37	n/a	"list additional fixers opted for during 2to3 conversion"),
38	n/a	]
39	n/a
40	n/a	boolean_options = ['compile', 'force']
41	n/a
42	n/a	negative_opt = {'no-compile': 'compile'}
43	n/a
44	n/a	def initialize_options(self):
45	n/a	self.build_lib = None
46	n/a	self.py_modules = None
47	n/a	self.package = None
48	n/a	self.package_data = None
49	n/a	self.package_dir = None
50	n/a	self.compile = False
51	n/a	self.optimize = 0
52	n/a	self.force = None
53	n/a	self._updated_files = []
54	n/a	self._doctests_2to3 = []
55	n/a	self.use_2to3 = False
56	n/a	self.convert_2to3_doctests = None
57	n/a	self.use_2to3_fixers = None
58	n/a
59	n/a	def finalize_options(self):
60	n/a	self.set_undefined_options('build',
61	n/a	'use_2to3', 'use_2to3_fixers',
62	n/a	'convert_2to3_doctests', 'build_lib',
63	n/a	'force')
64	n/a
65	n/a	# Get the distribution options that are aliases for build_py
66	n/a	# options -- list of packages and list of modules.
67	n/a	self.packages = self.distribution.packages
68	n/a	self.py_modules = self.distribution.py_modules
69	n/a	self.package_data = self.distribution.package_data
70	n/a	self.package_dir = None
71	n/a	if self.distribution.package_dir is not None:
72	n/a	self.package_dir = convert_path(self.distribution.package_dir)
73	n/a	self.data_files = self.get_data_files()
74	n/a
75	n/a	# Ick, copied straight from install_lib.py (fancy_getopt needs a
76	n/a	# type system! Hell, everything needs a type system!!!)
77	n/a	if not isinstance(self.optimize, int):
78	n/a	try:
79	n/a	self.optimize = int(self.optimize)
80	n/a	assert 0 <= self.optimize <= 2
81	n/a	except (ValueError, AssertionError):
82	n/a	raise PackagingOptionError("optimize must be 0, 1, or 2")
83	n/a
84	n/a	def run(self):
85	n/a	# XXX copy_file by default preserves atime and mtime. IMHO this is
86	n/a	# the right thing to do, but perhaps it should be an option -- in
87	n/a	# particular, a site administrator might want installed files to
88	n/a	# reflect the time of installation rather than the last
89	n/a	# modification time before the installed release.
90	n/a
91	n/a	# XXX copy_file by default preserves mode, which appears to be the
92	n/a	# wrong thing to do: if a file is read-only in the working
93	n/a	# directory, we want it to be installed read/write so that the next
94	n/a	# installation of the same module distribution can overwrite it
95	n/a	# without problems. (This might be a Unix-specific issue.) Thus
96	n/a	# we turn off 'preserve_mode' when copying to the build directory,
97	n/a	# since the build directory is supposed to be exactly what the
98	n/a	# installation will look like (ie. we preserve mode when
99	n/a	# installing).
100	n/a
101	n/a	# Two options control which modules will be installed: 'packages'
102	n/a	# and 'py_modules'. The former lets us work with whole packages, not
103	n/a	# specifying individual modules at all; the latter is for
104	n/a	# specifying modules one-at-a-time.
105	n/a
106	n/a	if self.py_modules:
107	n/a	self.build_modules()
108	n/a	if self.packages:
109	n/a	self.build_packages()
110	n/a	self.build_package_data()
111	n/a
112	n/a	if self.use_2to3 and self._updated_files:
113	n/a	self.run_2to3(self._updated_files, self._doctests_2to3,
114	n/a	self.use_2to3_fixers)
115	n/a
116	n/a	self.byte_compile(self.get_outputs(include_bytecode=False),
117	n/a	prefix=self.build_lib)
118	n/a
119	n/a	# -- Top-level worker functions ------------------------------------
120	n/a
121	n/a	def get_data_files(self):
122	n/a	"""Generate list of '(package,src_dir,build_dir,filenames)' tuples.
123	n/a
124	n/a	Helper function for finalize_options.
125	n/a	"""
126	n/a	data = []
127	n/a	if not self.packages:
128	n/a	return data
129	n/a	for package in self.packages:
130	n/a	# Locate package source directory
131	n/a	src_dir = self.get_package_dir(package)
132	n/a
133	n/a	# Compute package build directory
134	n/a	build_dir = os.path.join(*([self.build_lib] + package.split('.')))
135	n/a
136	n/a	# Length of path to strip from found files
137	n/a	plen = 0
138	n/a	if src_dir:
139	n/a	plen = len(src_dir) + 1
140	n/a
141	n/a	# Strip directory from globbed filenames
142	n/a	filenames = [
143	n/a	file[plen:] for file in self.find_data_files(package, src_dir)
144	n/a	]
145	n/a	data.append((package, src_dir, build_dir, filenames))
146	n/a	return data
147	n/a
148	n/a	def find_data_files(self, package, src_dir):
149	n/a	"""Return filenames for package's data files in 'src_dir'.
150	n/a
151	n/a	Helper function for get_data_files.
152	n/a	"""
153	n/a	globs = (self.package_data.get('', [])
154	n/a	+ self.package_data.get(package, []))
155	n/a	files = []
156	n/a	for pattern in globs:
157	n/a	# Each pattern has to be converted to a platform-specific path
158	n/a	filelist = glob(os.path.join(src_dir, convert_path(pattern)))
159	n/a	# Files that match more than one pattern are only added once
160	n/a	files.extend(fn for fn in filelist if fn not in files)
161	n/a	return files
162	n/a
163	n/a	def build_package_data(self):
164	n/a	"""Copy data files into build directory.
165	n/a
166	n/a	Helper function for run.
167	n/a	"""
168	n/a	# FIXME add tests for this method
169	n/a	for package, src_dir, build_dir, filenames in self.data_files:
170	n/a	for filename in filenames:
171	n/a	target = os.path.join(build_dir, filename)
172	n/a	srcfile = os.path.join(src_dir, filename)
173	n/a	self.mkpath(os.path.dirname(target))
174	n/a	outf, copied = self.copy_file(srcfile,
175	n/a	target, preserve_mode=False)
176	n/a	doctests = self.distribution.convert_2to3_doctests
177	n/a	if copied and srcfile in doctests:
178	n/a	self._doctests_2to3.append(outf)
179	n/a
180	n/a	# XXX - this should be moved to the Distribution class as it is not
181	n/a	# only needed for build_py. It also has no dependencies on this class.
182	n/a	def get_package_dir(self, package):
183	n/a	"""Return the directory, relative to the top of the source
184	n/a	distribution, where package 'package' should be found
185	n/a	(at least according to the 'package_dir' option, if any).
186	n/a	"""
187	n/a	path = package.split('.')
188	n/a	if self.package_dir is not None:
189	n/a	path.insert(0, self.package_dir)
190	n/a
191	n/a	if len(path) > 0:
192	n/a	return os.path.join(*path)
193	n/a
194	n/a	return ''
195	n/a
196	n/a	def check_package(self, package, package_dir):
197	n/a	"""Helper function for find_package_modules and find_modules."""
198	n/a	# Empty dir name means current directory, which we can probably
199	n/a	# assume exists. Also, os.path.exists and isdir don't know about
200	n/a	# my "empty string means current dir" convention, so we have to
201	n/a	# circumvent them.
202	n/a	if package_dir != "":
203	n/a	if not os.path.exists(package_dir):
204	n/a	raise PackagingFileError(
205	n/a	"package directory '%s' does not exist" % package_dir)
206	n/a	if not os.path.isdir(package_dir):
207	n/a	raise PackagingFileError(
208	n/a	"supposed package directory '%s' exists, "
209	n/a	"but is not a directory" % package_dir)
210	n/a
211	n/a	# Require __init__.py for all but the "root package"
212	n/a	if package:
213	n/a	init_py = os.path.join(package_dir, "__init__.py")
214	n/a	if os.path.isfile(init_py):
215	n/a	return init_py
216	n/a	else:
217	n/a	logger.warning("package init file %r not found "
218	n/a	"(or not a regular file)", init_py)
219	n/a
220	n/a	# Either not in a package at all (__init__.py not expected), or
221	n/a	# __init__.py doesn't exist -- so don't return the filename.
222	n/a	return None
223	n/a
224	n/a	def check_module(self, module, module_file):
225	n/a	if not os.path.isfile(module_file):
226	n/a	logger.warning("file %r (for module %r) not found",
227	n/a	module_file, module)
228	n/a	return False
229	n/a	else:
230	n/a	return True
231	n/a
232	n/a	def find_package_modules(self, package, package_dir):
233	n/a	self.check_package(package, package_dir)
234	n/a	module_files = glob(os.path.join(package_dir, "*.py"))
235	n/a	modules = []
236	n/a	if self.distribution.script_name is not None:
237	n/a	setup_script = os.path.abspath(self.distribution.script_name)
238	n/a	else:
239	n/a	setup_script = None
240	n/a
241	n/a	for f in module_files:
242	n/a	abs_f = os.path.abspath(f)
243	n/a	if abs_f != setup_script:
244	n/a	module = os.path.splitext(os.path.basename(f))[0]
245	n/a	modules.append((package, module, f))
246	n/a	else:
247	n/a	logger.debug("excluding %r", setup_script)
248	n/a	return modules
249	n/a
250	n/a	def find_modules(self):
251	n/a	"""Finds individually-specified Python modules, ie. those listed by
252	n/a	module name in 'self.py_modules'. Returns a list of tuples (package,
253	n/a	module_base, filename): 'package' is a tuple of the path through
254	n/a	package-space to the module; 'module_base' is the bare (no
255	n/a	packages, no dots) module name, and 'filename' is the path to the
256	n/a	".py" file (relative to the distribution root) that implements the
257	n/a	module.
258	n/a	"""
259	n/a	# Map package names to tuples of useful info about the package:
260	n/a	# (package_dir, checked)
261	n/a	# package_dir - the directory where we'll find source files for
262	n/a	# this package
263	n/a	# checked - true if we have checked that the package directory
264	n/a	# is valid (exists, contains __init__.py, ... ?)
265	n/a	packages = {}
266	n/a
267	n/a	# List of (package, module, filename) tuples to return
268	n/a	modules = []
269	n/a
270	n/a	# We treat modules-in-packages almost the same as toplevel modules,
271	n/a	# just the "package" for a toplevel is empty (either an empty
272	n/a	# string or empty list, depending on context). Differences:
273	n/a	# - don't check for __init__.py in directory for empty package
274	n/a	for module in self.py_modules:
275	n/a	path = module.split('.')
276	n/a	package = '.'.join(path[0:-1])
277	n/a	module_base = path[-1]
278	n/a
279	n/a	try:
280	n/a	package_dir, checked = packages[package]
281	n/a	except KeyError:
282	n/a	package_dir = self.get_package_dir(package)
283	n/a	checked = False
284	n/a
285	n/a	if not checked:
286	n/a	init_py = self.check_package(package, package_dir)
287	n/a	packages[package] = (package_dir, 1)
288	n/a	if init_py:
289	n/a	modules.append((package, "__init__", init_py))
290	n/a
291	n/a	# XXX perhaps we should also check for just .pyc files
292	n/a	# (so greedy closed-source bastards can distribute Python
293	n/a	# modules too)
294	n/a	module_file = os.path.join(package_dir, module_base + ".py")
295	n/a	if not self.check_module(module, module_file):
296	n/a	continue
297	n/a
298	n/a	modules.append((package, module_base, module_file))
299	n/a
300	n/a	return modules
301	n/a
302	n/a	def find_all_modules(self):
303	n/a	"""Compute the list of all modules that will be built, whether
304	n/a	they are specified one-module-at-a-time ('self.py_modules') or
305	n/a	by whole packages ('self.packages'). Return a list of tuples
306	n/a	(package, module, module_file), just like 'find_modules()' and
307	n/a	'find_package_modules()' do."""
308	n/a	modules = []
309	n/a	if self.py_modules:
310	n/a	modules.extend(self.find_modules())
311	n/a	if self.packages:
312	n/a	for package in self.packages:
313	n/a	package_dir = self.get_package_dir(package)
314	n/a	m = self.find_package_modules(package, package_dir)
315	n/a	modules.extend(m)
316	n/a	return modules
317	n/a
318	n/a	def get_source_files(self):
319	n/a	sources = [module[-1] for module in self.find_all_modules()]
320	n/a	sources += [
321	n/a	os.path.join(src_dir, filename)
322	n/a	for package, src_dir, build_dir, filenames in self.data_files
323	n/a	for filename in filenames]
324	n/a	return sources
325	n/a
326	n/a	def get_module_outfile(self, build_dir, package, module):
327	n/a	outfile_path = [build_dir] + list(package) + [module + ".py"]
328	n/a	return os.path.join(*outfile_path)
329	n/a
330	n/a	def get_outputs(self, include_bytecode=True):
331	n/a	modules = self.find_all_modules()
332	n/a	outputs = []
333	n/a	for package, module, module_file in modules:
334	n/a	package = package.split('.')
335	n/a	filename = self.get_module_outfile(self.build_lib, package, module)
336	n/a	outputs.append(filename)
337	n/a	if include_bytecode:
338	n/a	if self.compile:
339	n/a	outputs.append(imp.cache_from_source(filename, True))
340	n/a	if self.optimize:
341	n/a	outputs.append(imp.cache_from_source(filename, False))
342	n/a
343	n/a	outputs += [
344	n/a	os.path.join(build_dir, filename)
345	n/a	for package, src_dir, build_dir, filenames in self.data_files
346	n/a	for filename in filenames]
347	n/a
348	n/a	return outputs
349	n/a
350	n/a	def build_module(self, module, module_file, package):
351	n/a	if isinstance(package, str):
352	n/a	package = package.split('.')
353	n/a	elif not isinstance(package, (list, tuple)):
354	n/a	raise TypeError(
355	n/a	"'package' must be a string (dot-separated), list, or tuple")
356	n/a
357	n/a	# Now put the module source file into the "build" area -- this is
358	n/a	# easy, we just copy it somewhere under self.build_lib (the build
359	n/a	# directory for Python source).
360	n/a	outfile = self.get_module_outfile(self.build_lib, package, module)
361	n/a	dir = os.path.dirname(outfile)
362	n/a	self.mkpath(dir)
363	n/a	return self.copy_file(module_file, outfile, preserve_mode=False)
364	n/a
365	n/a	def build_modules(self):
366	n/a	modules = self.find_modules()
367	n/a	for package, module, module_file in modules:
368	n/a	# Now "build" the module -- ie. copy the source file to
369	n/a	# self.build_lib (the build directory for Python source).
370	n/a	# (Actually, it gets copied to the directory for this package
371	n/a	# under self.build_lib.)
372	n/a	self.build_module(module, module_file, package)
373	n/a
374	n/a	def build_packages(self):
375	n/a	for package in self.packages:
376	n/a	# Get list of (package, module, module_file) tuples based on
377	n/a	# scanning the package directory. 'package' is only included
378	n/a	# in the tuple so that 'find_modules()' and
379	n/a	# 'find_package_tuples()' have a consistent interface; it's
380	n/a	# ignored here (apart from a sanity check). Also, 'module' is
381	n/a	# the unqualified module name (ie. no dots, no package -- we
382	n/a	# already know its package!), and 'module_file' is the path to
383	n/a	# the .py file, relative to the current directory
384	n/a	# (ie. including 'package_dir').
385	n/a	package_dir = self.get_package_dir(package)
386	n/a	modules = self.find_package_modules(package, package_dir)
387	n/a
388	n/a	# Now loop over the modules we found, "building" each one (just
389	n/a	# copy it to self.build_lib).
390	n/a	for package_, module, module_file in modules:
391	n/a	assert package == package_
392	n/a	self.build_module(module, module_file, package)