py3c-dev 1.0-1 / usr / share / doc / py3c-dev / html / cheatsheet.html

This file is indexed.

/usr/share/doc/py3c-dev/html/cheatsheet.html is in py3c-dev 1.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>The py3c Cheatsheet &mdash; py3c 1.0a1 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="py3c 1.0a1 documentation" href="index.html"/>
        <link rel="next" title="Definitions in py3c" href="defs.html"/>
        <link rel="prev" title="Cleanup – Dropping Support for Python 2" href="guide-cleanup.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> py3c
          

          
          </a>

          
            
            
              <div class="version">
                1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="guide.html">Porting guide for Python C Extensions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">The py3c Cheatsheet</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#strings">Strings</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ints">Ints</a></li>
<li class="toctree-l2"><a class="reference internal" href="#floats">Floats</a></li>
<li class="toctree-l2"><a class="reference internal" href="#comparisons">Comparisons</a></li>
<li class="toctree-l2"><a class="reference internal" href="#objects-types">Objects &amp; Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-initialization">Module initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="#cobject">CObject</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="defs.html">Definitions in py3c</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">py3c reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="special-guides.html">Special Porting Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to py3c</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">py3c Changes</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">py3c</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>The py3c Cheatsheet</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/cheatsheet.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="the-py3c-cheatsheet">
<h1>The py3c Cheatsheet<a class="headerlink" href="#the-py3c-cheatsheet" title="Permalink to this headline"></a></h1>
<div class="section" id="strings">
<h2>Strings<a class="headerlink" href="#strings" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>PyStr_* – for human-readable strings</li>
<li>PyBytes_* – for binary data</li>
<li>PyUnicode_* – when you used <code class="docutils literal"><span class="pre">unicode</span></code> in Python 2</li>
<li>PyString_* – when you don’t care about Python 3 yet</li>
</ul>
<p>Use PyStr_AsUTF8AndSize to get a char* and its length.</p>
</div>
<div class="section" id="ints">
<h2>Ints<a class="headerlink" href="#ints" title="Permalink to this headline"></a></h2>
<p>Use whatever you used in Python 2. For py3-only code, use <code class="docutils literal"><span class="pre">PyLong</span></code>.</p>
</div>
<div class="section" id="floats">
<h2>Floats<a class="headerlink" href="#floats" title="Permalink to this headline"></a></h2>
<p>Don’t pass the useless second argument to <a class="reference internal" href="reference.html#c.PyFloat_FromString" title="PyFloat_FromString"><code class="xref c c-func docutils literal"><span class="pre">PyFloat_FromString()</span></code></a> as
you needed to do in Python 2.</p>
</div>
<div class="section" id="comparisons">
<h2>Comparisons<a class="headerlink" href="#comparisons" title="Permalink to this headline"></a></h2>
<p>Use <a class="reference external" href="https://www.python.org/dev/peps/pep-0207/">rich comparisons</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">static</span> <span class="n">PyObject</span><span class="o">*</span> <span class="n">mytype_richcmp</span><span class="p">(</span><span class="n">PyObject</span> <span class="o">*</span><span class="n">obj1</span><span class="p">,</span> <span class="n">PyObject</span> <span class="o">*</span><span class="n">obj2</span><span class="p">,</span> <span class="nb">int</span> <span class="n">op</span><span class="p">)</span>
<span class="p">{</span>
    <span class="k">if</span> <span class="p">(</span><span class="n">mytype_Check</span><span class="p">(</span><span class="n">obj2</span><span class="p">))</span> <span class="p">{</span>
        <span class="n">PY_RETURN_RICHCOMPARE</span><span class="p">(</span><span class="n">get_data</span><span class="p">(</span><span class="n">obj1</span><span class="p">),</span> <span class="n">get_data</span><span class="p">(</span><span class="n">obj2</span><span class="p">),</span> <span class="n">op</span><span class="p">);</span>
    <span class="p">}</span>
    <span class="n">Py_RETURN_NOTIMPLEMENTED</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">.</span><span class="n">tp_richcompare</span> <span class="o">=</span> <span class="n">mytype_richcmp</span>
</pre></div>
</div>
</div>
<div class="section" id="objects-types">
<h2>Objects &amp; Types<a class="headerlink" href="#objects-types" title="Permalink to this headline"></a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="48%" />
<col width="52%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Instead of</th>
<th class="head">use</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>obj-&gt;ob_type</td>
<td>Py_TYPE(obj)</td>
</tr>
<tr class="row-odd"><td>obj-&gt;ob_refcnt</td>
<td>Py_REFCNT(obj)</td>
</tr>
<tr class="row-even"><td>obj-&gt;ob_size</td>
<td>Py_SIZE(obj)</td>
</tr>
<tr class="row-odd"><td>PyVarObject_HEAD_INIT(NULL, 0)</td>
<td>PyObject_HEAD_INIT(NULL), 0</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="module-initialization">
<h2>Module initialization<a class="headerlink" href="#module-initialization" title="Permalink to this headline"></a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">static</span> <span class="n">struct</span> <span class="n">PyModuleDef</span> <span class="n">moduledef</span> <span class="o">=</span> <span class="p">{</span>
    <span class="n">PyModuleDef_HEAD_INIT</span><span class="p">,</span>
    <span class="o">.</span><span class="n">m_name</span> <span class="o">=</span> <span class="s2">&quot;spam&quot;</span><span class="p">,</span>
    <span class="o">.</span><span class="n">m_doc</span> <span class="o">=</span> <span class="n">PyDoc_STR</span><span class="p">(</span><span class="s2">&quot;Python wrapper for the spam submodule.&quot;</span><span class="p">),</span>
    <span class="o">.</span><span class="n">m_size</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span>
    <span class="o">.</span><span class="n">m_methods</span> <span class="o">=</span> <span class="n">spam_methods</span><span class="p">,</span>
<span class="p">};</span>

<span class="n">MODULE_INIT_FUNC</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="p">{</span>
    <span class="o">...</span>
    <span class="n">m</span> <span class="o">=</span> <span class="n">PyModule_Create</span><span class="p">(</span><span class="o">&amp;</span><span class="n">moduledef</span><span class="p">);</span>
    <span class="o">...</span>
    <span class="k">if</span> <span class="p">(</span><span class="n">error</span><span class="p">)</span> <span class="p">{</span>
        <span class="k">return</span> <span class="n">NULL</span><span class="p">;</span>
    <span class="p">}</span>
    <span class="o">...</span>
    <span class="k">return</span> <span class="n">m</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="cobject">
<h2>CObject<a class="headerlink" href="#cobject" title="Permalink to this headline"></a></h2>
<p>Use the <a class="reference external" href="https://docs.python.org/3/c-api/capsule.html#capsules">PyCapsule</a> API.
If you need to support 2.6, see the chapter <a class="reference internal" href="capsulethunk.html"><span class="doc">PyCapsule API for Python 2.6</span></a>.</p>
</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="defs.html" class="btn btn-neutral float-right" title="Definitions in py3c" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="guide-cleanup.html" class="btn btn-neutral" title="Cleanup – Dropping Support for Python 2" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, Red Hat, Inc. and/or its affiliates.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'1.0a1',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>

APT Browse - Built by Thomas Orozco.