4.8.1.2 IncrementalEncoder オブジェクト

バージョン 2.5 で 新たに追加 された仕様です。

IncrementalEncoder クラスは入力を複数ステップでエンコードするのに 使われます。全ての漸増的エンコーダが Python codec レジストリと互換性を持つために 定義すべきメソッドとして、このクラスには以下のメソッドが定義されています。

クラス IncrementalEncoder( [errors])
IncrementalEncoder インスタンスのコンストラクタ。

全ての漸増的エンコーダはこのコンストラクタインタフェースを提供しなければなりません。 さらにキーワード引数を付け加えるのは構いませんが、Python codec レジストリで 利用されるのはここで定義されているものだけです。

IncrementalEncodererrors キーワード引数を提供して 異なったエラー取扱方法を実装することもできます。あらかじめ定義されている パラメータは以下の通りです。

引数 errors は同名の属性に割り当てられます。属性に割り当てることで IncrementalEncoder オブジェクトが生きている間にエラー取扱戦略を 違うものに切り替えることができるようになります。

errors 引数に許される値の集合は register_error() で 拡張できます。

encode( object[, final])
object を(エンコーダの現在の状態を考慮に入れて)エンコードし、 得られたエンコードされたオブジェクトを返します。encode 呼び出し がこれで最後という時には final は真でなければなりません(デフォルトは偽です)。

reset( )
エンコーダを初期状態にリセットします。

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