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

#	count	content
1	n/a	"""Install all modules (extensions and pure Python)."""
2	n/a
3	n/a	import os
4	n/a	import imp
5	n/a
6	n/a	from packaging import logger
7	n/a	from packaging.command.cmd import Command
8	n/a	from packaging.errors import PackagingOptionError
9	n/a
10	n/a
11	n/a	# Extension for Python source files.
12	n/a	# XXX dead code? most of the codebase checks for literal '.py'
13	n/a	if hasattr(os, 'extsep'):
14	n/a	PYTHON_SOURCE_EXTENSION = os.extsep + "py"
15	n/a	else:
16	n/a	PYTHON_SOURCE_EXTENSION = ".py"
17	n/a
18	n/a
19	n/a	class install_lib(Command):
20	n/a
21	n/a	description = "install all modules (extensions and pure Python)"
22	n/a
23	n/a	# The options for controlling byte compilation are two independent sets:
24	n/a	# 'compile' is strictly boolean, and only decides whether to
25	n/a	# generate .pyc files. 'optimize' is three-way (0, 1, or 2), and
26	n/a	# decides both whether to generate .pyo files and what level of
27	n/a	# optimization to use.
28	n/a
29	n/a	user_options = [
30	n/a	('install-dir=', 'd', "directory to install to"),
31	n/a	('build-dir=', 'b', "build directory (where to install from)"),
32	n/a	('force', 'f', "force installation (overwrite existing files)"),
33	n/a	('compile', 'c', "compile .py to .pyc [default]"),
34	n/a	('no-compile', None, "don't compile .py files"),
35	n/a	('optimize=', 'O',
36	n/a	"also compile with optimization: -O1 for \"python -O\", "
37	n/a	"-O2 for \"python -OO\", and -O0 to disable [default: -O0]"),
38	n/a	('skip-build', None, "skip the build steps"),
39	n/a	]
40	n/a
41	n/a	boolean_options = ['force', 'compile', 'skip-build']
42	n/a
43	n/a	negative_opt = {'no-compile': 'compile'}
44	n/a
45	n/a	def initialize_options(self):
46	n/a	# let the 'install_dist' command dictate our installation directory
47	n/a	self.install_dir = None
48	n/a	self.build_dir = None
49	n/a	self.force = False
50	n/a	self.compile = None
51	n/a	self.optimize = None
52	n/a	self.skip_build = None
53	n/a
54	n/a	def finalize_options(self):
55	n/a	# Get all the information we need to install pure Python modules
56	n/a	# from the umbrella 'install_dist' command -- build (source) directory,
57	n/a	# install (target) directory, and whether to compile .py files.
58	n/a	self.set_undefined_options('install_dist',
59	n/a	('build_lib', 'build_dir'),
60	n/a	('install_lib', 'install_dir'),
61	n/a	'force', 'compile', 'optimize',
62	n/a	'skip_build')
63	n/a
64	n/a	if self.compile is None:
65	n/a	self.compile = True
66	n/a	if self.optimize is None:
67	n/a	self.optimize = 0
68	n/a
69	n/a	if not isinstance(self.optimize, int):
70	n/a	try:
71	n/a	self.optimize = int(self.optimize)
72	n/a	if self.optimize not in (0, 1, 2):
73	n/a	raise AssertionError
74	n/a	except (ValueError, AssertionError):
75	n/a	raise PackagingOptionError("optimize must be 0, 1, or 2")
76	n/a
77	n/a	def run(self):
78	n/a	# Make sure we have built everything we need first
79	n/a	self.build()
80	n/a
81	n/a	# Install everything: simply dump the entire contents of the build
82	n/a	# directory to the installation directory (that's the beauty of
83	n/a	# having a build directory!)
84	n/a	outfiles = self.install()
85	n/a
86	n/a	# (Optionally) compile .py to .pyc and/or .pyo
87	n/a	if outfiles is not None and self.distribution.has_pure_modules():
88	n/a	# XXX comment from distutils: "This [prefix stripping] is far from
89	n/a	# complete, but it should at least generate usable bytecode in RPM
90	n/a	# distributions." -> need to find exact requirements for
91	n/a	# byte-compiled files and fix it
92	n/a	install_root = self.get_finalized_command('install_dist').root
93	n/a	self.byte_compile(outfiles, prefix=install_root)
94	n/a
95	n/a	# -- Top-level worker functions ------------------------------------
96	n/a	# (called from 'run()')
97	n/a
98	n/a	def build(self):
99	n/a	if not self.skip_build:
100	n/a	if self.distribution.has_pure_modules():
101	n/a	self.run_command('build_py')
102	n/a	if self.distribution.has_ext_modules():
103	n/a	self.run_command('build_ext')
104	n/a
105	n/a	def install(self):
106	n/a	if os.path.isdir(self.build_dir):
107	n/a	outfiles = self.copy_tree(self.build_dir, self.install_dir)
108	n/a	else:
109	n/a	logger.warning(
110	n/a	'%s: %r does not exist -- no Python modules to install',
111	n/a	self.get_command_name(), self.build_dir)
112	n/a	return
113	n/a	return outfiles
114	n/a
115	n/a	# -- Utility methods -----------------------------------------------
116	n/a
117	n/a	def _mutate_outputs(self, has_any, build_cmd, cmd_option, output_dir):
118	n/a	if not has_any:
119	n/a	return []
120	n/a
121	n/a	build_cmd = self.get_finalized_command(build_cmd)
122	n/a	build_files = build_cmd.get_outputs()
123	n/a	build_dir = getattr(build_cmd, cmd_option)
124	n/a
125	n/a	prefix_len = len(build_dir) + len(os.sep)
126	n/a	outputs = []
127	n/a	for file in build_files:
128	n/a	outputs.append(os.path.join(output_dir, file[prefix_len:]))
129	n/a
130	n/a	return outputs
131	n/a
132	n/a	def _bytecode_filenames(self, py_filenames):
133	n/a	bytecode_files = []
134	n/a	for py_file in py_filenames:
135	n/a	# Since build_py handles package data installation, the
136	n/a	# list of outputs can contain more than just .py files.
137	n/a	# Make sure we only report bytecode for the .py files.
138	n/a	ext = os.path.splitext(os.path.normcase(py_file))[1]
139	n/a	if ext != PYTHON_SOURCE_EXTENSION:
140	n/a	continue
141	n/a	if self.compile:
142	n/a	bytecode_files.append(imp.cache_from_source(py_file, True))
143	n/a	if self.optimize:
144	n/a	bytecode_files.append(imp.cache_from_source(py_file, False))
145	n/a
146	n/a	return bytecode_files
147	n/a
148	n/a	# -- External interface --------------------------------------------
149	n/a	# (called by outsiders)
150	n/a
151	n/a	def get_outputs(self):
152	n/a	"""Return the list of files that would be installed if this command
153	n/a	were actually run. Not affected by the "dry-run" flag or whether
154	n/a	modules have actually been built yet.
155	n/a	"""
156	n/a	pure_outputs = \
157	n/a	self._mutate_outputs(self.distribution.has_pure_modules(),
158	n/a	'build_py', 'build_lib',
159	n/a	self.install_dir)
160	n/a	if self.compile:
161	n/a	bytecode_outputs = self._bytecode_filenames(pure_outputs)
162	n/a	else:
163	n/a	bytecode_outputs = []
164	n/a
165	n/a	ext_outputs = \
166	n/a	self._mutate_outputs(self.distribution.has_ext_modules(),
167	n/a	'build_ext', 'build_lib',
168	n/a	self.install_dir)
169	n/a
170	n/a	return pure_outputs + bytecode_outputs + ext_outputs
171	n/a
172	n/a	def get_inputs(self):
173	n/a	"""Get the list of files that are input to this command, ie. the
174	n/a	files that get installed as they are named in the build tree.
175	n/a	The files in this list correspond one-to-one to the output
176	n/a	filenames returned by 'get_outputs()'.
177	n/a	"""
178	n/a	inputs = []
179	n/a
180	n/a	if self.distribution.has_pure_modules():
181	n/a	build_py = self.get_finalized_command('build_py')
182	n/a	inputs.extend(build_py.get_outputs())
183	n/a
184	n/a	if self.distribution.has_ext_modules():
185	n/a	build_ext = self.get_finalized_command('build_ext')
186	n/a	inputs.extend(build_ext.get_outputs())
187	n/a
188	n/a	return inputs