Commit 8ae84a55 authored by ggellner@basestar's avatar ggellner@basestar

Applied patches to fix typos. Also added an hgignore, and the .static files...

Applied patches to fix typos. Also added an hgignore, and the .static files needed to generate output.
parent a8312bd9
syntax: glob
*.pyc
*~
.*.swp
syntax: regexp
^build/
......@@ -209,7 +209,7 @@ Here's a complete example. It defines a property which adds to a list each
time it is written to, returns the list when it is read, and empties the list
when it is deleted.::
#cheesy.pyx Test input
# cheesy.pyx
cdef class CheeseShop:
cdef object cheeses
......@@ -228,6 +228,7 @@ when it is deleted.::
def __del__(self):
del self.cheeses[:]
# Test input
from cheesy import CheeseShop
shop = CheeseShop()
......@@ -242,7 +243,7 @@ when it is deleted.::
del shop.cheese
print shop.cheese
#Test output
# Test output
We don't have: []
We don't have: ['camembert']
We don't have: ['camembert', 'cheddar']
......@@ -280,8 +281,7 @@ functions, C methods are declared using :keyword:`cdef` instead of
:keyword:`def`. C methods are "virtual", and may be overridden in derived
extension types.::
pets.pyx
Output
# pets.pyx
cdef class Parrot:
cdef void describe(self):
......@@ -301,6 +301,8 @@ extension types.::
p1.describe()
print "p2:"
p2.describe()
# Output
p1:
This parrot is resting.
p2:
......
......@@ -293,10 +293,7 @@ can then be called and the extension types used as usual.
Any public C type or extension type declarations in the Cython module are also
made available when you include :file:`modulename_api.h`.::
delorean.pyx
marty.c
# delorean.pyx
cdef public struct Vehicle:
int speed
float power
......@@ -305,6 +302,7 @@ made available when you include :file:`modulename_api.h`.::
if v.speed >= 88 and v.power >= 1.21:
print "Time travel achieved"
# marty.c
#include "delorean_api.h"
Vehicle car;
......
......@@ -327,7 +327,7 @@ body, and the loop may have an else clause.
Error return values
-------------------
If you don't do anything special, a function declared with :keyword`cdef` that
If you don't do anything special, a function declared with :keyword:`cdef` that
does not return a Python object has no way of reporting Python exceptions to
its caller. If an exception is detected in such a function, a warning message
is printed and the exception is ignored.
......@@ -520,7 +520,7 @@ Such expressions are made up of literal values and names defined using ``DEF``
statements, combined using any of the Python expression syntax.
The following compile-time names are predefined, corresponding to the values
returned by :func:``os.uname``.
returned by :func:`os.uname`.
UNAME_SYSNAME, UNAME_NODENAME, UNAME_RELEASE,
UNAME_VERSION, UNAME_MACHINE
......
......@@ -108,7 +108,7 @@ python. One can declare variables and return values for functions to be of the
:ctype:`bint` type. For example::
cdef int i = x
Cdef bint b = x
cdef bint b = x
The first conversion would happen via ``x.__int__()`` whereas the second would
happen via ``x.__nonzero__()``. (Actually, if ``x`` is the python object
......@@ -197,10 +197,10 @@ In Cython ``<type>x`` will try and do a coercion (as would happen on assignment
It does not stop one from casting where there is no conversion (though it will
emit a warning). If one really wants the address, cast to a ``void *`` first.
As in Pyrex ``<MyExtensionType>x`` will cast ``x`` to type <ctype>`MyExtensionType` without any
As in Pyrex ``<MyExtensionType>x`` will cast ``x`` to type :ctype:`MyExtensionType` without any
type checking. Cython supports the syntax ``<MyExtensionType?>`` to do the cast
with type checking (i.e. it will throw an error if ``x`` is not a (subclass of)
<ctype>`MyExtensionType`.
:ctype:`MyExtensionType`.
Optional arguments in cdef/cpdef functions
------------------------------------------
......
......@@ -16,7 +16,12 @@ suffix, containing C declarations that are to be available to other Cython
modules, and an implementation file with a ``.pyx`` suffix, containing
everything else. When a module wants to use something declared in another
module's definition file, it imports it using the :keyword:`cimport`
statement. What a Definition File contains A definition file can contain:
statement.
What a Definition File contains
-------------------------------
A definition file can contain:
* Any kind of C type declaration.
* extern C function or variable declarations.
......@@ -77,9 +82,9 @@ uses it.
d.filler = dishes.sausage
def serve():
spamdish d
cdef spamdish d
prepare(&d)
print "%d oz spam, filler no. %d" % (d->oz_of_spam, d->otherstuff)
print "%d oz spam, filler no. %d" % (d.oz_of_spam, d.otherstuff)
It is important to understand that the :keyword:`cimport` statement can only
be used to import C data types, C functions and variables, and extension
......@@ -139,12 +144,12 @@ C functions defined at the top level of a module can be made available via
:keyword:`cimport` by putting headers for them in the ``.pxd`` file, for
example,:
:file:`volume.pxd`:
:file:`spammery.pyx`::
:file:`volume.pxd`::
cdef float cube(float)
:file:`spammery.pyx`::
from volume cimport cube
def menu(description, size):
......@@ -185,17 +190,22 @@ Python methods.
Here is an example of a module which defines and exports an extension type,
and another module which uses it.::
Shrubbing.pxd Shrubbing.pyx
# Shrubbing.pxd
cdef class Shrubbery:
cdef int width
cdef int length cdef class Shrubbery:
cdef int length
# Shrubbing.pyx
cdef class Shrubbery:
def __new__(self, int w, int l):
self.width = w
self.length = l
def standard_shrubbery():
return Shrubbery(3, 7)
Landscaping.pyx
# Landscaping.pyx
cimport Shrubbing
import Shrubbing
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment