脱初心者！Python pathlibでスマートにファイル操作：基本を徹底マスター

Pythonでファイルやディレクトリを操作する際、より直感的でオブジェクト指向的なアプローチを提供してくれるのがpathlibモジュールです。従来のosモジュールに比べて、コードが格段に読みやすく、扱いやすくなるため、現代のPythonプログラミングでは必須の知識と言えるでしょう。

この記事では、pathlibの基本的な使い方から、ファイルやディレクトリの操作、そしてosモジュールとの比較まで、初心者の方にも分かりやすく解説します。

この記事を読むことで、あなたはpathlibを自在に操り、日々のファイル操作をよりスマートに行うことができるようになるでしょう。

なぜpathlibを使うべきなのか？
pathlibの基本：Pathオブジェクトの生成
Pathオブジェクトの主要な属性とメソッド
pathlibとosモジュールの比較
まとめ

なぜpathlibを使うべきなのか？

Pythonでファイルパスを扱う方法はいくつかありますが、なぜpathlibが推奨されるのでしょうか？その理由は主に以下の3点です。

オブジェクト指向: pathlibは、ファイルパスをPathオブジェクトとして扱います。これにより、メソッドチェーンを使って直感的に操作を行うことができます。
可読性の向上: 文字列結合や関数呼び出しを繰り返す従来のosモジュールに比べて、コードが格段に読みやすくなります。
プラットフォーム非依存: pathlibは、異なるオペレーティングシステム（Windows、macOS、Linuxなど）間でのパスの表現の違いを吸収してくれるため、プラットフォームに依存しないコードを書くことができます。

pathlibの基本：Pathオブジェクトの生成

pathlibを使うには、まずPathオブジェクトを生成する必要があります。基本的な生成方法を見ていきましょう。

現在のディレクトリのPathオブジェクトを取得

現在の作業ディレクトリを表すPathオブジェクトを取得するには、以下のように記述します。

Python

from pathlib import Path

current_dir = Path('.')
print(current_dir)

特定のパスのPathオブジェクトを生成

特定のファイルやディレクトリのパスを表すPathオブジェクトを生成するには、以下のようにパスを文字列として渡します。

Python

file_path = Path('./my_file.txt')
print(file_path)

dir_path = Path('/home/user/documents')
print(dir_path)

パスの結合

複数のパス要素を結合して新しいPathオブジェクトを作成するには、/演算子を使用します。これは、os.path.join()よりも直感的で分かりやすいです。

Python

parent_dir = Path('/home/user')
sub_dir = Path('images')
image_file = parent_dir / sub_dir / 'photo.jpg'
print(image_file)

Pathオブジェクトの主要な属性とメソッド

生成したPathオブジェクトは、様々な属性やメソッドを持っています。これらを活用することで、ファイルやディレクトリに関する様々な情報を取得したり、操作を実行したりすることができます。

基本的な属性

