Language Basics

#

Language Basics

- Python functions vs. C functions
- Python objects as parameters and return values
- C variable and type definitions
  - Forward Declarations
  - Grouping multiple C declarations
- Automatic type conversions
  - Caveats when using a Python string in a C context
- Scope rules
- Statements and expressions
  - Differences between C and Pyrex expressions
  - Integer for-loops
  - Catching exceptions and tracebacks
- Error return values
  - Checking return values of non-Pyrex functions
- The include statement
- Keyword-only arguments
- Built-in Names
  - Built-in Constants
  - Built-in Functions
  - Built-in Types
- Conditional Compilation
  - Compile-Time Definitions
  - Conditional Statements

This section describes the basic features of the Pyrex language. The facilities covered in this section allow you to create Python-callable functions that manipulate C data structures and convert between Python and C data types. Later sections will cover facilities for wrapping external C code, creating new Python types and cooperation between Pyrex modules.

## Python functions vs. C functions

There are two kinds of function definition in Pyrex:

Python functions are defined using the def statement, as in Python. They take Python objects as parameters and return Python objects.

C functions are defined using the new cdef statement. They take either Python objects or C values as parameters, and can return either Python objects or C values.

Within a Pyrex module, Python functions and C functions can call each other freely, but only Python functions can be called from outside the module by interpreted Python code. So, any functions that you want to "export" from your Pyrex module must be declared as Python functions using def.

Parameters of either type of function can be declared to have C data types, using normal C declaration syntax. For example,

>     def spam(int i, char *s):
>         ...

>     cdef int eggs(unsigned long l, float f):
>         ...

When a parameter of a Python function is declared to have a C data type, it is passed in as a Python object and automatically converted to a C value, if possible. Automatic conversion is currently only possible for numeric types and string types; attempting to use any other type for the parameter of a Python function will result in a compile-time error.

C functions, on the other hand, can have parameters of any type, since they're passed in directly using a normal C function call.

## Python objects as parameters and return values

If no type is specified for a parameter or return value, it is assumed to be a Python object. (Note that this is different from the C convention, where it would default to `int`.) For example, the following defines a C function that takes two Python objects as parameters and returns a Python object:

>     cdef spamobjs(x, y):
>         ...

Reference counting for these objects is performed automatically according to the standard Python/C API rules (i.e. borrowed references are taken as parameters and a new reference is returned).

The name object can also be used to explicitly declare something as a Python object. This can be useful if the name being declared would otherwise be taken as the name of a type, for example,

>     cdef ftang(object int):
>         ...

declares a parameter called `int` which is a Python object. You can also use object as the explicit return type of a function, e.g.

>     cdef object ftang(object int):
>         ...

In the interests of clarity, it is probably a good idea to always be explicit about object parameters in C functions.

## C variable and type definitions

The cdef statement is also used to declare C variables, either local or module-level:

>     cdef int i, j, k
>     cdef float f, g[42], *h

and C struct, union or enum types:

>     cdef struct Grail:
>         int age
>         float volume

>     cdef union Food:
>         char *spam
>         float *eggs

>     cdef enum CheeseType:
>         cheddar, edam,
>         camembert

>     cdef enum CheeseState:
>         hard = 1
>         soft = 2
>         runny = 3

There is currently no special syntax for defining a constant, but you can use an anonymous enum declaration for this purpose, for example,

> `cdef enum:`
> `tons_of_spam = 3`

Note that the words struct, union and enum are used only when defining a type, not when referring to it. For example, to declare a variable pointing to a Grail you would write

>     cdef Grail *gp

and not

>     cdef struct Grail *gp # WRONG

There is also a ctypedef statement for giving names to types, e.g.

>     ctypedef unsigned long ULong

>     ctypedef int *IntPtr

### Forward Declarations

If you have two struct or union types containing pointers that refer to each other, you will need to use a forward declaration for at least one of them. This is simply the header of a struct or union without the colon or body, for example,
cdef struct Sandwich
cdef struct Lunchbox:
Sandwich *lunch
cdef struct Sandwich:
Lunchbox *container
You can also forward-declare C functions, but there should be little need to do this. Pyrex processes all declarations in a module before analysing any executable statements, so calling a function defined further down in the source file is usually not a problem.

