-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
sharing.html
201 lines (198 loc) · 10.4 KB
/
sharing.html
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
<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Mozilla/4.61 (Macintosh; I; PPC) [Netscape]"><title>Sharing Declarations Between Cython Modules</title></head>
<body>
<h1> <hr width="100%">Sharing Declarations Between Cython Modules
<hr width="100%"></h1>
This section describes a new set of facilities introduced in Cython 0.8
for making C declarations and extension types in one Cython module available
for use in another Cython module. These facilities are closely modelled on
the Python import mechanism, and can be thought of as a compile-time version
of it.
<h2> Contents</h2>
<ul>
<li> <a href="#DefAndImpFiles">Definition and Implementation files</a></li>
<ul>
<li> <a href="#WhatDefFileContains">What a Definition File contains</a></li>
<li> <a href="#WhatImpFileContains">What an Implementation File contains</a></li>
</ul>
<li> <a href="#CImportStatement">The <tt>cimport</tt> statement</a></li>
<ul>
<li> <a href="#SearchPaths">Search paths for definition files</a></li>
<li> <a href="#ResolvingNamingConflicts">Using <tt>cimport</tt> to resolve
naming conflicts</a></li>
</ul>
<li> <a href="#SharingExtensionTypes">Sharing extension types</a></li>
</ul>
<h2> <a name="DefAndImpFiles"></a>Definition and Implementation files</h2>
A Cython module can be split into two parts: a <i>definition file</i> with
a <tt>.pxd</tt> suffix, containing C declarations that are to be available
to other Cython modules, and an <i>implementation file</i> with a <tt>.pyx</tt>
suffix, containing everything else. When a module wants to use something
declared in another module's definition file, it imports it using the <a href="#CImportStatement"><b>cimport</b> statement</a>.
<h3> <a name="WhatDefFileContains"></a>What a Definition File contains</h3>
A definition file can contain:
<ul>
<li> Any kind of C type declaration.</li>
<li> <b>extern</b> C function or variable declarations.</li>
<li> The definition part of an extension type (<a href="#SharingExtensionTypes">see below</a>).</li>
</ul>
It cannot currently contain any non-extern C function or variable declarations
(although this may be possible in a future version).
<p>It cannot contain the implementations of any C or Python functions, or
any Python class definitions, or any executable statements. </p>
<blockquote>NOTE: You don't need to (and shouldn't) declare anything in a
declaration file <b>public</b> in order to make it available to other Cython
modules; its mere presence in a definition file does that. You only need a
public declaration if you want to make something available to external C code.</blockquote>
<h3> <a name="WhatImpFileContains"></a>What an Implementation File contains</h3>
An implementation file can contain any kind of Cython statement, although
there are some restrictions on the implementation part of an extension type
if the corresponding definition file also defines that type (see below).
<h2> <a name="CImportStatement"></a>The <tt>cimport</tt> statement</h2>
The <b>cimport</b> statement is used in a definition or implementation
file to gain access to names declared in another definition file. Its syntax
exactly parallels that of the normal Python import statement:
<blockquote><tt>cimport </tt><i>module</i><tt> [, </tt><i>module</i><tt>...]</tt></blockquote>
<blockquote><tt>from </tt><i>module</i><tt> cimport </tt><i>name</i><tt>
[as </tt><i>name</i><tt>] [, </tt><i>name</i><tt> [as </tt><i>name</i><tt>]
...]</tt></blockquote>
Here is an example. The file on the left is a definition file which exports
a C data type. The file on the right is an implementation file which imports
and uses it. <br>
<table cellpadding="5" cols="2" width="100%">
<tbody>
<tr>
<td bgcolor="#ffcc00" width="40%"><b><tt>dishes.pxd</tt></b></td>
<td bgcolor="#5dbaca"><b><tt>restaurant.pyx</tt></b></td>
</tr>
<tr align="left" valign="top">
<td bgcolor="#ffcc18" width="40%"><tt>cdef enum otherstuff:</tt> <br>
<tt> sausage, eggs, lettuce</tt> <p><tt>cdef struct spamdish:</tt> <br>
<tt> int oz_of_spam</tt> <br>
<tt> otherstuff filler</tt></p>
</td>
<td bgcolor="#5dbaca"><tt>cimport dishes</tt> <br>
<tt>from dishes cimport spamdish</tt> <p><tt>cdef void prepare(spamdish *d):</tt> <br>
<tt> d.oz_of_spam = 42</tt> <br>
<tt> d.filler = dishes.sausage</tt> </p>
<p><tt>def serve():</tt> <br>
<tt> spamdish d</tt> <br>
<tt> prepare(&d)</tt> <br>
<tt> print "%d oz spam, filler no. %d" % \</tt>
<br>
<tt> (d->oz_of_spam,
d->otherstuff)</tt></p>
</td>
</tr>
</tbody> </table>
<p>It is important to understand that the <b>cimport</b> statement can <i>only</i>
be used to import C data types, external C functions and variables, and extension
types. It cannot be used to import any Python objects, and (with one exception)
it doesn't imply any Python import at run time. If you want to refer to any
Python names from a module that you have cimported, you will have to include
a regular <b>import</b> statement for it as well. </p>
<p>The exception is that when you use <b>cimport</b> to import an extension
type, its type object is imported at run time and made available by the
name under which you imported it. Using <b>cimport</b> to import extension
types is covered in more detail <a href="#SharingExtensionTypes">below</a>.
</p>
<h3> <a name="SearchPaths"></a>Search paths for definition files</h3>
When you <b>cimport</b> a module called <tt>modulename</tt>, the Cython
compiler searches for a file called <tt>modulename.pxd</tt> along the search
path for include files, as specified by <b>-I</b> command line options.
<p>Also, whenever you compile a file <tt>modulename.pyx</tt>, the corresponding
definition file <tt>modulename.pxd</tt> is first searched for along the
same path, and if found, it is processed before processing the <tt>.pyx</tt>
file. </p>
<h3> <a name="ResolvingNamingConflicts"></a>Using cimport to resolve naming
conflicts</h3>
The cimport mechanism provides a clean and simple way to solve the problem
of wrapping external C functions with Python functions of the same name.
All you need to do is put the extern C declarations into a .pxd file for
an imaginary module, and cimport that module. You can then refer to the C
functions by qualifying them with the name of the module. Here's an example:
<br>
<table cellpadding="5" cols="2" width="100%">
<tbody>
<tr>
<td bgcolor="#ffcc00" width="50%"><b><tt>c_lunch.pxd</tt></b></td>
<td bgcolor="#5dbaca"><b><tt>lunch.pyx</tt></b></td>
</tr>
<tr align="left" valign="top">
<td bgcolor="#ffcc18" width="50%"><tt>cdef extern from "lunch.h":</tt>
<br>
<tt> void eject_tomato(float)</tt></td>
<td bgcolor="#5dbaca"><tt>cimport c_lunch</tt> <p><tt>def eject_tomato(float speed):</tt> <br>
<tt> c_lunch.eject_tomato(speed)</tt></p>
</td>
</tr>
</tbody> </table>
<p>You don't need any <tt>c_lunch.pyx</tt> file, because the only things
defined in <tt>c_lunch.pxd</tt> are extern C entities. There won't be any
actual <tt>c_lunch</tt> module at run time, but that doesn't matter -- <tt>c_lunch</tt>
has done its job of providing an additional namespace at compile time. </p>
<h2> <a name="SharingExtensionTypes"></a>Sharing Extension Types</h2>
An extension type declaration can also be split into two parts, one in
a definition file and the other in the corresponding implementation file.
<br>
<br>
The definition part of the extension type can only declare C attributes
and C methods, not Python methods, and it must declare <i>all</i> of that
type's C attributes and C methods.<br>
<br>
The implementation part must implement all of the C methods declared in
the definition part, and may not add any further C attributes. It may also
define Python methods.
<p>Here is an example of a module which defines and exports an extension
type, and another module which uses it. <br>
<table cellpadding="5" cols="2" width="100%">
<tbody>
<tr>
<td bgcolor="#ffcc18" width="30%"><b><tt>Shrubbing.pxd</tt></b></td>
<td bgcolor="#5dbaca" width="50%"><b><tt>Shrubbing.pyx</tt></b></td>
</tr>
<tr align="left" valign="top">
<td bgcolor="#ffcc18" width="30%"><tt>cdef class Shrubbery:</tt> <br>
<tt> cdef int width</tt> <br>
<tt> cdef int length</tt></td>
<td bgcolor="#5dbaca" width="50%"><tt>cdef class Shrubbery:</tt> <br>
<tt> def __new__(self, int w, int l):</tt> <br>
<tt> self.width = w</tt>
<br>
<tt> self.length = l</tt>
<p><tt>def standard_shrubbery():</tt> <br>
<tt> return Shrubbery(3, 7)</tt></p>
</td>
</tr>
<tr>
<td colspan="2" bgcolor="#8cbc1c" width="30%"><b><tt>Landscaping.pyx</tt></b></td>
</tr>
<tr>
<td colspan="2" bgcolor="#99cc00" width="30%"><tt>cimport Shrubbing</tt>
<br>
<tt>import Shrubbing</tt> <p><tt>cdef Shrubbing.Shrubbery sh</tt> <br>
<tt>sh = Shrubbing.standard_shrubbery()</tt> <br>
<tt>print "Shrubbery size is %d x %d" % (sh.width, sh.height)</tt>
<br>
</p>
</td>
</tr>
</tbody> </table>
</p>
<p>Some things to note about this example: </p>
<ul>
<li> There is a <tt>cdef class Shrubbery</tt> declaration in both Shrubbing.pxd
and Shrubbing.pyx. When the Shrubbing module is compiled, these two declarations
are combined into one.</li>
<li> In Landscaping.pyx, the <tt>cimport Shrubbing</tt> declaration
allows us to refer to the Shrubbery type as <tt>Shrubbing.Shrubbery</tt>.
But it doesn't bind the name <tt>Shrubbery</tt> in Landscaping's module namespace
at run time, so to access <tt>Shrubbery.standard_shrubbery</tt> we also
need to <tt>import Shrubbing</tt>.</li>
</ul>
<hr width="100%">Back to the <a href="overview.html">Language Overview</a>
<br>
<br>
</body></html>