GNU Info

(python2.1-api.info)File Objects

---

Next: Instance Objects Prev: Other Objects Up: Other Objects

---

Enter node , (file) or (file)node

File Objects
------------

Python's built-in file objects are implemented entirely on the `FILE*'
support from the C standard library.  This is an implementation detail
and may change in future releases of Python.

`PyFileObject'
     This subtype of `PyObject' represents a Python file object.

`PyTypeObject PyFile_Type'
     This instance of `PyTypeObject' represents the Python file type.
     This is exposed to Python programs as `types.FileType'.

`int PyFile_Check(PyObject *p)'
     Returns true if its argument is a `PyFileObject'.

`PyObject* PyFile_FromString(char *filename, char *mode)'
     On success, returns a new file object that is opened on the file
     given by FILENAME, with a file mode given by MODE, where MODE has
     the same semantics as the standard C routine `fopen()' .  On
     failure, returns `NULL'.

`PyObject* PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE*))'
     Creates a new `PyFileObject' from the already-open standard C file
     pointer, FP.  The function CLOSE will be called when the file
     should be closed.  Returns `NULL' on failure.

`FILE* PyFile_AsFile(PyFileObject *p)'
     Returns the file object associated with P as a `FILE*'.

`PyObject* PyFile_GetLine(PyObject *p, int n)'
     Equivalent to `P.readline([N])', this function reads one line from
     the object P.  P may be a file object or any object with a
     `readline()' method.  If N is `0', exactly one line is read,
     regardless of the length of the line.  If N is greater than `0',
     no more than N bytes will be read from the file; a partial line
     can be returned.  In both cases, an empty string is returned if
     the end of the file is reached immediately.  If N is less than `0',
     however, one line is read regardless of length, but `EOFError' is
     raised if the end of the file is reached immediately.

`PyObject* PyFile_Name(PyObject *p)'
     Returns the name of the file specified by P as a string object.

`void PyFile_SetBufSize(PyFileObject *p, int n)'
     Available on systems with `setvbuf()' only.  This should only be
     called immediately after file object creation.

`int PyFile_SoftSpace(PyObject *p, int newflag)'
     This function exists for internal use by the interpreter.  Sets
     the `softspace' attribute of P to NEWFLAG and returns the previous
     value.  P does not have to be a file object for this function to
     work properly; any object is supported (thought its only
     interesting if the `softspace' attribute can be set).  This
     function clears any errors, and will return `0' as the previous
     value if the attribute either does not exist or if there were
     errors in retrieving it.  There is no way to detect errors from
     this function, but doing so should not be needed.

`int PyFile_WriteObject(PyObject *obj, PyFileObject *p, int flags)'
     Writes object OBJ to file object P.  The only supported flag for
     FLAGS is `Py_PRINT_RAW' ; if given, the `str()' of the object is
     written instead of the `repr()'.  Returns `0' on success or `-1' on
     failure; the appropriate exception will be set.

`int PyFile_WriteString(char *s, PyFileObject *p, int flags)'
     Writes string S to file object P.  Returns `0' on success or `-1'
     on failure; the appropriate exception will be set.