Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 1 | """distutils.spawn |
| 2 | |
| 3 | Provides the 'spawn()' function, a front-end to various platform- |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 4 | specific functions for launching another program in a sub-process. |
| 5 | Also provides the 'find_executable()' to search the path for a given |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 6 | executable name. |
| 7 | """ |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 8 | |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 9 | import sys |
| 10 | import os |
| 11 | |
| 12 | from distutils.errors import DistutilsPlatformError, DistutilsExecError |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 13 | from distutils.debug import DEBUG |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 14 | from distutils import log |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 15 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 16 | def spawn(cmd, search_path=1, verbose=0, dry_run=0): |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 17 | """Run another program, specified as a command list 'cmd', in a new process. |
| 18 | |
| 19 | 'cmd' is just the argument list for the new process, ie. |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 20 | cmd[0] is the program to run and cmd[1:] are the rest of its arguments. |
| 21 | There is no way to run a program with a name different from that of its |
| 22 | executable. |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 23 | |
Andrew M. Kuchling | fec3262 | 2002-11-21 20:41:07 +0000 | [diff] [blame] | 24 | If 'search_path' is true (the default), the system's executable |
| 25 | search path will be used to find the program; otherwise, cmd[0] |
| 26 | must be the exact path to the executable. If 'dry_run' is true, |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 27 | the command will not actually be run. |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 28 | |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 29 | Raise DistutilsExecError if running the program fails in any way; just |
| 30 | return on success. |
| 31 | """ |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 32 | # cmd is documented as a list, but just in case some code passes a tuple |
| 33 | # in, protect our %-formatting code against horrible death |
| 34 | cmd = list(cmd) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 35 | if os.name == 'posix': |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 36 | _spawn_posix(cmd, search_path, dry_run=dry_run) |
Greg Ward | a4d132a | 1999-09-08 02:23:28 +0000 | [diff] [blame] | 37 | elif os.name == 'nt': |
Jeremy Hylton | cd8a114 | 2002-06-04 20:14:43 +0000 | [diff] [blame] | 38 | _spawn_nt(cmd, search_path, dry_run=dry_run) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 39 | else: |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 40 | raise DistutilsPlatformError( |
| 41 | "don't know how to spawn programs on platform '%s'" % os.name) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 42 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 43 | def _nt_quote_args(args): |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 44 | """Quote command-line arguments for DOS/Windows conventions. |
| 45 | |
| 46 | Just wraps every argument which contains blanks in double quotes, and |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 47 | returns a new argument list. |
| 48 | """ |
Greg Ward | e2b4452 | 2000-03-07 03:25:20 +0000 | [diff] [blame] | 49 | # XXX this doesn't seem very robust to me -- but if the Windows guys |
| 50 | # say it'll work, I guess I'll have to accept it. (What if an arg |
| 51 | # contains quotes? What other magic characters, other than spaces, |
| 52 | # have to be escaped? Is there an escaping mechanism other than |
| 53 | # quoting?) |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 54 | for i, arg in enumerate(args): |
| 55 | if ' ' in arg: |
| 56 | args[i] = '"%s"' % arg |
Greg Ward | a3c8bf3 | 2000-03-26 21:47:00 +0000 | [diff] [blame] | 57 | return args |
Greg Ward | e2b4452 | 2000-03-07 03:25:20 +0000 | [diff] [blame] | 58 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 59 | def _spawn_nt(cmd, search_path=1, verbose=0, dry_run=0): |
Greg Ward | 69628b0 | 1999-08-29 18:20:56 +0000 | [diff] [blame] | 60 | executable = cmd[0] |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 61 | cmd = _nt_quote_args(cmd) |
Greg Ward | 69628b0 | 1999-08-29 18:20:56 +0000 | [diff] [blame] | 62 | if search_path: |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 63 | # either we find one or it stays the same |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 64 | executable = find_executable(executable) or executable |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 65 | log.info(' '.join([executable] + cmd[1:])) |
Greg Ward | 69628b0 | 1999-08-29 18:20:56 +0000 | [diff] [blame] | 66 | if not dry_run: |
| 67 | # spawn for NT requires a full path to the .exe |
Greg Ward | 3b49c9b | 2000-01-17 21:57:55 +0000 | [diff] [blame] | 68 | try: |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 69 | rc = os.spawnv(os.P_WAIT, executable, cmd) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 70 | except OSError as exc: |
Greg Ward | 3b49c9b | 2000-01-17 21:57:55 +0000 | [diff] [blame] | 71 | # this seems to happen when the command isn't found |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 72 | if not DEBUG: |
| 73 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 74 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 75 | "command %r failed: %s" % (cmd, exc.args[-1])) |
Greg Ward | 69628b0 | 1999-08-29 18:20:56 +0000 | [diff] [blame] | 76 | if rc != 0: |
Greg Ward | 3b49c9b | 2000-01-17 21:57:55 +0000 | [diff] [blame] | 77 | # and this reflects the command running but failing |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 78 | if not DEBUG: |
| 79 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 80 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 81 | "command %r failed with exit status %d" % (cmd, rc)) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 82 | |
Ned Deily | a8f8b50 | 2011-06-28 19:44:24 -0700 | [diff] [blame] | 83 | if sys.platform == 'darwin': |
| 84 | from distutils import sysconfig |
| 85 | _cfg_target = None |
| 86 | _cfg_target_split = None |
| 87 | |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 88 | def _spawn_posix(cmd, search_path=1, verbose=0, dry_run=0): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 89 | log.info(' '.join(cmd)) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 90 | if dry_run: |
| 91 | return |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 92 | executable = cmd[0] |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 93 | exec_fn = search_path and os.execvp or os.execv |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 94 | env = None |
Ned Deily | a8f8b50 | 2011-06-28 19:44:24 -0700 | [diff] [blame] | 95 | if sys.platform == 'darwin': |
| 96 | global _cfg_target, _cfg_target_split |
| 97 | if _cfg_target is None: |
| 98 | _cfg_target = sysconfig.get_config_var( |
| 99 | 'MACOSX_DEPLOYMENT_TARGET') or '' |
| 100 | if _cfg_target: |
| 101 | _cfg_target_split = [int(x) for x in _cfg_target.split('.')] |
| 102 | if _cfg_target: |
| 103 | # ensure that the deployment target of build process is not less |
| 104 | # than that used when the interpreter was built. This ensures |
| 105 | # extension modules are built with correct compatibility values |
| 106 | cur_target = os.environ.get('MACOSX_DEPLOYMENT_TARGET', _cfg_target) |
| 107 | if _cfg_target_split > [int(x) for x in cur_target.split('.')]: |
| 108 | my_msg = ('$MACOSX_DEPLOYMENT_TARGET mismatch: ' |
| 109 | 'now "%s" but "%s" during configure' |
| 110 | % (cur_target, _cfg_target)) |
| 111 | raise DistutilsPlatformError(my_msg) |
| 112 | env = dict(os.environ, |
| 113 | MACOSX_DEPLOYMENT_TARGET=cur_target) |
| 114 | exec_fn = search_path and os.execvpe or os.execve |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 115 | pid = os.fork() |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 116 | if pid == 0: # in the child |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 117 | try: |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 118 | if env is None: |
| 119 | exec_fn(executable, cmd) |
| 120 | else: |
| 121 | exec_fn(executable, cmd, env) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 122 | except OSError as e: |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 123 | if not DEBUG: |
| 124 | cmd = executable |
| 125 | sys.stderr.write("unable to execute %r: %s\n" |
| 126 | % (cmd, e.strerror)) |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 127 | os._exit(1) |
Fred Drake | b94b849 | 2001-12-06 20:51:35 +0000 | [diff] [blame] | 128 | |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 129 | if not DEBUG: |
| 130 | cmd = executable |
| 131 | sys.stderr.write("unable to execute %r for unknown reasons" % cmd) |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 132 | os._exit(1) |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 133 | else: # in the parent |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 134 | # Loop until the child either exits or is terminated by a signal |
| 135 | # (ie. keep waiting if it's merely stopped) |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 136 | while True: |
Hye-Shik Chang | 904de5b | 2004-02-24 23:54:17 +0000 | [diff] [blame] | 137 | try: |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 138 | pid, status = os.waitpid(pid, 0) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 139 | except OSError as exc: |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 140 | if not DEBUG: |
| 141 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 142 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 143 | "command %r failed: %s" % (cmd, exc.args[-1])) |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 144 | if os.WIFSIGNALED(status): |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 145 | if not DEBUG: |
| 146 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 147 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 148 | "command %r terminated by signal %d" |
| 149 | % (cmd, os.WTERMSIG(status))) |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 150 | elif os.WIFEXITED(status): |
| 151 | exit_status = os.WEXITSTATUS(status) |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 152 | if exit_status == 0: |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 153 | return # hey, it succeeded! |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 154 | else: |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 155 | if not DEBUG: |
| 156 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 157 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 158 | "command %r failed with exit status %d" |
| 159 | % (cmd, exit_status)) |
Greg Ward | a30f7ac | 2000-09-26 02:00:51 +0000 | [diff] [blame] | 160 | elif os.WIFSTOPPED(status): |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 161 | continue |
Greg Ward | b4dbfb3 | 1999-08-14 23:57:17 +0000 | [diff] [blame] | 162 | else: |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 163 | if not DEBUG: |
| 164 | cmd = executable |
Collin Winter | 5b7e9d7 | 2007-08-30 03:52:21 +0000 | [diff] [blame] | 165 | raise DistutilsExecError( |
Éric Araujo | 45fc871 | 2014-03-13 04:55:35 -0400 | [diff] [blame] | 166 | "unknown error executing %r: termination status %d" |
| 167 | % (cmd, status)) |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 168 | |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 169 | def find_executable(executable, path=None): |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 170 | """Tries to find 'executable' in the directories listed in 'path'. |
| 171 | |
| 172 | A string listing directories separated by 'os.pathsep'; defaults to |
| 173 | os.environ['PATH']. Returns the complete filename or None if not found. |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 174 | """ |
| 175 | if path is None: |
| 176 | path = os.environ['PATH'] |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 177 | |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 178 | paths = path.split(os.pathsep) |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 179 | base, ext = os.path.splitext(executable) |
| 180 | |
Jesus Cea | d17833d | 2012-10-11 01:20:12 +0200 | [diff] [blame] | 181 | if (sys.platform == 'win32') and (ext != '.exe'): |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 182 | executable = executable + '.exe' |
Tarek Ziadé | 861d644 | 2009-06-02 16:18:55 +0000 | [diff] [blame] | 183 | |
Greg Ward | 88608ca | 2000-08-02 01:08:02 +0000 | [diff] [blame] | 184 | if not os.path.isfile(executable): |
| 185 | for p in paths: |
| 186 | f = os.path.join(p, executable) |
| 187 | if os.path.isfile(f): |
| 188 | # the file exists, we have a shot at spawn working |
| 189 | return f |
| 190 | return None |
| 191 | else: |
| 192 | return executable |