ctypes struct returned from library
What you ar asking is nto the sole problem in your example. Just to answer just what you asked first: you have to annotate the C function return type, so that ctypes know it is a memory address - otherwise it is a (4 byte) integer by default (while in any 64 bit OS, pointers are 8 bytes long).
Then you can create Python side POINT structures by using the (hidden) "from_address" method in your POINT class:
test_lib.get_point.restype = c_void_p
p = POINT.from_address(test_lib.get_point())
print(p.x, p.y)
Before that works, however, you have a more fundamental issue on the C side: the POINT structure you declare on your example only exists while get_point
is running, and is deallocated afterwards. The code above would lead to a segmentation fault.
Your C code have to allocate memory properly. And also, you should take provisions to deallocate data structures you allocate in C - otherwise you will have memory leaks as each call to the function in C allocates more memory and you don't free that. (Notice that this memory won't be freed by itself when the Python POINT object goes out of scope).
Your C code could be like this:
#include <stdlib.h>
#include <stdio.h>
typedef struct point {
int x;
int y;
} POINT;
POINT *get_point()
{
POINT *p;
POINT initial = {1, 2};
p = malloc(sizeof(POINT));
*p = initial;
return p;
}
void free_point(POINT *p)
{
free(p);
}
And with this Python part:
from ctypes import *
import os
lib_name = '/testlib.so'
test_lib = CDLL(os.getcwd() + lib_name)
class POINT(Structure):
_fields_ = [('x', c_int),
('y', c_int)]
test_lib.get_point.restype = c_void_p
p1 = POINT.from_address( test_lib.get_point())
print (p1.x, p1.y)
test_lib.free_point(byref(p1))
del p1
everything should just work.
(just so that this answer is a complete ctypes example, I will add the GCC commands to build the testlib file:
gcc -c -fPIC test.c -o test.o
gcc test.o -shared -o testlib.so
)
Here's the basics. Although not strictly required in this case, setting .argtypes
and .restype
correctly helps ctypes
marshal parameters correctly and detect incorrectly passed parameters.
Similar to passing arrays to C functions, create_string_buffer
returns an c_char_Array_array_size
object, but it is marshaled as a pointer to it's first element (c_char_p
) so it agrees with the .argtypes
assignment.
Without the .argtypes
assignment, passing something incorrect such as an int
or a create_unicode_buffer()
array would crash or have the wrong result. But defining it correctly would catch those errors and raise an exception.
test.c
#include <string.h>
#ifdef _WIN32
# define API __declspec(dllexport)
#else
# define API
#endif
API int get_camera_info(char * description, char * serial_number, char * manufacturer)
{
strcpy(description, "Description");
strcpy(serial_number, "12345678");
strcpy(manufacturer, "Manufacturer");
return 1;
}
test.py
from ctypes import *
MAX_STR = 256 # docs better say how big the buffers are required to be.
# int get_camera_info(char * description, char * serial_number, char * manufacturer)
dll = CDLL('./test')
dll.get_camera_info.argtypes = c_char_p,c_char_p,c_char_p
dll.get_camera_info.restype = c_int
desc = create_string_buffer(MAX_STR)
sn = create_string_buffer(MAX_STR)
mfg = create_string_buffer(MAX_STR)
ret = dll.get_camera_info(desc,sn,mfg)
print(desc.value.decode(),sn.value.decode(),mfg.value.decode())
Output:
Description 12345678 Manufacturer
Note that .value
returns a byte string at the beginning of the buffer up to the first null byte exclusive. .raw
will dump a byte string with every byte of the buffer. .decode()
converts a byte string into a Unicode string using UTF-8 as the default encoding.
数据映射:
[const] char * -> string.encode()