Pythonのpipesモジュールでシェルパイプラインを操作する方法

PythonからUNIXのコマンドパイプライン機構を利用する方法を解説します。コマンドパイプラインとは、複数のコマンドを連結し、あるファイルから別のファイルへとデータを変換しながら処理していく仕組みです。

このモジュールは内部で /bin/sh のコマンドラインを使用するため、os.system() や os.popen() といったメソッドと組み合わせて動作します。

注意： pipes モジュールはPython 3.11で非推奨となり、Python 3.13で削除されました。古いバージョンのPythonで動作させる場合にのみ使用できます。最新の環境では subprocess モジュールの利用が推奨されます。

このモジュールを利用するには、まず次のようにインポートします。

import pipes

pipes.Templateクラスとは

pipes モジュールには Template クラスが用意されています。このクラスは、パイプラインを抽象化したものであり、以下に示すさまざまなメソッドを持っています。

Template.reset()メソッド

パイプラインテンプレートを初期状態に戻すためのメソッドです。

Template.clone()メソッド

現在のテンプレートと同じ内容を持つ、新しいテンプレートオブジェクトを作成するためのメソッドです。

Template.debug(flag)メソッド

デバッグを行うためのメソッドです。flag に True を指定するとデバッグモードが有効になり、実行中のコマンドが順次出力されるようになります。

Template.append(command, kind)メソッド

パイプラインの末尾に新しいタスク（コマンド）を追加するためのメソッドです。command にはBourneシェルのコマンドを指定し、kind は2文字の文字列で構成されます。

1文字目の意味：

2文字目の意味：

Template.prepend(command, kind)メソッド

パイプラインの先頭に新しいタスクを挿入するためのメソッドです。引数の指定方法は append() メソッドと同様です。

Template.open(file, mode)メソッド

ファイルを読み込みまたは書き込み用に開くためのメソッドです。実際の読み書き処理は、構築されたパイプラインを通じて行われます。

Template.copy(infile, outfile)メソッド

パイプラインを通じて、infile から outfile へデータをコピーするためのメソッドです。

サンプルコード

以下は、pipes.Template を使ってパイプラインを構築し、ファイルへ結果を書き出す例です。

import pipes

my_template = pipes.Template()
my_template.append('tr a-z A-Z', '--')
my_template.prepend('echo Python Programming', '--')  # 先頭にコマンドを追加
my_template.append('rev', '--')
my_template.debug(True)

my_file = my_template.open('test_file', 'w')
my_file.close()

content = open('test_file').read()
print(content)

実行結果

$ python3 example.py
echo Python Programming |
tr a-z A-Z |
rev >test_file
+ rev
+ tr a-z A-Z
+ echo Python Programming
GNIMMARGORP NOHTYP

この例では、「echo」で出力した文字列を tr コマンドで大文字に変換し、さらに rev コマンドで逆順に並べ替えています。最終的に「GNIMMARGORP NOHTYP」という結果がファイルに書き込まれました。デバッグモードが有効になっているため、実行された各コマンドもコンソールに出力されていることが確認できます。