Tutorial de Cython: Cómo acelerar Python

Python es un poderoso lenguaje de programación que es fácil de aprender y fácil de trabajar, pero no siempre es el más rápido de ejecutar, especialmente cuando se trata de matemáticas o estadísticas. Las bibliotecas de terceros como NumPy, que envuelven las bibliotecas de C, pueden mejorar el rendimiento de algunas operaciones de manera significativa, pero a veces solo necesita la velocidad y el poder de C directamente en Python.

Cython se desarrolló para facilitar la escritura de extensiones C para Python y para permitir que el código Python existente se transforme en C. Además, Cython permite que el código optimizado se envíe con una aplicación Python sin dependencias externas.

En este tutorial, veremos los pasos necesarios para transformar el código Python existente en Cython y usarlo en una aplicación de producción.

Video relacionado: Uso de Cython para acelerar Python

Un ejemplo de Cython

Comencemos con un ejemplo simple tomado de la documentación de Cython, una implementación no muy eficiente de una función integral:

def f (x):

    devolver x ** 2-x

def integra_f (a, b, N):

    s = 0

    dx = (ba) / N

    para i en el rango (N):

        s + = f (a + i * dx)

    devolver s * dx

El código es fácil de leer y comprender, pero se ejecuta lentamente. Esto se debe a que Python debe convertir constantemente entre sus propios tipos de objetos y los tipos numéricos sin procesar de la máquina.

Ahora considere la versión Cython del mismo código, con las adiciones de Cython subrayadas:

 cdef f (doble x):

    devolver x ** 2-x

def integra_f (doble a, doble b, int N):

    cdef int i

    cdef doble s, x, dx

    s = 0

    dx = (ba) / N

    para i en el rango (N):

        s + = f (a + i * dx)

    devolver s * dx

Estas adiciones nos permiten declarar explícitamente los tipos de variables en todo el código, de modo que el compilador Cython pueda traducir esas adiciones "decoradas" en C. 

Vídeo relacionado: Cómo Python facilita la programación

Python, perfecto para TI, simplifica muchos tipos de trabajo, desde la automatización de sistemas hasta el trabajo en campos de vanguardia como el aprendizaje automático.

Sintaxis de Cython

Las palabras clave utilizadas para decorar el código Cython no se encuentran en la sintaxis convencional de Python. Fueron desarrollados específicamente para Cython, por lo que cualquier código decorado con ellos no se ejecutará como un programa Python convencional.

Estos son los elementos más comunes de la sintaxis de Cython:

Tipos de variables

Algunos de los tipos de variables utilizadas en Cython son ecos de propios tipos de Python, como  int, float, y long. Otros tipos de variables de Cython también se encuentran en C, como charo struct, como son declaraciones como unsigned long. Y otros son exclusivos de Cython, como bintuna representación de nivel C de los True/Falsevalores de Python .

Los tipos de función cdefycpdef

La cdefpalabra clave indica el uso de un tipo Cython o C. También se usa para definir funciones como lo haría en Python.

Las funciones escritas en Cython usando la defpalabra clave de Python son visibles para otro código de Python, pero incurren en una penalización de rendimiento. Las funciones que usan la cdefpalabra clave solo son visibles para otros códigos Cython o C, pero se ejecutan mucho más rápido. Si tiene funciones que solo se llaman internamente desde un módulo Cython, use cdef.

Una tercera palabra clave, cpdefproporciona compatibilidad tanto con el código Python como con el código C, de tal manera que el código C puede acceder a la función declarada a toda velocidad. Sin embargo, esta conveniencia tiene un costo: las  cpdeffunciones generan más código y tienen un poco más de sobrecarga de llamadas que cdef.

Otras palabras clave de Cython

