Python Language
Scrivere estensioni

Ciao mondo con estensione C

Il seguente file sorgente C (che chiameremo hello.c a scopo dimostrativo) produce un modulo di estensione denominato hello che contiene una singola funzione greet() :

#include <Python.h>
#include <stdio.h>

#if PY_MAJOR_VERSION >= 3
#define IS_PY3K
#endif

static PyObject *hello_greet(PyObject *self, PyObject *args)
{
    const char *input;
    if (!PyArg_ParseTuple(args, "s", &input)) {
        return NULL;
    }
    printf("%s", input);
    Py_RETURN_NONE;
}

static PyMethodDef HelloMethods[] = {
    { "greet", hello_greet, METH_VARARGS, "Greet the user" },
    { NULL, NULL, 0, NULL }
};

#ifdef IS_PY3K
static struct PyModuleDef hellomodule = {
    PyModuleDef_HEAD_INIT, "hello", NULL, -1, HelloMethods
};

PyMODINIT_FUNC PyInit_hello(void)
{
    return PyModule_Create(&hellomodule);
}
#else
PyMODINIT_FUNC inithello(void)
{
    (void) Py_InitModule("hello", HelloMethods);
}
#endif

Per compilare il file con il compilatore gcc , esegui il seguente comando nel tuo terminale preferito:

gcc /path/to/your/file/hello.c -o /path/to/your/file/hello

Per eseguire la funzione greet() che abbiamo scritto in precedenza, creare un file nella stessa directory e chiamarlo hello.py

import hello          # imports the compiled library
hello.greet("Hello!") # runs the greet() function with "Hello!" as an argument

Passare un file aperto alle estensioni C

Passa un oggetto file aperto da Python al codice di estensione C.

È possibile convertire il file in un descrittore di file intero utilizzando la funzione PyObject_AsFileDescriptor :

PyObject *fobj;
int fd = PyObject_AsFileDescriptor(fobj);
if (fd < 0){
    return NULL;
}

Per convertire un descrittore di file intero in un oggetto python, usa PyFile_FromFd .

int fd; /* Existing file descriptor */
PyObject *fobj = PyFile_FromFd(fd, "filename","r",-1,NULL,NULL,NULL,1);

Estensione C con c ++ e Boost

Questo è un esempio di base di un'estensione C che utilizza C ++ e Boost .

Codice C ++

Codice C ++ messo in hello.cpp:

#include <boost/python/module.hpp>
#include <boost/python/list.hpp>
#include <boost/python/class.hpp>
#include <boost/python/def.hpp>

// Return a hello world string.
std::string get_hello_function()
{
   return "Hello world!";
}

// hello class that can return a list of count hello world strings.
class hello_class
{
public:

   // Taking the greeting message in the constructor.
   hello_class(std::string message) : _message(message) {}

   // Returns the message count times in a python list.
   boost::python::list as_list(int count)
   {
      boost::python::list res;
      for (int i = 0; i < count; ++i) {
         res.append(_message);
      }
      return res;
   }
   
private:
   std::string _message;
};


// Defining a python module naming it to "hello".
BOOST_PYTHON_MODULE(hello)
{
   // Here you declare what functions and classes that should be exposed on the module.

   // The get_hello_function exposed to python as a function.
   boost::python::def("get_hello", get_hello_function);

   // The hello_class exposed to python as a class.
   boost::python::class_<hello_class>("Hello", boost::python::init<std::string>())
      .def("as_list", &hello_class::as_list)
      ;   
}

Per compilarlo in un modulo python occorrono le intestazioni python e le librerie boost. Questo esempio è stato realizzato su Ubuntu 12.04 usando python 3.4 e gcc. Boost è supportato su molte piattaforme. Nel caso di Ubuntu i pacchetti necessari sono stati installati usando:

sudo apt-get install gcc libboost-dev libpython3.4-dev

Compilare il file sorgente in un file .so che può essere successivamente importato come modulo purché si trovi sul percorso python:

gcc -shared -o hello.so -fPIC -I/usr/include/python3.4 hello.cpp -lboost_python-py34 -lboost_system -l:libpython3.4m.so

Il codice python nel file example.py:

import hello

print(hello.get_hello())

h = hello.Hello("World hello!")
print(h.as_list(3))

Quindi python3 example.py darà il seguente risultato:

Hello world!
['World hello!', 'World hello!', 'World hello!']