https://pydocument.hatenablog.com/entry/2023/03/23/205901

この記事では、Pythonのopen() 関数の各オプションを詳しく解説し、具体的なコード例とともに、どのような状況でどのオプションを使うべきかを説明します。

`open()` 関数の基本構文

open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

引数	説明
`file`	開くファイルの名前（パスを含む）を指定します。必須。
`mode`	ファイルを開くモードを指定します。後述。
`buffering`	バッファリングポリシーを制御します。後述。
`encoding`	テキストファイルのエンコーディングを指定します（例：`'utf-8'`, `'shift_jis'`）。後述。
`errors`	エンコーディングエラーの処理方法を指定します（例：`'ignore'`, `'replace'`）。後述。
`newline`	改行コードの扱いを制御します。後述。
`closefd`	ファイル記述子を閉じるかどうかを指定します（通常は `True` のままにします）。
`opener`	カスタムオープナーを指定します（高度な使用法）。

`mode` オプション：ファイルの開き方を指定

open() 関数の mode オプションは、ファイルの開き方を決定します。主要なモードとその組み合わせをまとめます。

モード	説明
`'r'`	読み込み専用（デフォルト）。ファイルが存在しない場合は `FileNotFoundError` が発生。
`'w'`	書き込み専用。ファイルが存在する場合は内容を消去して上書き。存在しない場合は新規作成。
`'a'`	追記専用。ファイルが存在する場合は末尾に追記。存在しない場合は新規作成。
`'x'`	排他的書き込み専用。ファイルが存在する場合は `FileExistsError` が発生。新規作成のみを安全に行いたい場合に有用。
`'b'`	バイナリモード。テキストファイルではなく、バイナリデータを扱う場合に指定。他のモードと組み合わせて使用（例：`'rb'`, `'wb'`, `'ab'`）。
`'t'`	テキストモード（デフォルト）。通常、エンコーディングを指定してテキストファイルを扱う（例：`'rt'`, `'wt'`, `'at'`）。指定しない場合はシステムのデフォルトエンコーディングが使用される。
`'+'`	更新（読み書き両用）モード。他のモードと組み合わせて使用（例：`'r+'`, `'w+'`, `'a+'`）。`'w+'` は既存の内容を消去することに注意。`'r+'` は既存のファイルがないと`FileNotFoundError`が発生。`'a+'`は常に末尾に追記。

`mode`のサンプルコード

# 既存のテキストファイルを読み書き両用で開く
with open('my_file.txt', 'r+', encoding='utf-8') as f:
    content = f.read()
    f.seek(0)  # ファイルポインタを先頭に戻す
    f.write('Modified content\n')

# 新しいテキストファイルを作成し、書き込み後に読み込む
with open('new_file.txt', 'w+', encoding='utf-8') as f:
    f.write('Hello')
    f.seek(0)
    content = f.read()
    print(content)

`buffering` オプション：バッファリングを制御

buffering オプションは、ファイル I/O のバッファリングポリシーを制御します。通常、buffering はデフォルトのままで問題ありません。リアルタイムログなど、即時性が求められる場合に buffering=1 を検討します。バイナリデータで、かつパフォーマンスが重要な場合は、より大きなバッファサイズ（例えば buffering=4096）を指定することを検討します。

値	説明
`-1`	デフォルト。システムのデフォルトのバッファリングを使用。通常、テキストモードでは行バッファリング、バイナリモードではブロックバッファリング。
`0`	バッファリングを無効にする（バイナリモードでのみ許可）。
`1`	行バッファリング（テキストモードでのみ有効）。改行文字が出現するたびにバッファがフラッシュ（書き込み）される。
`> 1`	指定されたバイト数のバッファを使用。

`buffering` のサンプリコード

# 行バッファリングでログファイルを開く
with open('my_log_file.txt', 'a', buffering=1, encoding='utf-8') as f:
    f.write('Log entry 1\n')  # この行はすぐに出力される
    f.write('Log entry 2')  # この行はまだ出力されない可能性がある
    f.flush() # 明示的にバッファの内容を書き込み

`encoding` オプション：文字エンコーディングを指定

encoding オプションは、テキストファイルを読み書きする際の文字エンコーディングを指定します。encoding を指定しない場合、異なる環境でプログラムを実行したときに文字化けが発生する可能性があります。特に、異なる OS や言語設定の環境で動作するプログラムでは、encoding を明示的に指定することが非常に重要です。

エンコーディング	説明
`'utf-8'`	Unicode (UTF-8)。多くの環境で推奨されるエンコーディング。
`'shift_jis'`	Shift JIS (日本語)。Windows 環境でよく使われる。
`'euc-jp'`	EUC-JP (日本語)。主に UNIX 系システムで使われる。
`'latin-1'`	ISO 8859-1 (Latin-1)。西ヨーロッパ言語でよく使われる。
指定なし	システムのデフォルトエンコーディングが使用される（`locale.getpreferredencoding()` で確認可能）。環境によって異なるため、注意が必要。

`encoding` のサンプルコード

# UTF-8 でエンコードされたテキストファイルを読み込む
with open('utf8_file.txt', 'r', encoding='utf-8') as f:
    content = f.read()

# Shift-JIS でエンコードされたテキストファイルを書き込む
with open('shift_jis_file.txt', 'w', encoding='shift_jis') as f:
    f.write('こんにちは、世界！')

`errors` オプション：エンコーディングエラーの処理

errors オプションは、encoding で指定されたエンコーディングでエラーが発生した場合の処理方法を指定します。errors オプションは、ファイルの内容が完全に正しいエンコーディングで保存されていない可能性がある場合に役立ちますが、'ignore' は情報が失われる可能性があることに注意してください。

値	説明
`'strict'` (デフォルト)	`UnicodeDecodeError` または `UnicodeEncodeError` 例外を発生させる。
`'ignore'`	エンコード/デコードできない文字を無視する。
`'replace'`	エンコードできない文字を `?` に、デコードできない文字を (U+FFFD) に置き換える。
`'backslashreplace'`	エンコードできない文字を `\xNN` 形式のエスケープシーケンスに置き換える。Python のデバッグ時に有用。
`'xmlcharrefreplace'`	エンコードできない文字を XML 文字参照（`&#NN;`）に置き換える。XML/HTML ファイル生成時に有用。

`errors` のサンプルコード

# デコードエラーを無視する
with open('corrupted_file.txt', 'r', encoding='utf-8', errors='ignore') as f:
    content = f.read()  # 不正な文字は無視される

# デコードエラーを ? で置き換える
with open('corrupted_file.txt', 'r', encoding='utf-8', errors='replace') as f:
    content = f.read()  # 不正な文字は ? に置き換えられる

`newline` オプション：改行コードの扱い

newline オプションは、テキストモードでの改行コードの扱いを制御します。通常、newline はデフォルトのままで問題ありません。特定の改行コードを厳密に制御する必要がある場合にのみ、このオプションを使用します。

値	説明
`None`	デフォルト。ユニバーサル改行モード。入力では、`\n`、`\r`、`\r\n` のいずれも `\n` に変換される。出力では、`\n` はシステムのデフォルトの行区切り文字に変換される。
`''`	ユニバーサル改行モードを有効にするが、入力時に改行コードの変換を行わない。出力時は `\n` を変換しない。
`'\n'`	LF (Line Feed) のみを改行として認識。
`'\r'`	CR (Carriage Return) のみを改行として認識。
`'\r\n'`	CR+LF (Carriage Return + Line Feed) のみを改行として認識。

`newline` のサンプルコード

# 入力ファイルの改行コードを変換せず、出力ファイルの改行コードを \r\n にする
with open('input.txt', 'r', encoding='utf-8', newline='') as fin, \
     open('output.txt', 'w', encoding='utf-8', newline='\r\n') as fout:
    for line in fin:
        fout.write(line)

まとめ

Python の open() 関数は、file と mode だけでなく、buffering、encoding、errors、newline といったオプションを組み合わせることで、ファイル操作の挙動を詳細に制御できます。これらのオプションを理解し、適切に使いこなすことで、さまざまな状況に対応した、より安全で効率的なファイル操作を実現できます。特に、異なる環境間でのテキストファイルの互換性を保つためには、encoding オプションの適切な指定が不可欠です。

open() 関数の基本的な使い方とエラー対応についてはこちらの記事を参照ください。

pydocument.hatenablog.com

open() 関数の基本構文

mode オプション：ファイルの開き方を指定

modeのサンプルコード

buffering オプション：バッファリングを制御

buffering のサンプリコード

encoding オプション：文字エンコーディングを指定

encoding のサンプルコード

errors オプション：エンコーディングエラーの処理

errors のサンプルコード

newline オプション：改行コードの扱い

newline のサンプルコード

まとめ