### Grouping multiple C declarations

If you have a series of declarations that all begin with cdef, you can group them into a cdef block like this:

    cdef:

     struct Spam:
     int tons

     int i
     float f
     Spam *p

     void f(Spam *s):
     print s.tons, "Tons of spam"

## Automatic type conversions

In most situations, automatic conversions will be performed for the basic numeric and string types when a Python object is used in a context requiring a C value, or vice versa. The following table summarises the conversion possibilities.

C types | From Python types | To Python types
--- | --- | ---
[unsigned] char [unsigned] short int, long | int, long | int
unsigned int unsigned long [unsigned] long long | int, long | long
float, double, long double | int, long, float | float
char * | str | str

### Caveats when using a Python string in a C context

You need to be careful when using a Python string in a context expecting a char *. In this situation, a pointer to the contents of the Python string is used, which is only valid as long as the Python string exists. So you need to make sure that a reference to the original Python string is held for as long as the C string is needed. If you can't guarantee that the Python string will live long enough, you will need to copy the C string.
Pyrex detects and prevents some mistakes of this kind. For instance, if you attempt something like

    cdef char *s
    s = pystring1 + pystring2

then Pyrex will produce the error message "Obtaining char * from temporary Python value". The reason is that concatenating the two Python strings produces a new Python string object that is referenced only by a temporary internal variable that Pyrex generates. As soon as the statement has finished, the temporary variable will be decrefed and the Python string deallocated, leaving s dangling. Since this code could not possibly work, Pyrex refuses to compile it.
The solution is to assign the result of the concatenation to a Python variable, and then obtain the char * from that, i.e.

    cdef char *s
    p = pystring1 + pystring2
    s = p

It is then your responsibility to hold the reference p for as long as necessary.
Keep in mind that the rules used to detect such errors are only heuristics. Sometimes Pyrex will complain unnecessarily, and sometimes it will fail to detect a problem that exists. Ultimately, you need to understand the issue and be careful what you do.

## Scope rules

Pyrex determines whether a variable belongs to a local scope, the module scope, or the built-in scope completely statically. As with Python, assigning to a variable which is not otherwise declared implicitly declares it to be a Python variable residing in the scope where it is assigned. Unlike Python, however, a name which is referred to but not declared or assigned is assumed to reside in the builtin scope, not the module scope. Names added to the module dictionary at run time will not shadow such names.
This can result in some odd things happening under rare circumstances, for example
`print __name__`

In Pyrex, instead of printing the name of the current module, this prints the name of the builtins module. The reason is that because Pyrex hasn't seen a declaration of anything called __name__ in the module, it's assumed to reside in the builtins. The solution is to use a global statement to declare __name__ as a module-level name:

`global __name__``
print __name__`

Another consequence of these rules is that the module-level scope behaves the same way as a Python local scope if you refer to a variable before assigning to it. In particular, tricks such as the following will not work in Pyrex:

>     try:
>       x = True
>     except NameError:
>       True = 1

because, due to the assignment in the last line, True will always be looked up in the module-level scope. You would have to do something like this instead:

>     import __builtin__
>     try:
>      True = __builtin__.True
>     except AttributeError:
>      True = 1

## Statements and expressions

Control structures and expressions follow Python syntax for the most part. When applied to Python objects, they have the same semantics as in Python (unless otherwise noted). Most of the Python operators can also be applied to C values, with the obvious semantics.

If Python objects and C values are mixed in an expression, conversions are performed automatically between Python objects and C numeric or string types.

Reference counts are maintained automatically for all Python objects, and all Python operations are automatically checked for errors, with appropriate action taken.

### Differences between C and Pyrex expressions

There are some differences in syntax and semantics between C expressions and Pyrex expressions, particularly in the area of C constructs which have no direct equivalent in Python.

- An integer literal without an L suffix is treated as a C constant, and will be truncated to whatever size your C compiler thinks appropriate. With an L suffix, it will be converted to Python long integer (even if it would be small enough to fit into a C int).
- There is no `->` operator in Pyrex. Instead of `p->x`, use `p.x`
- There is no `*` operator in Pyrex. Instead of `*p`, use `p[0]`
- There is an `&` operator, with the same semantics as in C.
- The null C pointer is called `NULL`, not 0 (and `NULL` is a reserved word).
- Character literals are written with a c prefix, for example:

    c'X'

