Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 1 | """distutils.command.build_scripts |
| 2 | |
| 3 | Implements the Distutils 'build_scripts' command.""" |
| 4 | |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 5 | __revision__ = "$Id$" |
| 6 | |
Christian Heimes | 05e8be1 | 2008-02-23 18:30:17 +0000 | [diff] [blame] | 7 | import os, re |
Guido van Rossum | bcb0e20 | 2003-01-24 14:56:52 +0000 | [diff] [blame] | 8 | from stat import ST_MODE |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 9 | from distutils import sysconfig |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 10 | from distutils.core import Command |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 11 | from distutils.dep_util import newer |
Martin v. Löwis | 6178db6 | 2008-12-01 04:38:52 +0000 | [diff] [blame] | 12 | from distutils.util import convert_path, Mixin2to3 |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 13 | from distutils import log |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 14 | import tokenize |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 15 | |
Greg Ward | 7cf7e7e | 2001-07-25 20:20:11 +0000 | [diff] [blame] | 16 | # check if Python is called on the first line with this expression |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 17 | first_line_re = re.compile(b'^#!.*python[0-9.]*([ \t].*)?$') |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 18 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 19 | class build_scripts(Command): |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 20 | |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 21 | description = "\"build\" scripts (copy and fixup #! line)" |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 22 | |
| 23 | user_options = [ |
| 24 | ('build-dir=', 'd', "directory to \"build\" (copy) to"), |
| 25 | ('force', 'f', "forcibly build everything (ignore file timestamps"), |
Martin v. Löwis | 9f5c0c4 | 2004-08-25 11:37:43 +0000 | [diff] [blame] | 26 | ('executable=', 'e', "specify final destination interpreter path"), |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 27 | ] |
| 28 | |
Greg Ward | 99b032e | 2000-09-25 01:41:15 +0000 | [diff] [blame] | 29 | boolean_options = ['force'] |
| 30 | |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 31 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 32 | def initialize_options(self): |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 33 | self.build_dir = None |
| 34 | self.scripts = None |
| 35 | self.force = None |
Martin v. Löwis | 9f5c0c4 | 2004-08-25 11:37:43 +0000 | [diff] [blame] | 36 | self.executable = None |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 37 | self.outfiles = None |
| 38 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 39 | def finalize_options(self): |
Greg Ward | cb1f4c4 | 2000-09-30 18:27:54 +0000 | [diff] [blame] | 40 | self.set_undefined_options('build', |
| 41 | ('build_scripts', 'build_dir'), |
Martin v. Löwis | 9f5c0c4 | 2004-08-25 11:37:43 +0000 | [diff] [blame] | 42 | ('force', 'force'), |
| 43 | ('executable', 'executable')) |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 44 | self.scripts = self.distribution.scripts |
| 45 | |
Fred Drake | 4b49823 | 2004-03-25 22:04:52 +0000 | [diff] [blame] | 46 | def get_source_files(self): |
| 47 | return self.scripts |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 48 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 49 | def run(self): |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 50 | if not self.scripts: |
| 51 | return |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 52 | self.copy_scripts() |
| 53 | |
Fred Drake | 53a7906 | 2001-03-02 07:28:03 +0000 | [diff] [blame] | 54 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 55 | def copy_scripts(self): |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 56 | """Copy each script listed in 'self.scripts'; if it's marked as a |
| 57 | Python script in the Unix way (first line matches 'first_line_re', |
| 58 | ie. starts with "\#!" and contains "python"), then adjust the first |
Greg Ward | 612eb9f | 2000-07-27 02:13:20 +0000 | [diff] [blame] | 59 | line to refer to the current Python interpreter as we copy. |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 60 | """ |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 61 | self.mkpath(self.build_dir) |
Guido van Rossum | bcb0e20 | 2003-01-24 14:56:52 +0000 | [diff] [blame] | 62 | outfiles = [] |
Martin v. Löwis | 6178db6 | 2008-12-01 04:38:52 +0000 | [diff] [blame] | 63 | updated_files = [] |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 64 | for script in self.scripts: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 65 | adjust = False |
Just van Rossum | 8d8e7a3 | 2001-07-29 21:39:18 +0000 | [diff] [blame] | 66 | script = convert_path(script) |
Greg Ward | fe55e86 | 2000-05-25 20:05:52 +0000 | [diff] [blame] | 67 | outfile = os.path.join(self.build_dir, os.path.basename(script)) |
Guido van Rossum | bcb0e20 | 2003-01-24 14:56:52 +0000 | [diff] [blame] | 68 | outfiles.append(outfile) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 69 | |
| 70 | if not self.force and not newer(script, outfile): |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 71 | log.debug("not copying %s (up-to-date)", script) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 72 | continue |
| 73 | |
| 74 | # Always open the file, but ignore failures in dry-run mode -- |
| 75 | # that way, we'll get accurate feedback if we can read the |
| 76 | # script. |
| 77 | try: |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 78 | f = open(script, "rb") |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 79 | except IOError: |
| 80 | if not self.dry_run: |
| 81 | raise |
| 82 | f = None |
| 83 | else: |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 84 | encoding, lines = tokenize.detect_encoding(f.readline) |
| 85 | f.seek(0) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 86 | first_line = f.readline() |
| 87 | if not first_line: |
| 88 | self.warn("%s is an empty file (skipping)" % script) |
Greg Ward | a4efe65 | 2000-05-25 01:20:15 +0000 | [diff] [blame] | 89 | continue |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 90 | |
| 91 | match = first_line_re.match(first_line) |
| 92 | if match: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 93 | adjust = True |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 94 | post_interp = match.group(1) or b'' |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 95 | |
| 96 | if adjust: |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 97 | log.info("copying and adjusting %s -> %s", script, |
| 98 | self.build_dir) |
Martin v. Löwis | 6178db6 | 2008-12-01 04:38:52 +0000 | [diff] [blame] | 99 | updated_files.append(outfile) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 100 | if not self.dry_run: |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 101 | if not sysconfig.python_build: |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 102 | executable = self.executable |
Michael W. Hudson | fb173cd | 2001-12-10 16:15:44 +0000 | [diff] [blame] | 103 | else: |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 104 | executable = os.path.join( |
Tarek Ziadé | 3679727 | 2010-07-22 12:50:05 +0000 | [diff] [blame] | 105 | sysconfig.get_config_var("BINDIR"), |
| 106 | "python%s%s" % (sysconfig.get_config_var("VERSION"), |
Victor Stinner | 1947477 | 2011-05-11 00:14:28 +0200 | [diff] [blame] | 107 | sysconfig.get_config_var("EXE"))) |
| 108 | executable = os.fsencode(executable) |
| 109 | shebang = b"#!" + executable + post_interp + b"\n" |
| 110 | # Python parser starts to read a script using UTF-8 until |
| 111 | # it gets a #coding:xxx cookie. The shebang has to be the |
| 112 | # first line of a file, the #coding:xxx cookie cannot be |
| 113 | # written before. So the shebang has to be decodable from |
| 114 | # UTF-8. |
| 115 | try: |
| 116 | shebang.decode('utf-8') |
| 117 | except UnicodeDecodeError: |
| 118 | raise ValueError( |
| 119 | "The shebang ({!r}) is not decodable " |
| 120 | "from utf-8".format(shebang)) |
| 121 | # If the script is encoded to a custom encoding (use a |
| 122 | # #coding:xxx cookie), the shebang has to be decodable from |
| 123 | # the script encoding too. |
| 124 | try: |
| 125 | shebang.decode(encoding) |
| 126 | except UnicodeDecodeError: |
| 127 | raise ValueError( |
| 128 | "The shebang ({!r}) is not decodable " |
| 129 | "from the script encoding ({})" |
| 130 | .format(shebang, encoding)) |
Victor Stinner | cfd365b | 2011-05-19 15:18:36 +0200 | [diff] [blame] | 131 | with open(outfile, "wb") as outf: |
| 132 | outf.write(shebang) |
| 133 | outf.writelines(f.readlines()) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 134 | if f: |
| 135 | f.close() |
| 136 | else: |
Christian Heimes | 072c0f1 | 2008-01-03 23:01:04 +0000 | [diff] [blame] | 137 | if f: |
| 138 | f.close() |
Martin v. Löwis | 6178db6 | 2008-12-01 04:38:52 +0000 | [diff] [blame] | 139 | updated_files.append(outfile) |
Greg Ward | 80fa55e | 2000-05-25 02:03:56 +0000 | [diff] [blame] | 140 | self.copy_file(script, outfile) |
| 141 | |
Guido van Rossum | bcb0e20 | 2003-01-24 14:56:52 +0000 | [diff] [blame] | 142 | if os.name == 'posix': |
| 143 | for file in outfiles: |
| 144 | if self.dry_run: |
| 145 | log.info("changing mode of %s", file) |
| 146 | else: |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 147 | oldmode = os.stat(file)[ST_MODE] & 0o7777 |
| 148 | newmode = (oldmode | 0o555) & 0o7777 |
Guido van Rossum | d3590f9 | 2003-01-29 16:58:31 +0000 | [diff] [blame] | 149 | if newmode != oldmode: |
| 150 | log.info("changing mode of %s from %o to %o", |
| 151 | file, oldmode, newmode) |
| 152 | os.chmod(file, newmode) |
Martin v. Löwis | 6178db6 | 2008-12-01 04:38:52 +0000 | [diff] [blame] | 153 | # XXX should we modify self.outfiles? |
| 154 | return outfiles, updated_files |
| 155 | |
| 156 | class build_scripts_2to3(build_scripts, Mixin2to3): |
| 157 | |
| 158 | def copy_scripts(self): |
| 159 | outfiles, updated_files = build_scripts.copy_scripts(self) |
| 160 | if not self.dry_run: |
| 161 | self.run_2to3(updated_files) |
| 162 | return outfiles, updated_files |