Otras palabras clave en Cython proporcionan control sobre aspectos del flujo y el comportamiento del programa que no están disponibles en Python:

  • gily nogil. Estos son administradores de contexto que se utilizan para delinear secciones de código que requieren ( with gil:) o no requieren ( with nogil:) Bloqueo de intérprete global de Python, o GIL. El código C que no realiza llamadas a la API de Python puede ejecutarse más rápido en un nogilbloque, especialmente si está realizando una operación de larga duración, como leer desde una conexión de red.
  • cimportEsto indica a Cython que importe tipos de datos, funciones, variables y tipos de extensión de C. Las aplicaciones Cython que usan los módulos C nativos de NumPy, por ejemplo, usan cimportpara obtener acceso a esas funciones.
  • include. Esto coloca el código fuente de un archivo Cython dentro de otro, de la misma manera que en C. Tenga en cuenta que Cython tiene una forma más sofisticada de compartir declaraciones entre archivos Cython además de includes.
  • ctypedef. Se utiliza para hacer referencia a las definiciones de tipo en archivos de encabezado C externos.
  • extern. Se usa con cdefpara referirse a funciones o variables de C que se encuentran en otros módulos.
  • public/api. Se usa para hacer declaraciones en módulos Cython que serán visibles para otro código C.
  • inline. Usado para indicar que una función dada debe estar en línea, o tener su código colocado en el cuerpo de la función de llamada siempre que se use, en aras de la velocidad. Por ejemplo, la ffunción en el ejemplo de código anterior podría decorarse con inlinepara reducir la sobrecarga de llamadas a la función, porque solo se usa en un lugar. (Tenga en cuenta que el compilador de C puede realizar su propia inserción automáticamente, pero le inlinepermite especificar explícitamente si algo debe estar integrado).

It is not necessary to know all of the Cython keywords in advance. Cython code tends to be written incrementally—first you write valid Python code, then you add Cython decoration to speed it up. Thus you can pick up Cython’s extended keyword syntax piecemeal, as you need it.

Compile Cython

Now that we have some idea of what a simple Cython program looks like and why it looks the way it does, let’s walk through the steps needed to compile Cython into a working binary.

To build a working Cython program, we will need three things:

  1. The Python interpreter. Use the most recent release version, if you can.
  2. The Cython package. You can add Cython to Python by way of the pip package manager: pip install cython
  3. A C compiler.

Item #3 can be tricky if you’re using Microsoft Windows as your development platform. Unlike Linux, Windows doesn’t come with a C compiler as a standard component. To address this, grab a copy of Microsoft Visual Studio Community Edition, which includes Microsoft’s C compiler and costs nothing. 

Note that, as of this writing, the most recent release version of Cython is 0.29.16, but a beta version of Cython 3.0 is available for use. If you use pip install cython, the most current non-beta version will be installed. If you want to try out the beta, use pip install cython>=3.0a1 to install the most recent edition of the Cython 3.0 branch. Cython’s developers recommend trying the Cython 3.0 branch whenever possible, because in some cases it generates significantly faster code.

Cython programs use the .pyx file extension. In a new directory, create a file named num.pyx that contains the Cython code example shown above (the second code sample under “A Cython example”) and a file named main.py that contains the following code:

from num import integrate_f

print (integrate_f(1.0, 10.0, 2000))

This is a regular Python progam that will call the integrate_f function found in num.pyx. Python code “sees” Cython code as just another module, so you don’t need to do anything special other than import the compiled module and run its functions.

Finally, add a file named setup.py with the following code:

from distutils.core import setup from distutils.extension import Extension from Cython.Build import cythonize ext_modules = [ Extension( r'num', [r'num.pyx'] ), ] setup( name="num", ext_modules=cythonize(ext_modules),

)

setup.py is normally used by Python to install the module it’s associated with, and can also be used to direct Python to compile C extensions for that module. Here we’re using setup.py to compile Cython code.

If you’re on Linux, and you have a C compiler installed (typically the case), you can compile the .pyx file to C by running the command: 

python setup.py build_ext --inplace

If you’re using Microsoft Windows and Microsoft Visual Studio 2017 or better, you’ll need to make sure you have the most recent version of setuptools installed in Python (version 46.1.3 as of this writing) before that command will work. This ensures that Python’s build tools will be able to auto-detect and use the version of Visual Studio you have installed.

