Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / ref / descriptors.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="ref.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="ref.html" title='Python 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="descriptor-invocation.html" />
13<link rel="prev" href="new-style-attribute-access.html" />
14<link rel="parent" href="attribute-access.html" />
15<link rel="next" href="descriptor-invocation.html" />
16<meta name='aesop' content='information' />
17<title>3.3.2.2 Implementing Descriptors </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="3.3.2.1 More attribute access"
25 href="new-style-attribute-access.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="3.3.2 Customizing attribute access"
28 href="attribute-access.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="3.3.2.3 Invoking Descriptors"
31 href="descriptor-invocation.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 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="new-style-attribute-access.html">3.3.2.1 More attribute access</A>
46<b class="navlabel">Up:</b>
47<a class="sectref" rel="parent" href="attribute-access.html">3.3.2 Customizing attribute access</A>
48<b class="navlabel">Next:</b>
49<a class="sectref" rel="next" href="descriptor-invocation.html">3.3.2.3 Invoking Descriptors</A>
50</div>
51<hr /></div>
52</DIV>
53<!--End of Navigation Panel-->
54
55<H3><A NAME="SECTION005322000000000000000"></A><A NAME="descriptors"></A>
56<BR>
573.3.2.2 Implementing Descriptors
58</H3>
59
60<P>
61The following methods only apply when an instance of the class
62containing the method (a so-called <em>descriptor</em> class) appears in
63the class dictionary of another new-style class, known as the
64<em>owner</em> class. In the examples below, ``the attribute'' refers to
65the attribute whose name is the key of the property in the owner
66class' <code>__dict__</code>. Descriptors can only be implemented as
67new-style classes themselves.
68
69<P>
70<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
71 <td><nobr><b><tt id='l2h-214' xml:id='l2h-214' class="method">__get__</tt></b>(</nobr></td>
72 <td><var>self, instance, owner</var>)</td></tr></table></dt>
73<dd>
74Called to get the attribute of the owner class (class attribute access)
75or of an instance of that class (instance attribute access).
76<var>owner</var> is always the owner class, while <var>instance</var> is the
77instance that the attribute was accessed through, or <code>None</code> when
78the attribute is accessed through the <var>owner</var>. This method should
79return the (computed) attribute value or raise an
80<tt class="exception">AttributeError</tt> exception.
81</dl>
82
83<P>
84<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
85 <td><nobr><b><tt id='l2h-215' xml:id='l2h-215' class="method">__set__</tt></b>(</nobr></td>
86 <td><var>self, instance, value</var>)</td></tr></table></dt>
87<dd>
88Called to set the attribute on an instance <var>instance</var> of the owner
89class to a new value, <var>value</var>.
90</dl>
91
92<P>
93<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
94 <td><nobr><b><tt id='l2h-216' xml:id='l2h-216' class="method">__delete__</tt></b>(</nobr></td>
95 <td><var>self, instance</var>)</td></tr></table></dt>
96<dd>
97Called to delete the attribute on an instance <var>instance</var> of the
98owner class.
99</dl>
100
101<P>
102
103<DIV CLASS="navigation">
104<div class='online-navigation'>
105<p></p><hr />
106<table align="center" width="100%" cellpadding="0" cellspacing="2">
107<tr>
108<td class='online-navigation'><a rel="prev" title="3.3.2.1 More attribute access"
109 href="new-style-attribute-access.html"><img src='../icons/previous.png'
110 border='0' height='32' alt='Previous Page' width='32' /></A></td>
111<td class='online-navigation'><a rel="parent" title="3.3.2 Customizing attribute access"
112 href="attribute-access.html"><img src='../icons/up.png'
113 border='0' height='32' alt='Up One Level' width='32' /></A></td>
114<td class='online-navigation'><a rel="next" title="3.3.2.3 Invoking Descriptors"
115 href="descriptor-invocation.html"><img src='../icons/next.png'
116 border='0' height='32' alt='Next Page' width='32' /></A></td>
117<td align="center" width="100%">Python Reference Manual</td>
118<td class='online-navigation'><a rel="contents" title="Table of Contents"
119 href="contents.html"><img src='../icons/contents.png'
120 border='0' height='32' alt='Contents' width='32' /></A></td>
121<td class='online-navigation'><img src='../icons/blank.png'
122 border='0' height='32' alt='' width='32' /></td>
123<td class='online-navigation'><a rel="index" title="Index"
124 href="genindex.html"><img src='../icons/index.png'
125 border='0' height='32' alt='Index' width='32' /></A></td>
126</tr></table>
127<div class='online-navigation'>
128<b class="navlabel">Previous:</b>
129<a class="sectref" rel="prev" href="new-style-attribute-access.html">3.3.2.1 More attribute access</A>
130<b class="navlabel">Up:</b>
131<a class="sectref" rel="parent" href="attribute-access.html">3.3.2 Customizing attribute access</A>
132<b class="navlabel">Next:</b>
133<a class="sectref" rel="next" href="descriptor-invocation.html">3.3.2.3 Invoking Descriptors</A>
134</div>
135</div>
136<hr />
137<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
138</DIV>
139<!--End of Navigation Panel-->
140<ADDRESS>
141See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
142</ADDRESS>
143</BODY>
144</HTML>