Vytváříme v C/C++ modul pro Python

Michal Hořejšek 3. 11. 2009

Programovací jazyk Python má velké plus, že složité věci v něm můžete napsat opravdu jednoduše a tím urychlit vývoj. Naopak velkým nedostatkem je výkon tohoto jazyka. U malých projektů to sice nepocítíte, ale u větších, kde se často něco počítá, to je horší. Jak pro Python vytvořit modul v C/C++?

Python je velmi oblíbený jazyk hlavně díky jeho jednoduchosti, tedy díky tomu, že je interpretovaný. Proto můžeme složité věci psát jednoduše a místo několika řádků v C/C++ napsat jen jeden a máme vystaráno – je to dobré pro čitelnost. Dále je to výborné kvůli přenositelnosti – nemusíme totiž zdrojový kód kompilovat do strojového kódu pro každou architekturu a stačí jen spustit zdrojový kód a nechat zpracovávat instrukci za instrukcí.

python logo

Chcete o Pythonu vědět více?

Pokud se chcete o programovacím jazyce Python dozvědět více, určitě nesmíte vynechat náš seriál Létající cirkus, kde se v jednadvaceti článcích dozvíte o vývoji v Pythonu to nejdůležitější.

Z tohoto důvodu je zároveň ale Python pomalejší a výrazně se to projeví na opravdu náročných výpočtech (sám o sobě je Python rychlík ve srovnání s jinými interpretovanými jazyky, zvlášť když umíme Python správně využít). Pro eliminaci této nevýhody můžeme využít možnost vyrábět pro Python v jazyku C nebo C++ (existuje i implementace v jazyce Java).

C/C++ kód

Ukážeme si jednoduchou ukázku, jak si vyrobit v C/C++ malou kalkulačku, která bude umět sčítání a odčítání a kterou budeme používat v Pythonu.

#include <Python.h>

PyDoc_STRVAR( calc__doc__, "calc" );
PyDoc_STRVAR( plus__doc__, "plus(x,y)" );
PyDoc_STRVAR( minus__doc__, "minus(x,y)" );

static PyObject * py_plus( PyObject *self, PyObject *args )
{
  int x=0, y=0;
  if ( !PyArg_ParseTuple( args, "ii", &x, &y ) )
    return NULL;
  return PyInt_FromLong( ( long ) x+y );
}

static PyObject * py_minus( PyObject *self, PyObject *args )
{
  int x=0, y=0;
  if ( !PyArg_ParseTuple( args, "ii", &x, &y ) )
    return NULL;
  return PyInt_FromLong( ( long ) x-y );
}

static PyMethodDef calc_methods[] = {
  { "plus",  py_plus, METH_VARARGS, plus__doc__ },
  { "minus",  py_minus, METH_VARARGS, minus__doc__ },
  { NULL, NULL }
};

PyMODINIT_FUNC initcalc( void )
{
  Py_InitModule3( "calc", calc_methods, calc__doc__ );
}

Nejprve si na prvním nainkludujeme potřebný hlavičkový soubor, abychom mohli modul pro Python vytvořit.

Na třetím až pátým řádku si nadefinujeme dokumentační proměnné pro náš modul i funkce. Tyto řetězce budou poté přístupné klasicky v Pythonu pod proměnnou __doc__. (Můžeme si nechat zobrazit instrukcí  print calc.__doc__).

Poté následují samotné funkce modulu. Na sedmém řádku je, jak má vypadat, hlavička funkce, která se bude volat z Pythonu. Pokud se ptáte, co to je PyObject, tak je to univerzální pythoní datový typ pro cokoli. Pro každou funkci budeme mít vždy připraveny dva argumenty. První argument je self určuje objekt, který voláme (v našem případě to bude vždy Null) a druhý argument args předává funkci v C/C++ všechny předávané argumenty z Pythonu.

V obou funkcích budeme pracovat s dvěmi celými čísly, a proto si v obou funkcích nejprve nadefinujeme dvě proměnné typu integer. Tyto proměnné následně naplníme předávanými čísly z Pythonu pomocí PyArg_ParseTuple. Tato funkce nám nejen „vytáhne“ čísla, ale zabrání nesprávnému použití (například špatný datový typ, či jiný počet argumentů), proto funkci používám v podmínce a v případě selhání vrátím NULL (pokud se ptáte proč NULL a ne Py_None, který reprezentuje pythoní None, tak je to proto, že chceme, aby se vyvolala výjimka a oznámila chybu). Pokud vše dobře dopadne, tak nakonec vrátím pythoní datový typ integer pomocí funkce PyInt_FromLong (všimněte si, že jsem při výpočtu přetypoval výsledek na  long integer).

