Pythonモジュールsubprocessの詳細

2年 ago

結衣, 春花

1 minute

Pythonのsubprocessモジュールは、子プロセスを生成するためのモジュールであり、Pythonスクリプト内でシステムコマンドや他の実行可能プログラムを呼び出すことを可能にします。subprocessモジュールは、より高度な方法で子プロセスを作成、管理、および相互作用させるための手段を提供しており、例えば子プロセスの出力、入力、およびエラー情報を取得することができます。

subprocessモジュールで最も重要なクラスはPopenクラスです。このクラスは、子プロセスを作成し、その子プロセスと対話するために使用されます。一般的なメソッドや属性には、以下が含まれています：

サブプロセスを開始し、argsを引数として渡す。バッファーサイズは0で、実行可能ファイルは指定しない。標準入力、標準出力、標準エラー出力は指定せず、事前実行関数も指定しない。ファイルディスクリプタをクローズし、シェルを使用しない。作業ディレクトリや環境変数も指定せず、ユニバーサル改行コードは無効。プロセスの開始情報や作成フラグもデフォルトで設定。
指定されたargsパラメータ（文字列でもよい）を実行し、Popenオブジェクトを返すメソッドです。argsパラメータは文字列、リスト、またはタプルで指定できます。文字列の場合は実行するコマンドを表し、リストやタプルの場合はコマンドとその引数を表します。
bufsizeパラメータは、子プロセスの標準I/Oバッファサイズを指定するために使用され、デフォルトは0であり、システムのデフォルトバッファを使用することを意味します。executableパラメータは、実行する実行可能ファイルを指定するために使用され、デフォルトはNoneであり、argsの最初のパラメータを実行可能ファイルとして使用することを意味します。
stdin、stdout、stderrパラメータは、子プロセスの標準入力、標準出力、標準エラー出力のファイルディスクリプタを指定するために使用されます。デフォルトでは、それらはNoneであり、親プロセスの標準入力、標準出力、標準エラー出力を使用することを意味します。
preexec_fnパラメータは、子プロセスが実行される前に呼び出される実行可能オブジェクトを指定するものであり、デフォルトではNoneです。close_fdsパラメータは、親プロセス内のすべてのファイルディスクリプタを子プロセスが実行される前に閉じるかどうかを指定するものであり、デフォルトではTrueです。
shellパラメータは、コマンドをシェルで実行するかどうかを指定するもので、デフォルトはFalseです。cwdパラメータは、サブプロセスの現在の作業ディレクトリを指定するもので、デフォルトはNoneです。envパラメータは、サブプロセスの環境変数を指定するもので、デフォルトはNoneであり、親プロセスの環境変数を使用することを示します。
universal_newlinesパラメータは、子プロセスの標準入出力をテキストモードでやり取りするかどうかを指定するためのものであり、デフォルトではFalseとなっています。startupinfoおよびcreationflagsパラメータは、一部の起動情報とマークを子プロセスに指定するために使用されますが、通常は設定する必要はありません。
Popen.stdout を出力
この属性は、子プロセスの標準出力を表し、ファイルオブジェクトです。read、readline、readlinesなどのメソッドを使って子プロセスの出力を読み取ることができます。
Popenの標準エラー出力
この属性は、子プロセスの標準エラー出力を表し、ファイルオブジェクトです。read、readline、readlinesなどのメソッドを使用して、子プロセスのエラー出力を読み取ることができます。
Popen.stdin → subprocess.Popenのstdin
この属性は子プロセスの標準入力を示し、ファイルオブジェクトです。writeやwritelinesなどのメソッドを使用して、子プロセスの標準入力にデータを書き込むことができます。
Popen.wait() を使います。
この方法は、子プロセスの終了を待ち、子プロセスの終了ステータスコードを返すために使用されます。
Popenを終了する()
この方法は、子プロセスを終了させるために使用されます。

上記の方法と属性以外にも、subprocessモジュールには、子プロセスとのやり取りをより便利にするためのcall、check_call、check_outputなどの他のいくつかのメソッドや関数が用意されています。これらのメソッドや関数は、指定されたコマンドを実行し、子プロセスの出力や終了ステータスを返すなど、類似した役割を果たします。

subprocessモジュールを使用する際には、shell=Trueパラメータの使用を避けるように配慮すべきです。なぜなら、shellパラメータを使用するとセキュリティ上の問題が発生する可能性があるからです。複雑なコマンドを実行する場合は、コマンドと引数を分けて、リストまたはタプルの形でPopenクラスのargsパラメータに渡すことが推奨されます。