If the compilation is successful, you should see new files appear in the directory: num.c (the C file generated by Cython) and a file with either a .o extension (on Linux) or a .pyd extension (on Windows). That’s the binary that the C file has been compiled into. You may also see a \build subdirectory, which contains the artifacts from the build process.

Run python main.py, and you should see something like the following returned as a response:

283.297530375

That’s the output from the compiled integral function, as invoked by our pure Python code. Try playing with the parameters passed to the function in main.py to see how the output changes.

Note that whenever you make changes to the .pyx file, you will need to recompile it. (Any changes you make to conventional Python code will take effect immediately.)

The resulting compiled file has no dependencies except the version of Python it was compiled for, and so can be bundled into a binary wheel. Note that if you refer to other libraries in your code, like NumPy (see below), you will need to provide those as part of the application’s requirements.

How to use Cython

Now that you know how to “Cythonize” a piece of code, the next step is to determine how your Python application can benefit from Cython. Where exactly should you apply it?

For best results, use Cython to optimize these kinds of Python functions:

  1. Functions that run in tight loops, or require long amounts of processing time in a single “hot spot” of code.
  2. Functions that perform numerical manipulations.
  3. Functions that work with objects that can be represented in pure C, such as basic numerical types, arrays, or structures, rather than Python object types like lists, dictionaries, or tuples.

Python has traditionally been less efficient at loops and numerical manipulations than other, non-interpreted languages. The more you decorate your code to indicate it should use base numerical types that can be turned into C, the faster it will do number-crunching.

Using Python object types in Cython isn’t itself a problem. Cython functions that use Python objects will still compile, and Python objects may be preferable when performance isn’t the top consideration. But any code that makes use of Python objects will be limited by the performance of the Python runtime, as Cython will generate code to directly address Python’s APIs and ABIs.

Another worthy target of Cython optimization is Python code that interacts directly with a C library. You can skip the Python “wrapper” code and interface with the libraries directly.

However, Cython does not automatically generate the proper call interfaces for those libraries. You will need to have Cython refer to the function signatures in the library’s header files, by way of a cdef extern from declaration. Note that if you don’t have the header files, Cython is forgiving enough to let you declare external function signatures that approximate the original headers. But use the originals whenever possible to be safe.

One external C library that Cython can use right out of the box is NumPy. To take advantage of Cython’s fast access to NumPy arrays, use cimport numpy (optionally with as np to keep its namespace distinct), and then use cdef statements to declare NumPy variables, such as cdef np.array or np.ndarray.

Cython profiling

The first step to improving an application’s performance is to profile it—to generate a detailed report of where the time is being spent during execution. Python provides built-in mechanisms for generating code profiles. Cython not only hooks into those mechanisms but has profiling tools of its own.

Python’s own profiler, cProfile, generates reports that show which functions take up the most amount of time in a given Python program. By default, Cython code doesn’t show up in those reports, but you can enable profiling on Cython code by inserting a compiler directive at the top of the .pyx file with functions you want to include in the profiling:

# cython: profile=True

You can also enable line-by-line tracing on the C code generated by Cython, but this imposes a lot of overhead, and so is turned off by default.

Note that profiling imposes a performance hit, so be sure to toggle profiling off for code that is being shipped into production.

Cython can also generate code reports that indicate how much of a given .pyx file is being converted to C, and how much of it remains Python code. To see this in action, edit the setup.py file in our example and add the following two lines at the top:

import Cython.Compiler.Options

Cython.Compiler.Options.annotate = True

(Alternatively, you can use a directive in setup.py to enable annotations, but the above method is often easier to work with.)

Elimine los .carchivos generados en el proyecto y vuelva a ejecutar el setup.pyscript para recompilar todo. Cuando haya terminado, debería ver un archivo HTML en el mismo directorio que comparte el nombre de su archivo en .pyx este caso,  num.html. Abra el archivo HTML y verá las partes de su código que aún dependen de Python resaltadas en amarillo. Puede hacer clic en las áreas amarillas para ver el código C subyacente generado por Cython.