Pythonのpathlibライブラリの使い方ガイド

# pathlibを使ったパス結合の例
from pathlib import Path # pathlibのPathクラスをインポート

p = Path('data') / 'sample.txt' # dataというディレクトリ名でPathオブジェクトを生成し、sample.txtと結合
print(p)  # data/sample.txt

from pathlib import Path # pathlibのPathクラスをインポート

# カレントディレクトリ（現在開いているフォルダ）からの相対パスを生成する場合
p = Path('data/sample.txt') # パスオブジェクトを作成
print(p)  # data/sample.txt

# 絶対パスを指定する場合
p = Path('/home/user/data/sample.txt')
print(p)  # /home/user/data/sample.txt

# カレントディレクトリ
current_dir = Path.cwd() # プログラムを実行している「今いるディレクトリ」の絶対パスを取得

# ユーザーディレクトリ
home_dir = Path.home()  # ユーザーのホームディレクトリの絶対パスを取得
						# Linux/Macなら「/home/ユーザー名」
						# Windowsなら「C:\Users\ユーザー名」

p = Path('data/sample.txt') # パスオブジェクトを作成
if p.exists(): # もしそのパスのファイルかフォルダが存在するなら
    print('ファイルまたはディレクトリが存在します')
else:
    print('存在しません')

p = Path('data/sample.txt') # パスオブジェクトを作成
if p.is_file(): # もしそれがファイルなら（存在する＆フォルダでないなら）
    print('これはファイルです')

p = Path('data') # パスオブジェクトを作成
if p.is_dir(): # もしそれがディレクトリ（ファイル）なら（存在する＆ファイルでないなら）
    print('これはディレクトリです')

p = Path('data/sample.txt') # パスオブジェクトを作成
if p.exists():		 # もしそのパスのファイルかフォルダが存在するなら
    info = p.stat()  # そのファイルの情報を取得
    print(f"サイズ: {info.st_size} バイト, 最終更新: {info.st_mtime}")

from pathlib import Path

dir_path = Path('data') # パスオブジェクトを作成
for entry in dir_path.iterdir(): # このパス直下にある全てのファイルを１つずつ
    print(entry)  # 出力する

from pathlib import Path

dir_path = Path('data') # パスオブジェクトを作成
for file_path in dir_path.glob('*.txt'): # このパス直下にある、拡張子がtxtのファイルを１つずつ
    print(file_path)  # 出力する

from pathlib import Path

dir_path = Path('data') # パスオブジェクトを作成
for file_path in dir_path.rglob('*.csv'): # このパス以下の全ての階層にある、拡張子がcsvのファイルを１つずつ
    print(file_path)  # 出力する

from pathlib import Path

Path('output/logs').mkdir(parents=True, exist_ok=True)
# Path('output/logs')でパスオブジェクトを作成し、.mkdir()でディレクトリを作成
# parents=Trueにより、親ディレクトリが存在しない場合は一括で作成
# exist_ok=Trueにより、同じ名前のディレクトリが存在していてもエラーを出さずにスルー

from pathlib import Path

Path('output/empty.txt').touch()
# Path('output/logs')でパスオブジェクトを作成し、.touch()で空ファイルを作成

from pathlib import Path

file_path = Path('output/empty.txt') # パスオブジェクトを作成
if file_path.exists():  # もしそのパスのファイルかフォルダが存在するなら
    file_path.unlink()  # そのファイルを削除

from pathlib import Path

dir_path = Path('output/logs') # パスオブジェクトを作成
if dir_path.exists(): # もしそのパスのファイルかフォルダが存在するなら
    dir_path.rmdir()  # ディレクトリが空の場合のみ削除

from pathlib import Path

file_path = Path('data/sample.txt') # パスオブジェクトを作成
if file_path.exists(): # もしそのパスのファイルかフォルダが存在するなら
    content = file_path.read_text(encoding='utf-8') # テキストモードで読み込み、中身をcontentに格納
    print(content)  # ファイルの中身を表示

from pathlib import Path

file_path = Path('output/newfile.txt') # パスオブジェクトを作成
text = "こんにちは、Python pathlibのファイル書き込み例です。"

