7.5.1 ファイルオブジェクト (file object)

7.5.1 ファイルオブジェクト (file object)

Python の組み込みファイルオブジェクトは、全て標準 C ライブラリの FILE* サポートの上に実装されています。以下の詳細説明は一実装に関するもので、将来の Python のリリースで変更されるかもしれません。

PyFileObject: この PyObject のサブタイプは Python のファイル型オブジェクトを表現します。

PyTypeObject PyFile_Type: この PyTypeObject のインスタンスは Python のファイル型を表現します。このオブジェクトは types.FileType として Python プログラムで公開されています。

int PyFile_Check( PyObject *p): 引数が PyFileObject か PyFileObject のサブタイプのときに真を返します。バージョン 2.2 で変更された仕様: サブタイプを引数にとれるようになりました

int PyFile_CheckExact( PyObject *p): 引数が PyFileObject 型で、かつ PyFileObject 型のサブタイプでないときに真を返します。バージョン 2.2 で新たに追加された仕様です。

PyObject* PyFile_FromString( char *filename, char *mode): 戻り値: 新たな参照.
成功すると、filename に指定した名前のファイルを mode に指定したファイルモードで開いて得た新たなファイルオブジェクトを返します。 mode のセマンティクスは標準 C ルーチン fopen() と同じです。失敗するとNULL を返します。

PyObject* PyFile_FromFile( FILE *fp, char *name, char *mode, int (*close)(FILE*)): 戻り値: 新たな参照.
すでに開かれている標準 C ファイルポインタ fp から新たな PyFileObject を生成します。この関数で生成したファイルオブジェクトは、閉じる際にclose に指定した関数を呼び出します。失敗するとNULLを返します。

FILE* PyFile_AsFile( PyFileObject *p): p に関連付けられたファイルオブジェクトを FILE* で返します。

PyObject* PyFile_GetLine( PyObject *p, int n): 戻り値: 新たな参照.
p.readline([n]) と同じで、この関数はオブジェクト p の各行を読み出します。 p はファイルオブジェクトか、readline() メソッドを持つ何らかのオブジェクトでかまいません。n が 0 の場合、行の長さに関係なく正確に 1 行だけ読み出します。n が 0 より大きければ、n バイト以上のデータは読み出しません; 従って、行の一部だけが返される場合があります。どちらの場合でも、読み出し後すぐにファイルの終端に到達した場合には空文字列を返します。n が 0 より小さければ、長さに関わらず 1 行だけを読み出しますが、すぐにファイルの終端に到達した場合には EOFError を送出します。

PyObject* PyFile_Name( PyObject *p): 戻り値: 借りた参照.
p に指定したファイルの名前を文字列オブジェクトで返します。

void PyFile_SetBufSize( PyFileObject *p, int n): setvbuf() があるシステムでのみ利用できます。この関数を呼び出してよいのはファイルオブジェクトの生成直後のみです。

int PyFile_Encoding( PyFileObject *p, char *enc): Unicode オブジェクトをファイルに出力するときにのエンコード方式を enc にします。成功すると 1 を、失敗すると 0 を返します。バージョン 2.3 で新たに追加された仕様です。

int PyFile_SoftSpace( PyObject *p, int newflag): この関数はインタプリタの内部的な利用のために存在します。この関数はp の softspace 属性を newflag に設定し、以前の設定値を返します。この関数を正しく動作させるために、 p がファイルオブジェクトである必然性はありません; 任意のオブジェクトをサポートします (softspace 属性が設定されているかどうかのみが問題だと思ってください)。この関数は全てのエラーを解消し、属性値が存在しない場合や属性値を取得する際にエラーが生じると、0 を以前の値として返します。この関数からはエラーを検出できませんが、そもそもそういう必要はありません。

int PyFile_WriteObject( PyObject *obj, PyFileObject *p, int flags): オブジェクト obj をファイルオブジェクト p に書き込みます。 flag がサポートするフラグは Py_PRINT_RAW だけです; このフラグを指定すると、オブジェクトにrepr() ではなく str() を適用した結果をファイルに書き出します。成功した場合には 0 を返し、失敗すると -1 を返して適切な例外をセットします。

int PyFile_WriteString( const char *s, PyFileObject *p): 文字列 s をファイルオブジェクト p に書き出します。成功した場合には 0 を返し、失敗すると -1 を返して適切な例外をセットします。

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