1ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh"""distutils.spawn 2ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 3ffab958fd8d42ed7227d83007350e61555a1fa36Andrew HsiehProvides the 'spawn()' function, a front-end to various platform- 4ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehspecific functions for launching another program in a sub-process. 5ffab958fd8d42ed7227d83007350e61555a1fa36Andrew HsiehAlso provides the 'find_executable()' to search the path for a given 6ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehexecutable name. 7ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh""" 8ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 9ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh__revision__ = "$Id$" 10ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 11ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehimport sys 12ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehimport os 13ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 14ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils.errors import DistutilsPlatformError, DistutilsExecError 15ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehfrom distutils import log 16ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 17ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef spawn(cmd, search_path=1, verbose=0, dry_run=0): 18ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """Run another program, specified as a command list 'cmd', in a new process. 19ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 20ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 'cmd' is just the argument list for the new process, ie. 21ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh cmd[0] is the program to run and cmd[1:] are the rest of its arguments. 22ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh There is no way to run a program with a name different from that of its 23ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable. 24ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 25ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh If 'search_path' is true (the default), the system's executable 26ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh search path will be used to find the program; otherwise, cmd[0] 27ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh must be the exact path to the executable. If 'dry_run' is true, 28ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh the command will not actually be run. 29ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 30ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh Raise DistutilsExecError if running the program fails in any way; just 31ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return on success. 32ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """ 33ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if os.name == 'posix': 34ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _spawn_posix(cmd, search_path, dry_run=dry_run) 35ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh elif os.name == 'nt': 36ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _spawn_nt(cmd, search_path, dry_run=dry_run) 37ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh elif os.name == 'os2': 38ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _spawn_os2(cmd, search_path, dry_run=dry_run) 39ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh else: 40ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsPlatformError, \ 41ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "don't know how to spawn programs on platform '%s'" % os.name 42ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 43ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef _nt_quote_args(args): 44ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """Quote command-line arguments for DOS/Windows conventions. 45ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 46ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh Just wraps every argument which contains blanks in double quotes, and 47ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh returns a new argument list. 48ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """ 49ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # XXX this doesn't seem very robust to me -- but if the Windows guys 50ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # say it'll work, I guess I'll have to accept it. (What if an arg 51ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # contains quotes? What other magic characters, other than spaces, 52ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # have to be escaped? Is there an escaping mechanism other than 53ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # quoting?) 54ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh for i, arg in enumerate(args): 55ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if ' ' in arg: 56ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh args[i] = '"%s"' % arg 57ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return args 58ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 59ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef _spawn_nt(cmd, search_path=1, verbose=0, dry_run=0): 60ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable = cmd[0] 61ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh cmd = _nt_quote_args(cmd) 62ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if search_path: 63ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # either we find one or it stays the same 64ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable = find_executable(executable) or executable 65ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh log.info(' '.join([executable] + cmd[1:])) 66ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if not dry_run: 67ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # spawn for NT requires a full path to the .exe 68ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh try: 69ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh rc = os.spawnv(os.P_WAIT, executable, cmd) 70ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh except OSError, exc: 71ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # this seems to happen when the command isn't found 72ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 73ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed: %s" % (cmd[0], exc[-1]) 74ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if rc != 0: 75ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # and this reflects the command running but failing 76ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 77ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed with exit status %d" % (cmd[0], rc) 78ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 79ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef _spawn_os2(cmd, search_path=1, verbose=0, dry_run=0): 80ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable = cmd[0] 81ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if search_path: 82ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # either we find one or it stays the same 83ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable = find_executable(executable) or executable 84ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh log.info(' '.join([executable] + cmd[1:])) 85ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if not dry_run: 86ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # spawnv for OS/2 EMX requires a full path to the .exe 87ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh try: 88ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh rc = os.spawnv(os.P_WAIT, executable, cmd) 89ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh except OSError, exc: 90ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # this seems to happen when the command isn't found 91ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 92ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed: %s" % (cmd[0], exc[-1]) 93ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if rc != 0: 94ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # and this reflects the command running but failing 95ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh log.debug("command '%s' failed with exit status %d" % (cmd[0], rc)) 96ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 97ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed with exit status %d" % (cmd[0], rc) 98ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 99ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehif sys.platform == 'darwin': 100ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh from distutils import sysconfig 101ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _cfg_target = None 102ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _cfg_target_split = None 103ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 104ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef _spawn_posix(cmd, search_path=1, verbose=0, dry_run=0): 105ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh log.info(' '.join(cmd)) 106ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if dry_run: 107ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return 108ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exec_fn = search_path and os.execvp or os.execv 109ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exec_args = [cmd[0], cmd] 110ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if sys.platform == 'darwin': 111ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh global _cfg_target, _cfg_target_split 112ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if _cfg_target is None: 113ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _cfg_target = sysconfig.get_config_var( 114ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 'MACOSX_DEPLOYMENT_TARGET') or '' 115ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if _cfg_target: 116ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh _cfg_target_split = [int(x) for x in _cfg_target.split('.')] 117ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if _cfg_target: 118ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # ensure that the deployment target of build process is not less 119ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # than that used when the interpreter was built. This ensures 120ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # extension modules are built with correct compatibility values 121ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh cur_target = os.environ.get('MACOSX_DEPLOYMENT_TARGET', _cfg_target) 122ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if _cfg_target_split > [int(x) for x in cur_target.split('.')]: 123ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh my_msg = ('$MACOSX_DEPLOYMENT_TARGET mismatch: ' 124ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 'now "%s" but "%s" during configure' 125ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh % (cur_target, _cfg_target)) 126ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsPlatformError(my_msg) 127ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh env = dict(os.environ, 128ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh MACOSX_DEPLOYMENT_TARGET=cur_target) 129ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exec_fn = search_path and os.execvpe or os.execve 130ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exec_args.append(env) 131ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh pid = os.fork() 132ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 133ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if pid == 0: # in the child 134ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh try: 135ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exec_fn(*exec_args) 136ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh except OSError, e: 137ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh sys.stderr.write("unable to execute %s: %s\n" % 138ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh (cmd[0], e.strerror)) 139ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh os._exit(1) 140ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 141ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh sys.stderr.write("unable to execute %s for unknown reasons" % cmd[0]) 142ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh os._exit(1) 143ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh else: # in the parent 144ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # Loop until the child either exits or is terminated by a signal 145ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # (ie. keep waiting if it's merely stopped) 146ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh while 1: 147ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh try: 148ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh pid, status = os.waitpid(pid, 0) 149ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh except OSError, exc: 150ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh import errno 151ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if exc.errno == errno.EINTR: 152ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh continue 153ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 154ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed: %s" % (cmd[0], exc[-1]) 155ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if os.WIFSIGNALED(status): 156ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 157ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' terminated by signal %d" % \ 158ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh (cmd[0], os.WTERMSIG(status)) 159ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 160ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh elif os.WIFEXITED(status): 161ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh exit_status = os.WEXITSTATUS(status) 162ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if exit_status == 0: 163ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return # hey, it succeeded! 164ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh else: 165ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 166ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "command '%s' failed with exit status %d" % \ 167ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh (cmd[0], exit_status) 168ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 169ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh elif os.WIFSTOPPED(status): 170ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh continue 171ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 172ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh else: 173ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh raise DistutilsExecError, \ 174ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh "unknown error executing '%s': termination status %d" % \ 175ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh (cmd[0], status) 176ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 177ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsiehdef find_executable(executable, path=None): 178ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """Tries to find 'executable' in the directories listed in 'path'. 179ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 180ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh A string listing directories separated by 'os.pathsep'; defaults to 181ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh os.environ['PATH']. Returns the complete filename or None if not found. 182ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh """ 183ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if path is None: 184ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh path = os.environ['PATH'] 185ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh paths = path.split(os.pathsep) 186ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh base, ext = os.path.splitext(executable) 187ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 188ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if (sys.platform == 'win32' or os.name == 'os2') and (ext != '.exe'): 189ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh executable = executable + '.exe' 190ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh 191ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if not os.path.isfile(executable): 192ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh for p in paths: 193ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh f = os.path.join(p, executable) 194ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh if os.path.isfile(f): 195ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh # the file exists, we have a shot at spawn working 196ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return f 197ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return None 198ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh else: 199ffab958fd8d42ed7227d83007350e61555a1fa36Andrew Hsieh return executable 200