Jak zawinąć klasę C++ za pomocą Cythona?

Question

Mam klasę C++. Składa się z jednego pliku .ccp i jednego pliku .h. Kompiluje (mogę napisać główną metodę, która z powodzeniem używa go w C++). Jak zawinąć tę klasę w Cython, aby była dostępna w Pythonie?

Czytałem dokumenty i nie stosuję się do nich. Mówią o generowaniu pliku cpp. Kiedy próbowałem podążać za dokumentami, mój już istniejący cpp zostaje zdmuchnięty ...

Co mam zamiar umieścić w pliku pyx? Powiedziano mi definicji klasy, ale ile z tego? Tylko publiczne metody?

Czy potrzebny jest plik .pxd? Nie rozumiem, kiedy ten plik jest lub nie jest wymagany.

Próbowałem już zadawać te pytania na kanale IRC#python i nie mogę uzyskać odpowiedzi.

Answer 1

Po wielu szturchańcach, próbach i błędach, krzyczeniu i wydzieraniu włosów, w końcu udało mi się to zrobić. Najpierw jednak musiałem ponownie napisać moje C++ do C, co dla mnie naprawdę wymagało konwersji wszystkich zmiennych std::string na char* i śledzenia niektórych długości.

Kiedy skończyłem, miałem pliki .h i .c. Chciałem utworzyć jedną funkcję z kodu C dostępnego w Pythonie. Okazuje się, że Cython może skompilować twoje pliki C do rozszerzenia dla ciebie i połączyć wszystkie biblioteki za jednym razem, więc zaczynając od mojej instalacji.py, skończyło się patrząc tak:

from distutils.core import setup 
from distutils.extension import Extension 
from Cython.Distutils import build_ext 

ext_modules=[ 
    Extension("myext", 
    ["myext.pyx", "../stuff.c"], 
    libraries=["ssl", "crypto"] 
) 
] 

setup(
    name = "myext", 
    cmdclass = {"build_ext": build_ext}, 
    ext_modules = ext_modules 
) 

Jak widać, drugi argument do przedłużenia po prostu listę wszystkich plików, które muszą być kompilowane, Cython odrabia jak skompilować je w zależności od ich rozszerzenia pliku o ile mogę powiedzieć. Tablica bibliotek informuje kompilator Cythona, co musi być połączone (w tym przypadku owijałem niektóre elementy kryptograficzne, których nie mogłem udawać bezpośrednio przez istniejące biblioteki Pythona).

Aby rzeczywiście udostępnić moją funkcję C w pliku .pyx, należy napisać małe opakowanie w pliku .pxd. Moja myext.pxd wyglądał jak poniżej:

cdef extern from "../stuff.h": 
    char* myfunc(char* arg1, char* arg2, char* arg3) 

W .pyx następnie użyć deklarację cimport importować tę funkcję, która jest wtedy gotowy do użycia, jakby to była jakakolwiek inna funkcja Python:

cimport myext 

def my_python_func(arg1, arg2, arg3): 
    result = myext.myfunc(arg1, arg2, arg3) 
    return result 

Podczas kompilacji (na Macie przynajmniej) otrzymasz plik .so, który możesz zaimportować do Pythona i uruchomić funkcje z .pyx. Może być lepszy, bardziej poprawny sposób, aby wszystko działało, ale pochodzi z doświadczenia i to było pierwsze spotkanie, które udało mi się wypracować. Byłbym bardzo zainteresowany wskazówkami, w których mógłbym pójść źle.

Aktualizacja:

Po dalszego stosowania Cython, uważam, że to było bardzo proste, aby zintegrować go z C++ też, gdy wiesz, co robisz. Udostępnienie dostępnego w C++ string jest tak proste jak from libcpp.string cimport string w twoim pyx/pyd. Deklarując klasę C++ jest równie łatwe, jak:

cdef extern from "MyCPPClass.h": 
    cdef cppclass MyCPPClass: 
     int foo; 
     string bar; 

Pewnie trzeba zasadzie redeclare się .h definicję klasy w formacie pythonic, ale to niewielka cena za uzyskanie dostępu do już napisanych funkcji C++ .

Answer 2

Cython przeznaczony jest głównie do programowania w języku C, do integracji języka C++ z Pythonem Polecam Boost.Python. Ich doskonała dokumentacja powinna dość szybko zacząć pracę.

Answer 3

Nawet Cython jest ogólnie do użytku z C, może również wygenerować kod C++. Podczas kompilacji dodajesz flagę --cplus.

Teraz tworzenie wrapperów dla klasy jest proste i niewiele różni się od zawijania struktury. Różni się on głównie od zadeklarowania extern, ale to nie jest wielka różnica.

Załóżmy, że masz klasę MyCppClass w mycppclass.h.

cdef extern from "mycppclass.h": 
    cppclass MyCppClass: 
     int some_var 

     MyCppClass(int, char*) 
     void doStuff(void*) 
     char* getStuff(int) 

cdef class MyClass: 

    # the public-modifier will make the attribute public for cython, 
    # not for python. Maybe you need to access the internal C++ object from 
    # outside of the class. If not, you better declare it as private by just 
    # leaving out the `private` modifier. 
    # ---- EDIT ------ 
    # Sorry, this statement is wrong. The `private` modifier would make it available to Python, 
    # so the following line would cause an error es the Pointer to MyCppClass 
    # couldn't be converted to a Python object. 
    #>> cdef public MyCppClass* cobj 
    # correct is: 
    cdef MyCppClass* obj 

    def __init__(self, int some_var, char* some_string): 
     self.cobj = new MyCppClass(some_var, some_string) 
     if self.cobj == NULL: 
      raise MemoryError('Not enough memory.') 

    def __del__(self): 
     del self.cobj 

    property some_var: 
     def __get__(self): 
      return self.cobj.some_var 
     def __set__(self, int var): 
      self.cobj.some_var = var 

Zauważ, że słowo kluczowe new jest dostępna tylko wtedy, gdy jest ustawiona flaga --cplus, inaczej używać malloc z <stdlib.h> przez externing go.

Należy również pamiętać, że nie trzeba usuwać wskaźnika (->), aby wywołać metodę. Cython śledzi typ obiektu i stosuje to, co pasuje. Pliki

.pxd służą do oddzielania deklaracji od implementacji lub do unikania kolizji nazw. Wyobraź sobie, że chcesz nadać nazwę opakowaniu Pythona, takiemu jak klasa C++. Po prostu umieść w pliku .pxd deklaracje extern i cimport plik pxd w .pyx.

cimport my_pxd 
cdef my_pxd.SomeExternedType obj 

Uwaga: nie można pisać implementacji w pliku .pxd.