- Type casts are written `<type>value` , for example:

    cdef char *p, float *q
    p = <char*>q

Warning: Don't attempt to use a typecast to convert between Python and C data types -- it won't do the right thing. Leave Pyrex to perform the conversion automatically.

#### Operator Precedence

Keep in mind that there are some differences in operator precedence between Python and C, and that Pyrex uses the Python precedences, not the C ones.

### Integer for-loops

You should be aware that a for-loop such as

> `for i in range(n):`
> `...`

won't be very fast, even if `i` and `n` are declared as C integers, because `range` is a Python function. For iterating over ranges of integers, Pyrex has another form of for-loop:

> `for 0 <= i < n:`
> `...`

Provided the loop variable and the lower and upper bounds are all C integers, this form of loop will be much faster, because Pyrex will translate it into pure C code.

Some things to note about the integer for-loop:

- The target expression (the middle one) must be a variable name.
- The direction of iteration is determined by the relations. If they are both from the set {`<`, `<=`} then it is upwards; if they are both from the set {`>`, `>=`} then it is downwards. (Any other combination is disallowed.)

Like other Python looping statements, `break` and `continue` may be used in the body, and the loop may have an `else` clause.

### Catching exceptions and tracebacks

For reasons of efficiency, there are some differences between Pyrex and Python concerning the way exceptions caught by a try-except statement are handled.

- Exceptions caught by an except clause cannot be retrieved using sys.exc_info(). To access the caught exception, you must bind it to a name in the except clause.
  Pyrex also allows an additional name to be provided for catching the traceback. For example,

    try:
        start_engine()
    except HovercraftError, e, tb:
        print "Got an error:", e
        traceback.print_tb(tb)

- A raise statement with no arguments (to re-raise the last exception caught) must be lexically enclosed in the except clause which caught the exception. A raise statement in a Python function called from the except clause will not work.

    try:
     start_engine()
    except HovercraftError, e:
     print "Unable to start:", e
     raise # the exception caught by the enclosing except clause

##

## Error return values

If you don't do anything special, a function declared with 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.

If you want a C function that does not return a Python object to be able to propagate exceptions to its caller, you need to declare an exception value for it. Here is an example:

> `cdef int spam() except -1:`
> `...`

With this declaration, whenever an exception occurs inside `spam`, it will immediately return with the value `-1`. Furthermore, whenever a call to `spam` returns `-1`, an exception will be assumed to have occurred and will be propagated.

When you declare an exception value for a function, you should never explicitly return that value. If all possible return values are legal and you can't reserve one entirely for signalling errors, you can use an alternative form of exception value declaration:

> `cdef int spam() except? -1:`
> `...`

The "?" indicates that the value `-1` only indicates a possible error. In this case, Pyrex generates a call to `PyErr_Occurred` if the exception value is returned, to make sure it really is an error.

There is also a third form of exception value declaration:

> `cdef int spam() except *:`
> `...`

This form causes Pyrex to generate a call to `PyErr_Occurred` after every call to `spam`, regardless of what value it returns. If you have a function returning `void` that needs to propagate errors, you will have to use this form, since there isn't any return value to test.

Some things to note:

- Exception values can only declared for functions returning an integer, enum, float or pointer type, and the value must be a constant expression. The only possible pointer exception value is `NULL`. Void functions can only use the `except *` form.
- The exception value specification is part of the signature of the function. If you're passing a pointer to a function as a parameter or assigning it to a variable, the declared type of the parameter or variable must have the same exception value specification (or lack thereof). Here is an example of a pointer-to-function declaration with an exception value:

    int (*grail)(int, char *) except -1

- You don't need to (and shouldn't) declare exception values for functions which return Python objects. Remember that a function with no declared return type implicitly returns a Python object.

### Checking return values of non-Pyrex functions

It's important to understand that the `except` clause does not cause an error to be raised when the specified value is returned. For example, you can't write something like

>     cdef extern FILE *fopen(char *filename, char *mode) except NULL # WRONG!