属性	説明
`name`	ファイル名（拡張子を含む）またはディレクトリ名を取得します。
`stem`	ファイル名（拡張子を含まない）を取得します。
`suffix`	ファイルの拡張子を取得します。
`suffixes`	ファイルに複数の拡張子がある場合、それらをリストとして取得します。
`parent`	親ディレクトリの`Path`オブジェクトを取得します。
`anchor`	パスのルート部分（例: `/` や `C:\`）を取得します。
`drive`	Windowsにおけるドライブ名を取得します。
`parts`	パスを構成する各要素をタプルとして取得します。
`absolute()`	Pathオブジェクトの絶対パスを表す新しいPathオブジェクトを返します。

ファイルとディレクトリの存在確認

ファイルやディレクトリが存在するかどうかを確認するには、以下のメソッドを使用します。

exists(): ファイルまたはディレクトリが存在する場合にTrueを返します。
is_file(): Pathオブジェクトがファイルを表しており、かつ存在する場合にTrueを返します。
is_dir(): Pathオブジェクトがディレクトリを表しており、かつ存在する場合にTrueを返します。

Python

file_path = Path('./my_file.txt')
if file_path.exists():
    print(f"{file_path} は存在します。")

if file_path.is_file():
    print(f"{file_path} はファイルです。")

ファイルの操作

Pathオブジェクトは、ファイルの作成、削除、リネームなどの操作も行うことができます。

touch(): ファイルが存在しない場合は新規作成し、存在する場合は最終更新日時を更新します。
unlink(): ファイルを削除します。
rename(target): ファイルまたはディレクトリの名前をtargetに変更します。

Python

new_file = Path('./new_file.txt')
new_file.touch()
print(f"{new_file} を作成しました。")

new_file.rename('./renamed_file.txt')
print(f"{new_file} を ./renamed_file.txt にリネームしました。")

renamed_file = Path('./renamed_file.txt')
renamed_file.unlink()
print(f"{renamed_file} を削除しました。")

ディレクトリの操作

ディレクトリの作成や削除も簡単に行えます。

mkdir(parents=False, exist_ok=False)
- 新しいディレクトリを作成します。parents=Trueを指定すると、親ディレクトリが存在しない場合にそれらも作成します。exist_ok=Trueを指定すると、ディレクトリが既に存在してもエラーを発生させません。
rmdir(): 空のディレクトリを削除します。

Python

new_dir = Path('./new_directory')
new_dir.mkdir()
print(f"{new_dir} を作成しました。")

new_dir.rmdir()
print(f"{new_dir} を削除しました。")

# 親ディレクトリも同時に作成する場合
nested_dir = Path('./parent/child')
nested_dir.mkdir(parents=True, exist_ok=True)
print(f"{nested_dir} を作成しました。")

# ディレクトリ内のファイルを一覧表示
parent_dir = Path('./parent')
for item in parent_dir.iterdir():
    print(item)

# 特定のパターンに合致するファイルを検索
for item in parent_dir.glob('*.txt'):
    print(item)

# ディレクトリを再帰的に検索
for item in parent_dir.rglob('*.py'):
    print(item)

ファイルの読み書き

Pathオブジェクトは、ファイルの内容を簡単に読み書きするためのメソッドも提供しています。

read_text(encoding=None): ファイルの内容を文字列として読み込みます。エンコーディングを指定できます。
read_bytes(): ファイルの内容をバイト列として読み込みます。
write_text(data, encoding=None, newline=None): 文字列データをファイルに書き込みます。エンコーディングや改行コードを指定できます。
write_bytes(data): バイト列データをファイルに書き込みます。

Python

file_to_write = Path('./my_data.txt')
file_to_write.write_text("Hello, pathlib!", encoding='utf-8')
print(f"{file_to_write} に書き込みました。")

content = file_to_write.read_text(encoding='utf-8')
print(f"{file_to_write} の内容は: {content}")

file_to_write.unlink()

pathlibとosモジュールの比較

従来のファイル操作でよく使われていたosモジュールとpathlibを比較してみましょう。

操作	`os`モジュール	`pathlib`モジュール
パスの結合	`os.path.join('parent', 'child', 'file.txt')`	`Path('parent') / 'child' / 'file.txt'`
ファイルの存在確認	`os.path.exists('file.txt')`	`Path('file.txt').exists()`
ファイルかどうか確認	`os.path.isfile('file.txt')`	`Path('file.txt').is_file()`
ディレクトリかどうか確認	`os.path.isdir('directory')`	`Path('directory').is_dir()`
ファイル名取得	`os.path.basename('/path/to/file.txt')`	`Path('/path/to/file.txt').name`
拡張子取得	`os.path.splitext('/path/to/file.txt')[1]`	`Path('/path/to/file.txt').suffix`
ディレクトリ作成	`os.makedirs('new_dir', exist_ok=True)`	`Path('new_dir').mkdir(parents=True, exist_ok=True)`
ディレクトリ内のファイル一覧	`os.listdir('directory')`	`Path('directory').iterdir()`