Tutorial Cython: Cara mempercepat Python

Python adalah bahasa pemrograman hebat yang mudah dipelajari dan digunakan, tetapi tidak selalu yang tercepat untuk dijalankan — terutama ketika Anda berurusan dengan matematika atau statistik. Pustaka pihak ketiga seperti NumPy, yang membungkus pustaka C, dapat meningkatkan kinerja beberapa operasi secara signifikan, tetapi terkadang Anda hanya memerlukan kecepatan mentah dan kekuatan C secara langsung dengan Python.

Cython dikembangkan untuk mempermudah penulisan ekstensi C untuk Python, dan untuk memungkinkan kode Python yang ada diubah menjadi C. Terlebih lagi, Cython memungkinkan kode yang dioptimalkan untuk dikirimkan dengan aplikasi Python tanpa ketergantungan eksternal.

Dalam tutorial ini kita akan memandu langkah-langkah yang diperlukan untuk mengubah kode Python yang ada menjadi Cython, dan menggunakannya dalam aplikasi produksi.

Video terkait: Menggunakan Cython untuk mempercepat Python

Contoh Cython

Mari kita mulai dengan contoh sederhana yang diambil dari dokumentasi Cython, implementasi fungsi integral yang tidak terlalu efisien:

def f (x):

    return x ** 2-x

def integrated_f (a, b, N):

    s = 0

    dx = (ba) / N

    untuk i dalam rentang (N):

        s + = f (a + i * dx)

    kembali s * dx

Kode tersebut mudah dibaca dan dipahami, tetapi berjalan lambat. Ini karena Python harus terus-menerus mengonversi bolak-balik antara tipe objeknya sendiri dan tipe numerik mentah mesin.

Sekarang pertimbangkan versi Cython dari kode yang sama, dengan penambahan Cython yang digarisbawahi:

 cdef f (x ganda):

    return x ** 2-x

def integr_f (double a, double b, int N):

    cdef int i

    cdef ganda s, x, dx

    s = 0

    dx = (ba) / N

    untuk i dalam rentang (N):

        s + = f (a + i * dx)

    kembali s * dx

Penambahan ini memungkinkan kita untuk secara eksplisit mendeklarasikan jenis variabel di seluruh kode, sehingga compiler Cython dapat menerjemahkan tambahan "yang didekorasi" ke dalam C. 

Video terkait: Bagaimana Python membuat pemrograman lebih mudah

Sempurna untuk TI, Python menyederhanakan banyak jenis pekerjaan, dari otomatisasi sistem hingga bekerja di bidang-bidang mutakhir seperti pembelajaran mesin.

Sintaks Cython

Kata kunci yang digunakan untuk menghias kode Cython tidak ditemukan dalam sintaks Python konvensional. Mereka dikembangkan secara khusus untuk Cython, jadi kode apa pun yang didekorasi dengannya tidak akan berjalan sebagai program Python konvensional.

Ini adalah elemen paling umum dari sintaks Cython:

Jenis variabel

Beberapa jenis variabel yang digunakan dalam Cython adalah gema dari jenis Python sendiri, seperti  int, float, dan long. Jenis variabel Cython lainnya juga ditemukan di C, like charor struct, as are declarations like unsigned long. Dan yang lainnya unik untuk Cython, seperti bint, representasi tingkat-C dari True/Falsenilai-nilai Python .

Jenis cdefdan cpdeffungsi

Kata cdefkunci menunjukkan penggunaan tipe Cython atau C. Ini juga digunakan untuk mendefinisikan fungsi seperti yang Anda lakukan dengan Python.

Fungsi yang ditulis dalam Cython menggunakan defkata kunci Python dapat dilihat oleh kode Python lain, tetapi menimbulkan hukuman kinerja. Fungsi yang menggunakan cdefkata kunci hanya terlihat oleh kode Cython atau C lainnya, tetapi dijalankan lebih cepat. Jika Anda memiliki fungsi yang hanya dipanggil secara internal dari dalam modul Cython, gunakan cdef.

Kata kunci ketiga cpdef,, menyediakan kompatibilitas dengan kode Python dan kode C, sedemikian rupa sehingga kode C dapat mengakses fungsi yang dideklarasikan dengan kecepatan penuh. Kemudahan ini memiliki biaya, meskipun:  cpdeffungsi menghasilkan lebih banyak kode dan memiliki sedikit lebih banyak overhead panggilan daripada cdef.

Kata kunci Cython lainnya

Kata kunci lain di Cython memberikan kontrol atas aspek aliran program dan perilaku yang tidak tersedia di Python:

  • gildan nogil. Ini adalah manajer konteks yang digunakan untuk menggambarkan bagian kode yang memerlukan ( with gil:) atau tidak memerlukan ( with nogil:) Kunci Penerjemah Global Python, atau GIL. Kode C yang tidak membuat panggilan ke Python API dapat berjalan lebih cepat dalam sebuah nogilblok, terutama jika ia menjalankan operasi yang berjalan lama seperti membaca dari koneksi jaringan.
  • cimportIni mengarahkan Cython untuk mengimpor tipe data C, fungsi, variabel, dan tipe ekstensi. Aplikasi Cython yang menggunakan modul C asli NumPy, misalnya, digunakan cimportuntuk mendapatkan akses ke fungsi tersebut.
  • include. Ini menempatkan kode sumber dari satu file Cython di dalam yang lain, dengan cara yang hampir sama seperti di C. Perhatikan bahwa Cython memiliki cara yang lebih canggih untuk berbagi deklarasi antara file Cython selain hanya includes.
  • ctypedef. Digunakan untuk merujuk pada definisi tipe dalam file header C eksternal.
  • extern. Digunakan dengan cdefuntuk merujuk ke fungsi atau variabel C yang ditemukan di modul lain.
  • public/api. Digunakan untuk membuat deklarasi dalam modul Cython yang akan terlihat oleh kode C lainnya.
  • inline. Digunakan untuk menunjukkan bahwa fungsi yang diberikan harus sebaris, atau kodenya ditempatkan di badan fungsi pemanggil setiap kali digunakan, demi kecepatan. Misalnya, ffungsi dalam contoh kode di atas dapat didekorasi inlineuntuk mengurangi overhead panggilan fungsinya, karena hanya digunakan di satu tempat. (Perhatikan bahwa compiler C mungkin melakukan penyebarisannya sendiri secara otomatis, tetapi inlinememungkinkan Anda menentukan secara eksplisit apakah sesuatu harus sebaris.)

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

Hapus .cfile yang dihasilkan dalam proyek dan jalankan kembali setup.pyskrip untuk mengkompilasi ulang semuanya. Setelah selesai, Anda akan melihat file HTML dalam direktori yang sama dengan nama file .pyx Anda — dalam hal ini  num.html,. Buka file HTML dan Anda akan melihat bagian kode Anda yang masih bergantung pada Python yang disorot dengan warna kuning. Anda dapat mengklik pada area kuning untuk melihat kode C yang mendasari yang dihasilkan oleh Cython.