and expect an exception to be automatically raised if a call to fopen returns NULL. The except clause doesn't work that way; its only purpose is for propagating exceptions that have already been raised, either by a Pyrex function or a C function that calls Python/C API routines. To get an exception from a non-Python-aware function such as fopen, you will have to check the return value and raise it yourself, for example,

>     cdef FILE *p
>     p = fopen("spam.txt", "r")
>     if p == NULL:
>         raise SpamError("Couldn't open the spam file")

####

## The `include` statement

A Pyrex source file can include material from other files using the include statement, for example

>     include "spamstuff.pxi"

The contents of the named file are textually included at that point. The included file can contain any complete statements or declarations that are valid in the context where the include statement appears, including other include statements. The contents of the included file should begin at an indentation level of zero, and will be treated as though they were indented to the level of the include statement that is including the file.
Note that there are other mechanisms available for splitting Pyrex code into separate parts that may be more appropriate in many cases. See Sharing Declarations Between Pyrex Modules.

## Keyword-only arguments

Python functions can have keyword-only arguments listed after the * parameter and before the ** paramter if any, e.g.

    def f(a, b, *args, c, d = 42, e, **kwds):
     ...

Here c, d and e cannot be passed as position arguments and must be passed as keyword arguments. Furthermore, c and e are required keyword arguments, since they do not have a default value.
If the parameter name after the * is omitted, the function will not accept any extra positional arguments, e.g.

    def g(a, b, *, c, d):
     ...

takes exactly two positional parameters and has two required keyword parameters.

## Built-in Names

Pyrex knows about many of the names in the builtin namespace, and treats them specially in the interests of generating efficient code.

### Built-in Constants

Pyrex knows the following built-in constant and type names, and references their values directly instead of using a dictionary lookup.

Type objects (type type) | Exceptions (type type)
buffer enumerate file float int long open property str tuple xrange | Exception StopIteration StandardError ArithmeticError LookupError AsssertionError EOFError FloatingPointError EnvironmentError IOError OSError ImportError IndexError KeyError KeyboardInterrupt MemoryError NameError OverflowError RuntimeError NotImplementedError SyntaxError | IndentationError TabError ReferenceError SystemError SystemExit TypeError UnboundLocalError UnicodeError UnicodeEncodeError UnicodeDecodeError UnicodeTranslateError ValueError ZeroDivisionError Warning UserWarning DeprecationWarning PendingDeprecationWarning SyntaxWarning OverflowWarning RuntimeWarning FutureWarning
Constants (type object)
True False Ellipsis

Note that although some of the above names refer to type objects, they are not Pyrex type names and therefore can't be used to declare the type of a variable. Only the names listed under Built-in Types below can be used as type names in declarations.

### Built-in Functions

Pyrex compiles calls to the following built-in functions into direct calls to the corresponding Python/C API routines, making them particularly fast.

Function and arguments | Return type | Python/C API Equivalent
abs(obj) | object | PyNumber_Absolute
bool(obj) (Note 3) | int | PyObject_IsTrue
delattr(obj, name) | int | PyObject_DelAttr
dir(obj) | object | PyObject_Dir
divmod(x, y) | object | PyNumber_Divmod
getattr(obj, name) (Note 1) getattr3(obj, name, default) | object | PyObject_GetAttr
hasattr(obj, name) | int | PyObject_HasAttr
hash(obj) | int | PyObject_Hash
cintern(char *) (Note 5) | object | PyString_InternFromString
isinstance(obj, type) | int | PyObject_IsInstance
issubclass(obj, type) | int | PyObject_IsSubclass
issubtype(type, type) (Note 4) | int | PyType_IsSubType
iter(obj) | object | PyObject_GetIter
iter2(obj, obj) | object | PyCallIter_New
len(obj) | Py_ssize_t | PyObject_Length
pow(x, y, z) (Note 2) | object | PyNumber_Power
reload(obj) | object | PyImport_ReloadModule
repr(obj) | object | PyObject_Repr
setattr(obj, name) | void | PyObject_SetAttr
typecheck(obj, type) (Note 4) | int | PyObject_TypeCheck

