Ñò ô†³Kc@s:dZddkZeidjZddkZddkZddkZeoÜddkZddkZddk Z ddk l Z l Z l Z lZddk lZlZlZlZddklZlZddklZddklZlZlZlZlZlZdd kl Z l!Z!l"Z"n1ddk#Z#ddk$Z$ddk%Z%ddk&Z&d d d d gZ'yei(dƒZ)Wn dZ)nXye*Wne+j odZ*dZ,nXgZ-d„Z.dZ/dZ0d„Z1d„Z2d e3fd„ƒYZ4d„Z5d„Z6e7djoeo e6ƒne5ƒndS(sT)subprocess - Subprocesses with accessible I/O streams This module allows you to spawn processes, connect to their input/output/error pipes, and obtain their return codes. This module intends to replace several other, older modules and functions, like: os.system os.spawn* os.popen* popen2.* commands.* Information about how the subprocess module can be used to replace these modules and functions can be found below. Using the subprocess module =========================== This module defines one class called Popen: class Popen(args, bufsize=0, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=False, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0): Arguments are: args should be a string, or a sequence of program arguments. The program to execute is normally the first item in the args sequence or string, but can be explicitly set by using the executable argument. On UNIX, with shell=False (default): In this case, the Popen class uses os.execvp() to execute the child program. args should normally be a sequence. A string will be treated as a sequence with the string as the only item (the program to execute). On UNIX, with shell=True: If args is a string, it specifies the command string to execute through the shell. If args is a sequence, the first item specifies the command string, and any additional items will be treated as additional shell arguments. On Windows: the Popen class uses CreateProcess() to execute the child program, which operates on strings. If args is a sequence, it will be converted to a string using the list2cmdline method. Please note that not all MS Windows applications interpret the command line the same way: The list2cmdline is designed for applications using the same rules as the MS C runtime. bufsize, if given, has the same meaning as the corresponding argument to the built-in open() function: 0 means unbuffered, 1 means line buffered, any other positive value means use a buffer of (approximately) that size. A negative bufsize means to use the system default, which usually means fully buffered. The default value for bufsize is 0 (unbuffered). stdin, stdout and stderr specify the executed programs' standard input, standard output and standard error file handles, respectively. Valid values are PIPE, an existing file descriptor (a positive integer), an existing file object, and None. PIPE indicates that a new pipe to the child should be created. With None, no redirection will occur; the child's file handles will be inherited from the parent. Additionally, stderr can be STDOUT, which indicates that the stderr data from the applications should be captured into the same file handle as for stdout. If preexec_fn is set to a callable object, this object will be called in the child process just before the child is executed. If close_fds is true, all file descriptors except 0, 1 and 2 will be closed before the child process is executed. if shell is true, the specified command will be executed through the shell. If cwd is not None, the current directory will be changed to cwd before the child is executed. If env is not None, it defines the environment variables for the new process. If universal_newlines is true, the file objects stdout and stderr are opened as a text files, but lines may be terminated by any of '\n', the Unix end-of-line convention, '\r', the Macintosh convention or '\r\n', the Windows convention. All of these external representations are seen as '\n' by the Python program. Note: This feature is only available if Python is built with universal newline support (the default). Also, the newlines attribute of the file objects stdout, stdin and stderr are not updated by the communicate() method. The startupinfo and creationflags, if given, will be passed to the underlying CreateProcess() function. They can specify things such as appearance of the main window and priority for the new process. (Windows only) This module also defines two shortcut functions: call(*args, **kwargs): Run command with arguments. Wait for command to complete, then return the returncode attribute. The arguments are the same as for the Popen constructor. Example: retcode = call(["ls", "-l"]) Exceptions ---------- Exceptions raised in the child process, before the new program has started to execute, will be re-raised in the parent. Additionally, the exception object will have one extra attribute called 'child_traceback', which is a string containing traceback information from the childs point of view. The most common exception raised is OSError. This occurs, for example, when trying to execute a non-existent file. Applications should prepare for OSErrors. A ValueError will be raised if Popen is called with invalid arguments. Security -------- Unlike some other popen functions, this implementation will never call /bin/sh implicitly. This means that all characters, including shell metacharacters, can safely be passed to child processes. Popen objects ============= Instances of the Popen class have the following methods: poll() Check if child process has terminated. Returns returncode attribute. wait() Wait for child process to terminate. Returns returncode attribute. communicate(input=None) Interact with process: Send data to stdin. Read data from stdout and stderr, until end-of-file is reached. Wait for process to terminate. The optional stdin argument should be a string to be sent to the child process, or None, if no data should be sent to the child. communicate() returns a tuple (stdout, stderr). Note: The data read is buffered in memory, so do not use this method if the data size is large or unlimited. The following attributes are also available: stdin If the stdin argument is PIPE, this attribute is a file object that provides input to the child process. Otherwise, it is None. stdout If the stdout argument is PIPE, this attribute is a file object that provides output from the child process. Otherwise, it is None. stderr If the stderr argument is PIPE, this attribute is file object that provides error output from the child process. Otherwise, it is None. pid The process ID of the child process. returncode The child return code. A None value indicates that the process hasn't terminated yet. A negative value -N indicates that the child was terminated by signal N (UNIX only). Replacing older functions with the subprocess module ==================================================== In this section, "a ==> b" means that b can be used as a replacement for a. Note: All functions in this section fail (more or less) silently if the executed program cannot be found; this module raises an OSError exception. In the following examples, we assume that the subprocess module is imported with "from subprocess import *". Replacing /bin/sh shell backquote --------------------------------- output=`mycmd myarg` ==> output = Popen(["mycmd", "myarg"], stdout=PIPE).communicate()[0] Replacing shell pipe line ------------------------- output=`dmesg | grep hda` ==> p1 = Popen(["dmesg"], stdout=PIPE) p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) output = p2.communicate()[0] Replacing os.system() --------------------- sts = os.system("mycmd" + " myarg") ==> p = Popen("mycmd" + " myarg", shell=True) sts = os.waitpid(p.pid, 0) Note: * Calling the program through the shell is usually not required. * It's easier to look at the returncode attribute than the exitstatus. A more real-world example would look like this: try: retcode = call("mycmd" + " myarg", shell=True) if retcode < 0: print >>sys.stderr, "Child was terminated by signal", -retcode else: print >>sys.stderr, "Child returned", retcode except OSError, e: print >>sys.stderr, "Execution failed:", e Replacing os.spawn* ------------------- P_NOWAIT example: pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg") ==> pid = Popen(["/bin/mycmd", "myarg"]).pid P_WAIT example: retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg") ==> retcode = call(["/bin/mycmd", "myarg"]) Vector example: os.spawnvp(os.P_NOWAIT, path, args) ==> Popen([path] + args[1:]) Environment example: os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env) ==> Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"}) Replacing os.popen* ------------------- pipe = os.popen(cmd, mode='r', bufsize) ==> pipe = Popen(cmd, shell=True, bufsize=bufsize, stdout=PIPE).stdout pipe = os.popen(cmd, mode='w', bufsize) ==> pipe = Popen(cmd, shell=True, bufsize=bufsize, stdin=PIPE).stdin (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize, stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdin, child_stdout) = (p.stdin, p.stdout) (child_stdin, child_stdout, child_stderr) = os.popen3(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize, stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True) (child_stdin, child_stdout, child_stderr) = (p.stdin, p.stdout, p.stderr) (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize, stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True) (child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout) Replacing popen2.* ------------------ Note: If the cmd argument to popen2 functions is a string, the command is executed through /bin/sh. If it is a list, the command is directly executed. (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode) ==> p = Popen(["somestring"], shell=True, bufsize=bufsize stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdout, child_stdin) = (p.stdout, p.stdin) (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode) ==> p = Popen(["mycmd", "myarg"], bufsize=bufsize, stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdout, child_stdin) = (p.stdout, p.stdin) The popen2.Popen3 and popen3.Popen4 basically works as subprocess.Popen, except that: * subprocess.Popen raises an exception if the execution fails * the capturestderr argument is replaced with the stderr argument. * stdin=PIPE and stdout=PIPE must be specified. * popen2 closes all filedescriptors by default, but you have to specify close_fds=True with subprocess.Popen. iÿÿÿÿNtwin32(t GetStdHandletSTD_INPUT_HANDLEtSTD_OUTPUT_HANDLEtSTD_ERROR_HANDLE(tGetCurrentProcesstDuplicateHandletGetModuleFileNamet GetVersion(tDUPLICATE_SAME_ACCESStSW_HIDE(t CreatePipe(t CreateProcesst STARTUPINFOtGetExitCodeProcesstSTARTF_USESTDHANDLEStSTARTF_USESHOWWINDOWtCREATE_NEW_CONSOLE(tWaitForSingleObjecttINFINITEt WAIT_OBJECT_0tPopentPIPEtSTDOUTtcallt SC_OPEN_MAXiiicCs xtD]}|iƒqWdS(N(t_activetpoll(tinst((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt_cleanupsiþÿÿÿcOst||ŽiƒS(sÓRun command with arguments. Wait for command to complete, then return the returncode attribute. The arguments are the same as for the Popen constructor. Example: retcode = call(["ls", "-l"]) (Rtwait(targstkwargs((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyR—scCsOg}t}x3|D]+}g}|o|idƒnd|jp d|j}|o|idƒnx–|D]Ž}|djo|i|ƒqo|djo2|idt|ƒdƒg}|idƒqo|o|i|ƒg}n|i|ƒqoW|o|i|ƒn|o|i|ƒ|idƒqqWdi|ƒS(s• Translate a sequence of arguments into a command line string, using the same rules as the MS C runtime: 1) Arguments are delimited by white space, which is either a space or a tab. 2) A string surrounded by double quotation marks is interpreted as a single argument, regardless of white space contained within. A quoted string can be embedded in an argument. 3) A double quotation mark preceded by a backslash is interpreted as a literal double quotation mark. 4) Backslashes are interpreted literally, unless they immediately precede a double quotation mark. 5) If backslashes immediately precede a double quotation mark, every pair of backslashes is interpreted as a literal backslash. If the number of backslashes is odd, the last backslash escapes the next double quotation mark as described in rule 3. t s t"s\is\"t(tFalsetappendtlentextendtjoin(tseqtresultt needquotetargtbs_buftc((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt list2cmdline¢s8     cBsâeZddddddeeddeddd„ Zd„ZeoOd„Zd„Zd„Z d„Z d„Z d„Z d „Z dd „ZnLd „Zd „Zd „Zd„Z d„Zd„Z d„Z dd„ZRS(icCsýtƒt|ttfƒptdƒ‚nto8|d j otdƒ‚n|otdƒ‚q¦n;| d j otdƒ‚n|djotdƒ‚nd |_d |_ d |_ d |_ d |_ | |_ |i|||ƒ\}}}}}}|i||||| | | | || ||||||ƒ|oti|d|ƒ|_n|o?| oti|d|ƒ|_ q¦ti|d |ƒ|_ n|o?| oti|d|ƒ|_ qìti|d |ƒ|_ nti|ƒd S( sCreate new Popen instance.sbufsize must be an integers0preexec_fn is not supported on Windows platformss/close_fds is not supported on Windows platformss2startupinfo is only supported on Windows platformsis4creationflags is only supported on Windows platformstwbtrUtrbN(Rt isinstancetinttlongt TypeErrort mswindowstNonet ValueErrortstdintstdouttstderrtpidt returncodetuniversal_newlinest _get_handlest_execute_childtostfdopenRR%(tselfRtbufsizet executableR:R;R<t preexec_fnt close_fdstshelltcwdtenvR?t startupinfot creationflagstp2creadtp2cwritetc2preadtc2pwriteterrreadterrwrite((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt__init__çsH         '   cCs(|iddƒ}|iddƒ}|S(Ns s s (treplace(RDtdata((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt_translate_newlines3sc Cs‡|djo|djo|djodSd\}}d\}}d\}} |djottƒ}nƒ|tjo7tddƒ\}}|iƒ}ti|dƒ}n?t|ƒt i joti |ƒ}nti |i ƒƒ}|i |ƒ}|djottƒ}nƒ|tjo7tddƒ\}}|iƒ}ti|dƒ}n?t|ƒt i joti |ƒ}nti |i ƒƒ}|i |ƒ}|djottƒ} nš|tjo7tddƒ\}} |iƒ}ti|dƒ}nV|tjo |} n?t|ƒt i joti |ƒ} nti |i ƒƒ} |i | ƒ} |||||| fS(s|Construct and return tupel with IO objects: p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite iN(NNNNNN(NN(NN(NN(R8RRRR tDetachtmsvcrttopen_osfhandlettypettypestIntTypet get_osfhandletfilenot_make_inheritableRRR( RDR:R;R<RNRORPRQRRRS((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyR@=sP'              cCsttƒ|tƒddtƒS(s2Return a duplicate of handle, which is inheritableii(RRR (RDthandle((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyR`ys  cCs‰tiitiitdƒƒdƒ}tii|ƒpKtiitiitiƒdƒ}tii|ƒptdƒ‚q…n|S(s,Find and return absolut path to w9xpopen.exeis w9xpopen.exesZCannot locate w9xpopen.exe, which is needed for Popen to work with your shell or platform.( RBtpathR(tdirnameRtexiststsyst exec_prefixt RuntimeError(RDtw9xpopen((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt_find_w9xpopen€s  c Csõt|tiƒpt|ƒ}ntƒ}|djo |}nd| ||fjo.|itO_| |_||_ ||_ n| o˜|it O_t |_ tiiddƒ}|d|}tƒdjptii|ƒiƒdjo*|iƒ}d||f}| tO} q&ny4t||ddd| |||ƒ \}}}}Wn'tij o}t|iŒ‚nX||_||_|iƒ| djo| iƒn|djo|iƒn|djo|iƒndS( s$Execute program (MS Windows version)tCOMSPECscmd.exes /c ls command.coms"%s" %siN(R3R\t StringTypesR/R R8tdwFlagsRt hStdInputt hStdOutputt hStdErrorRR t wShowWindowRBtenvirontgetRRbtbasenametlowerRiRR t pywintypesterrort WindowsErrorRt_handleR=tClose(RDRRFRGRHRJRKR?RLRMRIRNRORPRQRRRStdefault_startupinfotcomspecRhthpthtR=ttidte((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRAsN               cCsW|idjo@t|idƒtjo#t|iƒ|_ti|ƒqPn|iS(sQCheck if child process has terminated. Returns returncode attribute.iN(R>R8RRxRRRtremove(RD((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRàs cCsL|idjo5t|itƒ}t|iƒ|_ti|ƒn|iS(sOWait for child process to terminate. Returns returncode attribute.N(R>R8RRxRRRR€(RDtobj((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRês cCs|i|iƒƒdS(N(R%tread(RDtfhtbuffer((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt _readerthreadôscCs²d}d}|ioEg}tid|id|i|fƒ}|itƒ|iƒn|ioEg}tid|id|i|fƒ}|itƒ|iƒn|i o2|djo|i i |ƒn|i i ƒn|io|i ƒn|io|i ƒn|djo|d}n|djo|d}n|i oHttdƒo8|o|i|ƒ}n|o|i|ƒ}qžn|iƒ||fS(szInteract with process: Send data to stdin. Read data from stdout and stderr, until end-of-file is reached. Wait for process to terminate. The optional input argument should be a string to be sent to the child process, or None, if no data should be sent to the child. communicate() returns a tuple (stdout, stderr).ttargetRitnewlinesN(R8R;t threadingtThreadR…t setDaemontTruetstartR<R:twritetcloseR(R?thasattrtopenRWR(RDtinputR;R<t stdout_threadt stderr_thread((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt communicateøsB           c Csqd\}}d\}}d\}} |djonP|tjotiƒ\}}n-t|ƒtijo |}n |iƒ}|djonP|tjotiƒ\}}n-t|ƒtijo |}n |iƒ}|djong|tjotiƒ\}} nD|tjo |} n-t|ƒtijo |} n |iƒ} |||||| fS(s|Construct and return tupel with IO objects: p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite N(NN(NN(NN( R8RRBtpipeR[R\R]R_R( RDR:R;R<RNRORPRQRRRS((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyR@1s:                 cCs\y ti}Wntj o d}nXti|tiƒ}ti|ti||BƒdS(Ni(tfcntlt FD_CLOEXECtAttributeErrortF_GETFDtF_SETFD(RDtfdt cloexec_flagtold((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt_set_cloexec_flag^s   cCsMxFtdtƒD]5}||joqnyti|ƒWqqXqWdS(Ni(trangetMAXFDRBRŽ(RDtbutti((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt _close_fdshs cCsat|tiƒo |g}n| oddg|}n|d jo|d}ntiƒ\}}|i|ƒtiƒ|_|idjoy—| oti | ƒn| oti | ƒn|oti |ƒnti |ƒ| oti | dƒn|oti |dƒn|oti |dƒn| oti | ƒn|o!|| fjoti |ƒn|o$|| |fjoti |ƒn|o|i d|ƒn|d joti |ƒn|ot |ƒn|d joti||ƒnti|||ƒWn\tiƒ\}}}ti|||ƒ}di|ƒ|_ti|ti|ƒƒnXtidƒnti |ƒ| o| oti | ƒn|o| oti |ƒn|o|oti |ƒnti|d ƒ}ti |ƒ|djo,ti|idƒti|ƒ}|‚nd S( sExecute program (POSIX version)s/bin/shs-ciiiR¡R#iÿiN(R3R\RkR8RBR•RžtforkR=RŽtdup2R£tchdirtapplytexecvptexecvpeRetexc_infot tracebacktformat_exceptionR(tchild_tracebackRtpickletdumpst_exitR‚twaitpidtloads(RDRRFRGRHRJRKR?RLRMRIRNRORPRQRRRSt errpipe_readt errpipe_writetexc_typet exc_valuettbt exc_linesRVtchild_exception((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRArsx           cCsjti|ƒoti|ƒ |_n3ti|ƒoti|ƒ|_n tdƒ‚ti|ƒdS(NsUnknown child exit status!( RBt WIFSIGNALEDtWTERMSIGR>t WIFEXITEDt WEXITSTATUSRgRR€(RDtsts((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt_handle_exitstatusÕs  cCsw|idjo`yCti|itiƒ\}}||ijo|i|ƒnWqptij oqpXn|iS(sQCheck if child process has terminated. Returns returncode attribute.N(R>R8RBR±R=tWNOHANGR¿Rv(RDR=R¾((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRás cCsC|idjo,ti|idƒ\}}|i|ƒn|iS(sOWait for child process to terminate. Returns returncode attribute.iN(R>R8RBR±R=R¿(RDR=R¾((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRîsc Cs¶g}g}d}d}|io9|iiƒ|o|i|iƒq[|iiƒn|io|i|iƒg}n|io|i|iƒg}nxj|p|o[ti||gƒ\}}}|i|joUti |ii ƒ|d ƒ} || }|p!|iiƒ|i |iƒq7n|i|joZti |ii ƒdƒ} | djo!|iiƒ|i |iƒn|i| ƒn|i|joZti |ii ƒdƒ} | djo!|iiƒ|i |iƒn|i| ƒq¦q¦W|djodi |ƒ}n|djodi |ƒ}n|ioHttdƒo8|o|i|ƒ}n|o|i|ƒ}q¢n|iƒ||fS(szInteract with process: Send data to stdin. Read data from stdout and stderr, until end-of-file is reached. Wait for process to terminate. The optional input argument should be a string to be sent to the child process, or None, if no data should be sent to the child. communicate() returns a tuple (stdout, stderr).iiR#R‡N(R8R:tflushR%RŽR;R<tselectRBRR_R€R‚R(R?RRRWR( RDR‘tread_sett write_setR;R<trlisttwlisttxlistt bytes_writtenRV((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyR”÷s^               N(t__name__t __module__R8R$RTRWR7R@R`RiRARRR…R”RžR£R¿(((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyRæs.   H  <   P 9 - c cCs.tdgdtƒiƒd}dGH|GHtiƒdjo&tdgdd„ƒ}|iƒndGHtd gdtƒ}td d gd |idtƒ}t|iƒdƒGHHd GHytdgƒiƒGHWnJtj o>}|i t i jodGHdGH|i GHq*dG|i GHnXt i dIJdS(NtpsR;is Process list:tidRGcSs tidƒS(id(RBtsetuid(((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pytNssLooking for 'hda'...tdmesgtgrepthdaR:sTrying a weird file...s/this/path/does/not/exists'The file didn't exist. I thought so...sChild traceback:tErrorsGosh. No error.(RRR”RBtgetuidRR;treprtOSErrorterrnotENOENTR­ReR<(tplisttptp1tp2R((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt _demo_posixBs*! cCsldGHtddtdtƒ}tdd|idtƒ}t|iƒdƒGHdGHtd ƒ}|iƒdS( Ns%Looking for 'PROMPT' in set output...tsetR;RIs find "PROMPT"R:isExecuting calc...tcalc(RRR‹R;RÔR”R(RÚRÛRÙ((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pyt _demo_windowsks t__main__(8t__doc__RetplatformR7RBR\R«RˆRYRutwin32apiRRRRRRRRtwin32conR R t win32pipeR t win32processR R RRRRt win32eventRRRRÂRÖR–R®t__all__tsysconfR R$t NameErrorR‹RRRRRR/tobjectRRÜRßRÉ(((s;/usr/lib/python2.6/site-packages/paste/util/subprocess24.pytTsX       "".        Dÿÿ^ )