[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / api / descriptor-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="slice-objects.html" />
<link rel="prev" href="iterator-objects.html" />
<link rel="parent" href="otherObjects.html" />
<link rel="next" href="slice-objects.html" />
<meta name='aesop' content='information' />
<title>7.5.6 Descriptor 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.5 Iterator Objects"
  href="iterator-objects.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.7 Slice Objects"
  href="slice-objects.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="iterator-objects.html">7.5.5 Iterator 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="slice-objects.html">7.5.7 Slice Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION009560000000000000000"></A><A NAME="descriptor-objects"></A>
<BR>
7.5.6 Descriptor Objects 
</H2>

<P>
``Descriptors'' are objects that describe some attribute of an object.
They are found in the dictionary of type objects.

<P>
<dl><dt>PyTypeObject <b><tt id='l2h-703' xml:id='l2h-703' class="cdata">PyProperty_Type</tt></b></dt>
<dd>
  The type object for the built-in descriptor types.
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-704' xml:id='l2h-704' class="cfunction">PyDescr_NewGetSet</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
					        PyGetSetDef *<var>getset</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-705' xml:id='l2h-705' class="cfunction">PyDescr_NewMember</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
					        PyMemberDef *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-706' xml:id='l2h-706' class="cfunction">PyDescr_NewMethod</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
                                                PyMethodDef *<var>meth</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-707' xml:id='l2h-707' class="cfunction">PyDescr_NewWrapper</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
						 struct wrapperbase *<var>wrapper</var>,
                                                 void *<var>wrapped</var>)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-708' xml:id='l2h-708' class="cfunction">PyDescr_NewClassMethod</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
						     PyMethodDef *<var>method</var>)</td></tr></table></dt>
<dd>
  
<span class="versionnote">New in version 2.3.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int&nbsp;<b><tt id='l2h-709' xml:id='l2h-709' class="cfunction">PyDescr_IsData</tt></b>(</nobr></td><td>PyObject *<var>descr</var>)</td></tr></table></dt>
<dd>
  Return true if the descriptor objects <var>descr</var> describes a data
  attribute, or false if it describes a method.  <var>descr</var> must be a
  descriptor object; there is no error checking.
  
<span class="versionnote">New in version 2.2.</span>

</dd></dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject*&nbsp;<b><tt id='l2h-710' xml:id='l2h-710' class="cfunction">PyWrapper_New</tt></b>(</nobr></td><td>PyObject *, PyObject *)</td></tr></table></dt>
<dd>
<div class="refcount-info">
  <span class="label">Return value:</span>
  <span class="value">New reference.</span>
</div>
  
<span class="versionnote">New in version 2.2.</span>

</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.5 Iterator Objects"
  href="iterator-objects.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.7 Slice Objects"
  href="slice-objects.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="iterator-objects.html">7.5.5 Iterator 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="slice-objects.html">7.5.7 Slice 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>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="api.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="api.html" title='Python/C API Reference Manual' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="slice-objects.html" />
	13	<link rel="prev" href="iterator-objects.html" />
	14	<link rel="parent" href="otherObjects.html" />
	15	<link rel="next" href="slice-objects.html" />
	16	<meta name='aesop' content='information' />
	17	<title>7.5.6 Descriptor Objects </title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="7.5.5 Iterator Objects"
	25	href="iterator-objects.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="7.5 Other Objects"
	28	href="otherObjects.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="7.5.7 Slice Objects"
	31	href="slice-objects.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python/C API Reference Manual</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><img src='../icons/blank.png'
	38	border='0' height='32' alt='' width='32' /></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="iterator-objects.html">7.5.5 Iterator Objects</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="slice-objects.html">7.5.7 Slice Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION009560000000000000000"></A><A NAME="descriptor-objects"></A>
	56	<BR>
	57	7.5.6 Descriptor Objects
	58	</H2>
	59
	60	<P>
	61	``Descriptors'' are objects that describe some attribute of an object.
	62	They are found in the dictionary of type objects.
	63
	64	<P>