Sice máme funkce napsané, ale v Pythonu ještě nebudou přístupné, protože nejsou namapovány. Takže po funkcích py_plus a py_minus následuje inicializace pole s funkcemi, které budou v Pythonu přístupné. V poli jsou pole, která na první položce definují název funkce v Pythonu; na další položce název funkce v C/C++; na třetí položce nalezneme METH_VARARGS, což určuje, že funkce nemá klíčové položky; a nakonec, na posledním místě je dokumentace k funkci – použité proměnné jsme si deklarovali už na začátku a můžeme klidně psát komentáře přímo sem. Jako na posledním místě musí být zarážka, která určuje konec a je to pouze pole složené z dvou položek, které jsou obě nastaveny na  NULL.

Úplně nakonec napíšeme inicializační funkci, která se provede po načtení modulu. V této rutině pouze inicializujeme modul funkcí Py_InitModule3 a sdělíme název modulu, mapování funkcí a dokumentaci k modulu.

Kompilace modulu

Tímto máme zdrojový kód našeho modulu a potřebujeme ho zkompilovat. Snad nejjednodušší cesta je pomocí Pythonu.

from distutils.core import setup, Extension
setup( name="calc", version="0.0", ext_modules = [ Extension( "calc", ["calc.c"] ) ] )

Nejprve jsme si importovali potřebné metody a poté jen zavolali metodu setup, která se o celou kompilaci postará. Nastaví jméno a verzi modulu (lze nastavit více věcí, podívejte se do dokuemtace). Argument ext_modules nastaví vstupní C/C++ soubor a výstupní název modulu.

Po zavolání tohoto pythoního skriptu se nám modul v C/C++ zkompiluje a nalezneme modul přibližně ve složce ""./build/lib.linux-x86_64–2.6"" (já mám 64bit systém, proto x86_64, proto se název složky může mírně měnit), kde je soubor ""calc.so"". Tento soubor je náš modul a přidáme si ho do složky našeho projektu.

Využívání modulu

Využívat modul je už hračkou. Stačí, pokud zkusíme zavolat postupně tyto instrukce:

>>> import calc
>>> calc.__doc__
'calc'
>>> calc.plus( 5, 2 )
7
>>> calc.minus.__doc__
'minus(x,y)'
>>> calc.minus( 5, 3 )
2

Závěr

Takto jednoduché je napsat vlastní jednoduchý modul v C/C++ pro Python a další informace můžete nalézt například v dokumentaci. Někdy příště se podíváme na nějaké specialitky při vytváření modulů pro Python.

Našli jste v článku chybu?
Měšec.cz: Udali ho na nelegální software a přišla Policie

Udali ho na nelegální software a přišla Policie

120na80.cz: Jak se zbavit nadměrného pocení?

Jak se zbavit nadměrného pocení?

DigiZone.cz: ČTÚ, červen: rušení lehce pokleslo

ČTÚ, červen: rušení lehce pokleslo

120na80.cz: SOS aneb spálená pokožka

SOS aneb spálená pokožka

Měšec.cz: Se stavebkem k soudu už (většinou) nemusíte

Se stavebkem k soudu už (většinou) nemusíte

Lupa.cz: eIDAS: Nepřehnali jsme to s výjimkami?

eIDAS: Nepřehnali jsme to s výjimkami?

Vitalia.cz: Paní výčepní: Holka, co mluví chlapům do piva

Paní výčepní: Holka, co mluví chlapům do piva

Vitalia.cz: Zmrzlinu? Ani snad ne

Zmrzlinu? Ani snad ne

Měšec.cz: Kurzy platebních karet: vyplatí se platit? (TEST)

Kurzy platebních karet: vyplatí se platit? (TEST)

Vitalia.cz: Mateřská - nejlepší období v životě ženy? Hahahaha

Mateřská - nejlepší období v životě ženy? Hahahaha

DigiZone.cz: Sázka na e-sporty stanici Prima vychází

Sázka na e-sporty stanici Prima vychází

DigiZone.cz: Skylink o půlnoci vypnul 12 525

Skylink o půlnoci vypnul 12 525

Lupa.cz: eIDAS: elektronické dokumenty platí jako papír

eIDAS: elektronické dokumenty platí jako papír

DigiZone.cz: Sat novinky: Skylink skončil s kanály ČT

Sat novinky: Skylink skončil s kanály ČT

Podnikatel.cz: Polská vejce na českém pultu Albertu

Polská vejce na českém pultu Albertu

Podnikatel.cz: Tahle praktika stála šmejdy přes milion

Tahle praktika stála šmejdy přes milion

Podnikatel.cz: Akční plán podpoří byznys padesátníků

Akční plán podpoří byznys padesátníků

Vitalia.cz: Klíšťata letos řádí, skvrna se udělá jen někomu

Klíšťata letos řádí, skvrna se udělá jen někomu

DigiZone.cz: Ve Varech představeni i noví "Četníci"

Ve Varech představeni i noví "Četníci"

Podnikatel.cz: 3 velké průšvihy obchodních řetězců

3 velké průšvihy obchodních řetězců