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

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/api.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: Contents Up: Python/C API Reference Manual Previous: Python/C API Reference Manual

Front Matter

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the names of Stichting Mathematisch Centrum or CWI or Corporation for National Research Initiatives or CNRI not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.

While CWI is the initial source for this software, a modified version is made available by the Corporation for National Research Initiatives (CNRI) at the Internet address ftp://ftp.python.org.

STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Abstract:

This manual documents the API used by C and C++ programmers who want to write extension modules or embed Python. It is a companion to Extending and Embedding the Python Interpreter, which describes the general principles of extension writing but does not document the API functions in detail.

Warning: The current version of this document is incomplete. I hope that it is nevertheless useful. I will continue to work on it, and release new versions from time to time, independent from Python source code releases.

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

[[yurttas/PL/SL/python/docs/core-python-programming/doc/152/api/api.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: Contents Up: Python/C API Reference Manual Previous: Python/C API Reference Manual

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

>

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/front.html

Front Matter

Abstract: