Урок за Cython: Как да ускорим Python

Python е мощен език за програмиране, който е лесен за изучаване и лесен за работа, но не винаги е най-бързият за изпълнение - особено когато се занимавате с математика или статистика. Библиотеки на трети страни като NumPy, които обгръщат C библиотеки, могат значително да подобрят производителността на някои операции, но понякога просто се нуждаете от суровата скорост и мощност на C директно в Python.

Cython е разработен, за да улесни писането на C разширения за Python и да позволи на съществуващия код на Python да бъде трансформиран в C. Нещо повече, Cython позволява оптимизираният код да бъде изпратен с приложение на Python без външни зависимости.

В този урок ще разгледаме стъпките, необходими за трансформиране на съществуващия код на Python в Cython и за използването му в производствено приложение.

Свързано видео: Използване на Cython за ускоряване на Python

Пример за Cython

Нека започнем с прост пример, взет от документацията на Cython, не много ефективно изпълнение на интегрална функция:

def f (x):

    връщане x ** 2-x

def integrate_f (a, b, N):

    s = 0

    dx = (ba) / N

    за i в обхват (N):

        s + = f (a + i * dx)

    връщане s * dx

Кодът е лесен за четене и разбиране, но работи бавно. Това е така, защото Python трябва постоянно да преобразува напред-назад между собствените си типове обекти и суровите цифрови типове на машината.

Сега помислете за версията на Cython на същия код, като добавките на Cython са подчертани:

 cdef f (двоен x):

    връщане x ** 2-x

def integrate_f (двойно a, двойно b, int N):

    cdef int i

    cdef двойно s, x, dx

    s = 0

    dx = (ba) / N

    за i в обхват (N):

        s + = f (a + i * dx)

    връщане s * dx

Тези допълнения ни позволяват да декларираме изрично типове променливи в целия код, така че компилаторът на Cython да може да преведе тези „декорирани“ добавки в C. 

Свързано видео: Как Python улеснява програмирането

Перфектен за ИТ, Python опростява много видове работа, от автоматизация на системата до работа в авангардни области като машинно обучение.

Синтаксис на Cython

Ключовите думи, използвани за украса на кода на Cython, не се срещат в конвенционалния синтаксис на Python. Те са разработени специално за Cython, така че всеки декориран с тях код няма да работи като конвенционална програма на Python.

Това са най-често срещаните елементи на синтаксиса на Cython:

Типове променливи

Някои от типовете на променливите, използвани в Cython са ехо на собствените видове Питон, като например  int, floatи long. Други типове променливи на Cython също се намират в C, like charили struct, както и декларациите like unsigned long. А други са уникални за Cython, като например bintпредставяне на True/Falseстойности на Python на ниво C.

В cdefи cpdefвидове функционални

В cdefключовата дума показва използването на тип Cython или C. Също така се използва за дефиниране на функции, както бихте направили в Python.

Функциите, написани в Cython, използвайки defключовата дума на Python, са видими за други кодове на Python, но налагат наказание за изпълнение. Функциите, които използват cdefключовата дума, са видими само за други Cython или C код, но се изпълняват много по-бързо. Ако имате функции, които се извикват само вътрешно от модул Cython, използвайте cdef.

Трета ключова дума, cpdefосигурява съвместимост както с кода на Python, така и с кода C, по такъв начин, че кодът C да има достъп до декларираната функция с пълна скорост. Това удобство обаче си струва:  cpdefфункциите генерират повече код и имат малко повече режийни разговори от cdef.

Други ключови думи на Cython

Други ключови думи в Cython осигуряват контрол върху аспекти на програмния поток и поведение, които не са налични в Python:

  • gilи nogil. Това са контекстни мениджъри, използвани за очертаване на раздели на кода, които изискват ( with gil:) или не изискват ( with nogil:) Глобалната интерпретационна ключалка на Python или GIL. Кодът C, който не извършва обаждания към API на Python, може да работи по-бързо в nogilблок, особено ако изпълнява продължителна операция, като четене от мрежова връзка.
  • cimportТова насочва Cython да импортира типове данни C, функции, променливи и типове разширения. Приложенията на Cython, които използват родните C модули на NumPy, например, използват, за cimportда получат достъп до тези функции.
  • include. Това поставя изходния код на един файл на Cython вътре в друг, по същия начин, както в C. Обърнете внимание, че Cython има по-сложен начин за споделяне на декларации между файлове на Cython, различни от само includes.
  • ctypedef. Използва се за препратка към дефиниции на типове във външни C заглавни файлове.
  • extern. Използва се с, за cdefда се позовава на C функции или променливи, намерени в други модули.
  • public/api. Използва се за деклариране в модули на Cython, които ще бъдат видими за други C кодове.
  • inline. Използва се, за да посочи дадена функция, трябва да бъде вградена или кодът й да бъде поставен в тялото на извикващата функция, когато тя се използва, за да се ускори Например, fфункцията в горния пример на код може да бъде украсена, за inlineда намали режийните извиквания на функциите си, защото се използва само на едно място. (Обърнете внимание, че компилаторът C може да извърши собствено вграждане автоматично, но 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.)

Изтрийте .cфайловете, генерирани в проекта, и стартирайте отново setup.pyскрипта, за да прекомпилирате всичко. Когато приключите, трябва да видите HTML файл в същата директория, който споделя името на вашия .pyx файл - в този случай  num.html,. Отворете HTML файла и ще видите частите на кода, които все още зависят от Python, маркирани в жълто. Можете да кликнете върху жълтите области, за да видите основния C код, генериран от Cython.