ログ、レポート、構成、エクスポート: 遅かれ早かれ、すべてのスクリプトがファイル システムにアクセスします。 Python ファイル処理 は始めるのが簡単ですが、コードが信頼できるかどうか、またはデータを静かに破壊するかどうかは、いくつかの詳細によって決まります。

このガイドでは、安全な習慣に焦点を当てて、テキスト ファイル、CSV、JSON、バイナリ データおよびパスについて説明します。これらの例は、一時フォルダー内の Python 3.13 で実行しました。示されている出力は、その実行からのものです。

open() と を使用してファイルを開きます

組み込み関数 open() はファイル オブジェクトを返します。 with ブロック内で使用します。

with open("notes.txt", "w", encoding="utf-8") as file:
    file.write("first line\n")
    file.write("second line\n")

print(file.closed)

# True

ブロックが終了すると、内部でエラーが発生した場合でも、Python はファイルを閉じます。 with がない場合は、close() を自分で呼び出す必要があり、例外によってその行がスキップされる可能性があります。ファイルを閉じた後にそのファイルを使用すると、エラーが発生します。

file.read()

# ValueError: I/O operation on closed file.

ファイルモード

open() の 2 番目の引数は、何をするつもりかを示します。

バイナリデータの場合は、"rb"または"wb"と同様にbを追加します。 Text がデフォルトですが、t として明示的に記述することもできます。

書いて追加する

write()は改行しないので、\nを自分で入れてください。追加すると、既存のものは保持されます。

with open("notes.txt", "a", encoding="utf-8") as file:
    file.write("third line\n")

モードと比較してください"w"これにより、警告はまったく表示されずに、3 行が 1 行に置き換えられました。

with open("notes.txt", "w", encoding="utf-8") as file:
    file.write("replaced\n")

# notes.txt now contains only: replaced

上書きしてはいけない場合は"x"を使用してください。 notes.txt がすでに存在していたため、テストでは FileExistsError が発生しました。

ファイルを読む

読み取る方法はいくつかあり、正しい選択はファイルのサイズによって異なります。

with open("notes.txt", encoding="utf-8") as file:
    print(repr(file.read()))

# 'first line\nsecond line\n'

with open("notes.txt", encoding="utf-8") as file:
    for line in file:
        print(line.strip())

# first line
# second line
# third line

\n 文字が生の文字列に保持されていることに注目してください。 strip() はそれらを削除します。ファイル オブジェクトはその位置も記憶しているため、中断したところから読み取りが続行されます。

with open("notes.txt", encoding="utf-8") as file:
    print(file.readline().strip())
    print(file.readlines())

# first line
# ['second line\n', 'third line\n']

ファイルのループ処理は、大きなログとエクスポートの重要なテクニックです。一度に 1 行ずつ読み取るため、数ギガバイトのファイルをメモリに収める必要はありません。

ファイルエラーを処理する

ファイルが見つからないか、ロックされているか、読み取れない可能性があるため、次のことを計画してください。

try:
    with open("missing.txt", encoding="utf-8") as file:
        data = file.read()
except FileNotFoundError as error:
    print(error)

# [Errno 2] No such file or directory: 'missing.txt'

チェックしてから開くまでの間にファイルが消える可能性があるため、最初に exists() でチェックするのではなく、ファイルを開いてエラーをキャッチしてみてください。 Python 例外処理 のガイドでは、このアプローチについて説明しています。

CSVファイル

引用符で囲まれた値にはカンマが含まれる可能性があるため、CSV 行をカンマで分割しないでください。標準 csv モジュールはこれらのルールを処理します。 DictWriter と DictReader が最も読みやすいオプションです。

import csv

with open("orders.csv", "w", newline="", encoding="utf-8") as file:
    writer = csv.DictWriter(file, fieldnames=["id", "customer", "total"])
    writer.writeheader()
    writer.writerow({"id": 1, "customer": "Asha", "total": 1200})
    writer.writerow({"id": 2, "customer": "Ben", "total": 300})

with open("orders.csv", newline="", encoding="utf-8") as file:
    rows = list(csv.DictReader(file))

print(rows[0])
print(sum(int(r["total"]) for r in rows))

# {'id': '1', 'customer': 'Asha', 'total': '1200'}
# 1500

2 つの詳細が重要です。ドキュメントで推奨されているように、CSV ファイルを開くときに Windows で空白行を防ぐために newline="" を渡します。そして、すべての値は 文字列 (偶数) として返されるため、合計に int() が必要でした。大量のデータを扱う場合には、pandas などのライブラリの方が適しています。

