Yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/fileObjects.html

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/moduleObjects.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/otherObjects.html|]]

Python/C API Reference Manual

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/contents.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/genindex.html|]]

Next: 7.5.2 Module Objects Up: 7.5 Other Objects Previous: 7.5 Other Objects

7.5.1 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): Return value: New reference.
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*)): Return value: New reference.
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): Return value: New reference.
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): Return value: Borrowed reference.
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.

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/moduleObjects.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/otherObjects.html|]]

Python/C API Reference Manual

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/contents.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/genindex.html|]]

Next: 7.5.2 Module Objects Up: 7.5 Other Objects Previous: 7.5 Other Objects

Send comments on this document to python-docs@python.org.

blank.gif">

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/genindex.html|]]

Next: 1.4 Embedding Python Up: 1. Introduction Previous: 1.2.2 Types

Send comments on this document to python-docs@python.org.

b>PyErr_SetFromErrno (PyObject *type)

This is a convenience function to raise an exception when a C library function has returned an error and set the C variable errno. It constructs a tuple object whose first item is the integer errno value and whose second item is the corresponding error message (gotten from strerror()), and then calls "PyErr_SetObject(type, object)". On Unix, when the errno value is EINTR, indicating an interrupted system call, this calls PyErr_CheckSignals(), and if that set the error indicator, leaves it set to that. The function always returns NULL, so a wrapper function around a system call can write "return PyErr_SetFromErrno();" when the system call returns an error.

void PyErr_BadInternalCall (): This is a shorthand for "PyErr_SetString(PyExc_TypeError, message)", where message indicates that an internal operation (e.g. a Python/C API function) was invoked with an illegal argument. It is mostly for internal use.

int PyErr_CheckSignals (): This function interacts with Python's signal handling. It checks whether a signal has been sent to the processes and if so, invokes the corresponding signal handler. If the signal module is supported, this can invoke a signal handler written in Python. In all cases, the default effect for SIGINT is to raise the KeyboardInterrupt exception. If an exception is raised the error indicator is set and the function returns 1; otherwise the function returns 0. The error indicator may or may not be cleared if it was previously set.

void PyErr_SetInterrupt (): This function is obsolete. It simulates the effect of a SIGINT signal arriving -- the next time PyErr_CheckSignals() is called, KeyboardInterrupt will be raised. It may be called without holding the interpreter lock.

PyObject* PyErr_NewException (char *name, PyObject *base, PyObject *dict): Return value: New reference.
This utility function creates and returns a new exception object. The name argument must be the name of the new exception, a C string of the form module.class. The base and dict arguments are normally NULL. Normally, this creates a class object derived from the root for all exceptions, the built-in name Exception (accessible in C as PyExc_Exception). In this case the __module__ attribute of the new class is set to the first part (up to the last dot) of the name argument, and the class name is set to the last part (after the last dot). When the user has specified the -X command line option to use string exceptions, for backward compatibility, or when the base argument is not a class object (and not NULL), a string object created from the entire name argument is returned. The base argument can be used to specify an alternate base class. The dict argument can be used to specify a dictionary of class variables and methods.

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/standardExceptions.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/api.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/countingRefs.html|]]

Python/C API Reference Manual

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/contents.html|]]

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/genindex.html|]]

Next: 4.1 Standard Exceptions Up: Python/C API Reference Manual Previous: 3. Reference Counting

Send comments on this document to python-docs@python.org.

drwxrwxrwx 2 nobody nobody 371 Oct 19 19:57 alt/

Yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/fileObjects.html

7.5.1 File Objects

Navigation menu

Search