file_path.write_text(text, encoding='utf-8') # UTF-8エンコーディングでテキストファイルとして書き込む
print("ファイルを書き込みました")

from pathlib import Path

file_path = Path('data/image.png') # パスオブジェクトを作成
if file_path.exists(): # もしそのパスのファイルかフォルダが存在するなら
    data = file_path.read_bytes() #バイナリモードで開き、その中身を「bytes型」（バイト列）として全て読み込む
    print(f"バイト数: {len(data)}")  # ファイルサイズを表示

from pathlib import Path

src = Path('data/image.png')  # パスオブジェクトを作成
dst = Path('output/copy.png') # パスオブジェクトを作成

if src.exists():			# もしそのパスのファイルかフォルダが存在するなら
    data = src.read_bytes() # srcのバイナリモード（bytes型）で全て読み込み、data変数に格納
    dst.write_bytes(data)   # 読み込んだバイナリデータdataに書きこむ
    print("画像ファイルをコピーしました")

from pathlib import Path

base_dir = Path('data')
file_path = base_dir / 'logs' / '2024' / 'report.txt'
print(file_path)  # data/logs/2024/report.txt

from pathlib import Path

p = Path('data/sample.txt')
print(p.parent)     # sample.txtの親ディレクトリの名前：data
print(p.name)       # sample.txtの名前：sample.txt
print(p.stem)       # sample.txtの親ディレクトリの拡張子を除く名前：sample
print(p.suffix)     # sample.txtの親ディレクトリの拡張子：.txt

from pathlib import PureWindowsPath, PurePosixPath

win_path = PureWindowsPath('C:/Users/User/data.txt') # Windows風のパスを作成
posix_path = PurePosixPath('/home/user/data.txt')	 # NIX（LinuxやMacなど）風のパスを作成

print(win_path)    # C:\Users\User\data.txt
print(posix_path)  # /home/user/data.txt

from pathlib import Path

p = Path('data') / 'sample.txt'
print(p)  # Windowsなら「\」、Unixなら「/」で表示

from pathlib import Path

p = Path('data/sample.txt') # パスオブジェクトを作成
print(p.resolve())  # 絶対パスを表示

from pathlib import Path

p = Path('output/old.txt') 	   # パスオブジェクトを作成
if p.exists():				   # もしそのパスのファイルかフォルダが存在するなら
    p.rename('output/new.txt') # 名称を変更
    print("ファイル名を変更しました")

from pathlib import Path

p = Path('data/sample.txt') # パスオブジェクトを作成
new_name = p.with_name('sample2.txt')   # ファイル名をsample2.txtに変更
new_ext  = p.with_suffix('.csv')        # 拡張子を.csvに変更
print(new_name)  # data/sample2.txt
print(new_ext)   # data/sample.csv

from pathlib import Path

p = Path('data/sample.txt')
# open関数にPathオブジェクトをそのまま渡すのはOK
with open(p, encoding='utf-8') as f:
    print(f.read())

# しかし、os.path.join にはPathオブジェクトを渡すとTypeErrorになる
import os
try:
    os.path.join(p, 'test.txt')  # エラー！
except TypeError as e:
    print("TypeError:", e)

os.path.join(str(p), 'test.txt')  # OK

from pathlib import Path

# 良い例
p = Path('data') / 'sample.txt'  # OSを気にしなくてOK

# 悪い例
p = Path('data\\sample.txt')  # Windows専用になってしまう

from pathlib import Path

p = Path('not_exist.txt')
if not p.exists():
    print("ファイルが存在しません")
else:
    print(p.read_text())

from pathlib import Path
import shutil

dir_path = Path('output/logs')
if dir_path.exists():
    shutil.rmtree(dir_path)  # ディレクトリごと中身も削除

# os.pathの場合
import os
for filename in os.listdir('data'):
    if filename.endswith('.txt'):
        print(os.path.join('data', filename))
        
# pathlibの場合
from pathlib import Path
for file_path in Path('data').glob('*.txt'):
    print(file_path)