JSONファイル

JSON は、構成データと API データの通常の形式です。 Python 辞書 にきちんとマッピングされており、次のものがリストされています。

import json

config = {"debug": True, "retries": 3, "hosts": ["a", "b"]}

with open("config.json", "w", encoding="utf-8") as file:
    json.dump(config, file, indent=2)

with open("config.json", encoding="utf-8") as file:
    print(json.load(file)["retries"])

# 3

名前を覚えておいてください。dump と load はファイルを操作し、dumps と loads は文字列を操作します。日付などの型は直接保存できないため、最初に文字列に変換する必要があります。

pathlib を使用してパスを操作する

パスを文字列で結合すると、オペレーティング システム間で破損します。標準の pathlib モジュールは区切り文字を処理し、便利なショートカットを提供します。

from pathlib import Path

path = Path("data") / "reports" / "summary.txt"
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text("all good\n", encoding="utf-8")

print(path.read_text(encoding="utf-8").strip())   # all good
print(path.suffix, path.stem, path.exists())      # .txt summary True
print(sorted(p.name for p in Path(".").glob("*.csv")))
# ['orders.csv']

最後の方法は、よくある頭痛を解決します。相対パスは、スクリプトが存在する場所からではなく、スクリプトを実行した場所から解決されるため、Path(__file__).parentからパスを構築すると、多くの「ファイルが見つからない」という予期せぬ事態を回避できます。

バイナリファイル

画像、PDF、ZIP ファイルはテキストではありません。 b でそれらを開くと、エンコードを行わずに bytes を読み書きします。

with open("pixel.bin", "wb") as file:
    file.write(bytes([255, 0, 128]))

with open("pixel.bin", "rb") as file:
    print(file.read())

# b'\xff\x00\x80'

より安全な書き込み

重要なファイルの書き込み中にプログラムがクラッシュすると、破損した結果が残る可能性があります。一般的な修正方法は、最初に一時ファイルに書き込んでから、それを所定の場所に交換することです。

temp = Path("settings.tmp")
temp.write_text("new", encoding="utf-8")
temp.replace("settings.txt")

print(Path("settings.txt").read_text(), temp.exists())

# new False

replace()は宛先を上書きします。同じファイル システム上では、通常、名前変更はアトミックであるため、読み手には、書きかけの混合ではなく、古いファイルまたは新しいファイルが表示されます。

実践例: ログを要約する

この短いスクリプトには、いくつかのアイデアがまとめられています。ログを一度に 1 行ずつ読み取るため、そのサイズは問題になりません。Counter を使用して各レベルをカウントし、新しいファイルに概要を書き込みます。

from collections import Counter

counts = Counter()
with open("app.log", encoding="utf-8") as file:
    for line in file:
        counts[line.split()[0]] += 1

with open("summary.txt", "w", encoding="utf-8") as out:
    for level, total in counts.most_common():
        out.write(f"{level}: {total}\n")

# summary.txt
# ERROR: 2
# INFO: 2
# WARN: 1

サンプル ログには 5 行がありました。空行は改行 line.split()[0] となるため、実際のスクリプトでは最初に空行をスキップする必要があります。

よくある間違い

• "a" を意味するのに "w" を使用します。 何も書き込まなくても、既存のデータは開くとすぐに消えます。
• エンコーディングの省略。 デフォルトはシステムによって異なるため、Linux で動作するスクリプトは、アクセント付きのテキストや絵文字を使用すると Windows では失敗する可能性があります。
• 巨大なファイルに対して read() を呼び出す。 これによりメモリが枯渇する可能性があるため、代わりに行をループします。
• CSV 値の int() を忘れます。 "10" + "20" を実行すると "1020" が返されます。
• CSV の newline="" は省略します。 Windows では予期しない空白行が表示される場合があります。
• ファイル コードをテストしていません。 pytest の tmp_path フィクスチャを使用して、テストが実際のファイルに触れないようにします。 pytest チュートリアルをご覧ください。

まとめ

ここでは、いくつかの習慣がほぼすべてをカバーしています。with を使用し、エンコーディングを設定し、"w" についてよく考え、難しい部分は csv、json、および pathlib に任せます。練習するには、CSV を読み取り、1 列を合計し、JSON 概要を新しいフォルダーに保存する小さなスクリプトを作成します。

よくある質問

学び続ける