sam-t2/devtools/v9/html/python/api/method-objects.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="moduleObjects.html" />
<link rel="prev" href="instanceObjects.html" />
<link rel="parent" href="otherObjects.html" />
<link rel="next" href="moduleObjects.html" />
<meta name='aesop' content='information' />
<title>7.5.3 Method Objects </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="7.5.2 Instance Objects"
  href="instanceObjects.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="7.5 Other Objects"
  href="otherObjects.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="7.5.4 Module Objects"
  href="moduleObjects.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="instanceObjects.html">7.5.2 Instance Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="moduleObjects.html">7.5.4 Module Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION009530000000000000000"></A><A NAME="method-objects"></A>
<BR>
7.5.3 Method Objects
</H2>

<P>
<a id='l2h-660' xml:id='l2h-660'></a>There are some useful functions that are useful for working with
method objects.

<P>
<dl><dt>PyTypeObject <b><tt id='l2h-661' xml:id='l2h-661' class="cdata">PyMethod_Type</tt></b></dt>
<dd>
  This instance of <tt class="ctype">PyTypeObject</tt> represents the Python method
  type.  This is exposed to Python programs as <code>types.MethodType</code>.
  <a id='l2h-663' xml:id='l2h-663'></a></dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int&nbsp;<b><tt id='l2h-664' xml:id='l2h-664' class="cfunction">PyMethod_Check</tt></b>(</nobr></td><td>PyObject *<var>o</var>)</td></tr></table></dt>
<dd>
  Return true if <var>o</var> is a method object (has type
  <tt class="cdata">PyMethod_Type</tt>).  The parameter must not be <tt class="constant">NULL</tt>.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-665' xml:id='l2h-665' class="cfunction">PyMethod_New</tt></b>(</nobr></td><td>PyObject *func.
                                           PyObject *<var>self</var>, PyObject *<var>class</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  Return a new method object, with <var>func</var> being any callable
  object; this is the function that will be called when the method is
  called.  If this method should be bound to an instance, <var>self</var>
  should be the instance and <var>class</var> should be the class of
  <var>self</var>, otherwise <var>self</var> should be <tt class="constant">NULL</tt> and <var>class</var>
  should be the class which provides the unbound method..
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-666' xml:id='l2h-666' class="cfunction">PyMethod_Class</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Return the class object from which the method <var>meth</var> was
  created; if this was created from an instance, it will be the class
  of the instance.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-667' xml:id='l2h-667' class="cfunction">PyMethod_GET_CLASS</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Macro version of <tt class="cfunction">PyMethod_Class()</tt> which avoids error
  checking.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-668' xml:id='l2h-668' class="cfunction">PyMethod_Function</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Return the function object associated with the method <var>meth</var>.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-669' xml:id='l2h-669' class="cfunction">PyMethod_GET_FUNCTION</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Macro version of <tt class="cfunction">PyMethod_Function()</tt> which avoids error
  checking.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-670' xml:id='l2h-670' class="cfunction">PyMethod_Self</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Return the instance associated with the method <var>meth</var> if it is
  bound, otherwise return <tt class="constant">NULL</tt>.
</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-671' xml:id='l2h-671' class="cfunction">PyMethod_GET_SELF</tt></b>(</nobr></td><td>PyObject *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">Borrowed reference.</span>
</div>
  Macro version of <tt class="cfunction">PyMethod_Self()</tt> which avoids error
  checking.
</dd></dl>

<P>

<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="7.5.2 Instance Objects"
  href="instanceObjects.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="7.5 Other Objects"
  href="otherObjects.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="7.5.4 Module Objects"
  href="moduleObjects.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="instanceObjects.html">7.5.2 Instance Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="moduleObjects.html">7.5.4 Module Objects</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>