Calling C functions in Python
Question:
I have a bunch of functions that I’ve written in C and I’d like some code I’ve written in Python to be able to access those functions.
I’ve read several questions on here that deal with a similar problem (here and here for example) but I’m confused about which approach I need to take.
One question recommends ctypes and another recommends cython. I’ve read a bit of the documentation for both, and I’m completely unclear about which one will work better for me.
Basically I’ve written some python code to do some two dimensional FFTs and I’d like the C code to be able to see that result and then process it through the various C functions I’ve written. I don’t know if it will be easier for me to call the Python from C or vice versa.
Answers:
It’ll be easier to call C from python. Your scenario sounds weird – normally people write most of the code in python except for the processor-intensive portion, which is written in C. Is the two-dimensional FFT the computationally-intensive part of your code?
You should call C from Python by writing a ctypes wrapper. Cython is for making python-like code run faster, ctypes is for making C functions callable from python. What you need to do is the following:
- Write the C functions you want to use. (You probably did this already)
- Create a shared object (.so, for linux, os x, etc) or dynamically loaded library (.dll, for windows) for those functions. (Maybe you already did this, too)
- Write the ctypes wrapper (It’s easier than it sounds, I wrote a how-to for that)
- Call a function from that wrapper in Python. (This is just as simple as calling any other python function)
If I understand well, you have no preference for dialoging as c => python or like python => c.
In that case I would recommend Cython. It is quite open to many kinds of manipulation, specially, in your case, calling a function that has been written in Python from C.
Here is how it works (public api) :
The following example assumes that you have a Python Class (self is an instance of it), and that this class has a method (name method) you want to call on this class and deal with the result (here, a double) from C. This function, written in a Cython extension would help you to do this call.
cdef public api double cy_call_func_double(object self, char* method, bint *error):
if (hasattr(self, method)):
error[0] = 0
return getattr(self, method)();
else:
error[0] = 1
On the C side, you’ll then be able to perform the call like so :
PyObject *py_obj = ....
...
if (py_obj) {
int error;
double result;
result = cy_call_func_double(py_obj, (char*)"initSimulation", &error);
cout << "Do something with the result : " << result << endl;
}
Where PyObject is a struct provided by Python/C API
After having caught the py_obj (by casting a regular python object, in your cython extension like this : <PyObject *>my_python_object), you would finally be able to call the initSimulation method on it and do something with the result.
(Here a double, but Cython can deal easily with vectors, sets, …)
Well, I am aware that what I just wrote can be confusing if you never wrote anything using Cython, but it aims to be a short demonstration of the numerous things it can do for you in term of merging.
By another hand, this approach can take more time than recoding your Python code into C, depending on the complexity of your algorithms.
In my opinion, investing time into learning Cython is pertinent only if you plan to have this kind of needs quite often…
Hope this was at least informative…
Well, here you are referring to two below things.
- How to call c function within from python (Extending python)
- How to call python function/script from C program (Embedding Python)
For #2 that is ‘Embedding Python’
You may use below code segment:
#include "python.h"
int main(int argc, char *argv[]) {
Py_SetProgramName(argv[0]); /* optional but recommended */
Py_Initialize();
PyRun_SimpleString("from time import time,ctimen"
"print 'Today is',ctime(time())n");
/*Or if you want to run python file within from the C code*/
//pyRun_SimpleFile("Filename");
Py_Finalize();
return 0; }
For #1 that is ‘Extending Python’
Then best bet would be to use Ctypes (btw portable across all variant of python).
from ctypes import *
libc = cdll.msvcrt
print libc.time(None)
1438069008
printf = libc.printf
printf(“Hello, %sn”, “World!”)
Hello, World!
14
printf(“%d bottles of beern”, 42)
42 bottles of beer
19
For detailed guide you may want to refer to my blog article:
There’s a nice and brief tutorial on this from Digital Ocean here. Short version:
1. Write C Code
You’ve already done this, so super short example:
#include <stdio.h>
int addFive(int i) {
return i + 5;
}
2. Create Shared Library File
Assuming the above C file is saved as c_functions.c, then to generate the .so file to call from python type in your terminal:
cc -fPIC -shared -o c_functions.so c_functions.c
3. Use Your C Code in Python!
Within your python module:
# Access your C code
from ctypes import *
so_file = "./c_functions.so"
c_functions = CDLL(so_file)
# Use your C code
c_functions.addFive(10)
That last line will output 15. You’re done!
I have a bunch of functions that I’ve written in C and I’d like some code I’ve written in Python to be able to access those functions.
I’ve read several questions on here that deal with a similar problem (here and here for example) but I’m confused about which approach I need to take.
One question recommends ctypes and another recommends cython. I’ve read a bit of the documentation for both, and I’m completely unclear about which one will work better for me.
Basically I’ve written some python code to do some two dimensional FFTs and I’d like the C code to be able to see that result and then process it through the various C functions I’ve written. I don’t know if it will be easier for me to call the Python from C or vice versa.
It’ll be easier to call C from python. Your scenario sounds weird – normally people write most of the code in python except for the processor-intensive portion, which is written in C. Is the two-dimensional FFT the computationally-intensive part of your code?
You should call C from Python by writing a ctypes wrapper. Cython is for making python-like code run faster, ctypes is for making C functions callable from python. What you need to do is the following:
- Write the C functions you want to use. (You probably did this already)
- Create a shared object (.so, for linux, os x, etc) or dynamically loaded library (.dll, for windows) for those functions. (Maybe you already did this, too)
- Write the ctypes wrapper (It’s easier than it sounds, I wrote a how-to for that)
- Call a function from that wrapper in Python. (This is just as simple as calling any other python function)
If I understand well, you have no preference for dialoging as c => python or like python => c.
In that case I would recommend Cython. It is quite open to many kinds of manipulation, specially, in your case, calling a function that has been written in Python from C.
Here is how it works (public api) :
The following example assumes that you have a Python Class (self is an instance of it), and that this class has a method (name method) you want to call on this class and deal with the result (here, a double) from C. This function, written in a Cython extension would help you to do this call.
cdef public api double cy_call_func_double(object self, char* method, bint *error):
if (hasattr(self, method)):
error[0] = 0
return getattr(self, method)();
else:
error[0] = 1
On the C side, you’ll then be able to perform the call like so :
PyObject *py_obj = ....
...
if (py_obj) {
int error;
double result;
result = cy_call_func_double(py_obj, (char*)"initSimulation", &error);
cout << "Do something with the result : " << result << endl;
}
Where PyObject is a struct provided by Python/C API
After having caught the py_obj (by casting a regular python object, in your cython extension like this : <PyObject *>my_python_object), you would finally be able to call the initSimulation method on it and do something with the result.
(Here a double, but Cython can deal easily with vectors, sets, …)
Well, I am aware that what I just wrote can be confusing if you never wrote anything using Cython, but it aims to be a short demonstration of the numerous things it can do for you in term of merging.
By another hand, this approach can take more time than recoding your Python code into C, depending on the complexity of your algorithms.
In my opinion, investing time into learning Cython is pertinent only if you plan to have this kind of needs quite often…
Hope this was at least informative…
Well, here you are referring to two below things.
- How to call c function within from python (Extending python)
- How to call python function/script from C program (Embedding Python)
For #2 that is ‘Embedding Python’
You may use below code segment:
#include "python.h"
int main(int argc, char *argv[]) {
Py_SetProgramName(argv[0]); /* optional but recommended */
Py_Initialize();
PyRun_SimpleString("from time import time,ctimen"
"print 'Today is',ctime(time())n");
/*Or if you want to run python file within from the C code*/
//pyRun_SimpleFile("Filename");
Py_Finalize();
return 0; }
For #1 that is ‘Extending Python’
Then best bet would be to use Ctypes (btw portable across all variant of python).
from ctypes import *
libc = cdll.msvcrt
print libc.time(None)
1438069008
printf = libc.printf
printf(“Hello, %sn”, “World!”)
Hello, World!
14printf(“%d bottles of beern”, 42)
42 bottles of beer
19
For detailed guide you may want to refer to my blog article:
There’s a nice and brief tutorial on this from Digital Ocean here. Short version:
1. Write C Code
You’ve already done this, so super short example:
#include <stdio.h>
int addFive(int i) {
return i + 5;
}
2. Create Shared Library File
Assuming the above C file is saved as c_functions.c, then to generate the .so file to call from python type in your terminal:
cc -fPIC -shared -o c_functions.so c_functions.c
3. Use Your C Code in Python!
Within your python module:
# Access your C code
from ctypes import *
so_file = "./c_functions.so"
c_functions = CDLL(so_file)
# Use your C code
c_functions.addFive(10)
That last line will output 15. You’re done!