rest25/c-api/intro.rst => rest262/c-api/intro.rst
f1.. highlightlang:: c
2
3
n4-.. _intro:
n4+.. _api-intro:
5
6************
7Introduction
8************
9
10The Application Programmer's Interface to Python gives C and C++ programmers
11access to the Python interpreter at a variety of levels.  The API is equally
12usable from C++, but for brevity it is generally referred to as the Python/C
25
26Many API functions are useful independent of whether you're embedding  or
27extending Python; moreover, most applications that embed Python  will need to
28provide a custom extension as well, so it's probably a  good idea to become
29familiar with writing an extension before  attempting to embed Python in a real
30application.
31
32
n33-.. _includes:
n33+.. _api-includes:
34
35Include Files
36=============
37
38All function, type and macro definitions needed to use the Python/C API are
39included in your code by the following line::
40
41   #include "Python.h"
65:file:`{exec_prefix}/include/pythonversion/`, where :envvar:`prefix` and
66:envvar:`exec_prefix` are defined by the corresponding parameters to Python's
67:program:`configure` script and *version* is ``sys.version[:3]``.  On Windows,
68the headers are installed in :file:`{prefix}/include`, where :envvar:`prefix` is
69the installation directory specified to the installer.
70
71To include the headers, place both directories (if different) on your compiler's
72search path for includes.  Do *not* place the parent directories on the search
n73-path and then use ``#include <python|version|/Python.h>``; this will break on
n73+path and then use ``#include <pythonX.Y/Python.h>``; this will break on
74multi-platform builds since the platform independent headers under
75:envvar:`prefix` include the platform specific headers from
76:envvar:`exec_prefix`.
77
78C++ users should note that though the API is defined entirely using C, the
79header files do properly declare the entry points to be ``extern "C"``, so there
80is no need to do anything special to use the API from C++.
81
82
n83-.. _objects:
n83+.. _api-objects:
84
85Objects, Types and Reference Counts
86===================================
87
88.. index:: object: type
89
90Most Python/C API functions have one or more arguments as well as a return value
91of type :ctype:`PyObject\*`.  This type is a pointer to an opaque data type
94assignments, scope rules, and argument passing), it is only fitting that they
95should be represented by a single C type.  Almost all Python objects live on the
96heap: you never declare an automatic or static variable of type
97:ctype:`PyObject`, only pointer variables of type :ctype:`PyObject\*` can  be
98declared.  The sole exception are the type objects; since these must never be
99deallocated, they are typically static :ctype:`PyTypeObject` objects.
100
101All Python objects (even Python integers) have a :dfn:`type` and a
n102-:dfn:`reference count`.  An object's type determines what kind of object  it is
n102+:dfn:`reference count`.  An object's type determines what kind of object it is
103-(e.g., an integer, a list, or a user-defined function; there are  many more as
103+(e.g., an integer, a list, or a user-defined function; there are many more as
104-explained in the Python Reference Manual (XXX reference: ../ref/ref.html)).  For
104+explained in :ref:`types`).  For each of the well-known types there is a macro
105-each of the well-known types there is a macro to check whether an object is of
105+to check whether an object is of that type; for instance, ``PyList_Check(a)`` is
106-that type; for instance, ``PyList_Check(a)`` is true if (and only if) the object
106+true if (and only if) the object pointed to by *a* is a Python list.
107-pointed to by *a* is a Python list.
108
109
n110-.. _refcounts:
n109+.. _api-refcounts:
111
112Reference Counts
113----------------
114
115The reference count is important because today's computers have a  finite (and
116often severely limited) memory size; it counts how many  different places there
117are that have a reference to an object.  Such a  place could be another object,
118or a global (or static) C variable, or  a local variable in some C function.
133is considerably more complex than the incref one, since it must check whether
134the reference count becomes zero and then cause the object's deallocator to be
135called. The deallocator is a function pointer contained in the object's type
136structure.  The type-specific deallocator takes care of decrementing the
137reference counts for other objects contained in the object if this is a compound
138object type, such as a list, as well as performing any additional finalization
139that's needed.  There's no chance that the reference count can overflow; at
140least as many bits are used to hold the reference count as there are distinct
n141-memory locations in virtual memory (assuming ``sizeof(long) >= sizeof(char*)``).
n140+memory locations in virtual memory (assuming ``sizeof(Py_ssize_t) >= sizeof(void*)``).
142Thus, the reference count increment is a simple operation.
143
144It is not necessary to increment an object's reference count for every  local
145variable that contains a pointer to an object.  In theory, the  object's
146reference count goes up by one when the variable is made to  point to it and it
147goes down by one when the variable goes out of  scope.  However, these two
148cancel each other out, so at the end the  reference count hasn't changed.  The
149only real reason to use the  reference count is to prevent the object from being
165
166A safe approach is to always use the generic operations (functions  whose name
167begins with ``PyObject_``, ``PyNumber_``, ``PySequence_`` or ``PyMapping_``).
168These operations always increment the reference count of the object they return.
169This leaves the caller with the responsibility to call :cfunc:`Py_DECREF` when
170they are done with the result; this soon becomes second nature.
171
172
n173-.. _refcountdetails:
n172+.. _api-refcountdetails:
174
175Reference Count Details
176^^^^^^^^^^^^^^^^^^^^^^^
177
178The reference count behavior of functions in the Python/C API is best  explained
179in terms of *ownership of references*.  Ownership pertains to references, never
180to objects (objects are not owned: they are always shared).  "Owning a
181reference" means being responsible for calling Py_DECREF on it when the
183the code that receives ownership of the reference then becomes responsible for
184eventually decref'ing it by calling :cfunc:`Py_DECREF` or :cfunc:`Py_XDECREF`
185when it's no longer needed---or passing on this responsibility (usually to its
186caller). When a function passes ownership of a reference on to its caller, the
187caller is said to receive a *new* reference.  When no ownership is transferred,
188the caller is said to *borrow* the reference. Nothing needs to be done for a
189borrowed reference.
190
n191-Conversely, when a calling function passes it a reference to an  object, there
n190+Conversely, when a calling function passes in a reference to an  object, there
192are two possibilities: the function *steals* a  reference to the object, or it
193does not.  *Stealing a reference* means that when you pass a reference to a
194function, that function assumes that it now owns that reference, and you are not
195responsible for it any longer.
196
197.. index::
198   single: PyList_SetItem()
199   single: PyTuple_SetItem()
330           Py_DECREF(item); /* Discard reference ownership */
331       }
332       return total;
333   }
334
335.. index:: single: sum_sequence()
336
337
n338-.. _types:
n337+.. _api-types:
339
340Types
341-----
342
343There are few other data types that play a significant role in  the Python/C
344API; most are simple C types such as :ctype:`int`,  :ctype:`long`,
345:ctype:`double` and :ctype:`char\*`.  A few structure types  are used to
346describe static tables used to list the functions exported  by a module or the
347data attributes of a new object type, and another is used to describe the value
348of a complex number.  These will  be discussed together with the functions that
349use them.
350
351
n352-.. _exceptions:
n351+.. _api-exceptions:
353
354Exceptions
355==========
356
357The Python programmer only needs to deal with exceptions if specific  error
358handling is required; unhandled exceptions are automatically  propagated to the
359caller, then to the caller's caller, and so on, until they reach the top-level
360interpreter, where they are reported to the  user accompanied by a stack
398are not the same: the Python objects represent the last exception being handled
399by a Python  :keyword:`try` ... :keyword:`except` statement, while the C level
400exception state only exists while an exception is being passed on between C
401functions until it reaches the Python bytecode interpreter's  main loop, which
402takes care of transferring it to ``sys.exc_type`` and friends.
403
404.. index:: single: exc_info() (in module sys)
405
n406-Note that starting with Python 1.5, the preferred, thread-safe way to  access
n405+Note that starting with Python 1.5, the preferred, thread-safe way to access the
407-the exception state from Python code is to call the function
406+exception state from Python code is to call the function :func:`sys.exc_info`,
408-:func:`sys.exc_info`, which returns the per-thread exception state  for Python
407+which returns the per-thread exception state for Python code.  Also, the
409-code.  Also, the semantics of both ways to access the  exception state have
408+semantics of both ways to access the exception state have changed so that a
410-changed so that a function which catches an  exception will save and restore its
409+function which catches an exception will save and restore its thread's exception
411-thread's exception state so as to  preserve the exception state of its caller.
410+state so as to preserve the exception state of its caller.  This prevents common
412-This prevents common bugs  in exception handling code caused by an innocent-
411+bugs in exception handling code caused by an innocent-looking function
413-looking function  overwriting the exception being handled; it also reduces the
412+overwriting the exception being handled; it also reduces the often unwanted
414-often  unwanted lifetime extension for objects that are referenced by the  stack
413+lifetime extension for objects that are referenced by the stack frames in the
415-frames in the traceback.
414+traceback.
416
417As a general principle, a function that calls another function to  perform some
418task should check whether the called function raised an  exception, and if so,
419pass the exception state on to its caller.  It  should discard any object
420references that it owns, and return an  error indicator, but it should *not* set
421another exception --- that would overwrite the exception that was just raised,
422and lose important information about the exact cause of the error.
423
485
486.. index:: single: incr_item()
487
488.. index::
489   single: PyErr_ExceptionMatches()
490   single: PyErr_Clear()
491   single: Py_XDECREF()
492
n493-This example represents an endorsed use of the :keyword:`goto` statement  in C!
n492+This example represents an endorsed use of the ``goto`` statement  in C!
494It illustrates the use of :cfunc:`PyErr_ExceptionMatches` and
495:cfunc:`PyErr_Clear` to handle specific exceptions, and the use of
496:cfunc:`Py_XDECREF` to dispose of owned references that may be *NULL* (note the
497``'X'`` in the name; :cfunc:`Py_DECREF` would crash when confronted with a
498*NULL* reference).  It is important that the variables used to hold owned
499references are initialized to *NULL* for this to work; likewise, the proposed
500return value is initialized to ``-1`` (failure) and only set to success after
501the final call made is successful.
502
503
n504-.. _embedding:
n503+.. _api-embedding:
505
506Embedding Python
507================
508
509The one important task that only embedders (as opposed to extension writers) of
510the Python interpreter have to worry about is the initialization, and possibly
511the finalization, of the Python interpreter.  Most functionality of the
512interpreter can only be used after the interpreter has been initialized.
520   triple: module; search; path
521   single: path (in module sys)
522
523The basic initialization function is :cfunc:`Py_Initialize`. This initializes
524the table of loaded modules, and creates the fundamental modules
525:mod:`__builtin__`, :mod:`__main__`, :mod:`sys`, and :mod:`exceptions`.  It also
526initializes the module search path (``sys.path``).
527
n528-.. % 
529- 
530.. index:: single: PySys_SetArgv()
531
532:cfunc:`Py_Initialize` does not set the "script argument list"  (``sys.argv``).
533If this variable is needed by Python code that  will be executed later, it must
534be set explicitly with a call to  ``PySys_SetArgv(argc, argv)`` subsequent to
535the call to :cfunc:`Py_Initialize`.
536
537On most systems (in particular, on Unix and Windows, although the details are
538slightly different), :cfunc:`Py_Initialize` calculates the module search path
539based upon its best guess for the location of the standard Python interpreter
540executable, assuming that the Python library is found in a fixed location
541relative to the Python interpreter executable.  In particular, it looks for a
n542-directory named :file:`lib/python|version|` relative to the parent directory
n539+directory named :file:`lib/python{X.Y}` relative to the parent directory
543where the executable named :file:`python` is found on the shell command search
544path (the environment variable :envvar:`PATH`).
545
546For instance, if the Python executable is found in
547:file:`/usr/local/bin/python`, it will assume that the libraries are in
n548-:file:`/usr/local/lib/python|version|`.  (In fact, this particular path is also
n545+:file:`/usr/local/lib/python{X.Y}`.  (In fact, this particular path is also
549the "fallback" location, used when no executable file named :file:`python` is
550found along :envvar:`PATH`.)  The user can override this behavior by setting the
551environment variable :envvar:`PYTHONHOME`, or insert additional directories in
552front of the standard path by setting :envvar:`PYTHONPATH`.
553
554.. index::
555   single: Py_SetProgramName()
556   single: Py_GetPath()
574Python and wants to free memory allocated by Python.  This can be accomplished
575by calling :cfunc:`Py_Finalize`.  The function :cfunc:`Py_IsInitialized` returns
576true if Python is currently in the initialized state.  More information about
577these functions is given in a later chapter. Notice that :cfunc:`Py_Finalize`
578does *not* free all memory allocated by the Python interpreter, e.g. memory
579allocated by extension modules currently cannot be released.
580
581
n582-.. _debugging:
n579+.. _api-debugging:
583
584Debugging Builds
585================
586
587Python can be built with several macros to enable extra checks of the
588interpreter and extension modules.  These checks tend to add a large amount of
589overhead to the runtime so they are not enabled by default.
590
592:file:`Misc/SpecialBuilds.txt` in the Python source distribution. Builds are
593available that support tracing of reference counts, debugging the memory
594allocator, or low-level profiling of the main interpreter loop.  Only the most
595frequently-used builds will be described in the remainder of this section.
596
597Compiling the interpreter with the :cmacro:`Py_DEBUG` macro defined produces
598what is generally meant by "a debug build" of Python. :cmacro:`Py_DEBUG` is
599enabled in the Unix build by adding :option:`--with-pydebug` to the
t600-:file:`configure` command.  It is also implied by the presence of the not-
t597+:file:`configure` command.  It is also implied by the presence of the
601-Python-specific :cmacro:`_DEBUG` macro.  When :cmacro:`Py_DEBUG` is enabled in
598+not-Python-specific :cmacro:`_DEBUG` macro.  When :cmacro:`Py_DEBUG` is enabled
602-the Unix build, compiler optimization is disabled.
599+in the Unix build, compiler optimization is disabled.
603
604In addition to the reference count debugging described below, the following
605extra checks are performed:
606
607* Extra checks are added to the object allocator.
608
609* Extra checks are added to the parser and compiler.
610
Legends
Colors
 Added 
Changed
Deleted
Links
(f)irst change
(n)ext change
(t)op