【Python】テキストファイルを読み書きモードで新規作成して開く（モードw+, w+t）【入門第65回】

194, 2019-09-24

こんにちは、narupoです。

今回も前回に引き続き、Pythonのファイル入出力についてです。
今回はテキストファイルを読み書きモードで新規作成して開く方法を解説します。

テキストファイルを読み書きモードで新規作成して開くには、open関数のmode引数に文字列w+またはw+tを指定します。
w+またはw+tモードのopen関数から得られるファイルオブジェクトは_io.TextIOWrapperです。
このファイルオブジェクトのメソッドを使うとテキストファイルに文字列を書き込むことが出来ます。

今回は具体的には↓を見ていきます。

テキストファイルを読み書きモードで新規作成して開く
ファイルオブジェクトのタイプ
文字列を読み込む
文字列を書き込む

ほかのファイル入出力についての入門記事は↓をご覧ください。

テキストファイルを読み書きモードで新規作成して開く

テキストファイルを読み書きモードで、かつ新規作成して開くにはopen関数を↓のようにして使います。

:::python
with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    pass

open関数の第1引数に開きたいテキストファイルのパスを指定します。
mode引数に文字列w+またはw+tを指定します。
encodingには開くテキストファイルのエンコーディングを指定します。

w+またはw+tモードは、ファイルが存在しない場合はファイルを新規作成してファイルを開きます。
そして、ファイルが既に存在する場合は、そのファイルの内容を空にしてからファイルを開きます。
特徴としてはwまたはwtと同じ特徴を持っているので、大切なデータが入っているファイルを誤って空にしないように注意してください。

その他、open関数の詳しい使い方については↓の記事をご覧ください。

【Python】ファイルを開いて閉じる。open関数の使い方【入門第54回】 - narupoのブログ

ファイルオブジェクトのタイプ

w+またはw+tモードで開いたテキストファイルのファイルオブジェクトのタイプは_io.TextIOWrapperです。

:::python
with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    print(type(fp))

↑のコードの実行結果は↓のようになります。

:::text
<class '_io.TextIOWrapper'>

io --- ストリームを扱うコアツール - TextIOWrapper — Python 3.7.4 ドキュメント

このTextIOWrapperはTextIOBaseを継承したクラスです。
さらにTextIOBaseはIOBaseを継承しています。
TextIOBaseとIOBaseの公式ドキュメントを見ればこのファイルオブジェクトで使えるメソッドを一望できます。

文字列を書き込む

ファイルオブジェクトのメソッドを使うとファイルを読み書き出来ます。
ファイルに文字列を書き込むにはwriteメソッドなどを使います。

:::python
with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    fp.write('猫\n')

↑のコードを実行すると↓のような内容のanimals.txtが作成されます。

:::text
猫

その他の書き込み用のメソッドについては↓の記事をご覧ください。

【Python】テキストファイルへの書き込み（モードw, wt）【入門第56回】 - narupoのブログ

文字列を読み込む

ファイルから文字列を読み込むにはreadメソッドなどを使います。

:::python
with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    content = fp.read()
    print(content)

↑のコードを実行した場合、contentの中身は空の文字列です。
ファイルの中身が空だからですね。
↓のように書きこんでからreadしてみるとどうでしょうか。

:::python
with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    # 1行書き込む
    fp.write('猫\n')

    # 1行読み込む？
    content = fp.read()
    print(content)

↑これもcontentの中身は空になります。
これの原因は、ファイルのオフセット位置です。
writeメソッドは書き込むときにファイルのオフセット位置を書き込んだ分進めます。
そのため、↑のコードではwriteメソッドを呼び出した直後のファイルのオフセット位置はファイル終端（EOF）になっています。
ファイル終端からreadをした場合、読み込む文字列が無いのでreadの返す値は空の文字列になります。

↓のようにwriteのあとにファイルのオフセット位置をファイル先頭に戻すと、readで1行読み込めます。

:::python
import os

with open('animals.txt', mode='w+', encoding='utf-8') as fp:
    # 1行書き込む
    fp.write('猫\n')

    # オフセット位置をファイル先頭に戻す
    fp.seek(0, os.SEEK_SET)

    # 1行読み込む
    content = fp.read()
    print(content)