subprocess
--- サブプロセス管理¶
ソースコード: Lib/subprocess.py
subprocess
モジュールは新しいプロセスの開始、入力/出力/エラーパイプの接続、リターンコードの取得を可能とします。このモジュールは以下の古いモジュールや関数を置き換えることを目的としています:
os.system
os.spawn*
これらのモジュールや関数の代わりに、subprocess
モジュールをどのように使うかについてを以下の節で説明します。
参考
PEP 324 -- subprocess モジュールを提案している PEP
subprocess
モジュールを使う¶
サブプロセスを起動するために推奨される方法は、すべての用法を扱える run()
関数を使用することです。より高度な用法では下層の Popen
インターフェースを直接使用することもできます。
run()
関数は Python 3.5 で追加されました; 過去のバージョンとの互換性の維持が必要な場合は、古い高水準 API 節をご覧ください。
-
subprocess.
run
(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None, **other_popen_kwargs)¶ args で指定されたコマンドを実行します。コマンドの完了を待って、
CompletedProcess
インスタンスを返します。上記の引数は、もっともよく使われるものだけ示しており、後述の よく使われる引数 で説明されています (そのためここではキーワード専用引数の表記に省略されています)。関数の完全な使用法を説明しても大部分が
Popen
コンストラクターの内容と同じになります - この関数のほとんどの引数はPopen
インターフェイスに渡されます。(timeout、input および check は除く。)capture_output を true に設定すると、stdout および stderr が捕捉されます。 このとき、内部では
stdout=PIPE
およびstderr=PIPE
に設定されたPopen
オブジェクトが自動的に作られます。なお、stdout または stderr 引数を capture_output と同時に指定することはできません。両者をまとめてひとつのストリームとして捕捉したい場合は、capture_output を指定するのではなく、stdout=PIPE
andstderr=STDOUT
を指定してください。引数 timeout は
Popen.communicate()
に渡されます。タイムアウトが発生すると、子プロセスは kill され、待機されます。子プロセスが中断されたあとTimeoutExpired
が再び送出されます。引数 input は
Popen.communicate()
を経由し、サブプロセスの標準入力に渡されます。これはバイト列であるか、(encoding
もしくはerrors
が指定されているか、text
引数が true である場合は) 文字列でなければなりません。この引数が指定されると、内部でPopen
オブジェクトがstdin=PIPE
で自動的に作成され、引数 stdin は使用されません。check に真を指定した場合、プロセスが非ゼロの終了コードで終了すると
CalledProcessError
例外が送出されます。 この例外の属性には、引数、終了コード、標準出力および標準エラー出力が捕捉できた場合に格納されます。encoding または errors 引数が指定されるか、text 引数が true である場合、stdin, stdout および stderr のためのファイルオブジェクトはテキストモードでオープンされます。 その際には指定された encoding および errors が使われるか、デフォルトの
io.TextIOWrapper
になります。universal_newlines 引数は text 引数と等価であり、後方互換性のために提供されています。そうでない場合、デフォルトでこれらのファイルオブジェクトはバイナリモードでオープンされます。env が
None
以外の場合、これは新しいプロセスでの環境変数を定義します。デフォルトでは、子プロセスは現在のプロセスの環境変数を引き継ぎます。Popen
に直接渡されます。例:
>>> subprocess.run(["ls", "-l"]) # doesn't capture output CompletedProcess(args=['ls', '-l'], returncode=0) >>> subprocess.run("exit 1", shell=True, check=True) Traceback (most recent call last): ... subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1 >>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True) CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0, stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'')
バージョン 3.5 で追加.
バージョン 3.6 で変更: encoding と error が引数に追加されました。
バージョン 3.7 で変更: universal_newlines 引数のよりわかりやすい名前として、text 引数が追加されました。capture_output 引数が追加されました。
バージョン 3.8.17 で変更: Changed Windows shell search order for
shell=True
. The current directory and%PATH%
are replaced with%COMSPEC%
and%SystemRoot%\System32\cmd.exe
. As a result, dropping a malicious program namedcmd.exe
into a current directory no longer works.
-
class
subprocess.
CompletedProcess
¶ run()
の戻り値。プロセスが終了したことを表します。-
args
¶ プロセスを起動するときに使用された引数。1 個のリストか 1 個の文字列になります。
-
returncode
¶ 子プロセスの終了コード。一般に、終了ステータス 0 はプロセスが正常に終了したことを示します。
負の値
-N
は子プロセスがシグナルN
により中止させられたことを示します (POSIX のみ)。
-
stdout
¶ 子プロセスから補足された標準出力です。バイトシーケンス、もしくは
run()
でエンコーディングが指定された場合、エラーの場合、text=True が指定された場合は文字列が出力されます。標準出力が補足されなかった場合はNone
になります。プロセスが
stderr=subprocess.STDOUT
で実行された場合、標準出力と標準エラー出力が混合されたものがこの属性に格納され、stderr
はNone
になります。
-
stderr
¶ 子プロセスから補足された標準エラー出力です。バイト列、もしくは
run()
でエンコーディングが指定された場合、エラーの場合、text=True が指定された場合は文字列です。標準エラー出力が補足できなかったらNone
になります。
-
check_returncode
()¶ returncode
が非ゼロの場合、CalledProcessError
が送出されます。
バージョン 3.5 で追加.
-
-
subprocess.
DEVNULL
¶ Popen
の stdin, stdout, stderr 引数に渡して、標準入出力をos.devnull
から入出力するように指定するための特殊値です。バージョン 3.3 で追加.
-
subprocess.
PIPE
¶ Popen
の stdin, stdout, stderr 引数に渡して、標準ストリームに対するパイプを開くことを指定するための特殊値です。Popen.communicate()
に非常に有用です。
-
exception
subprocess.
SubprocessError
¶ このモジュールの他のすべての例外のための基底クラスです。
バージョン 3.3 で追加.
-
exception
subprocess.
TimeoutExpired
¶ SubprocessError
のサブクラスです。子プロセスの終了を待機している間にタイムアウトが発生した場合に送出されます。-
cmd
¶ 子プロセスの生成に使用されるコマンド本文。
-
timeout
¶ タイムアウト秒数。
-
output
¶ run()
またはcheck_output()
によって捕捉された子プロセスの出力。捕捉されなかったらNone
になります。
バージョン 3.3 で追加.
バージョン 3.5 で変更: 属性 stdout および stderr が追加されました。
-
-
exception
subprocess.
CalledProcessError
¶ SubprocessError
のサブクラスです。check_call()
またはcheck_output()
によって実行されたプロセスが非ゼロの終了ステータスを返した場合に送出されます。-
returncode
¶ 子プロセスの終了ステータスです。もしプロセスがシグナルによって終了したなら、これは負のシグナル番号になります。
-
cmd
¶ 子プロセスの生成に使用されるコマンド本文。
-
output
¶ run()
またはcheck_output()
によって捕捉された子プロセスの出力。捕捉されなかったらNone
になります。
バージョン 3.5 で変更: 属性 stdout および stderr が追加されました。
-
よく使われる引数¶
幅広い使用例をサポートするために、Popen
コンストラクター (とその他の簡易関数) は、多くのオプション引数を受け付けます。一般的な用法については、これらの引数の多くはデフォルト値のままで問題ありません。通常必要とされる引数は以下の通りです:
args はすべての呼び出しに必要で、文字列あるいはプログラム引数のシーケンスでなければなりません。一般に、引数のシーケンスを渡す方が望ましいです。なぜなら、モジュールが必要な引数のエスケープやクオート (例えばファイル名中のスペースを許すこと) の面倒を見ることができるためです。単一の文字列を渡す場合、shell は
True
でなければなりません (以下を参照)。もしくは、その文字列は引数を指定せずに実行される単なるプログラムの名前でなければなりません。stdin, stdout および stderr には、実行するプログラムの標準入力、標準出力、および標準エラー出力のファイルハンドルをそれぞれ指定します。有効な値は
PIPE
、DEVNULL
、既存のファイル記述子 (正の整数)、既存のファイルオブジェクトおよびNone
です。PIPE
を指定すると新しいパイプが子プロセスに向けて作られます。DEVNULL
を指定すると特殊ファイルos.devnull
が使用されます。デフォルト設定のNone
を指定するとリダイレクトは起こりません。子プロセスのファイルハンドルはすべて親から受け継がれます。加えて、stderr をSTDOUT
にすると、子プロセスの stderr からの出力は stdout と同じファイルハンドルに出力されます。If encoding or errors are specified, or text (also known as universal_newlines) is true, the file objects stdin, stdout and stderr will be opened in text mode using the encoding and errors specified in the call or the defaults for
io.TextIOWrapper
.stdin については、入力での行末文字
'\n'
はデフォルトの行セパレーターos.linesep
に変換されます。stdout と stderr については、出力での行末はすべて'\n'
に変換されます。詳細はio.TextIOWrapper
クラスのドキュメントでコンストラクターの引数 newline がNone
である場合を参照してください。If text mode is not used, stdin, stdout and stderr will be opened as binary streams. No encoding or line ending conversion is performed.
バージョン 3.6 で追加: encoding と error が引数に追加されました。
バージョン 3.7 で追加: universal_newlines の別名として、text 引数が追加されました。
注釈
ファイルオブジェクト
Popen.stdin
、Popen.stdout
ならびにPopen.stderr
の改行属性はPopen.communicate()
メソッドで更新されません。shell が
True
なら、指定されたコマンドはシェルによって実行されます。あなたが Python を主として (ほとんどのシステムシェル以上の) 強化された制御フローのために使用していて、さらにシェルパイプ、ファイル名ワイルドカード、環境変数展開、~
のユーザーホームディレクトリへの展開のような他のシェル機能への簡単なアクセスを望むなら、これは有用かもしれません。しかしながら、Python 自身が多くのシェル的な機能の実装を提供していることに注意してください (特にglob
,fnmatch
,os.walk()
,os.path.expandvars()
,os.path.expanduser()
,shutil
)。バージョン 3.3 で変更: universal_newlines が
True
の場合、クラスはエンコーディングlocale.getpreferredencoding()
の代わりにlocale.getpreferredencoding(False)
を使用します。この変更についての詳細は、io.TextIOWrapper
クラスを参照してください。注釈
shell=True
を使う前に セキュリティで考慮すべき点 を読んでください。
これらのオプションは、他のすべてのオプションとともに Popen
コンストラクターのドキュメントの中でより詳細に説明されています。
Popen コンストラクター¶
このモジュールの中で、根底のプロセス生成と管理は Popen
クラスによって扱われます。簡易関数によってカバーされないあまり一般的でないケースを開発者が扱えるように、Popen
クラスは多くの柔軟性を提供しています。
-
class
subprocess.
Popen
(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None, text=None)¶ 新しいプロセスで子のプログラムを実行します。POSIX においては、子のプログラムを実行するために、このクラスは
os.execvp()
のような挙動を使用します。Windows においては、このクラスは Windows のCreateProcess()
関数を使用します。Popen
への引数は以下の通りです。args はプログラム引数のシーケンスか、単一の文字列または path-like オブジェクト でなければなりません。デフォルトでは、args がシーケンスの場合に実行されるプログラムは args の最初の要素です。args が文字列の場合、解釈はプラットフォーム依存であり、下記に説明されます。デフォルトの挙動からの追加の違いについては shell および executable 引数を参照してください。特に明記されない限り、args をシーケンスとして渡すことが推奨されます。
An example of passing some arguments to an external program as a sequence is:
Popen(["/usr/bin/git", "commit", "-m", "Fixes a bug."])
POSIX 上では、args が文字列の場合、その文字列は実行すべきプログラムの名前またはパスとして解釈されます。しかし、これはプログラムに引数を渡さない場合にのみ可能です。
注釈
It may not be obvious how to break a shell command into a sequence of arguments, especially in complex cases.
shlex.split()
can illustrate how to determine the correct tokenization for args:>>> import shlex, subprocess >>> command_line = input() /bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'" >>> args = shlex.split(command_line) >>> print(args) ['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"] >>> p = subprocess.Popen(args) # Success!
特に注意すべき点は、シェル内でスペースで区切られたオプション (-input など) と引数 (eggs.txt など) はリストの別々の要素になるのに対し、シェル内で (上記のスペースを含むファイル名や echo コマンドのように) クォーティングやバックスラッシュエスケープが必要なものは単一のリスト要素であることです。
Windows 上では、args がシーケンスなら Windows における引数シーケンスから文字列への変換 に記述された方法で文字列に変換されます。これは根底の
CreateProcess()
が文字列上で動作するからです。バージョン 3.6 で変更: args parameter accepts a path-like object if shell is
False
and a sequence containing path-like objects on POSIX.バージョン 3.8 で変更: args parameter accepts a path-like object if shell is
False
and a sequence containing bytes and path-like objects on Windows.shell 引数 (デフォルトでは
False
) は、実行するプログラムとしてシェルを使用するかどうかを指定します。 shell がTrue
の場合、 args をシーケンスとしてではなく文字列として渡すことが推奨されます。POSIX で
shell=True
の場合、シェルのデフォルトは/bin/sh
になります。args が文字列の場合、この文字列はシェルを介して実行されるコマンドを指定します。したがって、文字列は厳密にシェルプロンプトで打つ形式と一致しなければなりません。例えば、文字列の中にスペースを含むファイル名がある場合は、クォーティングやバックスラッシュエスケープが必要です。args がシーケンスの場合には、最初の要素はコマンド名を表わす文字列として、残りの要素は追加の引数としてシェルに渡されます。つまり、以下のPopen
と等価ということです:Popen(['/bin/sh', '-c', args[0], args[1], ...])
Windows で
shell=True
とすると、COMSPEC
環境変数がデフォルトシェルを指定します。Windows でshell=True
を指定する必要があるのは、実行したいコマンドがシェルに組み込みの場合だけです (例えば dir や copy)。バッチファイルやコンソールベースの実行ファイルを実行するためにshell=True
は必要ありません。注釈
shell=True
を使う前に セキュリティで考慮すべき点 を読んでください。bufsize は標準入力/標準出力/標準エラー出力パイプファイルオブジェクトを生成するときに
open()
関数の対応する引数に渡されます:0
はバッファーされないことを意味します (読み込みおよび書き出しのたびにシステムコールが行われ、すぐに復帰します)。1
はラインバッファーを意味します (universal_newlines=True
、すなわちテキストモードの場合のみ使用可能)。それ以外の正の整数はバッファーのおよそのサイズになることを意味します。
負のサイズ (デフォルト) は io.DEFAULT_BUFFER_SIZE のシステムデフォルトが使用されることを意味します。
バージョン 3.3.1 で変更: ほとんどのコードが期待する振る舞いに合わせてデフォルトでバッファリングが有効となるよう bufsize のデフォルト値が -1 になりました。Python 3.2.4 および 3.3.1 より前のバージョンでは、誤ってバッファーされず短い読み込みを許可する
0
がデフォルトになっていました。これは意図したものではなく、ほとんどのコードが期待する Python 2 での振る舞いとも一致していませんでした。executable 引数は、実行する置換プログラムを指定します。これが必要になるのは極めて稀です。
shell=False
のときは、executable は args で指定されている実行プログラムを置換します。しかし、オリジナルの args は依然としてプログラムに渡されます。ほとんどのプログラムは、args で指定されたプログラムをコマンド名として扱います。そして、それは実際に実行されたプログラムとは異なる可能性があります。POSIX において、ps のようなユーティリティの中では、args 名が実行ファイルの表示名になります。shell=True
の場合、POSIX において executable 引数はデフォルトの/bin/sh
に対する置換シェルを指定します。バージョン 3.6 で変更: executable 引数が POSIX で path-like object を受け付けるようになりました。
バージョン 3.8 で変更: executable 引数が Windows で path-like object を受け付けるようになりました。
バージョン 3.8.17 で変更: Changed Windows shell search order for
shell=True
. The current directory and%PATH%
are replaced with%COMSPEC%
and%SystemRoot%\System32\cmd.exe
. As a result, dropping a malicious program namedcmd.exe
into a current directory no longer works.stdin、stdout および stderr には、実行するプログラムの標準入力、標準出力、および標準エラー出力のファイルハンドルをそれぞれ指定します。有効な値は
PIPE
,DEVNULL
, 既存のファイル記述子 (正の整数)、既存の ファイルオブジェクト 、そしてNone
です。PIPE
を指定すると新しいパイプが子プロセスに向けて作られます。DEVNULL
を指定すると特殊ファイルos.devnull
が使用されます。デフォルト設定のNone
を指定するとリダイレクトは起こりません。子プロセスのファイルハンドルはすべて親から受け継がれます。加えて、stderr をSTDOUT
にすると、子プロセスの標準エラー出力からの出力は標準出力と同じファイルハンドルに出力されます。preexec_fn に呼び出し可能オブジェクトが指定されている場合、このオブジェクトは子プロセスが実行される直前 (fork されたあと、exec される直前) に子プロセス内で呼ばれます。(POSIXのみ)
警告
アプリケーション中に複数のスレッドが存在する状態で preexec_fn 引数を使用するのは安全ではありません。exec が呼ばれる前に子プロセスがデッドロックを起こすことがあります。それを使用しなければならない場合、プログラムを自明なものにしておいてください! 呼び出すライブラリの数を最小にしてください。
注釈
子プロセスのために環境を変更する必要がある場合は、preexec_fn の中でそれをするのではなく env 引数を使用します。start_new_session 引数は、子プロセスの中で os.setsid() を呼ぶ過去の一般的な preexec_fn の使用方法の代わりになります。
バージョン 3.8 で変更: The preexec_fn parameter is no longer supported in subinterpreters. The use of the parameter in a subinterpreter raises
RuntimeError
. The new restriction may affect applications that are deployed in mod_wsgi, uWSGI, and other embedded environments.If close_fds is true, all file descriptors except
0
,1
and2
will be closed before the child process is executed. Otherwise when close_fds is false, file descriptors obey their inheritable flag as described in ファイル記述子の継承.On Windows, if close_fds is true then no handles will be inherited by the child process unless explicitly passed in the
handle_list
element ofSTARTUPINFO.lpAttributeList
, or by standard handle redirection.バージョン 3.2 で変更: close_fds のデフォルトは、
False
から上記のものに変更されました。バージョン 3.7 で変更: On Windows the default for close_fds was changed from
False
toTrue
when redirecting the standard handles. It's now possible to set close_fds toTrue
when redirecting the standard handles.pass_fds はオプションで、親と子の間で開いたままにしておくファイル記述子のシーケンスを指定します。何らかの pass_fds を渡した場合、close_fds は強制的に
True
になります。(POSIXのみ)バージョン 3.2 で変更: pass_fds 引数が追加されました。
If cwd is not
None
, the function changes the working directory to cwd before executing the child. cwd can be a string, bytes or path-like object. In particular, the function looks for executable (or for the first item in args) relative to cwd if the executable path is a relative path.バージョン 3.6 で変更: cwd 引数が POSIX で path-like object を受け付けるようになりました。
バージョン 3.7 で変更: cwd 引数が Windows で path-like object を受け付けるようになりました。
バージョン 3.8 で変更: cwd 引数が Windows で bytes オブジェクトを受け付けるようになりました。
restore_signals が真の場合 (デフォルト)、Python が SIG_IGN に設定したすべてのシグナルは子プロセスが exec される前に子プロセスの SIG_DFL に格納されます。現在これには SIGPIPE, SIGXFZ および SIGXFSZ シグナルが含まれています。(POSIX のみ)
バージョン 3.2 で変更: restore_signals が追加されました。
start_new_session が真の場合、サブプロセスの実行前に子プロセス内で setsid() システムコールが作成されます。(POSIX のみ)
バージョン 3.2 で変更: start_new_session が追加されました。
env が
None
以外の場合、これは新しいプロセスでの環境変数を定義します。デフォルトでは、子プロセスは現在のプロセスの環境変数を引き継ぎます。注釈
env を指定する場合、プログラムを実行するのに必要な変数すべてを与えなければなりません。Windows で Side-by-Side アセンブリ を実行するためには、env は正しい
SystemRoot
を 含まなければなりません 。If encoding or errors are specified, or text is true, the file objects stdin, stdout and stderr are opened in text mode with the specified encoding and errors, as described above in よく使われる引数. The universal_newlines argument is equivalent to text and is provided for backwards compatibility. By default, file objects are opened in binary mode.
バージョン 3.6 で追加: encoding と errors が追加されました。
バージョン 3.7 で追加: text が、universal_newlines のより読みやすい別名として追加されました。
startupinfo は、基底の
CreateProcess
関数に渡されるSTARTUPINFO
オブジェクトになります。creationflags は、与えられるなら、以下のフラグのうち一つ以上にできます:Popen オブジェクトは
with
文によってコンテキストマネージャーとしてサポートされます: 終了時には標準ファイル記述子が閉じられ、プロセスを待機します:with Popen(["ifconfig"], stdout=PIPE) as proc: log.write(proc.stdout.read())
引数
executable
,args
,cwd
,env
を指定して 監査イベントsubprocess.Popen
を送出します。バージョン 3.2 で変更: コンテキストマネージャーサポートが追加されました。
バージョン 3.6 で変更: Popen destructor now emits a
ResourceWarning
warning if the child process is still running.バージョン 3.8 で変更: Popen can use
os.posix_spawn()
in some cases for better performance. On Windows Subsystem for Linux and QEMU User Emulation, Popen constructor usingos.posix_spawn()
no longer raise an exception on errors like missing program, but the child process fails with a non-zeroreturncode
.
例外¶
Exceptions raised in the child process, before the new program has started to execute, will be re-raised in the parent.
もっとも一般的に起こる例外は OSError
です。これは、たとえば存在しないファイルを実行しようとしたときなどに発生します。アプリケーションは OSError
例外に備えておかなければなりません。
不正な引数で Popen
が呼ばれた場合は ValueError
が発生します。
呼び出されたプロセスが非ゼロのリターンコードを返した場合 check_call()
や check_output()
は CalledProcessError
を送出します。
call()
や Popen.communicate()
のような timeout 引数を受け取るすべての関数とメソッドは、プロセスが終了する前にタイムアウトが発生した場合に TimeoutExpired
を送出します。
このモジュールで定義されたすべての例外は SubprocessError
を継承しています。
バージョン 3.3 で追加:
SubprocessError
基底クラスが追加されました。
セキュリティで考慮すべき点¶
Unlike some other popen functions, this library will not
implicitly choose to call a system shell. This means that all characters,
including shell metacharacters, can safely be passed to child processes.
If the shell is invoked explicitly, via shell=True
, it is the application's
responsibility to ensure that all whitespace and metacharacters are
quoted appropriately to avoid
shell injection
vulnerabilities.
shell=True
を使用するときは、シェルコマンドで使用される文字列の空白やメタ文字は shlex.quote()
関数を使うと正しくエスケープできます。
On Windows, batch files (*.bat
or *.cmd
) may be launched by the
operating system in a system shell regardless of the arguments passed to this
library. This could result in arguments being parsed according to shell rules,
but without any escaping added by Python. If you are intentionally launching a
batch file with arguments from untrusted sources, consider passing
shell=True
to allow Python to escape special characters. See gh-114539
for additional discussion.
Popen オブジェクト¶
Popen
クラスのインスタンスには、以下のようなメソッドがあります:
-
Popen.
poll
()¶ 子プロセスが終了しているかどうかを調べます。
returncode
属性を設定して返します。そうでなければNone
を返します。
-
Popen.
wait
(timeout=None)¶ 子プロセスが終了するまで待ちます。
returncode
属性を設定して返します。プロセスが timeout 秒後に終了してない場合、
TimeoutExpired
例外を送出します。この例外を捕捉して wait を再試行するのは安全です。注釈
stdout=PIPE
やstderr=PIPE
を使っていて、より多くのデータを受け入れるために OS のパイプバッファーをブロックしているパイプに子プロセスが十分な出力を生成した場合、デッドロックが発生します。これを避けるにはPopen.communicate()
を使用してください。注釈
この関数はビジーループ (非ブロック化呼び出しと短いスリープ) を使用して実装されています。非同期の待機には
asyncio
モジュールを使用してください (asyncio.create_subprocess_exec
を参照)。バージョン 3.3 で変更: timeout が追加されました
-
Popen.
communicate
(input=None, timeout=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 and set the
returncode
attribute. The optional input argument should be data to be sent to the child process, orNone
, if no data should be sent to the child. If streams were opened in text mode, input must be a string. Otherwise, it must be bytes.communicate()
returns a tuple(stdout_data, stderr_data)
. The data will be strings if streams were opened in text mode; otherwise, bytes.子プロセスの標準入力にデータを送りたい場合は、 Popen オブジェクトを
stdin=PIPE
と指定して作成しなければなりません。同じく、戻り値のタプルからNone
ではない値を取得するためには、stdout=PIPE
かつ/またはstderr=PIPE
を指定しなければなりません。プロセスが timeout 秒後に終了してない場合、
TimeoutExpired
例外が送出されます。この例外を捕捉して通信を再試行しても出力データは失われません。タイムアウトが発生した場合子プロセスは kill されません。したがって、適切にクリーンアップを行うために、正常に動作するアプリケーションは子プロセスを kill して通信を終了すべきです:
proc = subprocess.Popen(...) try: outs, errs = proc.communicate(timeout=15) except TimeoutExpired: proc.kill() outs, errs = proc.communicate()
注釈
受信したデータはメモリにバッファーされます。そのため、返されるデータが大きいかあるいは制限がないような場合はこのメソッドを使うべきではありません。
バージョン 3.3 で変更: timeout が追加されました
-
Popen.
send_signal
(signal)¶ signal シグナルを子プロセスに送ります。
注釈
Windows では、SIGTERM は
terminate()
の別名です。CTRL_C_EVENT と CTRL_BREAK_EVENT を、CREATE_NEW_PROCESS_GROUP を含む creationflags で始まった、プロセスに送れます。
-
Popen.
terminate
()¶ 子プロセスを停止します。POSIX OS では、このメソッドは SIGTERM シグナルを子プロセスに送ります。Windows では、Win32 API の
TerminateProcess()
関数を利用して子プロセスを止めます。
-
Popen.
kill
()¶ 子プロセスを kill します。POSIX OS では SIGKILL シグナルを子プロセスに送ります。Windows では、
kill()
はterminate()
の別名です。
以下の属性も利用可能です:
-
Popen.
stdin
¶ If the stdin argument was
PIPE
, this attribute is a writeable stream object as returned byopen()
. If the encoding or errors arguments were specified or the universal_newlines argument wasTrue
, the stream is a text stream, otherwise it is a byte stream. If the stdin argument was notPIPE
, this attribute isNone
.
-
Popen.
stdout
¶ If the stdout argument was
PIPE
, this attribute is a readable stream object as returned byopen()
. Reading from the stream provides output from the child process. If the encoding or errors arguments were specified or the universal_newlines argument wasTrue
, the stream is a text stream, otherwise it is a byte stream. If the stdout argument was notPIPE
, this attribute isNone
.
-
Popen.
stderr
¶ If the stderr argument was
PIPE
, this attribute is a readable stream object as returned byopen()
. Reading from the stream provides error output from the child process. If the encoding or errors arguments were specified or the universal_newlines argument wasTrue
, the stream is a text stream, otherwise it is a byte stream. If the stderr argument was notPIPE
, this attribute isNone
.
警告
.stdin.write
, .stdout.read
, .stderr.read
を利用すると、別のパイプの OS パイプバッファーがいっぱいになってデッドロックが発生する恐れがあります。これを避けるためには communicate()
を利用してください。
-
Popen.
pid
¶ 子プロセスのプロセス ID が入ります。
shell 引数を
True
に設定した場合は、生成されたシェルのプロセス ID になります。
-
Popen.
returncode
¶ poll()
かwait()
(か、間接的にcommunicate()
) から設定された、子プロセスの終了ステータスが入ります。None
はまだその子プロセスが終了していないことを示します。負の値
-N
は子プロセスがシグナルN
により中止させられたことを示します (POSIX のみ)。
Windows Popen ヘルパー¶
STARTUPINFO
クラスと以下の定数は、Windows のみで利用できます。
-
class
subprocess.
STARTUPINFO
(*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)¶ Partial support of the Windows STARTUPINFO structure is used for
Popen
creation. The following attributes can be set by passing them as keyword-only arguments.バージョン 3.7 で変更: キーワード専用引数のサポートが追加されました。
-
dwFlags
¶ 特定の
STARTUPINFO
の属性が、プロセスがウィンドウを生成するときに使われるかを決定するビットフィールドです:si = subprocess.STARTUPINFO() si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW
-
hStdInput
¶ dwFlags
がSTARTF_USESTDHANDLES
を指定すれば、この属性がプロセスの標準入力処理です。STARTF_USESTDHANDLES
が指定されなければ、標準入力のデフォルトはキーボードバッファーです。
-
hStdOutput
¶ dwFlags
がSTARTF_USESTDHANDLES
を指定すれば、この属性がプロセスの標準出力処理です。そうでなければ、この属性は無視され、標準出力のデフォルトはコンソールウィンドウのバッファーです。
-
hStdError
¶ dwFlags
がSTARTF_USESTDHANDLES
を指定すれば、この属性がプロセスの標準エラー処理です。そうでなければ、この属性は無視され、標準エラー出力のデフォルトはコンソールウィンドウのバッファーです。
-
wShowWindow
¶ dwFlags
がSTARTF_USESHOWWINDOW
を指定すれば、この属性は ShowWindow 関数のnCmdShow
引数で指定された値なら、SW_SHOWDEFAULT
以外の任意のものにできます。しかし、この属性は無視されます。この属性には
SW_HIDE
が提供されています。これは、Popen
がshell=True
として呼び出されたときに使われます。
-
lpAttributeList
¶ A dictionary of additional attributes for process creation as given in
STARTUPINFOEX
, see UpdateProcThreadAttribute.Supported attributes:
- handle_list
Sequence of handles that will be inherited. close_fds must be true if non-empty.
The handles must be temporarily made inheritable by
os.set_handle_inheritable()
when passed to thePopen
constructor, elseOSError
will be raised with Windows errorERROR_INVALID_PARAMETER
(87).警告
In a multithreaded process, use caution to avoid leaking handles that are marked inheritable when combining this feature with concurrent calls to other process creation functions that inherit all handles such as
os.system()
. This also applies to standard handle redirection, which temporarily creates inheritable handles.
バージョン 3.7 で追加.
-
Windows Constants¶
subprocess
モジュールは、以下の定数を公開しています。
-
subprocess.
STD_INPUT_HANDLE
¶ 標準入力デバイスです。この初期値は、コンソール入力バッファ、
CONIN$
です。
-
subprocess.
STD_OUTPUT_HANDLE
¶ 標準出力デバイスです。この初期値は、アクティブコンソールスクリーン、
CONOUT$
です。
-
subprocess.
STD_ERROR_HANDLE
¶ 標準エラーデバイスです。この初期値は、アクティブコンソールスクリーン、
CONOUT$
です。
-
subprocess.
SW_HIDE
¶ ウィンドウを隠します。別のウィンドウがアクティブになります。
-
subprocess.
STARTF_USESTDHANDLES
¶ 追加情報を保持する、
STARTUPINFO.hStdInput
,STARTUPINFO.hStdOutput
, およびSTARTUPINFO.hStdError
属性を指定します。
-
subprocess.
STARTF_USESHOWWINDOW
¶ 追加情報を保持する、
STARTUPINFO.wShowWindow
属性を指定します。
-
subprocess.
CREATE_NEW_CONSOLE
¶ 新しいプロセスが、親プロセスのコンソールを継承する (デフォルト) のではなく、新しいコンソールを持ちます。
-
subprocess.
CREATE_NEW_PROCESS_GROUP
¶ 新しいプロセスグループが生成されることを指定する
Popen
creationflags
パラメーターです。このフラグは、サブプロセスでos.kill()
を使うのに必要です。CREATE_NEW_CONSOLE
が指定されていたら、このフラグは無視されます。
-
subprocess.
ABOVE_NORMAL_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have an above average priority.バージョン 3.7 で追加.
-
subprocess.
BELOW_NORMAL_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have a below average priority.バージョン 3.7 で追加.
-
subprocess.
HIGH_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have a high priority.バージョン 3.7 で追加.
-
subprocess.
IDLE_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have an idle (lowest) priority.バージョン 3.7 で追加.
-
subprocess.
NORMAL_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have an normal priority. (default)バージョン 3.7 で追加.
-
subprocess.
REALTIME_PRIORITY_CLASS
¶ A
Popen
creationflags
parameter to specify that a new process will have realtime priority. You should almost never use REALTIME_PRIORITY_CLASS, because this interrupts system threads that manage mouse input, keyboard input, and background disk flushing. This class can be appropriate for applications that "talk" directly to hardware or that perform brief tasks that should have limited interruptions.バージョン 3.7 で追加.
-
subprocess.
CREATE_NO_WINDOW
¶ A
Popen
creationflags
parameter to specify that a new process will not create a window.バージョン 3.7 で追加.
-
subprocess.
DETACHED_PROCESS
¶ A
Popen
creationflags
parameter to specify that a new process will not inherit its parent's console. This value cannot be used with CREATE_NEW_CONSOLE.バージョン 3.7 で追加.
-
subprocess.
CREATE_DEFAULT_ERROR_MODE
¶ A
Popen
creationflags
parameter to specify that a new process does not inherit the error mode of the calling process. Instead, the new process gets the default error mode. This feature is particularly useful for multithreaded shell applications that run with hard errors disabled.バージョン 3.7 で追加.
古い高水準 API¶
Python 3.5 より前のバージョンでは、サブプロセスに対して以下の 3 つの関数からなる高水準 API が用意されていました。現在多くの場合 run()
の使用で済みますが、既存の多くのコードではこれらの関数が使用されています。
-
subprocess.
call
(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)¶ args で指定されたコマンドを実行します。コマンドの終了を待ち、
returncode
属性を返します。Code needing to capture stdout or stderr should use
run()
instead:run(...).returncode
To suppress stdout or stderr, supply a value of
DEVNULL
.上記の引数は、よく使われるものだけ示しています。関数の全使用法は
Popen
コンストラクターの内容と同じになります - この関数は、このインターフェースに直接指定される timeout 以外は与えられた全引数を渡します。注釈
この関数を使用する際は
stdout=PIPE
およびstderr=PIPE
を使用しないでください。子プロセスが OS のパイプバッファーを埋めてしまうほどの出力データを生成した場合、パイプからは読み込まれないので、子プロセスがブロックされることがあります。バージョン 3.3 で変更: timeout が追加されました
バージョン 3.8.17 で変更: Changed Windows shell search order for
shell=True
. The current directory and%PATH%
are replaced with%COMSPEC%
and%SystemRoot%\System32\cmd.exe
. As a result, dropping a malicious program namedcmd.exe
into a current directory no longer works.
-
subprocess.
check_call
(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)¶ 指定された引数でコマンドを実行し、完了を待ちます。コマンドのリターンコードがゼロならば返りますが、非ゼロなら
CalledProcessError
例外が送出されます。CalledProcessError
オブジェクトにはリターンコードがreturncode
属性として格納されています。Code needing to capture stdout or stderr should use
run()
instead:run(..., check=True)
To suppress stdout or stderr, supply a value of
DEVNULL
.上記の引数は、よく使われるものだけ示しています。関数の全使用法は
Popen
コンストラクターの内容と同じになります - この関数は、このインターフェースに直接指定される timeout 以外は与えられた全引数を渡します。注釈
この関数を使用する際は
stdout=PIPE
およびstderr=PIPE
を使用しないでください。子プロセスが OS のパイプバッファーを埋めてしまうほどの出力データを生成した場合、パイプからは読み込まれないので、子プロセスがブロックされることがあります。バージョン 3.3 で変更: timeout が追加されました
バージョン 3.8.17 で変更: Changed Windows shell search order for
shell=True
. The current directory and%PATH%
are replaced with%COMSPEC%
and%SystemRoot%\System32\cmd.exe
. As a result, dropping a malicious program namedcmd.exe
into a current directory no longer works.
-
subprocess.
check_output
(args, *, stdin=None, stderr=None, shell=False, cwd=None, encoding=None, errors=None, universal_newlines=None, timeout=None, text=None, **other_popen_kwargs)¶ 引数でコマンドを実行し、その出力を返します。
コマンドのリターンコードが非ゼロならば
CalledProcessError
例外が送出されます。CalledProcessError
オブジェクトには、リターンコードがreturncode
属性に、コマンドからの出力がoutput
属性に、それぞれ格納されています。これは次と等価です:
run(..., check=True, stdout=PIPE).stdout
The arguments shown above are merely some common ones. The full function signature is largely the same as that of
run()
- most arguments are passed directly through to that interface. One API deviation fromrun()
behavior exists: passinginput=None
will behave the same asinput=b''
(orinput=''
, depending on other arguments) rather than using the parent's standard input file handle.デフォルトで、この関数はデータをエンコードされたバイトとして返します。出力されたデータの実際のエンコードは起動されているコマンドに依存するため、テキストへのデコードは通常アプリケーションレベルで扱う必要があります。
This behaviour may be overridden by setting text, encoding, errors, or universal_newlines to
True
as described in よく使われる引数 andrun()
.標準エラー出力も結果に含めるには、
stderr=subprocess.STDOUT
を使います:>>> subprocess.check_output( ... "ls non_existent_file; exit 0", ... stderr=subprocess.STDOUT, ... shell=True) 'ls: non_existent_file: No such file or directory\n'
バージョン 3.1 で追加.
バージョン 3.3 で変更: timeout が追加されました
バージョン 3.4 で変更: キーワード引数 input が追加されました。
バージョン 3.6 で変更: encoding and errors were added. See
run()
for details.バージョン 3.7 で追加: text が、universal_newlines のより読みやすい別名として追加されました。
バージョン 3.8.17 で変更: Changed Windows shell search order for
shell=True
. The current directory and%PATH%
are replaced with%COMSPEC%
and%SystemRoot%\System32\cmd.exe
. As a result, dropping a malicious program namedcmd.exe
into a current directory no longer works.
古い関数を subprocess
モジュールで置き換える¶
この節では、 "a becomes b" と書かれているものは a の代替として b が使えるということを表します。
注釈
この節で紹介されている "a" 関数は全て、実行するプログラムが見つからないときは (おおむね) 静かに終了します。それに対して "b" 代替手段は OSError
例外を送出します。
また、要求された操作が非ゼロの終了コードを返した場合、check_output()
を使用した置き換えは CalledProcessError
で失敗します。その出力は、送出された例外の output
属性として利用可能です。
以下の例では、適切な関数が subprocess
モジュールからすでにインポートされていることを前提としています。
Replacing /bin/sh shell command substitution¶
output=$(mycmd myarg)
これは以下のようになります:
output = check_output(["mycmd", "myarg"])
シェルのパイプラインを置き換える¶
output=$(dmesg | grep hda)
これは以下のようになります:
p1 = Popen(["dmesg"], stdout=PIPE)
p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
p1.stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits.
output = p2.communicate()[0]
p2 を開始した後の p1.stdout.close()
の呼び出しは、p1 が p2 の前に存在した場合に、p1 が SIGPIPE を受け取るために重要です。
あるいは、信頼された入力に対しては、シェル自身のパイプラインサポートを直接使用することもできます:
output=$(dmesg | grep hda)
これは以下のようになります:
output=check_output("dmesg | grep hda", shell=True)
os.system()
を置き換える¶
sts = os.system("mycmd" + " myarg")
# becomes
sts = call("mycmd" + " myarg", shell=True)
注釈:
このプログラムは普通シェル経由で呼び出す必要はありません。
より現実的な例ではこうなるでしょう:
try:
retcode = call("mycmd" + " myarg", shell=True)
if retcode < 0:
print("Child was terminated by signal", -retcode, file=sys.stderr)
else:
print("Child returned", retcode, file=sys.stderr)
except OSError as e:
print("Execution failed:", e, file=sys.stderr)
os.spawn
関数群を置き換える¶
P_NOWAIT の例:
pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
==>
pid = Popen(["/bin/mycmd", "myarg"]).pid
P_WAIT の例:
retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
==>
retcode = call(["/bin/mycmd", "myarg"])
シーケンスを使った例:
os.spawnvp(os.P_NOWAIT, path, args)
==>
Popen([path] + args[1:])
環境変数を使った例:
os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
==>
Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})
os.popen()
, os.popen2()
, os.popen3()
を置き換える¶
(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)
終了コードハンドリングは以下のように解釈します:
pipe = os.popen(cmd, 'w')
...
rc = pipe.close()
if rc is not None and rc >> 8:
print("There were some errors")
==>
process = Popen(cmd, stdin=PIPE)
...
process.stdin.close()
if process.wait() != 0:
print("There were some errors")
popen2
モジュールの関数群を置き換える¶
注釈
popen2 関数の cmd 引数が文字列の場合、コマンドは /bin/sh によって実行されます。リストの場合、コマンドは直接実行されます。
(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)
popen2.Popen3
および popen2.Popen4
は以下の点を除けば、基本的に subprocess.Popen
と同じです:
レガシーなシェル呼び出し関数¶
このモジュールでは、以下のような 2.x commands
モジュールからのレガシー関数も提供しています。これらの操作は、暗黙的にシステムシェルを起動します。また、セキュリティに関して上述した保証や例外処理一貫性は、これらの関数では有効ではありません。
-
subprocess.
getstatusoutput
(cmd)¶ シェル中の cmd を実行して
(exitcode, output)
を返します。Execute the string cmd in a shell with
Popen.check_output()
and return a 2-tuple(exitcode, output)
. The locale encoding is used; see the notes on よく使われる引数 for more details.A trailing newline is stripped from the output. The exit code for the command can be interpreted as the return code of subprocess. Example:
>>> subprocess.getstatusoutput('ls /bin/ls') (0, '/bin/ls') >>> subprocess.getstatusoutput('cat /bin/junk') (1, 'cat: /bin/junk: No such file or directory') >>> subprocess.getstatusoutput('/bin/junk') (127, 'sh: /bin/junk: not found') >>> subprocess.getstatusoutput('/bin/kill $$') (-15, '')
利用可能な環境: POSIX と Windows。
バージョン 3.3.4 で変更: Windows のサポートが追加されました。
The function now returns (exitcode, output) instead of (status, output) as it did in Python 3.3.3 and earlier. exitcode has the same value as
returncode
.
-
subprocess.
getoutput
(cmd)¶ シェル中の cmd を実行して出力 (stdout と stderr) を返します。
getstatusoutput()
に似ていますが、終了コードは無視され、コマンドの出力のみを返します。例えば:>>> subprocess.getoutput('ls /bin/ls') '/bin/ls'
利用可能な環境: POSIX と Windows。
バージョン 3.3.4 で変更: Windowsで利用可能になりました
注釈¶
Windows における引数シーケンスから文字列への変換¶
Windows では、 args シーケンスは以下の (MS C ランタイムで使われる規則に対応する) 規則を使って解析できる文字列に変換されます:
引数は、スペースかタブのどちらかの空白で分けられます。
ダブルクオーテーションマークで囲まれた文字列は、空白が含まれていたとしても 1 つの引数として解釈されます。クオートされた文字列は引数に埋め込めます。
バックスラッシュに続くダブルクオーテーションマークは、リテラルのダブルクオーテーションマークと解釈されます。
バックスラッシュは、ダブルクオーテーションが続かない限り、リテラルとして解釈されます。
複数のバックスラッシュにダブルクオーテーションマークが続くなら、バックスラッシュ 2 つで 1 つのバックスラッシュ文字と解釈されます。バックスラッシュの数が奇数なら、最後のバックスラッシュは規則 3 に従って続くダブルクオーテーションマークをエスケープします。
参考
shlex
コマンドラインを解析したりエスケープしたりする関数を提供するモジュール。