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

#	count	content
1	n/a	"""Build scripts (copy to build dir and fix up shebang line)."""
2	n/a
3	n/a	import os
4	n/a	import re
5	n/a	import sysconfig
6	n/a	from tokenize import detect_encoding
7	n/a
8	n/a	from packaging.command.cmd import Command
9	n/a	from packaging.util import convert_path, newer
10	n/a	from packaging import logger
11	n/a	from packaging.compat import Mixin2to3
12	n/a
13	n/a
14	n/a	# check if Python is called on the first line with this expression
15	n/a	first_line_re = re.compile(b'^#!.python[0-9.]([ \t].*)?$')
16	n/a
17	n/a	class build_scripts(Command, Mixin2to3):
18	n/a
19	n/a	description = "build scripts (copy and fix up shebang line)"
20	n/a
21	n/a	user_options = [
22	n/a	('build-dir=', 'd', "directory to build (copy) to"),
23	n/a	('force', 'f', "forcibly build everything (ignore file timestamps"),
24	n/a	('executable=', 'e', "specify final destination interpreter path"),
25	n/a	]
26	n/a
27	n/a	boolean_options = ['force']
28	n/a
29	n/a
30	n/a	def initialize_options(self):
31	n/a	self.build_dir = None
32	n/a	self.scripts = None
33	n/a	self.force = None
34	n/a	self.executable = None
35	n/a	self.outfiles = None
36	n/a	self.use_2to3 = False
37	n/a	self.convert_2to3_doctests = None
38	n/a	self.use_2to3_fixers = None
39	n/a
40	n/a	def finalize_options(self):
41	n/a	self.set_undefined_options('build',
42	n/a	('build_scripts', 'build_dir'),
43	n/a	'use_2to3', 'use_2to3_fixers',
44	n/a	'convert_2to3_doctests', 'force',
45	n/a	'executable')
46	n/a	self.scripts = self.distribution.scripts
47	n/a
48	n/a	def get_source_files(self):
49	n/a	return self.scripts
50	n/a
51	n/a	def run(self):
52	n/a	if not self.scripts:
53	n/a	return
54	n/a	copied_files = self.copy_scripts()
55	n/a	if self.use_2to3 and copied_files:
56	n/a	self._run_2to3(copied_files, fixers=self.use_2to3_fixers)
57	n/a
58	n/a	def copy_scripts(self):
59	n/a	"""Copy each script listed in 'self.scripts'; if it's marked as a
60	n/a	Python script in the Unix way (first line matches 'first_line_re',
61	n/a	ie. starts with "\#!" and contains "python"), then adjust the first
62	n/a	line to refer to the current Python interpreter as we copy.
63	n/a	"""
64	n/a	self.mkpath(self.build_dir)
65	n/a	outfiles = []
66	n/a	for script in self.scripts:
67	n/a	adjust = False
68	n/a	script = convert_path(script)
69	n/a	outfile = os.path.join(self.build_dir, os.path.basename(script))
70	n/a	outfiles.append(outfile)
71	n/a
72	n/a	if not self.force and not newer(script, outfile):
73	n/a	logger.debug("not copying %s (up-to-date)", script)
74	n/a	continue
75	n/a
76	n/a	# Always open the file, but ignore failures in dry-run mode --
77	n/a	# that way, we'll get accurate feedback if we can read the
78	n/a	# script.
79	n/a	try:
80	n/a	f = open(script, "rb")
81	n/a	except IOError:
82	n/a	if not self.dry_run:
83	n/a	raise
84	n/a	f = None
85	n/a	else:
86	n/a	encoding, lines = detect_encoding(f.readline)
87	n/a	f.seek(0)
88	n/a	first_line = f.readline()
89	n/a	if not first_line:
90	n/a	logger.warning('%s: %s is an empty file (skipping)',
91	n/a	self.get_command_name(), script)
92	n/a	continue
93	n/a
94	n/a	match = first_line_re.match(first_line)
95	n/a	if match:
96	n/a	adjust = True
97	n/a	post_interp = match.group(1) or b''
98	n/a
99	n/a	if adjust:
100	n/a	logger.info("copying and adjusting %s -> %s", script,
101	n/a	self.build_dir)
102	n/a	if not self.dry_run:
103	n/a	if not sysconfig.is_python_build():
104	n/a	executable = self.executable
105	n/a	else:
106	n/a	executable = os.path.join(
107	n/a	sysconfig.get_config_var("BINDIR"),
108	n/a	"python%s%s" % (sysconfig.get_config_var("VERSION"),
109	n/a	sysconfig.get_config_var("EXE")))
110	n/a	executable = os.fsencode(executable)
111	n/a	shebang = b"#!" + executable + post_interp + b"\n"
112	n/a	# Python parser starts to read a script using UTF-8 until
113	n/a	# it gets a #coding:xxx cookie. The shebang has to be the
114	n/a	# first line of a file, the #coding:xxx cookie cannot be
115	n/a	# written before. So the shebang has to be decodable from
116	n/a	# UTF-8.
117	n/a	try:
118	n/a	shebang.decode('utf-8')
119	n/a	except UnicodeDecodeError:
120	n/a	raise ValueError(
121	n/a	"The shebang ({!r}) is not decodable "
122	n/a	"from utf-8".format(shebang))
123	n/a	# If the script is encoded to a custom encoding (use a
124	n/a	# #coding:xxx cookie), the shebang has to be decodable from
125	n/a	# the script encoding too.
126	n/a	try:
127	n/a	shebang.decode(encoding)
128	n/a	except UnicodeDecodeError:
129	n/a	raise ValueError(
130	n/a	"The shebang ({!r}) is not decodable "
131	n/a	"from the script encoding ({})"
132	n/a	.format(shebang, encoding))
133	n/a	with open(outfile, "wb") as outf:
134	n/a	outf.write(shebang)
135	n/a	outf.writelines(f.readlines())
136	n/a	if f:
137	n/a	f.close()
138	n/a	else:
139	n/a	if f:
140	n/a	f.close()
141	n/a	self.copy_file(script, outfile)
142	n/a
143	n/a	if os.name == 'posix':
144	n/a	for file in outfiles:
145	n/a	if self.dry_run:
146	n/a	logger.info("changing mode of %s", file)
147	n/a	else:
148	n/a	oldmode = os.stat(file).st_mode & 0o7777
149	n/a	newmode = (oldmode \| 0o555) & 0o7777
150	n/a	if newmode != oldmode:
151	n/a	logger.info("changing mode of %s from %o to %o",
152	n/a	file, oldmode, newmode)
153	n/a	os.chmod(file, newmode)
154	n/a	return outfiles