Python 標準ライブラリのtarfileモジュールは、tar 形式のアーカイブファイルを Python コードから操作するための便利なツールです。このモジュールを使用すると、tar アーカイブの作成、展開、内容確認など、tar コマンドを使用せずに実行できます。また、gzip（.tar.gz）、bz2（.tar.bz2）、lzma（.tar.xz）形式にも対応しています。本記事では、tarfileモジュールの基本的な使い方から応用的な活用方法までを解説します。
1. 概要
tarfileモジュールは、tar 形式のアーカイブを Python コードで扱うためのツールです。このモジュールを利用することで、以下の操作が可能になります：
- tar アーカイブの作成
- tar アーカイブ内の内容の確認
- tar アーカイブの展開
- tar アーカイブ内の特定のファイルの抽出
gzip や bz2 形式で圧縮された tar アーカイブにも対応しており、幅広い場面で利用できます。
2. tar アーカイブを操作する
2.1 tar アーカイブを開く
tar アーカイブを操作するには、tarfile.open()関数を使用します。この関数は以下の引数を受け取ります：
name：操作対象のファイル名mode：操作モード（例：'r'で読み取り、'w'で書き込み）- 圧縮形式（例：
'gz'、'bz2'、'xz'）
使用例
import tarfile
# tarアーカイブを読み取りモードで開く
tar = tarfile.open('example.tar.gz', mode='r:gz')
# アーカイブ内のファイル名一覧を取得
print(tar.getnames())
# tarアーカイブを閉じる
tar.close()2.2 tar アーカイブの中身を確認する
getnames()メソッドを使用してアーカイブ内のファイル一覧を取得できます。
使用例
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
# ファイル名一覧を表示
for name in tar.getnames():
print(name)3. tar アーカイブを作成する
tarfileモジュールを使用すると、既存のファイルをまとめて新しい tar アーカイブを作成できます。
3.1 tar アーカイブを新規作成
tarfile.open()関数でモードを'w'（新規作成）または'w:gz'（gzip 形式で新規作成）に指定します。
使用例
import tarfile
# tarアーカイブを作成
with tarfile.open('example.tar.gz', mode='w:gz') as tar:
tar.add('file1.txt') # ファイルを追加
tar.add('file2.txt', arcname='renamed_file2.txt') # ファイル名を変更して追加
# 作成したアーカイブの確認
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
print(tar.getnames())4. tar アーカイブを展開する
tarfileモジュールを使用すると、tar アーカイブを簡単に展開できます。
4.1 すべてのファイルを展開
extractall()メソッドを使用してアーカイブ内のすべてのファイルを展開します。
使用例
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
tar.extractall(path='output_dir') # 指定したディレクトリに展開4.2 特定のファイルを展開
特定のファイルのみを展開する場合は、extract()またはextractfile()を使用します。
使用例
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
tar.extract('file1.txt', path='output_dir') # file1.txtのみを展開
# ファイルの中身を直接読み込む
with tar.extractfile('file1.txt') as f:
content = f.read()
print(content.decode('utf-8'))5. よくあるエラーと対処法
5.1 非 tar 形式ファイルを開こうとした場合
非 tar 形式のファイルをtarfile.open()で開こうとすると、ReadErrorが発生します。
対策
事前にtarfile.is_tarfile()でファイル形式を確認します。
使用例
if tarfile.is_tarfile('example.tar.gz'):
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
print(tar.getnames())
else:
print('指定されたファイルはtar形式ではありません。')5.2 閉じた tar ファイルへのアクセス
閉じた TarFile オブジェクトを操作しようとすると、OSErrorが発生します。
対策
with文を使用して、自動的にリソースを解放するようにします。
6. 実用例
6.1 大量のファイルをアーカイブして圧縮
大量のログファイルなどをアーカイブして gzip 形式で圧縮する例です。
import tarfile
import os
# 複数のログファイルをアーカイブ
with tarfile.open('logs_archive.tar.gz', mode='w:gz') as tar:
for log_file in os.listdir('logs'):
tar.add(os.path.join('logs', log_file))6.2 展開先ディレクトリに特定の条件を適用
アーカイブ内のファイルを展開し、特定のファイルのみ処理する例です。
with tarfile.open('example.tar.gz', mode='r:gz') as tar:
for member in tar.getmembers():
if member.name.endswith('.txt'):
tar.extract(member, path='output_dir')7. 結論
tarfileモジュールを使用すると、Python コード内で tar 形式のアーカイブを簡単かつ効率的に操作できます。特に gzip や bz2 形式との互換性を持つ点が強力で、ログファイルのバックアップやデータ転送など、さまざまな用途に役立ちます。この記事を参考に、tarfileモジュールを活用してみてください。
