Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Gwenaël Samain
cython
Commits
4104a516
Commit
4104a516
authored
Feb 13, 2013
by
Stefan Behnel
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add tutorial section on naming C function parameters
parent
b53ae497
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
49 additions
and
3 deletions
+49
-3
docs/src/tutorial/clibraries.rst
docs/src/tutorial/clibraries.rst
+6
-0
docs/src/tutorial/external.rst
docs/src/tutorial/external.rst
+43
-3
No files found.
docs/src/tutorial/clibraries.rst
View file @
4104a516
...
@@ -77,6 +77,12 @@ use in your code or in other declarations, so that Cython gets to see
...
@@ -77,6 +77,12 @@ use in your code or in other declarations, so that Cython gets to see
a
sufficient
and
consistent
subset
of
them
.
Then
,
consider
adapting
a
sufficient
and
consistent
subset
of
them
.
Then
,
consider
adapting
them
somewhat
to
make
them
more
comfortable
to
work
with
in
Cython
.
them
somewhat
to
make
them
more
comfortable
to
work
with
in
Cython
.
Specifically
,
you
should
take
care
of
choosing
good
argument
names
for
the
C
functions
,
as
Cython
allows
you
to
pass
them
as
keyword
arguments
.
Changing
them
later
on
is
a
backwards
incompatible
API
modification
.
Choosing
good
names
right
away
will
make
these
functions
more
pleasant
to
work
with
from
Cython
code
.
One
noteworthy
difference
to
the
header
file
that
we
use
above
is
the
One
noteworthy
difference
to
the
header
file
that
we
use
above
is
the
declaration
of
the
``
Queue
``
struct
in
the
first
line
.
``
Queue
``
is
declaration
of
the
``
Queue
``
struct
in
the
first
line
.
``
Queue
``
is
in
this
case
used
as
an
*
opaque
handle
*;
only
the
library
that
is
in
this
case
used
as
an
*
opaque
handle
*;
only
the
library
that
is
...
...
docs/src/tutorial/external.rst
View file @
4104a516
...
@@ -38,8 +38,12 @@ Cython also provides declarations for the C math library::
...
@@ -38,8 +38,12 @@ Cython also provides declarations for the C math library::
cdef double f(double x):
cdef double f(double x):
return sin(x*x)
return sin(x*x)
However, this is a library that is not linked by default on some Unix-like
systems, such as Linux. In addition to cimporting the
Dynamic linking
---------------
The libc math library is special in that it is not linked by default
on some Unix-like systems, such as Linux. In addition to cimporting the
declarations, you must configure your build system to link against the
declarations, you must configure your build system to link against the
shared library ``m``. For distutils, it is enough to add it to the
shared library ``m``. For distutils, it is enough to add it to the
``libraries`` parameter of the ``Extension()`` setup::
``libraries`` parameter of the ``Extension()`` setup::
...
@@ -60,12 +64,16 @@ shared library ``m``. For distutils, it is enough to add it to the
...
@@ -60,12 +64,16 @@ shared library ``m``. For distutils, it is enough to add it to the
ext_modules = ext_modules
ext_modules = ext_modules
)
)
External declarations
---------------------
If you want to access C code for which Cython does not provide a ready
If you want to access C code for which Cython does not provide a ready
to use declaration, you must declare them yourself. For example, the
to use declaration, you must declare them yourself. For example, the
above ``sin()`` function is defined as follows::
above ``sin()`` function is defined as follows::
cdef extern from "math.h":
cdef extern from "math.h":
double sin(double)
double sin(double
x
)
This declares the ``sin()`` function in a way that makes it available
This declares the ``sin()`` function in a way that makes it available
to Cython code and instructs Cython to generate C code that includes
to Cython code and instructs Cython to generate C code that includes
...
@@ -77,3 +85,35 @@ Just like the ``sin()`` function from the math library, it is possible
...
@@ -77,3 +85,35 @@ Just like the ``sin()`` function from the math library, it is possible
to declare and call into any C library as long as the module that
to declare and call into any C library as long as the module that
Cython generates is properly linked against the shared or static
Cython generates is properly linked against the shared or static
library.
library.
Naming parameters
-----------------
Both C and Cython support signature declarations without parameter
names like this::
cdef extern from "string.h":
char* strstr(const char*, const char*)
However, this prevents Cython code from calling it with keyword
arguments (supported since Cython 0.19). It is therefore preferable
to write the declaration like this instead::
cdef extern from "string.h":
char* strstr(const char *haystack, const char *needle)
You can now make it clear which of the two arguments does what in
your call, thus avoiding any ambiguities and often making your code
more readable::
cdef char* data = "hfvcakdfagbcffvschvxcdfgccbcfhvgcsnfxjh"
pos = strstr(needle='akd', haystack=data)
print pos != NULL
Note that changing existing parameter names later is a backwards
incompatible API modification, just as for Python code. Thus, if
you provide your own declarations for external C or C++ functions,
it is usually worth the additional bit of effort to choose the
names of their arguments well.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment