Pythonを使用したtarアーカイブファイルの読み取りと書き込み（tarfile）

「tar」ユーティリティは、もともとUNIXオペレーティングシステム用に導入されました。その目的は、ファイルの配布を容易にするtarballと呼ばれることが多い単一のアーカイブファイルに複数のファイルを収集することです。 Pythonの標準ライブラリのtarfileモジュールの関数は、tarアーカイブの作成と、必要に応じてtarballからの抽出に役立ちます。アーカイブは、gzip、bz2、およびlzma圧縮を使用して、または圧縮なしで構築できます。

このモジュールで定義されている主な関数はmain（）であり、これを使用してtarファイルへの書き込みまたはtarファイルからの読み取りを実行します。

Open（）

この関数は、パラメーターとして提供されたファイル名に対応するTarFileオブジェクトを返します。この関数には、modeと呼ばれる別のパラメーターが必要です。これは、デフォルトでは「r」であり、圧縮されていないことを示します。その他のモードは以下のとおりです

モジュールはTarFileクラスを定義します。 open（）関数の代わりに、コンストラクターを呼び出すことでTarFileオブジェクトをインスタンス化できます。

TarFile（）

このコンストラクターには、ファイル名とモードパラメーターも必要です。モードパラメータの可能な値は上記のとおりです。

このクラスの他のメソッドは次のとおりです

add（）

このメソッドは、ファイルをアーカイブに追加します。このメソッドには、ファイル、ディレクトリ、シンボリックリンク、ショートカットなどの名前を付ける必要があります。デフォルトでは、ディレクトリは再帰的に追加されます。再帰的な追加を防ぐには、再帰的なパラメータをFalseに設定します。

addfile（）

このメソッドは、TarInfoオブジェクトをアーカイブに追加します。

extractall（）

このメソッドは、他のパスが明示的に指定されていない場合、アーカイブのすべてのメンバーを現在のパスに抽出します。

extract（）

このメソッドは、指定されたメンバーを指定されたパスに抽出します。デフォルトは現在のパスです。

次の例では、gzipアルゴリズムを使用して圧縮するtarファイルを開き、ファイルを追加します。

>>> fp = tarfile.open("zen.tar.gz","w:gz")
>>> fp.add("zen.txt")
>>> fp.close()

「zen.txt」ファイルが現在の作業ディレクトリに存在すると仮定すると、「zen.tar.gz」ファイルに追加されます。

次のコードは、tarアーカイブからファイルを抽出し、すべてのファイル（この場合はonのみ）を抽出して、現在のフォルダーに配置します。結果を確認するには、現在のフォルダの「zen.txt」を削除するか、名前を変更します。

>>> fp = tarfile.open("zen.tar.gz","r:gz")
>>> fp.extractall()
>>> fp.close()

「zen.txt」ファイルが現在のディレクトリに表示されます。

現在のディレクトリ内のすべてのファイルで構成されるtarを作成するには、次のコードを使用します

import tarfile, glob
>>> fp=tarfile.open('file.tar','w')
>>> for file in glob.glob('*.*'):
fp.add(file)
>>> fp.close()

コマンドラインインターフェイス

tarファイルの作成と抽出は、コマンドラインインターフェイスを介して実行できます。たとえば、「lines.txt」ファイルは、コマンドウィンドウで実行された次のコマンドによってtarファイルに追加されます

C:\python36 >python -m tarfile -c line.tar lines.txt

次のコマンドラインオプションを使用できます。

次のコマンドラインは、現在のディレクトリの下のnewdirフォルダにline.tarを抽出します。

C:\python36>python -m tarfile -e line.tar newdir/

次のコマンドラインは、tarアーカイブ内のすべてのファイルを一覧表示します。

C:\python36>python -m tarfile -l files.tar

tarfileモジュールに関するこの記事では、tarfileモジュールで定義されているクラスと関数について説明しました。