65	<dl><dt>PyTypeObject <b><tt id='l2h-703' xml:id='l2h-703' class="cdata">PyProperty_Type</tt></b></dt>
66	<dd>
67	The type object for the built-in descriptor types.
68
69	<span class="versionnote">New in version 2.2.</span>
70
71	</dd></dl>
72
73	<P>
74	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-704' xml:id='l2h-704' class="cfunction">PyDescr_NewGetSet</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
75	PyGetSetDef *<var>getset</var>)</td></tr></table></dt>
76	<dd>
77	<div class="refcount-info">
78	<span class="label">Return value:</span>
79	<span class="value">New reference.</span>
80	</div>
81
82	<span class="versionnote">New in version 2.2.</span>
83
84	</dd></dl>
85
86	<P>
87	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-705' xml:id='l2h-705' class="cfunction">PyDescr_NewMember</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
88	PyMemberDef *<var>meth</var>)</td></tr></table></dt>
89	<dd>
90	<div class="refcount-info">
91	<span class="label">Return value:</span>
92	<span class="value">New reference.</span>
93	</div>
94
95	<span class="versionnote">New in version 2.2.</span>
96
97	</dd></dl>
98
99	<P>
100	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-706' xml:id='l2h-706' class="cfunction">PyDescr_NewMethod</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
101	PyMethodDef *<var>meth</var>)</td></tr></table></dt>
102	<dd>
103	<div class="refcount-info">
104	<span class="label">Return value:</span>
105	<span class="value">New reference.</span>
106	</div>
107
108	<span class="versionnote">New in version 2.2.</span>
109
110	</dd></dl>
111
112	<P>
113	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-707' xml:id='l2h-707' class="cfunction">PyDescr_NewWrapper</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
114	struct wrapperbase *<var>wrapper</var>,
115	void *<var>wrapped</var>)</td></tr></table></dt>
116	<dd>
117	<div class="refcount-info">
118	<span class="label">Return value:</span>
119	<span class="value">New reference.</span>
120	</div>
121
122	<span class="versionnote">New in version 2.2.</span>
123
124	</dd></dl>
125
126	<P>
127	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-708' xml:id='l2h-708' class="cfunction">PyDescr_NewClassMethod</tt></b>(</nobr></td><td>PyTypeObject *<var>type</var>,
128	PyMethodDef *<var>method</var>)</td></tr></table></dt>
129	<dd>
130
131	<span class="versionnote">New in version 2.3.</span>
132
133	</dd></dl>
134
135	<P>
136	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>int <b><tt id='l2h-709' xml:id='l2h-709' class="cfunction">PyDescr_IsData</tt></b>(</nobr></td><td>PyObject *<var>descr</var>)</td></tr></table></dt>
137	<dd>
138	Return true if the descriptor objects <var>descr</var> describes a data
139	attribute, or false if it describes a method. <var>descr</var> must be a
140	descriptor object; there is no error checking.
141
142	<span class="versionnote">New in version 2.2.</span>
143
144	</dd></dl>
145
146	<P>
147	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td><nobr>PyObject* <b><tt id='l2h-710' xml:id='l2h-710' class="cfunction">PyWrapper_New</tt></b>(</nobr></td><td>PyObject , PyObject )</td></tr></table></dt>
148	<dd>
149	<div class="refcount-info">
150	<span class="label">Return value:</span>
151	<span class="value">New reference.</span>
152	</div>
153
154	<span class="versionnote">New in version 2.2.</span>
155
156	</dd></dl>
157
158	<P>
159
160	<DIV CLASS="navigation">
161	<div class='online-navigation'>
162	<p></p><hr />
163	<table align="center" width="100%" cellpadding="0" cellspacing="2">
164	<tr>
165	<td class='online-navigation'><a rel="prev" title="7.5.5 Iterator Objects"
166	href="iterator-objects.html"><img src='../icons/previous.png'
167	border='0' height='32' alt='Previous Page' width='32' /></A></td>
168	<td class='online-navigation'><a rel="parent" title="7.5 Other Objects"
169	href="otherObjects.html"><img src='../icons/up.png'
170	border='0' height='32' alt='Up One Level' width='32' /></A></td>
171	<td class='online-navigation'><a rel="next" title="7.5.7 Slice Objects"
172	href="slice-objects.html"><img src='../icons/next.png'
173	border='0' height='32' alt='Next Page' width='32' /></A></td>
174	<td align="center" width="100%">Python/C API Reference Manual</td>
175	<td class='online-navigation'><a rel="contents" title="Table of Contents"
176	href="contents.html"><img src='../icons/contents.png'
177	border='0' height='32' alt='Contents' width='32' /></A></td>
178	<td class='online-navigation'><img src='../icons/blank.png'
179	border='0' height='32' alt='' width='32' /></td>
180	<td class='online-navigation'><a rel="index" title="Index"
181	href="genindex.html"><img src='../icons/index.png'
182	border='0' height='32' alt='Index' width='32' /></A></td>
183	</tr></table>
184	<div class='online-navigation'>
185	<b class="navlabel">Previous:</b>
186	<a class="sectref" rel="prev" href="iterator-objects.html">7.5.5 Iterator Objects</A>
187	<b class="navlabel">Up:</b>
188	<a class="sectref" rel="parent" href="otherObjects.html">7.5 Other Objects</A>
189	<b class="navlabel">Next:</b>
190	<a class="sectref" rel="next" href="slice-objects.html">7.5.7 Slice Objects</A>
191	</div>
192	</div>
193	<hr />
194	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
195	</DIV>
196	<!--End of Navigation Panel-->
197	<ADDRESS>
198	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
199	</ADDRESS>
200	</BODY>
201	</HTML>