← Back to branch summary

~dkuhlman/python-training-materials/Materials

« back to all changes in this revision

Viewing changes to python-2.7.11-docs-html/c-api/descriptor.html

  • Committer: Dave Kuhlman
  • Date: 2017-04-15 16:24:56 UTC
  • Revision ID: dkuhlman@davekuhlman.org-20170415162456-iav9vozzg4iwqwv3
Updated docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
python-2.7.11-docs-html/c-api/descriptor.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
 
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
 
 
4
 
 
5
 
<html xmlns="http://www.w3.org/1999/xhtml">
6
 
  <head>
7
 
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
 
    
9
 
    <title>Descriptor Objects &mdash; Python 2.7.11 documentation</title>
10
 
    
11
 
    <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
12
 
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13
 
    
14
 
    <script type="text/javascript">
15
 
      var DOCUMENTATION_OPTIONS = {
16
 
        URL_ROOT:    '../',
17
 
        VERSION:     '2.7.11',
18
 
        COLLAPSE_INDEX: false,
19
 
        FILE_SUFFIX: '.html',
20
 
        HAS_SOURCE:  true
21
 
      };
22
 
    </script>
23
 
    <script type="text/javascript" src="../_static/jquery.js"></script>
24
 
    <script type="text/javascript" src="../_static/underscore.js"></script>
25
 
    <script type="text/javascript" src="../_static/doctools.js"></script>
26
 
    <script type="text/javascript" src="../_static/sidebar.js"></script>
27
 
    <link rel="search" type="application/opensearchdescription+xml"
28
 
          title="Search within Python 2.7.11 documentation"
29
 
          href="../_static/opensearch.xml"/>
30
 
    <link rel="author" title="About these documents" href="../about.html" />
31
 
    <link rel="copyright" title="Copyright" href="../copyright.html" />
32
 
    <link rel="top" title="Python 2.7.11 documentation" href="../contents.html" />
33
 
    <link rel="up" title="Concrete Objects Layer" href="concrete.html" />
34
 
    <link rel="next" title="Slice Objects" href="slice.html" />
35
 
    <link rel="prev" title="Iterator Objects" href="iterator.html" />
36
 
    <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
37
 
    <script type="text/javascript" src="../_static/copybutton.js"></script>
38
 
    <script type="text/javascript" src="../_static/version_switch.js"></script>
39
 
 
40
 
    
41
 
 
42
 
  </head>
43
 
  <body role="document">  
44
 
    <div class="related" role="navigation" aria-label="related navigation">
45
 
      <h3>Navigation</h3>
46
 
      <ul>
47
 
        <li class="right" style="margin-right: 10px">
48
 
          <a href="../genindex.html" title="General Index"
49
 
             accesskey="I">index</a></li>
50
 
        <li class="right" >
51
 
          <a href="../py-modindex.html" title="Python Module Index"
52
 
             >modules</a> |</li>
53
 
        <li class="right" >
54
 
          <a href="slice.html" title="Slice Objects"
55
 
             accesskey="N">next</a> |</li>
56
 
        <li class="right" >
57
 
          <a href="iterator.html" title="Iterator Objects"
58
 
             accesskey="P">previous</a> |</li>
59
 
        <li><img src="../_static/py.png" alt=""
60
 
                 style="vertical-align: middle; margin-top: -1px"/></li>
61
 
        <li><a href="https://www.python.org/">Python</a> &raquo;</li>
62
 
        <li>
63
 
          <span class="version_switcher_placeholder">2.7.11</span>
64
 
          <a href="../index.html">Documentation</a> &raquo;
65
 
        </li>
66
 
 
67
 
          <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &raquo;</li>
68
 
          <li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> &raquo;</li> 
69
 
      </ul>
70
 
    </div>    
71
 
 
72
 
    <div class="document">
73
 
      <div class="documentwrapper">
74
 
        <div class="bodywrapper">
75
 
          <div class="body" role="main">
76
 
            
77
 
  <div class="section" id="descriptor-objects">
78
 
<span id="id1"></span><h1>Descriptor Objects<a class="headerlink" href="#descriptor-objects" title="Permalink to this headline">¶</a></h1>
79
 