Note 1: There are two different functions corresponding to the Python getattr depending on whether a third argument is used. In a non-call context, they both evaluate to the Python getattr function.
Note 2: Only the three-argument form of pow() is supported. Use the ** operator otherwise.
Note 3: In a non-call context, the name bool refers to the Python built-in bool type.
Note 4: The functions typecheck and issubtype have no exact Python equivalent. They are included for fast, safe type checking of extension types. They are safer than using isinstance and issubclass for this purpose, because the behaviour of the latter functions can be overridden, so they don't necessarily reflect the true C types of the objects involved.
Note 5: This function is named cintern instead of intern because it takes a null-terminated C string rather than a Python string, and therefore cannot handle strings containing null bytes.
Only direct function calls using these names are optimised. If you do something else with one of these names that assumes it's a Python object, such as assign it to a Python variable, and later call it, the call will be made as a Python function call.

### Built-in Types

Pyrex knows about the following builtin types:
dict
list
object
slice
type
If you declare a variable as being of one of these types, then calls to the methods in the table below will be compiled to direct Python/C API calls, avoiding the overhead of a Python attribute lookup and function call. In the case of attributes, they will be accessed directly from the object's C struct.
Referring to the types themselves is also slightly more efficient, because the relevant type object is accessed directly rather than via a global variable lookup.

Method or Attribute | Return type | Python/C API Equivalent | Notes
Type dict
clear() |  | PyDict_Clear |
copy() |  | PyDict_Copy |
items() | object | PyDict_Items |
keys() | object | PyDict_Keys |
values() | object | PyDict_Values |
merge(obj, override) |  | PyDict_Merge | Merge items from a mapping
update(obj) |  | PyDict_Update |
merge_pairs(obj, override) |  | PyDict_MergeFromSeq2 | Merge (key, value) pairs from a sequence
Type list
insert(int, obj) |  | PyList_Insert |
append(obj) |  | PyList_Append |
sort() |  | PyList_Sort |
reverse() |  | PyList_Reverse |
as_tuple() | object | PyList_AsTuple |
Type slice
indices() | object | PySlice_Indices |
start | object |  |
stop | object |  |
step | object |  |

Some of the above methods have no direct Python equivalent, but are there to provide access to routines that exist in the Python/C API.
As an example, the following compiles into code containing no Python attribute lookups or function calls.
cdef list cheeses
cheeses = []
cheeses.append("camembert")
cheeses.append("cheddar")
cheeses.insert(1, "something runny")

## Conditional Compilation

Some features are available for conditional compilation and compile-time constants within a Pyrex source file.

### Compile-Time Definitions

A compile-time constant can be defined using the DEF statement:

    DEF FavouriteFood = "spam"
    DEF ArraySize = 42
    DEF OtherArraySize = 2 * ArraySize + 17

The right-hand side of the DEF must be a valid compile-time expression. 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 os.uname().

    UNAME_SYSNAME, UNAME_NODENAME, UNAME_RELEASE,
    UNAME_VERSION, UNAME_MACHINE

The following selection of builtin constants and functions are also available:

    None, True, False,
    abs, bool, chr, cmp, complex, dict, divmod, enumerate,
    float, hash, hex, int, len, list, long, map, max, min,
    oct, ord, pow, range, reduce, repr, round, slice, str,
    sum, tuple, xrange, zip

A name defined using DEF can be used anywhere an identifier can appear, and it is replaced with its compile-time value as though it were written into the source at that point as a literal. For this to work, the compile-time expression must evaluate to a Python value of type int, long, float or str.

    cdef int a1[ArraySize]
    cdef int a2[OtherArraySize]
    print "I like", FavouriteFood

### Conditional Statements

The IF statement can be used to conditionally include or exclude sections of code at compile time. It works in a similar way to the #if preprocessor directive in C.

    IF UNAME_SYSNAME == "Windows":
     include "icky_definitions.pxi"
    ELIF UNAME_SYSNAME == "Darwin":
     include "nice_definitions.pxi"
    ELIF UNAME_SYSNAME == "Linux":
     include "penguin_definitions.pxi"
    ELSE:
     include "other_definitions.pxi"

The ELIF and ELSE clauses are optional. An IF statement can appear anywhere that a normal statement or declaration can appear, and it can contain any statements or declarations that would be valid in that context, including DEF statements and other IF statements.
The expressions in the IF and ELIF clauses must be valid compile-time expressions as for the DEF statement, although they can evaluate to any Python value, and the truth of the result is determined in the usual Python way.
---