sam-t2/devtools/v9/html/python/api/countingRefs.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="api.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="api.html" title='Python/C API Reference Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="exceptionHandling.html" />
<link rel="prev" href="veryhigh.html" />
<link rel="parent" href="api.html" />
<link rel="next" href="exceptionHandling.html" />
<meta name='aesop' content='information' />
<title>3. Reference Counting </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2. The Very High"
  href="veryhigh.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
  href="api.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4. Exception Handling"
  href="exceptionHandling.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="veryhigh.html">2. The Very High</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="exceptionHandling.html">4. Exception Handling</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION005000000000000000000"></A><A NAME="countingRefs"></A>
<BR>
3. Reference Counting
</H1>

<P>
The macros in this section are used for managing reference counts
of Python objects.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void&nbsp;<b><tt id='l2h-84' xml:id='l2h-84' class="cfunction">Py_INCREF</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Increment the reference count for object <var>o</var>.  The object must
  not be <tt class="constant">NULL</tt>; if you aren't sure that it isn't <tt class="constant">NULL</tt>, use
  <tt class="cfunction">Py_XINCREF()</tt>.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void&nbsp;<b><tt id='l2h-85' xml:id='l2h-85' class="cfunction">Py_XINCREF</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Increment the reference count for object <var>o</var>.  The object may be
  <tt class="constant">NULL</tt>, in which case the macro has no effect.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void&nbsp;<b><tt id='l2h-86' xml:id='l2h-86' class="cfunction">Py_DECREF</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Decrement the reference count for object <var>o</var>.  The object must
  not be <tt class="constant">NULL</tt>; if you aren't sure that it isn't <tt class="constant">NULL</tt>, use
  <tt class="cfunction">Py_XDECREF()</tt>.  If the reference count reaches zero, the
  object's type's deallocation function (which must not be <tt class="constant">NULL</tt>) is
  invoked.

<P>
<span class="warning"><b class="label">Warning:</b>
The deallocation function can cause arbitrary Python code
  to be invoked (e.g. when a class instance with a <tt class="method">__del__()</tt>
  method is deallocated).  While exceptions in such code are not
  propagated, the executed code has free access to all Python global
  variables.  This means that any object that is reachable from a
  global variable should be in a consistent state before
  <tt class="cfunction">Py_DECREF()</tt> is invoked.  For example, code to delete an
  object from a list should copy a reference to the deleted object in
  a temporary variable, update the list data structure, and then call
  <tt class="cfunction">Py_DECREF()</tt> for the temporary variable.</span>
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void&nbsp;<b><tt id='l2h-87' xml:id='l2h-87' class="cfunction">Py_XDECREF</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Decrement the reference count for object <var>o</var>.  The object may be
  <tt class="constant">NULL</tt>, in which case the macro has no effect; otherwise the effect
  is the same as for <tt class="cfunction">Py_DECREF()</tt>, and the same warning
  applies.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>void&nbsp;<b><tt id='l2h-88' xml:id='l2h-88' class="cfunction">Py_CLEAR</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Decrement the reference count for object <var>o</var>.  The object may be
  <tt class="constant">NULL</tt>, in which case the macro has no effect; otherwise the effect
  is the same as for <tt class="cfunction">Py_DECREF()</tt>, except that the argument
  is also set to <tt class="constant">NULL</tt>.  The warning for <tt class="cfunction">Py_DECREF()</tt> does
  not apply with respect to the object passed because the macro
  carefully uses a temporary variable and sets the argument to <tt class="constant">NULL</tt>
  before decrementing its reference count.

<P>
It is a good idea to use this macro whenever decrementing the value
  of a variable that might be traversed during garbage collection.

<P>

<span class="versionnote">New in version 2.4.</span>

</dd></dl>

<P>
The following functions are for runtime dynamic embedding of Python:
<tt class="cfunction">Py_IncRef(PyObject *o)</tt>, <tt class="cfunction">Py_DecRef(PyObject *o)</tt>.
They are simply exported function versions of <tt class="cfunction">Py_XINCREF()</tt> and
<tt class="cfunction">Py_XDECREF()</tt>, respectively.

<P>
The following functions or macros are only for use within the
interpreter core: <tt class="cfunction">_Py_Dealloc()</tt>,
<tt class="cfunction">_Py_ForgetReference()</tt>, <tt class="cfunction">_Py_NewReference()</tt>, as
well as the global variable <tt class="cdata">_Py_RefTotal</tt>.

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="2. The Very High"
  href="veryhigh.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Python/C API Reference Manual"
  href="api.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4. Exception Handling"
  href="exceptionHandling.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="veryhigh.html">2. The Very High</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="api.html">Python/C API Reference Manual</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="exceptionHandling.html">4. Exception Handling</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>