<p>&#8220;Descriptors&#8221; are objects that describe some attribute of an object. They are
80
 
found in the dictionary of type objects.</p>
81
 
<dl class="var">
82
 
<dt id="c.PyProperty_Type">
83
 
<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> <code class="descname">PyProperty_Type</code><a class="headerlink" href="#c.PyProperty_Type" title="Permalink to this definition">¶</a></dt>
84
 
<dd><p>The type object for the built-in descriptor types.</p>
85
 
<div class="versionadded">
86
 
<p><span class="versionmodified">New in version 2.2.</span></p>
87
 
</div>
88
 
</dd></dl>
89
 
 
90
 
<dl class="function">
91
 
<dt id="c.PyDescr_NewGetSet">
92
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyDescr_NewGetSet</code><span class="sig-paren">(</span><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a><em>&nbsp;*type</em>, struct PyGetSetDef<em>&nbsp;*getset</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_NewGetSet" title="Permalink to this definition">¶</a></dt>
93
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
94
 
<p><span class="versionmodified">New in version 2.2.</span></p>
95
 
</div>
96
 
</dd></dl>
97
 
 
98
 
<dl class="function">
99
 
<dt id="c.PyDescr_NewMember">
100
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyDescr_NewMember</code><span class="sig-paren">(</span><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a><em>&nbsp;*type</em>, struct <a class="reference internal" href="structures.html#c.PyMemberDef" title="PyMemberDef">PyMemberDef</a><em>&nbsp;*meth</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_NewMember" title="Permalink to this definition">¶</a></dt>
101
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
102
 
<p><span class="versionmodified">New in version 2.2.</span></p>
103
 
</div>
104
 
</dd></dl>
105
 
 
106
 
<dl class="function">
107
 
<dt id="c.PyDescr_NewMethod">
108
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyDescr_NewMethod</code><span class="sig-paren">(</span><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a><em>&nbsp;*type</em>, struct <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a><em>&nbsp;*meth</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_NewMethod" title="Permalink to this definition">¶</a></dt>
109
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
110
 
<p><span class="versionmodified">New in version 2.2.</span></p>
111
 
</div>
112
 
</dd></dl>
113
 
 
114
 
<dl class="function">
115
 
<dt id="c.PyDescr_NewWrapper">
116
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyDescr_NewWrapper</code><span class="sig-paren">(</span><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a><em>&nbsp;*type</em>, struct wrapperbase<em>&nbsp;*wrapper</em>, void<em>&nbsp;*wrapped</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_NewWrapper" title="Permalink to this definition">¶</a></dt>
117
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
118
 
<p><span class="versionmodified">New in version 2.2.</span></p>
119
 
</div>
120
 
</dd></dl>
121
 
 
122
 
<dl class="function">
123
 
<dt id="c.PyDescr_NewClassMethod">
124
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyDescr_NewClassMethod</code><span class="sig-paren">(</span><a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a><em>&nbsp;*type</em>, <a class="reference internal" href="structures.html#c.PyMethodDef" title="PyMethodDef">PyMethodDef</a><em>&nbsp;*method</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_NewClassMethod" title="Permalink to this definition">¶</a></dt>
125
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
126
 
<p><span class="versionmodified">New in version 2.3.</span></p>
127
 
</div>
128
 
</dd></dl>
129
 
 
130
 
<dl class="function">
131
 
<dt id="c.PyDescr_IsData">
132
 
int <code class="descname">PyDescr_IsData</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*descr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyDescr_IsData" title="Permalink to this definition">¶</a></dt>
133
 
<dd><p>Return true if the descriptor objects <em>descr</em> describes a data attribute, or
134
 
false if it describes a method.  <em>descr</em> must be a descriptor object; there is
135
 
no error checking.</p>
136
 
<div class="versionadded">
137
 
<p><span class="versionmodified">New in version 2.2.</span></p>
138
 
</div>
139
 
</dd></dl>
140
 
 
141
 
<dl class="function">
142
 
<dt id="c.PyWrapper_New">
143
 
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a>* <code class="descname">PyWrapper_New</code><span class="sig-paren">(</span><a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*</em>, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a><em>&nbsp;*</em><span class="sig-paren">)</span><a class="headerlink" href="#c.PyWrapper_New" title="Permalink to this definition">¶</a></dt>
144
 
<dd><em class="refcount">Return value: New reference.</em><div class="versionadded">
145
 
<p><span class="versionmodified">New in version 2.2.</span></p>
146
 
</div>
147
 
</dd></dl>
148
 
 
149
 
</div>
150
 
 
151
 
 
152
 
          </div>
153
 
        </div>
154
 
      </div>
155
 
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
156
 
        <div class="sphinxsidebarwrapper">
157
 
  <h4>Previous topic</h4>
158
 
  <p class="topless"><a href="iterator.html"
159
 
                        title="previous chapter">Iterator Objects</a></p>
160
 
  <h4>Next topic</h4>
161
 
  <p class="topless"><a href="slice.html"
162
 
                        title="next chapter">Slice Objects</a></p>
163
 
<h3>This Page</h3>
164
 
<ul class="this-page-menu">
165
 
  <li><a href="../bugs.html">Report a Bug</a></li>
166
 
  <li><a href="../_sources/c-api/descriptor.txt"
167
 
         rel="nofollow">Show Source</a></li>
168
 
</ul>
169
 
 
170
 
<div id="searchbox" style="display: none" role="search">
171
 
  <h3>Quick search</h3>
172
 
    <form class="search" action="../search.html" method="get">
173
 
      <input type="text" name="q" />
174
 
      <input type="submit" value="Go" />
175
 
      <input type="hidden" name="check_keywords" value="yes" />
176
 
      <input type="hidden" name="area" value="default" />
177
 
    </form>
178
 
    <p class="searchtip" style="font-size: 90%">
179
 
    Enter search terms or a module, class or function name.
180
 
    </p>
181
 
</div>
182
 
<script type="text/javascript">$('#searchbox').show(0);</script>
183
 
        </div>
184
 
      </div>
185
 
      <div class="clearer"></div>
186
 
    </div>  
187
 
    <div class="related" role="navigation" aria-label="related navigation">
188
 
      <h3>Navigation</h3>
189
 
      <ul>
190
 
        <li class="right" style="margin-right: 10px">
191
 
          <a href="../genindex.html" title="General Index"
192
 
             >index</a></li>
193
 
        <li class="right" >
194
 
          <a href="../py-modindex.html" title="Python Module Index"
195
 
             >modules</a> |</li>
196
 
        <li class="right" >
197
 
          <a href="slice.html" title="Slice Objects"
198
 
             >next</a> |</li>
199
 
        <li class="right" >
200
 
          <a href="iterator.html" title="Iterator Objects"
201
 
             >previous</a> |</li>
202
 
        <li><img src="../_static/py.png" alt=""
203
 
                 style="vertical-align: middle; margin-top: -1px"/></li>
204
 
        <li><a href="https://www.python.org/">Python</a> &raquo;</li>
205
 
        <li>
206
 
          <span class="version_switcher_placeholder">2.7.11</span>
207
 
          <a href="../index.html">Documentation</a> &raquo;
208
 
        </li>
209
 
 
210
 
          <li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &raquo;</li>
211
 
          <li class="nav-item nav-item-2"><a href="concrete.html" >Concrete Objects Layer</a> &raquo;</li> 
212
 
      </ul>
213
 
    </div>  
214
 
    <div class="footer">
215
 
    &copy; <a href="../copyright.html">Copyright</a> 1990-2016, Python Software Foundation.
216
 
    <br />
217
 
    The Python Software Foundation is a non-profit corporation.
218
 
    <a href="https://www.python.org/psf/donations/">Please donate.</a>
219
 
    <br />
220
 
    Last updated on Jan 23, 2016.
221
 
    <a href="../bugs.html">Found a bug</a>?
222
 
    <br />
223
 
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.
224
 
    </div>
225
 
 
226
 
  </body>
227
 
</html>
 
 
b'\\ No newline at end of file'