4.9.1.2 StreamWriter オブジェクト

StreamWriter クラスは Codec のサブクラスで、以下のメソッドを定義しています。全てのストリーム・ライターは、Python の codec レジストリとの互換性を保つために、これらのメソッドを定義する必要があります。

class StreamWriter( stream[, errors])

Constructor for a StreamWriter instance. StreamWriter インスタンスのコンストラクタ。

全てのストリーム・ライターのコンストラクタは、このインターフェイスを提供しなければなりません。キーワード引数を追加しても構いませんが、Python の codec レジストリは、ここで定義される引数だけを使います。

stream は、（バイナリで）書き込み可能なファイル的なオブジェクトでなくてはいけません。

StreamWriter は、errors キーワード引数を受けて、異なったエラー処理の仕組みを実装しても構いません。以下のパラメータは、あらかじめ定義されています。

errors 引数は、同名の属性に代入されます。この属性を変更することで、StreamWriter オブジェクトが生きている間に、異なるエラー処理に変更することができます。

errors 引数が取り得る値の種類は、register_error() で拡張できます。

write( object): Writes the object's contents encoded to the stream. エンコードされた object の内容をストリームに書き出す。

reset( ): 状態保持に使われていた codec のバッファを、強制的に出力し、リセットする。
このメソッドの呼び出したとき、出力先データをきれいな状態にし、状態を元に戻すのにストリーム全体を再スキャンすることなく、新しくフラッシュするデータを追加できるように保障するべきです。

ここまでで挙げたメソッドに加えて、StreamWriter は、元になっているストリームから、他の全てのメソッドや属性を、継承しなければなりません。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。