subprocess32.py 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752
  1. # subprocess - Subprocesses with accessible I/O streams
  2. #
  3. # For more information about this module, see PEP 324.
  4. #
  5. # Copyright (c) 2003-2005 by Peter Astrand <astrand@lysator.liu.se>
  6. #
  7. # Licensed to PSF under a Contributor Agreement.
  8. # See http://www.python.org/3.3/license for licensing details.
  9. r"""Subprocesses with accessible I/O streams
  10. This module allows you to spawn processes, connect to their
  11. input/output/error pipes, and obtain their return codes.
  12. For a complete description of this module see the Python documentation.
  13. Main API
  14. ========
  15. run(...): Runs a command, waits for it to complete, then returns a
  16. CompletedProcess instance.
  17. Popen(...): A class for flexibly executing a command in a new process
  18. Constants
  19. ---------
  20. DEVNULL: Special value that indicates that os.devnull should be used
  21. PIPE: Special value that indicates a pipe should be created
  22. STDOUT: Special value that indicates that stderr should go to stdout
  23. Older API
  24. =========
  25. call(...): Runs a command, waits for it to complete, then returns
  26. the return code.
  27. check_call(...): Same as call() but raises CalledProcessError()
  28. if return code is not 0
  29. check_output(...): Same as check_call() but returns the contents of
  30. stdout instead of a return code
  31. """
  32. import sys
  33. mswindows = (sys.platform == "win32")
  34. import os
  35. import errno
  36. import exceptions
  37. import types
  38. import time
  39. import traceback
  40. import gc
  41. import signal
  42. # Exception classes used by this module.
  43. class SubprocessError(Exception): pass
  44. class CalledProcessError(SubprocessError):
  45. """Raised when run() is called with check=True and the process
  46. returns a non-zero exit status.
  47. Attributes:
  48. cmd, returncode, stdout, stderr, output
  49. """
  50. def __init__(self, returncode, cmd, output=None, stderr=None):
  51. self.returncode = returncode
  52. self.cmd = cmd
  53. self.output = output
  54. self.stderr = stderr
  55. super(CalledProcessError, self).__init__(returncode, cmd,
  56. output, stderr)
  57. def __str__(self):
  58. if self.returncode and self.returncode < 0:
  59. return "Command '%s' died with signal %d." % (
  60. self.cmd, -self.returncode)
  61. else:
  62. return "Command '%s' returned non-zero exit status %d." % (
  63. self.cmd, self.returncode)
  64. #@property
  65. def __stdout_getter(self):
  66. """Alias for output attribute, to match stderr"""
  67. return self.output
  68. #@stdout.setter # Required Python 2.6
  69. def __stdout_setter(self, value):
  70. # There's no obvious reason to set this, but allow it anyway so
  71. # .stdout is a transparent alias for .output
  72. self.output = value
  73. stdout = property(__stdout_getter, __stdout_setter) # Python 2.4
  74. class TimeoutExpired(SubprocessError):
  75. """This exception is raised when the timeout expires while waiting for a
  76. child process.
  77. Attributes:
  78. cmd, output, stdout, stderr, timeout
  79. """
  80. def __init__(self, cmd, timeout, output=None, stderr=None):
  81. self.cmd = cmd
  82. self.timeout = timeout
  83. self.output = output
  84. self.stderr = stderr
  85. super(TimeoutExpired, self).__init__(cmd, timeout, output, stderr)
  86. def __str__(self):
  87. return ("Command '%s' timed out after %s seconds" %
  88. (self.cmd, self.timeout))
  89. #@property
  90. def __stdout_getter(self):
  91. return self.output
  92. #@stdout.setter # Required Python 2.6
  93. def __stdout_setter(self, value):
  94. # There's no obvious reason to set this, but allow it anyway so
  95. # .stdout is a transparent alias for .output
  96. self.output = value
  97. stdout = property(__stdout_getter, __stdout_setter) # Python 2.4
  98. if mswindows:
  99. import threading
  100. import msvcrt
  101. import _subprocess
  102. class STARTUPINFO:
  103. dwFlags = 0
  104. hStdInput = None
  105. hStdOutput = None
  106. hStdError = None
  107. wShowWindow = 0
  108. class pywintypes:
  109. error = IOError
  110. else:
  111. import select
  112. _has_poll = hasattr(select, 'poll')
  113. import fcntl
  114. import pickle
  115. try:
  116. import _posixsubprocess32 as _posixsubprocess
  117. except ImportError:
  118. _posixsubprocess = None
  119. import warnings
  120. warnings.warn("The _posixsubprocess module is not being used. "
  121. "Child process reliability may suffer if your "
  122. "program uses threads.", RuntimeWarning)
  123. try:
  124. import threading
  125. except ImportError:
  126. import dummy_threading as threading
  127. # When select or poll has indicated that the file is writable,
  128. # we can write up to _PIPE_BUF bytes without risk of blocking.
  129. # POSIX defines PIPE_BUF as >= 512.
  130. _PIPE_BUF = getattr(select, 'PIPE_BUF', 512)
  131. _FD_CLOEXEC = getattr(fcntl, 'FD_CLOEXEC', 1)
  132. def _set_cloexec(fd, cloexec):
  133. old = fcntl.fcntl(fd, fcntl.F_GETFD)
  134. if cloexec:
  135. fcntl.fcntl(fd, fcntl.F_SETFD, old | _FD_CLOEXEC)
  136. else:
  137. fcntl.fcntl(fd, fcntl.F_SETFD, old & ~_FD_CLOEXEC)
  138. if _posixsubprocess:
  139. _create_pipe = _posixsubprocess.cloexec_pipe
  140. else:
  141. def _create_pipe():
  142. fds = os.pipe()
  143. _set_cloexec(fds[0], True)
  144. _set_cloexec(fds[1], True)
  145. return fds
  146. __all__ = ["Popen", "PIPE", "STDOUT", "call", "check_call",
  147. "check_output", "CalledProcessError"]
  148. if mswindows:
  149. from _subprocess import (CREATE_NEW_CONSOLE, CREATE_NEW_PROCESS_GROUP,
  150. STD_INPUT_HANDLE, STD_OUTPUT_HANDLE,
  151. STD_ERROR_HANDLE, SW_HIDE,
  152. STARTF_USESTDHANDLES, STARTF_USESHOWWINDOW)
  153. # https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx
  154. # Note: In Python 3.3 this constant is found in the _winapi module.
  155. _WAIT_TIMEOUT = 0x102
  156. __all__.extend(["CREATE_NEW_CONSOLE", "CREATE_NEW_PROCESS_GROUP",
  157. "STD_INPUT_HANDLE", "STD_OUTPUT_HANDLE",
  158. "STD_ERROR_HANDLE", "SW_HIDE",
  159. "STARTF_USESTDHANDLES", "STARTF_USESHOWWINDOW"])
  160. try:
  161. MAXFD = os.sysconf("SC_OPEN_MAX")
  162. except:
  163. MAXFD = 256
  164. # This lists holds Popen instances for which the underlying process had not
  165. # exited at the time its __del__ method got called: those processes are wait()ed
  166. # for synchronously from _cleanup() when a new Popen object is created, to avoid
  167. # zombie processes.
  168. _active = []
  169. def _cleanup():
  170. for inst in _active[:]:
  171. res = inst._internal_poll(_deadstate=sys.maxint)
  172. if res is not None:
  173. try:
  174. _active.remove(inst)
  175. except ValueError:
  176. # This can happen if two threads create a new Popen instance.
  177. # It's harmless that it was already removed, so ignore.
  178. pass
  179. PIPE = -1
  180. STDOUT = -2
  181. DEVNULL = -3
  182. # This function is only used by multiprocessing, it is here so that people
  183. # can drop subprocess32 in as a replacement for the stdlib subprocess module.
  184. def _args_from_interpreter_flags():
  185. """Return a list of command-line arguments reproducing the current
  186. settings in sys.flags and sys.warnoptions."""
  187. flag_opt_map = {
  188. 'debug': 'd',
  189. # 'inspect': 'i',
  190. # 'interactive': 'i',
  191. 'optimize': 'O',
  192. 'dont_write_bytecode': 'B',
  193. 'no_user_site': 's',
  194. 'no_site': 'S',
  195. 'ignore_environment': 'E',
  196. 'verbose': 'v',
  197. 'bytes_warning': 'b',
  198. 'py3k_warning': '3',
  199. }
  200. args = []
  201. for flag, opt in flag_opt_map.items():
  202. v = getattr(sys.flags, flag)
  203. if v > 0:
  204. args.append('-' + opt * v)
  205. if getattr(sys.flags, 'hash_randomization') != 0:
  206. args.append('-R')
  207. for opt in sys.warnoptions:
  208. args.append('-W' + opt)
  209. return args
  210. def _eintr_retry_call(func, *args):
  211. while True:
  212. try:
  213. return func(*args)
  214. except (OSError, IOError), e:
  215. if e.errno == errno.EINTR:
  216. continue
  217. raise
  218. def _get_exec_path(env=None):
  219. """Returns the sequence of directories that will be searched for the
  220. named executable (similar to a shell) when launching a process.
  221. *env* must be an environment variable dict or None. If *env* is None,
  222. os.environ will be used.
  223. """
  224. if env is None:
  225. env = os.environ
  226. return env.get('PATH', os.defpath).split(os.pathsep)
  227. if hasattr(os, 'get_exec_path'):
  228. _get_exec_path = os.get_exec_path
  229. def call(*popenargs, **kwargs):
  230. """Run command with arguments. Wait for command to complete or
  231. timeout, then return the returncode attribute.
  232. The arguments are the same as for the Popen constructor. Example:
  233. retcode = call(["ls", "-l"])
  234. """
  235. timeout = kwargs.pop('timeout', None)
  236. p = Popen(*popenargs, **kwargs)
  237. try:
  238. return p.wait(timeout=timeout)
  239. except TimeoutExpired:
  240. p.kill()
  241. p.wait()
  242. raise
  243. def check_call(*popenargs, **kwargs):
  244. """Run command with arguments. Wait for command to complete. If
  245. the exit code was zero then return, otherwise raise
  246. CalledProcessError. The CalledProcessError object will have the
  247. return code in the returncode attribute.
  248. The arguments are the same as for the call function. Example:
  249. check_call(["ls", "-l"])
  250. """
  251. retcode = call(*popenargs, **kwargs)
  252. if retcode:
  253. cmd = kwargs.get("args")
  254. if cmd is None:
  255. cmd = popenargs[0]
  256. raise CalledProcessError(retcode, cmd)
  257. return 0
  258. def check_output(*popenargs, **kwargs):
  259. r"""Run command with arguments and return its output as a byte string.
  260. If the exit code was non-zero it raises a CalledProcessError. The
  261. CalledProcessError object will have the return code in the returncode
  262. attribute and output in the output attribute.
  263. The arguments are the same as for the Popen constructor. Example:
  264. >>> check_output(["ls", "-l", "/dev/null"])
  265. 'crw-rw-rw- 1 root root 1, 3 Oct 18 2007 /dev/null\n'
  266. The stdout argument is not allowed as it is used internally.
  267. To capture standard error in the result, use stderr=STDOUT.
  268. >>> check_output(["/bin/sh", "-c",
  269. ... "ls -l non_existent_file ; exit 0"],
  270. ... stderr=STDOUT)
  271. 'ls: non_existent_file: No such file or directory\n'
  272. """
  273. timeout = kwargs.pop('timeout', None)
  274. if 'stdout' in kwargs:
  275. raise ValueError('stdout argument not allowed, it will be overridden.')
  276. process = Popen(stdout=PIPE, *popenargs, **kwargs)
  277. try:
  278. output, unused_err = process.communicate(timeout=timeout)
  279. except TimeoutExpired:
  280. process.kill()
  281. output, unused_err = process.communicate()
  282. raise TimeoutExpired(process.args, timeout, output=output)
  283. retcode = process.poll()
  284. if retcode:
  285. raise CalledProcessError(retcode, process.args, output=output)
  286. return output
  287. class CompletedProcess(object):
  288. """A process that has finished running.
  289. This is returned by run().
  290. Attributes:
  291. args: The list or str args passed to run().
  292. returncode: The exit code of the process, negative for signals.
  293. stdout: The standard output (None if not captured).
  294. stderr: The standard error (None if not captured).
  295. """
  296. def __init__(self, args, returncode, stdout=None, stderr=None):
  297. self.args = args
  298. self.returncode = returncode
  299. self.stdout = stdout
  300. self.stderr = stderr
  301. def __repr__(self):
  302. args = ['args={!r}'.format(self.args),
  303. 'returncode={!r}'.format(self.returncode)]
  304. if self.stdout is not None:
  305. args.append('stdout={!r}'.format(self.stdout))
  306. if self.stderr is not None:
  307. args.append('stderr={!r}'.format(self.stderr))
  308. return "{}({})".format(type(self).__name__, ', '.join(args))
  309. def check_returncode(self):
  310. """Raise CalledProcessError if the exit code is non-zero."""
  311. if self.returncode:
  312. raise CalledProcessError(self.returncode, self.args, self.stdout,
  313. self.stderr)
  314. def run(*popenargs, **kwargs):
  315. """Run command with arguments and return a CompletedProcess instance.
  316. The returned instance will have attributes args, returncode, stdout and
  317. stderr. By default, stdout and stderr are not captured, and those attributes
  318. will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.
  319. If check is True and the exit code was non-zero, it raises a
  320. CalledProcessError. The CalledProcessError object will have the return code
  321. in the returncode attribute, and output & stderr attributes if those streams
  322. were captured.
  323. If timeout is given, and the process takes too long, a TimeoutExpired
  324. exception will be raised.
  325. There is an optional argument "input", allowing you to
  326. pass a string to the subprocess's stdin. If you use this argument
  327. you may not also use the Popen constructor's "stdin" argument, as
  328. it will be used internally.
  329. The other arguments are the same as for the Popen constructor.
  330. If universal_newlines=True is passed, the "input" argument must be a
  331. string and stdout/stderr in the returned object will be strings rather than
  332. bytes.
  333. """
  334. input = kwargs.pop('input', None)
  335. timeout = kwargs.pop('timeout', None)
  336. check = kwargs.pop('check', False)
  337. if input is not None:
  338. if 'stdin' in kwargs:
  339. raise ValueError('stdin and input arguments may not both be used.')
  340. kwargs['stdin'] = PIPE
  341. process = Popen(*popenargs, **kwargs)
  342. try:
  343. process.__enter__() # No-Op really... illustrate "with in 2.4"
  344. try:
  345. stdout, stderr = process.communicate(input, timeout=timeout)
  346. except TimeoutExpired:
  347. process.kill()
  348. stdout, stderr = process.communicate()
  349. raise TimeoutExpired(process.args, timeout, output=stdout,
  350. stderr=stderr)
  351. except:
  352. process.kill()
  353. process.wait()
  354. raise
  355. retcode = process.poll()
  356. if check and retcode:
  357. raise CalledProcessError(retcode, process.args,
  358. output=stdout, stderr=stderr)
  359. finally:
  360. # None because our context manager __exit__ does not use them.
  361. process.__exit__(None, None, None)
  362. return CompletedProcess(process.args, retcode, stdout, stderr)
  363. def list2cmdline(seq):
  364. """
  365. Translate a sequence of arguments into a command line
  366. string, using the same rules as the MS C runtime:
  367. 1) Arguments are delimited by white space, which is either a
  368. space or a tab.
  369. 2) A string surrounded by double quotation marks is
  370. interpreted as a single argument, regardless of white space
  371. contained within. A quoted string can be embedded in an
  372. argument.
  373. 3) A double quotation mark preceded by a backslash is
  374. interpreted as a literal double quotation mark.
  375. 4) Backslashes are interpreted literally, unless they
  376. immediately precede a double quotation mark.
  377. 5) If backslashes immediately precede a double quotation mark,
  378. every pair of backslashes is interpreted as a literal
  379. backslash. If the number of backslashes is odd, the last
  380. backslash escapes the next double quotation mark as
  381. described in rule 3.
  382. """
  383. # See
  384. # http://msdn.microsoft.com/en-us/library/17w5ykft.aspx
  385. # or search http://msdn.microsoft.com for
  386. # "Parsing C++ Command-Line Arguments"
  387. result = []
  388. needquote = False
  389. for arg in seq:
  390. bs_buf = []
  391. # Add a space to separate this argument from the others
  392. if result:
  393. result.append(' ')
  394. needquote = (" " in arg) or ("\t" in arg) or not arg
  395. if needquote:
  396. result.append('"')
  397. for c in arg:
  398. if c == '\\':
  399. # Don't know if we need to double yet.
  400. bs_buf.append(c)
  401. elif c == '"':
  402. # Double backslashes.
  403. result.append('\\' * len(bs_buf)*2)
  404. bs_buf = []
  405. result.append('\\"')
  406. else:
  407. # Normal char
  408. if bs_buf:
  409. result.extend(bs_buf)
  410. bs_buf = []
  411. result.append(c)
  412. # Add remaining backslashes, if any.
  413. if bs_buf:
  414. result.extend(bs_buf)
  415. if needquote:
  416. result.extend(bs_buf)
  417. result.append('"')
  418. return ''.join(result)
  419. _PLATFORM_DEFAULT_CLOSE_FDS = object()
  420. class Popen(object):
  421. def __init__(self, args, bufsize=0, executable=None,
  422. stdin=None, stdout=None, stderr=None,
  423. preexec_fn=None, close_fds=_PLATFORM_DEFAULT_CLOSE_FDS,
  424. shell=False, cwd=None, env=None, universal_newlines=False,
  425. startupinfo=None, creationflags=0,
  426. restore_signals=True, start_new_session=False,
  427. pass_fds=()):
  428. """Create new Popen instance."""
  429. _cleanup()
  430. # Held while anything is calling waitpid before returncode has been
  431. # updated to prevent clobbering returncode if wait() or poll() are
  432. # called from multiple threads at once. After acquiring the lock,
  433. # code must re-check self.returncode to see if another thread just
  434. # finished a waitpid() call.
  435. self._waitpid_lock = threading.Lock()
  436. self._child_created = False
  437. self._input = None
  438. self._communication_started = False
  439. if not isinstance(bufsize, (int, long)):
  440. raise TypeError("bufsize must be an integer")
  441. if mswindows:
  442. if preexec_fn is not None:
  443. raise ValueError("preexec_fn is not supported on Windows "
  444. "platforms")
  445. any_stdio_set = (stdin is not None or stdout is not None or
  446. stderr is not None)
  447. if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
  448. if any_stdio_set:
  449. close_fds = False
  450. else:
  451. close_fds = True
  452. elif close_fds and any_stdio_set:
  453. raise ValueError(
  454. "close_fds is not supported on Windows platforms"
  455. " if you redirect stdin/stdout/stderr")
  456. else:
  457. # POSIX
  458. if close_fds is _PLATFORM_DEFAULT_CLOSE_FDS:
  459. close_fds = True
  460. if pass_fds and not close_fds:
  461. import warnings
  462. warnings.warn("pass_fds overriding close_fds.", RuntimeWarning)
  463. close_fds = True
  464. if startupinfo is not None:
  465. raise ValueError("startupinfo is only supported on Windows "
  466. "platforms")
  467. if creationflags != 0:
  468. raise ValueError("creationflags is only supported on Windows "
  469. "platforms")
  470. self.args = args
  471. self.stdin = None
  472. self.stdout = None
  473. self.stderr = None
  474. self.pid = None
  475. self.returncode = None
  476. self.universal_newlines = universal_newlines
  477. # Input and output objects. The general principle is like
  478. # this:
  479. #
  480. # Parent Child
  481. # ------ -----
  482. # p2cwrite ---stdin---> p2cread
  483. # c2pread <--stdout--- c2pwrite
  484. # errread <--stderr--- errwrite
  485. #
  486. # On POSIX, the child objects are file descriptors. On
  487. # Windows, these are Windows file handles. The parent objects
  488. # are file descriptors on both platforms. The parent objects
  489. # are -1 when not using PIPEs. The child objects are -1
  490. # when not redirecting.
  491. (p2cread, p2cwrite,
  492. c2pread, c2pwrite,
  493. errread, errwrite) = self._get_handles(stdin, stdout, stderr)
  494. if mswindows:
  495. if p2cwrite != -1:
  496. p2cwrite = msvcrt.open_osfhandle(p2cwrite.Detach(), 0)
  497. if c2pread != -1:
  498. c2pread = msvcrt.open_osfhandle(c2pread.Detach(), 0)
  499. if errread != -1:
  500. errread = msvcrt.open_osfhandle(errread.Detach(), 0)
  501. if p2cwrite != -1:
  502. self.stdin = os.fdopen(p2cwrite, 'wb', bufsize)
  503. if c2pread != -1:
  504. if universal_newlines:
  505. self.stdout = os.fdopen(c2pread, 'rU', bufsize)
  506. else:
  507. self.stdout = os.fdopen(c2pread, 'rb', bufsize)
  508. if errread != -1:
  509. if universal_newlines:
  510. self.stderr = os.fdopen(errread, 'rU', bufsize)
  511. else:
  512. self.stderr = os.fdopen(errread, 'rb', bufsize)
  513. self._closed_child_pipe_fds = False
  514. exception_cleanup_needed = False
  515. try:
  516. try:
  517. self._execute_child(args, executable, preexec_fn, close_fds,
  518. pass_fds, cwd, env, universal_newlines,
  519. startupinfo, creationflags, shell,
  520. p2cread, p2cwrite,
  521. c2pread, c2pwrite,
  522. errread, errwrite,
  523. restore_signals, start_new_session)
  524. except:
  525. # The cleanup is performed within the finally block rather
  526. # than simply within this except block before the raise so
  527. # that any exceptions raised and handled within it do not
  528. # clobber the exception context we want to propagate upwards.
  529. # This is only necessary in Python 2.
  530. exception_cleanup_needed = True
  531. raise
  532. finally:
  533. if exception_cleanup_needed:
  534. for f in filter(None, (self.stdin, self.stdout, self.stderr)):
  535. try:
  536. f.close()
  537. except EnvironmentError:
  538. pass # Ignore EBADF or other errors
  539. if not self._closed_child_pipe_fds:
  540. to_close = []
  541. if stdin == PIPE:
  542. to_close.append(p2cread)
  543. if stdout == PIPE:
  544. to_close.append(c2pwrite)
  545. if stderr == PIPE:
  546. to_close.append(errwrite)
  547. if hasattr(self, '_devnull'):
  548. to_close.append(self._devnull)
  549. for fd in to_close:
  550. try:
  551. os.close(fd)
  552. except EnvironmentError:
  553. pass
  554. def __enter__(self):
  555. return self
  556. def __exit__(self, type, value, traceback):
  557. if self.stdout:
  558. self.stdout.close()
  559. if self.stderr:
  560. self.stderr.close()
  561. if self.stdin:
  562. self.stdin.close()
  563. # Wait for the process to terminate, to avoid zombies.
  564. self.wait()
  565. def _translate_newlines(self, data):
  566. data = data.replace("\r\n", "\n")
  567. data = data.replace("\r", "\n")
  568. return data
  569. def __del__(self, _maxint=sys.maxint, _active=_active):
  570. # If __init__ hasn't had a chance to execute (e.g. if it
  571. # was passed an undeclared keyword argument), we don't
  572. # have a _child_created attribute at all.
  573. if not getattr(self, '_child_created', False):
  574. # We didn't get to successfully create a child process.
  575. return
  576. # In case the child hasn't been waited on, check if it's done.
  577. self._internal_poll(_deadstate=_maxint)
  578. if self.returncode is None and _active is not None:
  579. # Child is still running, keep us alive until we can wait on it.
  580. _active.append(self)
  581. def _get_devnull(self):
  582. if not hasattr(self, '_devnull'):
  583. self._devnull = os.open(os.devnull, os.O_RDWR)
  584. return self._devnull
  585. def _stdin_write(self, input):
  586. if input:
  587. try:
  588. self.stdin.write(input)
  589. except EnvironmentError as e:
  590. if e.errno == errno.EPIPE:
  591. # communicate() must ignore broken pipe error
  592. pass
  593. elif e.errno == errno.EINVAL :
  594. # bpo-19612, bpo-30418: On Windows, stdin.write() fails
  595. # with EINVAL if the child process exited or if the child
  596. # process is still running but closed the pipe.
  597. pass
  598. else:
  599. raise
  600. try:
  601. self.stdin.close()
  602. except EnvironmentError as e:
  603. if e.errno in (errno.EPIPE, errno.EINVAL):
  604. pass
  605. else:
  606. raise
  607. def communicate(self, input=None, timeout=None):
  608. """Interact with process: Send data to stdin. Read data from
  609. stdout and stderr, until end-of-file is reached. Wait for
  610. process to terminate. The optional input argument should be a
  611. string to be sent to the child process, or None, if no data
  612. should be sent to the child.
  613. communicate() returns a tuple (stdout, stderr)."""
  614. if self._communication_started and input:
  615. raise ValueError("Cannot send input after starting communication")
  616. if timeout is not None:
  617. endtime = time.time() + timeout
  618. else:
  619. endtime = None
  620. # Optimization: If we are not worried about timeouts, we haven't
  621. # started communicating, and we have one or zero pipes, using select()
  622. # or threads is unnecessary.
  623. if (endtime is None and not self._communication_started and
  624. [self.stdin, self.stdout, self.stderr].count(None) >= 2):
  625. stdout = None
  626. stderr = None
  627. if self.stdin:
  628. self._stdin_write(input)
  629. elif self.stdout:
  630. stdout = _eintr_retry_call(self.stdout.read)
  631. self.stdout.close()
  632. elif self.stderr:
  633. stderr = _eintr_retry_call(self.stderr.read)
  634. self.stderr.close()
  635. self.wait()
  636. return (stdout, stderr)
  637. try:
  638. stdout, stderr = self._communicate(input, endtime, timeout)
  639. finally:
  640. self._communication_started = True
  641. sts = self.wait(timeout=self._remaining_time(endtime))
  642. return (stdout, stderr)
  643. def poll(self):
  644. return self._internal_poll()
  645. def _remaining_time(self, endtime):
  646. """Convenience for _communicate when computing timeouts."""
  647. if endtime is None:
  648. return None
  649. else:
  650. return endtime - time.time()
  651. def _check_timeout(self, endtime, orig_timeout):
  652. """Convenience for checking if a timeout has expired."""
  653. if endtime is None:
  654. return
  655. if time.time() > endtime:
  656. raise TimeoutExpired(self.args, orig_timeout)
  657. if mswindows:
  658. #
  659. # Windows methods
  660. #
  661. def _get_handles(self, stdin, stdout, stderr):
  662. """Construct and return tuple with IO objects:
  663. p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
  664. """
  665. if stdin is None and stdout is None and stderr is None:
  666. return (-1, -1, -1, -1, -1, -1)
  667. p2cread, p2cwrite = -1, -1
  668. c2pread, c2pwrite = -1, -1
  669. errread, errwrite = -1, -1
  670. if stdin is None:
  671. p2cread = _subprocess.GetStdHandle(_subprocess.STD_INPUT_HANDLE)
  672. if p2cread is None:
  673. p2cread, _ = _subprocess.CreatePipe(None, 0)
  674. elif stdin == PIPE:
  675. p2cread, p2cwrite = _subprocess.CreatePipe(None, 0)
  676. elif stdin == DEVNULL:
  677. p2cread = msvcrt.get_osfhandle(self._get_devnull())
  678. elif isinstance(stdin, int):
  679. p2cread = msvcrt.get_osfhandle(stdin)
  680. else:
  681. # Assuming file-like object
  682. p2cread = msvcrt.get_osfhandle(stdin.fileno())
  683. p2cread = self._make_inheritable(p2cread)
  684. if stdout is None:
  685. c2pwrite = _subprocess.GetStdHandle(_subprocess.STD_OUTPUT_HANDLE)
  686. if c2pwrite is None:
  687. _, c2pwrite = _subprocess.CreatePipe(None, 0)
  688. elif stdout == PIPE:
  689. c2pread, c2pwrite = _subprocess.CreatePipe(None, 0)
  690. elif stdout == DEVNULL:
  691. c2pwrite = msvcrt.get_osfhandle(self._get_devnull())
  692. elif isinstance(stdout, int):
  693. c2pwrite = msvcrt.get_osfhandle(stdout)
  694. else:
  695. # Assuming file-like object
  696. c2pwrite = msvcrt.get_osfhandle(stdout.fileno())
  697. c2pwrite = self._make_inheritable(c2pwrite)
  698. if stderr is None:
  699. errwrite = _subprocess.GetStdHandle(_subprocess.STD_ERROR_HANDLE)
  700. if errwrite is None:
  701. _, errwrite = _subprocess.CreatePipe(None, 0)
  702. elif stderr == PIPE:
  703. errread, errwrite = _subprocess.CreatePipe(None, 0)
  704. elif stderr == STDOUT:
  705. errwrite = c2pwrite
  706. elif stderr == DEVNULL:
  707. errwrite = msvcrt.get_osfhandle(self._get_devnull())
  708. elif isinstance(stderr, int):
  709. errwrite = msvcrt.get_osfhandle(stderr)
  710. else:
  711. # Assuming file-like object
  712. errwrite = msvcrt.get_osfhandle(stderr.fileno())
  713. errwrite = self._make_inheritable(errwrite)
  714. return (p2cread, p2cwrite,
  715. c2pread, c2pwrite,
  716. errread, errwrite)
  717. def _make_inheritable(self, handle):
  718. """Return a duplicate of handle, which is inheritable"""
  719. return _subprocess.DuplicateHandle(_subprocess.GetCurrentProcess(),
  720. handle, _subprocess.GetCurrentProcess(), 0, 1,
  721. _subprocess.DUPLICATE_SAME_ACCESS)
  722. def _find_w9xpopen(self):
  723. """Find and return absolut path to w9xpopen.exe"""
  724. w9xpopen = os.path.join(
  725. os.path.dirname(_subprocess.GetModuleFileName(0)),
  726. "w9xpopen.exe")
  727. if not os.path.exists(w9xpopen):
  728. # Eeek - file-not-found - possibly an embedding
  729. # situation - see if we can locate it in sys.exec_prefix
  730. w9xpopen = os.path.join(os.path.dirname(sys.exec_prefix),
  731. "w9xpopen.exe")
  732. if not os.path.exists(w9xpopen):
  733. raise RuntimeError("Cannot locate w9xpopen.exe, which is "
  734. "needed for Popen to work with your "
  735. "shell or platform.")
  736. return w9xpopen
  737. def _execute_child(self, args, executable, preexec_fn, close_fds,
  738. pass_fds, cwd, env, universal_newlines,
  739. startupinfo, creationflags, shell,
  740. p2cread, p2cwrite,
  741. c2pread, c2pwrite,
  742. errread, errwrite,
  743. unused_restore_signals, unused_start_new_session):
  744. """Execute program (MS Windows version)"""
  745. assert not pass_fds, "pass_fds not supported on Windows."
  746. if not isinstance(args, types.StringTypes):
  747. args = list2cmdline(args)
  748. # Process startup details
  749. if startupinfo is None:
  750. startupinfo = STARTUPINFO()
  751. if -1 not in (p2cread, c2pwrite, errwrite):
  752. startupinfo.dwFlags |= _subprocess.STARTF_USESTDHANDLES
  753. startupinfo.hStdInput = p2cread
  754. startupinfo.hStdOutput = c2pwrite
  755. startupinfo.hStdError = errwrite
  756. if shell:
  757. startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
  758. startupinfo.wShowWindow = _subprocess.SW_HIDE
  759. comspec = os.environ.get("COMSPEC", "cmd.exe")
  760. args = comspec + " /c " + '"%s"' % args
  761. if (_subprocess.GetVersion() >= 0x80000000L or
  762. os.path.basename(comspec).lower() == "command.com"):
  763. # Win9x, or using command.com on NT. We need to
  764. # use the w9xpopen intermediate program. For more
  765. # information, see KB Q150956
  766. # (http://web.archive.org/web/20011105084002/http://support.microsoft.com/support/kb/articles/Q150/9/56.asp)
  767. w9xpopen = self._find_w9xpopen()
  768. args = '"%s" %s' % (w9xpopen, args)
  769. # Not passing CREATE_NEW_CONSOLE has been known to
  770. # cause random failures on win9x. Specifically a
  771. # dialog: "Your program accessed mem currently in
  772. # use at xxx" and a hopeful warning about the
  773. # stability of your system. Cost is Ctrl+C wont
  774. # kill children.
  775. creationflags |= _subprocess.CREATE_NEW_CONSOLE
  776. # Start the process
  777. try:
  778. try:
  779. hp, ht, pid, tid = _subprocess.CreateProcess(executable, args,
  780. # no special security
  781. None, None,
  782. int(not close_fds),
  783. creationflags,
  784. env,
  785. cwd,
  786. startupinfo)
  787. except pywintypes.error, e:
  788. # Translate pywintypes.error to WindowsError, which is
  789. # a subclass of OSError. FIXME: We should really
  790. # translate errno using _sys_errlist (or similar), but
  791. # how can this be done from Python?
  792. raise WindowsError(*e.args)
  793. finally:
  794. # Child is launched. Close the parent's copy of those pipe
  795. # handles that only the child should have open. You need
  796. # to make sure that no handles to the write end of the
  797. # output pipe are maintained in this process or else the
  798. # pipe will not close when the child process exits and the
  799. # ReadFile will hang.
  800. if p2cread != -1:
  801. p2cread.Close()
  802. if c2pwrite != -1:
  803. c2pwrite.Close()
  804. if errwrite != -1:
  805. errwrite.Close()
  806. if hasattr(self, '_devnull'):
  807. os.close(self._devnull)
  808. # Retain the process handle, but close the thread handle
  809. self._child_created = True
  810. self._handle = hp
  811. self.pid = pid
  812. ht.Close()
  813. def _internal_poll(self, _deadstate=None,
  814. _WaitForSingleObject=_subprocess.WaitForSingleObject,
  815. _WAIT_OBJECT_0=_subprocess.WAIT_OBJECT_0,
  816. _GetExitCodeProcess=_subprocess.GetExitCodeProcess):
  817. """Check if child process has terminated. Returns returncode
  818. attribute.
  819. This method is called by __del__, so it can only refer to objects
  820. in its local scope.
  821. """
  822. if self.returncode is None:
  823. if _WaitForSingleObject(self._handle, 0) == _WAIT_OBJECT_0:
  824. self.returncode = _GetExitCodeProcess(self._handle)
  825. return self.returncode
  826. def wait(self, timeout=None, endtime=None):
  827. """Wait for child process to terminate. Returns returncode
  828. attribute."""
  829. if endtime is not None:
  830. timeout_millis = self._remaining_time(endtime)
  831. if timeout is None:
  832. timeout_millis = _subprocess.INFINITE
  833. else:
  834. timeout_millis = int(timeout * 1000)
  835. if self.returncode is None:
  836. result = _subprocess.WaitForSingleObject(self._handle,
  837. timeout_millis)
  838. if result == _WAIT_TIMEOUT:
  839. raise TimeoutExpired(self.args, timeout)
  840. self.returncode = _subprocess.GetExitCodeProcess(self._handle)
  841. return self.returncode
  842. def _readerthread(self, fh, buffer):
  843. buffer.append(fh.read())
  844. fh.close()
  845. def _communicate(self, input, endtime, orig_timeout):
  846. # Start reader threads feeding into a list hanging off of this
  847. # object, unless they've already been started.
  848. if self.stdout and not hasattr(self, "_stdout_buff"):
  849. self._stdout_buff = []
  850. self.stdout_thread = \
  851. threading.Thread(target=self._readerthread,
  852. args=(self.stdout, self._stdout_buff))
  853. self.stdout_thread.daemon = True
  854. self.stdout_thread.start()
  855. if self.stderr and not hasattr(self, "_stderr_buff"):
  856. self._stderr_buff = []
  857. self.stderr_thread = \
  858. threading.Thread(target=self._readerthread,
  859. args=(self.stderr, self._stderr_buff))
  860. self.stderr_thread.daemon = True
  861. self.stderr_thread.start()
  862. if self.stdin:
  863. self._stdin_write(input)
  864. # Wait for the reader threads, or time out. If we time out, the
  865. # threads remain reading and the fds left open in case the user
  866. # calls communicate again.
  867. if self.stdout is not None:
  868. self.stdout_thread.join(self._remaining_time(endtime))
  869. if self.stdout_thread.isAlive():
  870. raise TimeoutExpired(self.args, orig_timeout)
  871. if self.stderr is not None:
  872. self.stderr_thread.join(self._remaining_time(endtime))
  873. if self.stderr_thread.isAlive():
  874. raise TimeoutExpired(self.args, orig_timeout)
  875. # Collect the output from and close both pipes, now that we know
  876. # both have been read successfully.
  877. stdout = None
  878. stderr = None
  879. if self.stdout:
  880. stdout = self._stdout_buff
  881. self.stdout.close()
  882. if self.stderr:
  883. stderr = self._stderr_buff
  884. self.stderr.close()
  885. # All data exchanged. Translate lists into strings.
  886. if stdout is not None:
  887. stdout = stdout[0]
  888. if stderr is not None:
  889. stderr = stderr[0]
  890. # Translate newlines, if requested. We cannot let the file
  891. # object do the translation: It is based on stdio, which is
  892. # impossible to combine with select (unless forcing no
  893. # buffering).
  894. if self.universal_newlines and hasattr(file, 'newlines'):
  895. if stdout:
  896. stdout = self._translate_newlines(stdout)
  897. if stderr:
  898. stderr = self._translate_newlines(stderr)
  899. return (stdout, stderr)
  900. def send_signal(self, sig):
  901. """Send a signal to the process."""
  902. # Don't signal a process that we know has already died.
  903. if self.returncode is not None:
  904. return
  905. if sig == signal.SIGTERM:
  906. self.terminate()
  907. elif sig == signal.CTRL_C_EVENT:
  908. os.kill(self.pid, signal.CTRL_C_EVENT)
  909. elif sig == signal.CTRL_BREAK_EVENT:
  910. os.kill(self.pid, signal.CTRL_BREAK_EVENT)
  911. else:
  912. raise ValueError("Unsupported signal: %s" % sig)
  913. def terminate(self):
  914. """Terminates the process."""
  915. # Don't terminate a process that we know has already died.
  916. if self.returncode is not None:
  917. return
  918. _subprocess.TerminateProcess(self._handle, 1)
  919. kill = terminate
  920. else:
  921. #
  922. # POSIX methods
  923. #
  924. def _get_handles(self, stdin, stdout, stderr):
  925. """Construct and return tuple with IO objects:
  926. p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite
  927. """
  928. p2cread, p2cwrite = -1, -1
  929. c2pread, c2pwrite = -1, -1
  930. errread, errwrite = -1, -1
  931. if stdin is None:
  932. pass
  933. elif stdin == PIPE:
  934. p2cread, p2cwrite = _create_pipe()
  935. elif stdin == DEVNULL:
  936. p2cread = self._get_devnull()
  937. elif isinstance(stdin, int):
  938. p2cread = stdin
  939. else:
  940. # Assuming file-like object
  941. p2cread = stdin.fileno()
  942. if stdout is None:
  943. pass
  944. elif stdout == PIPE:
  945. c2pread, c2pwrite = _create_pipe()
  946. elif stdout == DEVNULL:
  947. c2pwrite = self._get_devnull()
  948. elif isinstance(stdout, int):
  949. c2pwrite = stdout
  950. else:
  951. # Assuming file-like object
  952. c2pwrite = stdout.fileno()
  953. if stderr is None:
  954. pass
  955. elif stderr == PIPE:
  956. errread, errwrite = _create_pipe()
  957. elif stderr == STDOUT:
  958. if c2pwrite != -1:
  959. errwrite = c2pwrite
  960. else: # child's stdout is not set, use parent's stdout
  961. errwrite = sys.__stdout__.fileno()
  962. elif stderr == DEVNULL:
  963. errwrite = self._get_devnull()
  964. elif isinstance(stderr, int):
  965. errwrite = stderr
  966. else:
  967. # Assuming file-like object
  968. errwrite = stderr.fileno()
  969. return (p2cread, p2cwrite,
  970. c2pread, c2pwrite,
  971. errread, errwrite)
  972. if hasattr(os, 'closerange'): # Introduced in 2.6
  973. @staticmethod
  974. def _closerange(fd_low, fd_high):
  975. os.closerange(fd_low, fd_high)
  976. else:
  977. @staticmethod
  978. def _closerange(fd_low, fd_high):
  979. for fd in xrange(fd_low, fd_high):
  980. while True:
  981. try:
  982. os.close(fd)
  983. except (OSError, IOError), e:
  984. if e.errno == errno.EINTR:
  985. continue
  986. break
  987. def _close_fds(self, but):
  988. self._closerange(3, but)
  989. self._closerange(but + 1, MAXFD)
  990. def _close_all_but_a_sorted_few_fds(self, fds_to_keep):
  991. # precondition: fds_to_keep must be sorted and unique
  992. start_fd = 3
  993. for fd in fds_to_keep:
  994. if fd >= start_fd:
  995. self._closerange(start_fd, fd)
  996. start_fd = fd + 1
  997. if start_fd <= MAXFD:
  998. self._closerange(start_fd, MAXFD)
  999. def _execute_child(self, args, executable, preexec_fn, close_fds,
  1000. pass_fds, cwd, env, universal_newlines,
  1001. startupinfo, creationflags, shell,
  1002. p2cread, p2cwrite,
  1003. c2pread, c2pwrite,
  1004. errread, errwrite,
  1005. restore_signals, start_new_session):
  1006. """Execute program (POSIX version)"""
  1007. if isinstance(args, types.StringTypes):
  1008. args = [args]
  1009. else:
  1010. args = list(args)
  1011. if shell:
  1012. args = ["/bin/sh", "-c"] + args
  1013. if executable:
  1014. args[0] = executable
  1015. if executable is None:
  1016. executable = args[0]
  1017. orig_executable = executable
  1018. # For transferring possible exec failure from child to parent.
  1019. # Data format: "exception name:hex errno:description"
  1020. # Pickle is not used; it is complex and involves memory allocation.
  1021. errpipe_read, errpipe_write = _create_pipe()
  1022. try:
  1023. try:
  1024. if _posixsubprocess:
  1025. fs_encoding = sys.getfilesystemencoding()
  1026. def fs_encode(s):
  1027. """Encode s for use in the env, fs or cmdline."""
  1028. if isinstance(s, str):
  1029. return s
  1030. else:
  1031. return s.encode(fs_encoding, 'strict')
  1032. # We must avoid complex work that could involve
  1033. # malloc or free in the child process to avoid
  1034. # potential deadlocks, thus we do all this here.
  1035. # and pass it to fork_exec()
  1036. if env is not None:
  1037. env_list = [fs_encode(k) + '=' + fs_encode(v)
  1038. for k, v in env.items()]
  1039. else:
  1040. env_list = None # Use execv instead of execve.
  1041. if os.path.dirname(executable):
  1042. executable_list = (fs_encode(executable),)
  1043. else:
  1044. # This matches the behavior of os._execvpe().
  1045. path_list = _get_exec_path(env)
  1046. executable_list = (os.path.join(dir, executable)
  1047. for dir in path_list)
  1048. executable_list = tuple(fs_encode(exe)
  1049. for exe in executable_list)
  1050. fds_to_keep = set(pass_fds)
  1051. fds_to_keep.add(errpipe_write)
  1052. self.pid = _posixsubprocess.fork_exec(
  1053. args, executable_list,
  1054. close_fds, sorted(fds_to_keep), cwd, env_list,
  1055. p2cread, p2cwrite, c2pread, c2pwrite,
  1056. errread, errwrite,
  1057. errpipe_read, errpipe_write,
  1058. restore_signals, start_new_session, preexec_fn)
  1059. self._child_created = True
  1060. else:
  1061. # Pure Python implementation: It is not thread safe.
  1062. # This implementation may deadlock in the child if your
  1063. # parent process has any other threads running.
  1064. gc_was_enabled = gc.isenabled()
  1065. # Disable gc to avoid bug where gc -> file_dealloc ->
  1066. # write to stderr -> hang. See issue1336
  1067. gc.disable()
  1068. try:
  1069. self.pid = os.fork()
  1070. except:
  1071. if gc_was_enabled:
  1072. gc.enable()
  1073. raise
  1074. self._child_created = True
  1075. if self.pid == 0:
  1076. # Child
  1077. reached_preexec = False
  1078. try:
  1079. # Close parent's pipe ends
  1080. if p2cwrite != -1:
  1081. os.close(p2cwrite)
  1082. if c2pread != -1:
  1083. os.close(c2pread)
  1084. if errread != -1:
  1085. os.close(errread)
  1086. os.close(errpipe_read)
  1087. # When duping fds, if there arises a situation
  1088. # where one of the fds is either 0, 1 or 2, it
  1089. # is possible that it is overwritten (#12607).
  1090. if c2pwrite == 0:
  1091. c2pwrite = os.dup(c2pwrite)
  1092. if errwrite == 0 or errwrite == 1:
  1093. errwrite = os.dup(errwrite)
  1094. # Dup fds for child
  1095. def _dup2(a, b):
  1096. # dup2() removes the CLOEXEC flag but
  1097. # we must do it ourselves if dup2()
  1098. # would be a no-op (issue #10806).
  1099. if a == b:
  1100. _set_cloexec(a, False)
  1101. elif a != -1:
  1102. os.dup2(a, b)
  1103. _dup2(p2cread, 0)
  1104. _dup2(c2pwrite, 1)
  1105. _dup2(errwrite, 2)
  1106. # Close pipe fds. Make sure we don't close the
  1107. # same fd more than once, or standard fds.
  1108. closed = set()
  1109. for fd in [p2cread, c2pwrite, errwrite]:
  1110. if fd > 2 and fd not in closed:
  1111. os.close(fd)
  1112. closed.add(fd)
  1113. if cwd is not None:
  1114. os.chdir(cwd)
  1115. # This is a copy of Python/pythonrun.c
  1116. # _Py_RestoreSignals(). If that were exposed
  1117. # as a sys._py_restoresignals func it would be
  1118. # better.. but this pure python implementation
  1119. # isn't likely to be used much anymore.
  1120. if restore_signals:
  1121. signals = ('SIGPIPE', 'SIGXFZ', 'SIGXFSZ')
  1122. for sig in signals:
  1123. if hasattr(signal, sig):
  1124. signal.signal(getattr(signal, sig),
  1125. signal.SIG_DFL)
  1126. if start_new_session and hasattr(os, 'setsid'):
  1127. os.setsid()
  1128. reached_preexec = True
  1129. if preexec_fn:
  1130. preexec_fn()
  1131. # Close all other fds, if asked for - after
  1132. # preexec_fn(), which may open FDs.
  1133. if close_fds:
  1134. if pass_fds:
  1135. fds_to_keep = set(pass_fds)
  1136. fds_to_keep.add(errpipe_write)
  1137. self._close_all_but_a_sorted_few_fds(
  1138. sorted(fds_to_keep))
  1139. else:
  1140. self._close_fds(but=errpipe_write)
  1141. if env is None:
  1142. os.execvp(executable, args)
  1143. else:
  1144. os.execvpe(executable, args, env)
  1145. except:
  1146. try:
  1147. exc_type, exc_value = sys.exc_info()[:2]
  1148. if isinstance(exc_value, OSError):
  1149. errno_num = exc_value.errno
  1150. else:
  1151. errno_num = 0
  1152. if not reached_preexec:
  1153. exc_value = "noexec"
  1154. message = '%s:%x:%s' % (exc_type.__name__,
  1155. errno_num, exc_value)
  1156. os.write(errpipe_write, message)
  1157. except Exception:
  1158. # We MUST not allow anything odd happening
  1159. # above to prevent us from exiting below.
  1160. pass
  1161. # This exitcode won't be reported to applications
  1162. # so it really doesn't matter what we return.
  1163. os._exit(255)
  1164. # Parent
  1165. if gc_was_enabled:
  1166. gc.enable()
  1167. finally:
  1168. # be sure the FD is closed no matter what
  1169. os.close(errpipe_write)
  1170. # A pair of non -1s means we created both fds and are
  1171. # responsible for closing them.
  1172. # self._devnull is not always defined.
  1173. devnull_fd = getattr(self, '_devnull', None)
  1174. if p2cread != -1 and p2cwrite != -1 and p2cread != devnull_fd:
  1175. os.close(p2cread)
  1176. if c2pwrite != -1 and c2pread != -1 and c2pwrite != devnull_fd:
  1177. os.close(c2pwrite)
  1178. if errwrite != -1 and errread != -1 and errwrite != devnull_fd:
  1179. os.close(errwrite)
  1180. if devnull_fd is not None:
  1181. os.close(devnull_fd)
  1182. # Prevent a double close of these fds from __init__ on error.
  1183. self._closed_child_pipe_fds = True
  1184. # Wait for exec to fail or succeed; possibly raising exception
  1185. # exception (limited in size)
  1186. errpipe_data = ''
  1187. while True:
  1188. part = _eintr_retry_call(os.read, errpipe_read, 50000)
  1189. errpipe_data += part
  1190. if not part or len(errpipe_data) > 50000:
  1191. break
  1192. finally:
  1193. # be sure the FD is closed no matter what
  1194. os.close(errpipe_read)
  1195. if errpipe_data != "":
  1196. try:
  1197. _eintr_retry_call(os.waitpid, self.pid, 0)
  1198. except OSError, e:
  1199. if e.errno != errno.ECHILD:
  1200. raise
  1201. try:
  1202. exception_name, hex_errno, err_msg = (
  1203. errpipe_data.split(':', 2))
  1204. except ValueError:
  1205. exception_name = 'RuntimeError'
  1206. hex_errno = '0'
  1207. err_msg = ('Bad exception data from child: ' +
  1208. repr(errpipe_data))
  1209. child_exception_type = getattr(
  1210. exceptions, exception_name, RuntimeError)
  1211. if issubclass(child_exception_type, OSError) and hex_errno:
  1212. errno_num = int(hex_errno, 16)
  1213. child_exec_never_called = (err_msg == "noexec")
  1214. if child_exec_never_called:
  1215. err_msg = ""
  1216. if errno_num != 0:
  1217. err_msg = os.strerror(errno_num)
  1218. if errno_num == errno.ENOENT:
  1219. if child_exec_never_called:
  1220. # The error must be from chdir(cwd).
  1221. err_msg += ': ' + repr(cwd)
  1222. else:
  1223. err_msg += ': ' + repr(orig_executable)
  1224. raise child_exception_type(errno_num, err_msg)
  1225. try:
  1226. exception = child_exception_type(err_msg)
  1227. except Exception:
  1228. exception = RuntimeError(
  1229. 'Could not re-raise %r exception from the'
  1230. ' child with error message %r' %
  1231. (child_exception_type, err_msg))
  1232. raise exception
  1233. def _handle_exitstatus(self, sts, _WIFSIGNALED=os.WIFSIGNALED,
  1234. _WTERMSIG=os.WTERMSIG, _WIFEXITED=os.WIFEXITED,
  1235. _WEXITSTATUS=os.WEXITSTATUS, _WIFSTOPPED=os.WIFSTOPPED,
  1236. _WSTOPSIG=os.WSTOPSIG):
  1237. """All callers to this function MUST hold self._waitpid_lock."""
  1238. # This method is called (indirectly) by __del__, so it cannot
  1239. # refer to anything outside of its local scope."""
  1240. if _WIFSIGNALED(sts):
  1241. self.returncode = -_WTERMSIG(sts)
  1242. elif _WIFEXITED(sts):
  1243. self.returncode = _WEXITSTATUS(sts)
  1244. elif _WIFSTOPPED(sts):
  1245. self.returncode = -_WSTOPSIG(sts)
  1246. else:
  1247. # Should never happen
  1248. raise RuntimeError("Unknown child exit status!")
  1249. def _internal_poll(self, _deadstate=None, _waitpid=os.waitpid,
  1250. _WNOHANG=os.WNOHANG, _os_error=os.error, _ECHILD=errno.ECHILD):
  1251. """Check if child process has terminated. Returns returncode
  1252. attribute.
  1253. This method is called by __del__, so it cannot reference anything
  1254. outside of the local scope (nor can any methods it calls).
  1255. """
  1256. if self.returncode is None:
  1257. if not self._waitpid_lock.acquire(False):
  1258. # Something else is busy calling waitpid. Don't allow two
  1259. # at once. We know nothing yet.
  1260. return None
  1261. try:
  1262. try:
  1263. if self.returncode is not None:
  1264. return self.returncode # Another thread waited.
  1265. pid, sts = _waitpid(self.pid, _WNOHANG)
  1266. if pid == self.pid:
  1267. self._handle_exitstatus(sts)
  1268. except _os_error, e:
  1269. if _deadstate is not None:
  1270. self.returncode = _deadstate
  1271. elif e.errno == _ECHILD:
  1272. # This happens if SIGCLD is set to be ignored or
  1273. # waiting for child processes has otherwise been
  1274. # disabled for our process. This child is dead, we
  1275. # can't get the status.
  1276. # http://bugs.python.org/issue15756
  1277. self.returncode = 0
  1278. finally:
  1279. self._waitpid_lock.release()
  1280. return self.returncode
  1281. def _try_wait(self, wait_flags):
  1282. """All callers to this function MUST hold self._waitpid_lock."""
  1283. try:
  1284. (pid, sts) = _eintr_retry_call(os.waitpid, self.pid, wait_flags)
  1285. except OSError, e:
  1286. if e.errno != errno.ECHILD:
  1287. raise
  1288. # This happens if SIGCLD is set to be ignored or waiting
  1289. # for child processes has otherwise been disabled for our
  1290. # process. This child is dead, we can't get the status.
  1291. pid = self.pid
  1292. sts = 0
  1293. return (pid, sts)
  1294. def wait(self, timeout=None, endtime=None):
  1295. """Wait for child process to terminate. Returns returncode
  1296. attribute."""
  1297. if self.returncode is not None:
  1298. return self.returncode
  1299. # endtime is preferred to timeout. timeout is only used for
  1300. # printing.
  1301. if endtime is not None or timeout is not None:
  1302. if endtime is None:
  1303. endtime = time.time() + timeout
  1304. elif timeout is None:
  1305. timeout = self._remaining_time(endtime)
  1306. if endtime is not None:
  1307. # Enter a busy loop if we have a timeout. This busy loop was
  1308. # cribbed from Lib/threading.py in Thread.wait() at r71065.
  1309. delay = 0.0005 # 500 us -> initial delay of 1 ms
  1310. while True:
  1311. if self._waitpid_lock.acquire(False):
  1312. try:
  1313. if self.returncode is not None:
  1314. break # Another thread waited.
  1315. (pid, sts) = self._try_wait(os.WNOHANG)
  1316. assert pid == self.pid or pid == 0
  1317. if pid == self.pid:
  1318. self._handle_exitstatus(sts)
  1319. break
  1320. finally:
  1321. self._waitpid_lock.release()
  1322. remaining = self._remaining_time(endtime)
  1323. if remaining <= 0:
  1324. raise TimeoutExpired(self.args, timeout)
  1325. delay = min(delay * 2, remaining, .05)
  1326. time.sleep(delay)
  1327. else:
  1328. while self.returncode is None:
  1329. self._waitpid_lock.acquire()
  1330. try:
  1331. if self.returncode is not None:
  1332. break # Another thread waited.
  1333. (pid, sts) = self._try_wait(0)
  1334. # Check the pid and loop as waitpid has been known to
  1335. # return 0 even without WNOHANG in odd situations.
  1336. # http://bugs.python.org/issue14396.
  1337. if pid == self.pid:
  1338. self._handle_exitstatus(sts)
  1339. finally:
  1340. self._waitpid_lock.release()
  1341. return self.returncode
  1342. def _communicate(self, input, endtime, orig_timeout):
  1343. if self.stdin and not self._communication_started:
  1344. # Flush stdio buffer. This might block, if the user has
  1345. # been writing to .stdin in an uncontrolled fashion.
  1346. self.stdin.flush()
  1347. if not input:
  1348. self.stdin.close()
  1349. if _has_poll:
  1350. stdout, stderr = self._communicate_with_poll(input, endtime,
  1351. orig_timeout)
  1352. else:
  1353. stdout, stderr = self._communicate_with_select(input, endtime,
  1354. orig_timeout)
  1355. self.wait(timeout=self._remaining_time(endtime))
  1356. # All data exchanged. Translate lists into strings.
  1357. if stdout is not None:
  1358. stdout = ''.join(stdout)
  1359. if stderr is not None:
  1360. stderr = ''.join(stderr)
  1361. # Translate newlines, if requested. We cannot let the file
  1362. # object do the translation: It is based on stdio, which is
  1363. # impossible to combine with select (unless forcing no
  1364. # buffering).
  1365. if self.universal_newlines and hasattr(file, 'newlines'):
  1366. if stdout:
  1367. stdout = self._translate_newlines(stdout)
  1368. if stderr:
  1369. stderr = self._translate_newlines(stderr)
  1370. return (stdout, stderr)
  1371. def _communicate_with_poll(self, input, endtime, orig_timeout):
  1372. stdout = None # Return
  1373. stderr = None # Return
  1374. if not self._communication_started:
  1375. self._fd2file = {}
  1376. poller = select.poll()
  1377. def register_and_append(file_obj, eventmask):
  1378. poller.register(file_obj.fileno(), eventmask)
  1379. self._fd2file[file_obj.fileno()] = file_obj
  1380. def close_unregister_and_remove(fd):
  1381. poller.unregister(fd)
  1382. self._fd2file[fd].close()
  1383. self._fd2file.pop(fd)
  1384. if self.stdin and input:
  1385. register_and_append(self.stdin, select.POLLOUT)
  1386. # Only create this mapping if we haven't already.
  1387. if not self._communication_started:
  1388. self._fd2output = {}
  1389. if self.stdout:
  1390. self._fd2output[self.stdout.fileno()] = []
  1391. if self.stderr:
  1392. self._fd2output[self.stderr.fileno()] = []
  1393. select_POLLIN_POLLPRI = select.POLLIN | select.POLLPRI
  1394. if self.stdout:
  1395. register_and_append(self.stdout, select_POLLIN_POLLPRI)
  1396. stdout = self._fd2output[self.stdout.fileno()]
  1397. if self.stderr:
  1398. register_and_append(self.stderr, select_POLLIN_POLLPRI)
  1399. stderr = self._fd2output[self.stderr.fileno()]
  1400. # Save the input here so that if we time out while communicating,
  1401. # we can continue sending input if we retry.
  1402. if self.stdin and self._input is None:
  1403. self._input_offset = 0
  1404. self._input = input
  1405. if self.universal_newlines and isinstance(self._input, unicode):
  1406. self._input = self._input.encode(
  1407. self.stdin.encoding or sys.getdefaultencoding())
  1408. while self._fd2file:
  1409. try:
  1410. ready = poller.poll(self._remaining_time(endtime))
  1411. except select.error, e:
  1412. if e.args[0] == errno.EINTR:
  1413. continue
  1414. raise
  1415. self._check_timeout(endtime, orig_timeout)
  1416. for fd, mode in ready:
  1417. if mode & select.POLLOUT:
  1418. chunk = self._input[self._input_offset :
  1419. self._input_offset + _PIPE_BUF]
  1420. self._input_offset += os.write(fd, chunk)
  1421. if self._input_offset >= len(self._input):
  1422. close_unregister_and_remove(fd)
  1423. elif mode & select_POLLIN_POLLPRI:
  1424. data = os.read(fd, 4096)
  1425. if not data:
  1426. close_unregister_and_remove(fd)
  1427. self._fd2output[fd].append(data)
  1428. else:
  1429. # Ignore hang up or errors.
  1430. close_unregister_and_remove(fd)
  1431. return (stdout, stderr)
  1432. def _communicate_with_select(self, input, endtime, orig_timeout):
  1433. if not self._communication_started:
  1434. self._read_set = []
  1435. self._write_set = []
  1436. if self.stdin and input:
  1437. self._write_set.append(self.stdin)
  1438. if self.stdout:
  1439. self._read_set.append(self.stdout)
  1440. if self.stderr:
  1441. self._read_set.append(self.stderr)
  1442. if self.stdin and self._input is None:
  1443. self._input_offset = 0
  1444. self._input = input
  1445. if self.universal_newlines and isinstance(self._input, unicode):
  1446. self._input = self._input.encode(
  1447. self.stdin.encoding or sys.getdefaultencoding())
  1448. stdout = None # Return
  1449. stderr = None # Return
  1450. if self.stdout:
  1451. if not self._communication_started:
  1452. self._stdout_buff = []
  1453. stdout = self._stdout_buff
  1454. if self.stderr:
  1455. if not self._communication_started:
  1456. self._stderr_buff = []
  1457. stderr = self._stderr_buff
  1458. while self._read_set or self._write_set:
  1459. try:
  1460. (rlist, wlist, xlist) = \
  1461. select.select(self._read_set, self._write_set, [],
  1462. self._remaining_time(endtime))
  1463. except select.error, e:
  1464. if e.args[0] == errno.EINTR:
  1465. continue
  1466. raise
  1467. # According to the docs, returning three empty lists indicates
  1468. # that the timeout expired.
  1469. if not (rlist or wlist or xlist):
  1470. raise TimeoutExpired(self.args, orig_timeout)
  1471. # We also check what time it is ourselves for good measure.
  1472. self._check_timeout(endtime, orig_timeout)
  1473. if self.stdin in wlist:
  1474. chunk = self._input[self._input_offset :
  1475. self._input_offset + _PIPE_BUF]
  1476. try:
  1477. bytes_written = os.write(self.stdin.fileno(), chunk)
  1478. except EnvironmentError as e:
  1479. if e.errno == errno.EPIPE:
  1480. self._write_set.remove(self.stdin)
  1481. self.stdin.close()
  1482. else:
  1483. raise
  1484. else:
  1485. self._input_offset += bytes_written
  1486. if self._input_offset >= len(self._input):
  1487. self.stdin.close()
  1488. self._write_set.remove(self.stdin)
  1489. if self.stdout in rlist:
  1490. data = os.read(self.stdout.fileno(), 1024)
  1491. if data == "":
  1492. self.stdout.close()
  1493. self._read_set.remove(self.stdout)
  1494. stdout.append(data)
  1495. if self.stderr in rlist:
  1496. data = os.read(self.stderr.fileno(), 1024)
  1497. if data == "":
  1498. self.stderr.close()
  1499. self._read_set.remove(self.stderr)
  1500. stderr.append(data)
  1501. return (stdout, stderr)
  1502. def send_signal(self, sig):
  1503. """Send a signal to the process
  1504. """
  1505. # Skip signalling a process that we know has already died.
  1506. if self.returncode is None:
  1507. os.kill(self.pid, sig)
  1508. def terminate(self):
  1509. """Terminate the process with SIGTERM
  1510. """
  1511. self.send_signal(signal.SIGTERM)
  1512. def kill(self):
  1513. """Kill the process with SIGKILL
  1514. """
  1515. self.send_signal(signal.SIGKILL)