Articles
Python入門
Pythonにおける`io`モジュール

Pythonにおける`io`モジュール

この記事ではPythonにおけるioモジュールについて説明します。

Pythonにおけるioモジュールについて実際的なサンプルを含めて解説します。

YouTube Video

Pythonにおけるioモジュール

入出力処理は、ファイル、ネットワーク、標準入出力などあらゆるデータ操作の基盤です。Pythonの io モジュールは、これらの入出力を統一的に扱うための抽象クラス群を提供しています。このモジュールを理解する鍵となるのが「ストリーム」という概念です。

ストリームとは？

ストリーム（stream）とは、データを順序よく連続的に読み書きするための抽象的な流れを指します。

ファイルの内容を1バイトずつ読み取ったり、ネットワーク経由でデータを送受信したりする際も、すべて「データの流れ（ストリーム）」として扱うことができます。

この仕組みを抽象化することで、ファイル・メモリ・ネットワークといった異なる入出力源を、共通の読み込みや書き込みなどの操作で扱えるようになります。

Pythonの io モジュールは、このストリームの統一的インターフェースを提供しており、テキストとバイナリの両方を効率的に処理できます。

io モジュールの基本構造

io モジュールは、ストリームの性質に応じて3層の階層構造を持っています。

  1. Raw 層 (RawIOBase)

    RawIOBaseは、OSのファイル記述子やデバイスなど、最も低レベルなバイト入出力を扱います。

  2. Buffered 層 (BufferedIOBase)

    BufferedIOBaseは、入出力の効率を高めるためにキャッシュ（バッファ）を提供します。BufferedReader や BufferedWriter が代表的です。

  3. Text 層 (TextIOBase)

    TextIOBaseは、バイト列を文字列に変換し、エンコーディング処理を担当します。通常、open() 関数でファイルを開くと、この層の TextIOWrapper が使われます。

この構造により、io モジュールはテキストとバイナリの入出力を明確に分離しつつ、柔軟な組み合わせを可能にしています。

io モジュールの基本構造

RawIOBaseは、最下層でOSのファイル記述子を扱い、その上に BufferedIOBase がキャッシュ層を追加し、最上層の TextIOBase が文字列変換を担当します。

1import io
2
3# Check the core base classes hierarchy
4print(io.IOBase.__subclasses__())
  • このコードは IOBase を継承する抽象クラス群を確認するためのものです。TextIOBase, BufferedIOBase, RawIOBase などが表示され、階層構造を確認できます。

io.IOBase: すべての基底クラス

IOBase はすべてのI/Oオブジェクトの抽象基底クラスで、共通のメソッド（close(), flush(), seekable() など）を定義します。直接使うことはほとんどなく、継承先を通して利用されます。

1import io
2
3f = io.StringIO("data")
4print(f.seekable())   # True
5print(f.readable())   # True
6print(f.writable())   # True
7f.close()
  • この例は IOBase の共通メソッド群が上位クラスでも利用できることを示しています。seekable() や readable() はストリームの特性を確認するために便利です。

io.RawIOBase: 最も低レベルな層

RawIOBase は OSのファイル記述子に最も近い層 で、バッファリングを行いません。代表的な実装は FileIO で、バイト単位で読み書きを行います。

1import io, os
2
3# Create a low-level FileIO object (no buffering)
4fd = os.open('raw_demo.bin', os.O_RDWR | os.O_CREAT)
5raw = io.FileIO(fd, mode='w+')
6raw.write(b'abc123')
7raw.seek(0)
8print(raw.read(6))  # b'abc123'
9raw.close()
  • FileIO は RawIOBase の具体的実装で、読み書きはすべて bytes で行われます。上位の BufferedIOBase と組み合わせることで効率を高めることができます。

io.BufferedIOBase: 中間層（バッファリングあり）

BufferedIOBase はバッファリングを行う中間層で、ディスクアクセスを効率化します。主な実装は BufferedReader, BufferedWriter, BufferedRandom, BufferedRWPair です。

1import io
2
3# Create a buffered binary stream on top of a BytesIO (simulate file)
4base = io.BytesIO()
5buffered = io.BufferedWriter(base)
6buffered.write(b'Python IO buffering')
7buffered.flush()
8base.seek(0)
9print(base.read())  # b'Python IO buffering'
  • この例では BufferedWriter により書き込みが一時的にメモリバッファに蓄えられ、flush() 呼び出しで実際に下層へ転送されます。

BufferedReader の例

BufferedReader は読み込み専用のバッファ付きストリームで、peek() や read() による効率的読み込みをサポートします。

1import io
2
3stream = io.BytesIO(b"1234567890")
4reader = io.BufferedReader(stream)
5print(reader.peek(5))   # b'12345' (non-destructive)
6print(reader.read(4))   # b'1234'
7print(reader.read(3))   # b'567'
  • peek() はデータを「のぞき見る」だけでポインタを進めません。read() と組み合わせることでバッファ制御を柔軟に行えます。

io.TextIOBase: テキスト専用層

TextIOBase は文字列を扱うための抽象層で、デコード・エンコードを内部で行います。実装クラスの代表は TextIOWrapper です。

 1import io
 2
 3# Wrap a binary stream to handle text encoding
 4binary = io.BytesIO()
 5text_stream = io.TextIOWrapper(binary, encoding='utf-8')
 6text_stream.write("\u3053\u3093\u306B\u3061\u306F")
 7text_stream.flush()
 8
 9# Reset stream position
10binary.seek(0)
11
12# Read bytes once
13data = binary.read()
14
15# Show both raw bytes and decoded text
16print("Raw bytes:", data)
17print("Decoded text:", data.decode('utf-8'))
  • この例では TextIOWrapper が文字列を UTF-8 にエンコードし、下層のバイナリストリームへ書き込みます。

TextIOWrapper の読み込み例

デコーディングは読み込み時に自動的に行われます。

1import io
2
3binary_data = io.BytesIO("Python I/O".encode('utf-8'))
4text_reader = io.TextIOWrapper(binary_data, encoding='utf-8')
5print(text_reader.read())  # 'Python I/O'
  • TextIOWrapper はテキスト入出力の基本クラスとして、ほぼすべての高レベルファイル操作の基盤になっています。

io.StringIO: メモリ上のテキストストリーム

StringIO はメモリ上で文字列ベースのファイルのように扱えるクラスです。I/O テストや一時データ生成に便利です。

1import io
2
3text_buf = io.StringIO()
4text_buf.write("In-memory text stream")
5text_buf.seek(0)
6print(text_buf.read())  # 'In-memory text stream'
  • StringIO はディスクを使わずにファイルライクな操作が可能で、単体テストなどで広く利用されます。

io.BytesIO: メモリ上のバイナリストリーム

BytesIO はバイト列（bytes）を扱うメモリ上のファイルクラスです。バイナリ処理やデータ圧縮など、ファイルを使いたくない場面で役立ちます。

1import io
2
3buf = io.BytesIO()
4buf.write(b'\x01\x02\x03')
5buf.seek(0)
6print(list(buf.read()))  # [1, 2, 3]
  • BytesIO は BufferedIOBase と同じインターフェースを持つため、多くのファイル API にそのまま代用できます。

カスタムストリーム（独自クラスを作る）

io のクラスは拡張可能で、自分でストリームクラスを作ることもできます。以下は書き込み時にすべて大文字化する TextIOBase のサブクラス例です。

 1import io
 2
 3class UpperTextIO(io.TextIOBase):
 4    def __init__(self):
 5        self.buffer = ""
 6    def write(self, s):
 7        self.buffer += s.upper()
 8        return len(s)
 9
10u = UpperTextIO()
11u.write("hello io")
12print(u.buffer)  # "HELLO IO"
  • このように TextIOBase の契約を守れば、任意のカスタム動作を定義できます。ファイルやネットワークなど特定用途に合わせたストリーム拡張も容易です。

まとめ

io モジュールは入出力処理を「抽象クラス＋具象クラス」の階層で整理しています。

  • RawIOBaseは、OSレベルのバイトI/Oクラスです。
  • BufferedIOBaseは、効率的なキャッシュ層を提供するクラスです。
  • TextIOBaseは、文字列の読み書きを管理するクラスです。
  • StringIOとBytesIOは、メモリ上のストリームを提供するクラスです。

これらのクラスを理解すれば、PythonのI/Oシステムの仕組みを正確に把握でき、ファイル操作やネットワーク通信、テスト用のストリーム設計にも応用できます。

YouTubeチャンネルでは、Visual Studio Codeを用いて上記の記事を見ながら確認できます。 ぜひYouTubeチャンネルもご覧ください。

YouTube Video

Pythonにおけるファイル操作Pythonにおける非同期処理