Tutorial Cython: come velocizzare Python

Python è un potente linguaggio di programmazione che è facile da imparare e facile da usare, ma non è sempre il più veloce da eseguire, specialmente quando si ha a che fare con matematica o statistica. Le librerie di terze parti come NumPy, che racchiudono le librerie C, possono migliorare significativamente le prestazioni di alcune operazioni, ma a volte hai solo bisogno della velocità e della potenza di C direttamente in Python.

Cython è stato sviluppato per semplificare la scrittura di estensioni C per Python e per consentire la trasformazione del codice Python esistente in C. Inoltre, Cython consente di distribuire il codice ottimizzato con un'applicazione Python senza dipendenze esterne.

In questo tutorial esamineremo i passaggi necessari per trasformare il codice Python esistente in Cython e utilizzarlo in un'applicazione di produzione.

Video correlato: utilizzo di Cython per velocizzare Python

Un esempio di Cython

Cominciamo con un semplice esempio tratto dalla documentazione di Cython, un'implementazione poco efficiente di una funzione integrale:

def f (x):

    return x ** 2-x

def integrate_f (a, b, N):

    s = 0

    dx = (ba) / N

    per i nell'intervallo (N):

        s + = f (a + i * dx)

    return s * dx

Il codice è di facile lettura e comprensione, ma viene eseguito lentamente. Questo perché Python deve costantemente convertire avanti e indietro tra i propri tipi di oggetto ei tipi numerici grezzi della macchina.

Consideriamo ora la versione Cython dello stesso codice, con le aggiunte di Cython sottolineate:

 cdef f (doppia x):

    return x ** 2-x

def integrate_f (doppia a, doppia b, int N):

    cdef int i

    cdef doppia s, x, dx

    s = 0

    dx = (ba) / N

    per i nell'intervallo (N):

        s + = f (a + i * dx)

    return s * dx

Queste aggiunte ci consentono di dichiarare esplicitamente i tipi di variabili in tutto il codice, in modo che il compilatore Cython possa tradurre quelle aggiunte "decorate" in C. 

Video correlato: come Python semplifica la programmazione

Perfetto per l'IT, Python semplifica molti tipi di lavoro, dall'automazione del sistema al lavoro in campi all'avanguardia come l'apprendimento automatico.

Sintassi di Cython

Le parole chiave utilizzate per decorare il codice Cython non si trovano nella sintassi Python convenzionale. Sono stati sviluppati specificamente per Cython, quindi qualsiasi codice decorato con loro non funzionerà come un programma Python convenzionale.

Questi sono gli elementi più comuni della sintassi di Cython:

Tipi variabili

Alcuni dei tipi di variabili utilizzate nella Cython sono echi di propri tipi di Python, come ad esempio  int, floate long. Altri tipi di variabili Cython si trovano anche in C, come charo struct, così come le dichiarazioni come unsigned long. E altri sono esclusivi di Cython, come bintuna rappresentazione di livello C dei True/Falsevalori Python .

I tipi di funzione cdefecpdef

La cdefparola chiave indica l'uso di un tipo Cython o C. Viene anche usato per definire le funzioni proprio come faresti in Python.

Le funzioni scritte in Cython utilizzando la defparola chiave di Python sono visibili ad altro codice Python, ma incorrono in una riduzione delle prestazioni. Le funzioni che utilizzano la cdefparola chiave sono visibili solo ad altri codici Cython o C, ma vengono eseguite molto più velocemente. Se hai funzioni che vengono chiamate solo internamente da un modulo Cython, usa cdef.

Una terza parola chiave, cpdeffornisce compatibilità sia con il codice Python che con il codice C, in modo tale che il codice C possa accedere alla funzione dichiarata a piena velocità. Questa comodità ha un costo, però: le  cpdeffunzioni generano più codice e hanno un sovraccarico di chiamata leggermente superiore rispetto a cdef.

Altre parole chiave di Cython

Altre parole chiave in Cython forniscono il controllo su aspetti del flusso e del comportamento del programma che non sono disponibili in Python:

  • gile nogil. Si tratta di gestori di contesto utilizzati per delineare sezioni di codice che richiedono ( with gil:) o non richiedono ( with nogil:) Global Interpreter Lock di Python o GIL. Il codice C che non effettua chiamate all'API Python può essere eseguito più velocemente in un nogilblocco, soprattutto se esegue un'operazione di lunga durata come la lettura da una connessione di rete.
  • cimportQuesto indica a Cython di importare tipi di dati C, funzioni, variabili e tipi di estensione. Le app Cython che utilizzano i moduli C nativi di NumPy, ad esempio, utilizzano cimportper accedere a tali funzioni.
  • include. Questo inserisce il codice sorgente di un file Cython all'interno di un altro, più o meno allo stesso modo di C. Notare che Cython ha un modo più sofisticato per condividere le dichiarazioni tra i file Cython oltre che solo includes.
  • ctypedef. Utilizzato per fare riferimento alle definizioni del tipo nei file di intestazione C esterni.
  • extern. Utilizzato con cdefper fare riferimento a funzioni o variabili C trovate in altri moduli.
  • public/api. Utilizzato per fare dichiarazioni nei moduli Cython che saranno visibili ad altro codice C.
  • inline. Utilizzato per indicare che una determinata funzione deve essere inline o avere il suo codice inserito nel corpo della funzione chiamante ogni volta che viene utilizzata, per motivi di velocità. Ad esempio, la ffunzione nell'esempio di codice sopra potrebbe essere decorata con inlineper ridurre il suo overhead di chiamata di funzione, perché viene utilizzata solo in un punto. (Nota che il compilatore C potrebbe eseguire automaticamente il proprio inlining, ma inlineti consente di specificare esplicitamente se qualcosa deve essere inline.)

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.)

Elimina i .cfile generati nel progetto e riesegui lo setup.pyscript per ricompilare tutto. Quando hai finito, si dovrebbe vedere un file HTML nella stessa directory che condivide il nome del file di .pyx, in questo caso,  num.html. Apri il file HTML e vedrai le parti del tuo codice che dipendono ancora da Python evidenziate in giallo. Puoi fare clic sulle aree gialle per vedere il codice C sottostante generato da Cython.