python模塊之subprocess模塊級方法

subprocess.run()

運行並等待args參數指定的指令完成，返回CompletedProcess實例。

參數：(*popenargs, input=None, capture_output=False, timeout=None, check=False, **kwargs)。除input, capture_output, timeout, check，其餘參數與Popen構造器參數一致。

capture_output：若是設置爲True，表示重定向stdout和stderr到管道，且不能再傳遞stderr或stdout參數，不然拋出異常。

input：input參數將做爲子進程的標準輸入傳遞給Popen.communicate()方法，必須是string(須要指定encoding或errors參數，或者設置text爲True)或byte類型。非None的input參數不能和stdin參數一塊兒使用，不然將拋出異常，構造Popen實例的stdin參數將指定爲subprocess.PIPE。

timeout：傳遞給Popen.communicate()方法。

check：若是設置爲True，進程執行返回非0狀態碼將拋出CalledProcessError異常。

# 源碼

def run(*popenargs, input=None, capture_output=False, timeout=None, check=False, **kwargs):
    if input is not None:
        if 'stdin' in kwargs:
            raise ValueError('stdin and input arguments may not both be used.')
        kwargs['stdin'] = PIPE
    
    if capture_output:
        if ('stdout' in kwargs) or ('stderr' in kwargs):
            raise ValueError('stdout and stderr arguments may not be used '
                             'with capture_output.')
        kwargs['stdout'] = PIPE
        kwargs['stderr'] = PIPE
    
    with Popen(*popenargs, **kwargs) as process:
        try:
            stdout, stderr = process.communicate(input, timeout=timeout)
        except TimeoutExpired:
            process.kill()
            stdout, stderr = process.communicate()
            raise TimeoutExpired(process.args, timeout, output=stdout,
                                 stderr=stderr)
        except:  # Including KeyboardInterrupt, communicate handled that.
            process.kill()
            # We don't call process.wait() as .__exit__ does that for us.
            raise
        retcode = process.poll()
        if check and retcode:
            raise CalledProcessError(retcode, process.args,
                                     output=stdout, stderr=stderr)
    return CompletedProcess(process.args, retcode, stdout, stderr)

---

python3.5版本前，call(), check_all(), checkoutput()三種方法構成了subprocess模塊的高級API。

subprocess.call()

運行並等待args參數指定的指令完成，返回執行狀態碼(Popen實例的returncode屬性)。

參數：(*popenargs, timeout=None, **kwargs)。與Popen構造器參數基本相同，除timeout外的全部參數都將傳遞給Popen接口。

調用call()函數不要使用stdout=PIPE或stderr=PIPE，由於若是子進程生成了足量的輸出到管道填滿OS管道緩衝區，子進程將因不能從管道讀取數據而致使阻塞。

# 源碼

def call(*popenargs, timeout=None, **kwargs):
    with Popen(*popenargs, **kwargs) as p:
        try:
            return p.wait(timeout=timeout)
        except:
            p.kill()
            p.wait()
            raise

subprocess.check_call()

運行並等待args參數指定的指令完成，返回0狀態碼或拋出CalledProcessError異常，該異常的cmd和returncode屬性能夠查看執行異常的指令和狀態碼。

參數：(*popenargs, **kwargs)。所有參數傳遞給call()函數。

注意事項同call()

# 源碼

def check_call(*popenargs, **kwargs):
    retcode = call(*popenargs, **kwargs)
    if retcode:
        cmd = kwargs.get("args")
        if cmd is None:
            cmd = popenargs[0]
        raise CalledProcessError(retcode, cmd)
    return 0

subprocess.check_output()

運行並等待args參數指定的指令完成，返回標準輸出(CompletedProcess實例的stdout屬性)，類型默認是byte字節，字節編碼可能取決於執行的指令，設置universal_newlines=True能夠返回string類型的值。
若是執行狀態碼非0，將拋出CalledProcessError異常。

參數：(*popenargs, timeout=None, **kwargs)。所有參數傳遞給run()函數，但不支持顯示地傳遞input=None繼承父進程的標準輸入文件句柄。

要在返回值中捕獲標準錯誤，設置stderr=subprocess.STDOUT；也能夠將標準錯誤重定向到管道stderr=subprocess.PIPE，經過CalledProcessError異常的stderr屬性訪問。

# 源碼

def check_output(*popenargs, timeout=None, **kwargs):
    if 'stdout' in kwargs:
        raise ValueError('stdout argument not allowed, it will be overridden.')

    if 'input' in kwargs and kwargs['input'] is None:
        # Explicitly passing input=None was previously equivalent to passing an
        # empty string. That is maintained here for backwards compatibility.
        kwargs['input'] = '' if kwargs.get('universal_newlines', False) else b''

    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
               **kwargs).stdout

---

subprocess模塊還提供了python2.x版本中commands模塊的相關函數。

subprocess.getstatusoutput(cmd)

其實是調用check_output()函數，在shell中執行string類型的cmd指令，返回(exitcode, output)形式的元組，output(包含stderr和stdout)是使用locale encoding解碼的字符串，並刪除告終尾的換行符。

# 源碼

try:
    data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
    exitcode = 0
except CalledProcessError as ex:
    data = ex.output
    exitcode = ex.returncode
if data[-1:] == '\n':
    data = data[:-1]
return exitcode, data

subprocess.getoutput(cmd)

與getstatusoutput()相似，但結果只返回output。