Source Files and Compilation


See Compilation reference section for more details

Cython source file names consist of the name of the module followed by a .pyx extension, for example a module called primes would have a source file named primes.pyx.

Once you have written your .pyx file, there are a couple of ways of turning it into an extension module. One way is to compile it manually with the Cython compiler, e.g.:

$ cython primes.pyx

This will produce a file called primes.c, which then needs to be compiled with the C compiler using whatever options are appropriate on your platform for generating an extension module. For these options look at the official Python documentation.

The other, and probably better, way is to use the distutils extension provided with Cython. The benefit of this method is that it will give the platform specific compilation options, acting like a stripped down autotools.


The distutils extension provided with Cython allows you to pass .pyx files directly to the Extension constructor in your setup file.

If you have a single Cython file that you want to turn into a compiled extension, say with filename example.pyx the associated would be:

from distutils.core import setup
from Cython.Build import cythonize

    ext_modules = cythonize("example.pyx")

To understand the more fully look at the official distutils documentation. To compile the extension for use in the current directory use:

$ python build_ext --inplace

Multiple Cython Files in a Package

To automatically compile multiple Cython files without listing all of them explicitly, you can use glob patterns:

    ext_modules = cythonize("package/*.pyx")

You can also use glob patterns in Extension objects if you pass them through cythonize():

extensions = [Extension("*", ["*.pyx"])]

    ext_modules = cythonize(extensions)


Cython is a compiler. Therefore it is natural that people tend to go through an edit/compile/test cycle with Cython modules. pyximport simplifies this process by executing the “compile” step at need during import. For instance, if you write a Cython module called foo.pyx, with Pyximport you can import it in a regular Python module like this:

import pyximport; pyximport.install()
import foo

Doing so will result in the compilation of foo.pyx (with appropriate exceptions if it has an error in it).

If you would always like to import Cython files without building them specially, you can also add the first line above to your That will install the hook every time you run Python. Then you can use Cython modules just with simple import statements, even like this:

$ python -c "import foo"

Note that it is not recommended to let pyximport build code on end user side as it hooks into their import system. The best way to cater for end users is to provide pre-built binary packages in the wheel packaging format.

To have more information of pyximport, please refer to Compiling with pyximport.