Editing PyMaemo/Accessing APIs without Python bindings

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
== Introduction ==
== Introduction ==
-
There are many libraries written in C that do not have native Python bindings yet. In Maemo, one of such libraries is libosso-abook, which manipulates the address book on Maemo devices.
+
Sometimes you don't need a complete binding for some library, just a couple functions that will solve your problem. For these cases, you can use the <code>ctypes</code> module to cherry-pick the needed functions and use them inside Python, no further steps needed.
-
While a full binding is very useful, in most cases you need to use just a couple of functions and data structures to get your work done. Instead of waiting for a binding to be implemented, you can use Python's <code>ctypes</code> module, which allows to directly call functions and access data structures from C libraries.
+
This page is not meant to be a complete <code>ctypes</code> guide; there is some great documentation at http://docs.python.org/library/ctypes.html.  
-
This document will explain how to do call C library functions using <code>ctypes</code>, using mainly libosso-abook as an example. The idea has been borrowed from [http://hermes.garage.maemo.org/ Hermes] application source code, which in turn is based on the trick described on the [http://faq.pygtk.org/index.py?req=show&file=faq23.041.htp PyGTK FAQ].
+
== Usage ==
-
This document is not meant to be a complete <code>ctypes</code> guide; for that, be sure to read the [http://docs.python.org/library/ctypes.html official API documentation]. It is assumed that you have read that document before continuing.
+
Let's say you want to use libc's printf, for some reason. All you need in python is:
-
== Basic Usage ==
+
import ctypes
 +
libc = ctypes.CDLL('libc.so.6')
 +
libc.printf('Hello world!')
-
Let's say you want to use <code>printf()</code> from the GNU C Library. All you need in Python is:
 
-
<source lang="python">
 
-
import ctypes
 
-
libc = ctypes.CDLL('libc.so.6')
 
-
libc.printf('Hello world!')
 
-
</source>
 
In a few words, you create an object correspondent to the library you need and use it to call the function directly. You can also store the functions in plain python objects to use them easily later:
In a few words, you create an object correspondent to the library you need and use it to call the function directly. You can also store the functions in plain python objects to use them easily later:
-
<source lang="python">
+
 
-
c_printf = libc.printf
+
c_printf = libc.printf
-
c_printf('Hello libc')
+
c_printf('Hello libc')
-
</source>
+
 
-
Remember that those are C functions, not Python ones, so you must supply arguments of the correct type to avoid undefined behavior (such as segmentation faults). As an example, if an integer is passed to the above function, you get
+
Remember that those are C functions, not Python ones, so you must supply arguments of the correct type to avoid undefined behavior. As a example, if I pass an integer to the above function, I get
  >>> c_printf(1)
  >>> c_printf(1)
  Segmentation fault (core dumped)
  Segmentation fault (core dumped)
-
== Initializing libosso-abook ==
+
== Wrapping function arguments ==
-
 
+
-
libosso-abook needs to be initialized by calling [http://maemo.org/api_refs/5.0/5.0-final/libosso-abook/libosso-abook-osso-abook-init.html#osso-abook-init osso-abook-init()]. This is similar to the example above, but a little more complex because the function takes three pointers: argc, argv and the OSSO context. First of all, you must create a <code>osso.Context</code> instance using the "osso" module (provided by python-osso):
+
-
<source lang="python">
+
-
import osso
+
-
 
+
-
osso_ctx = osso.Context("test_abook", "0.1")
+
-
</source>
+
-
Note: there is no documentation for python-osso yet, so see the C documentation for [http://maemo.org/api_refs/5.0/5.0-final/libosso/group__Init.html#g05d45d1e72c2cd74f665086225141431 osso_initialize()] for details about osso.Context() arguments. Note that only "application" and "version" attributes are used in Python.
+
-
 
+
-
Next, load and initialize libosso-abook library:
+
-
<source lang="python">
+
-
import sys
+
-
import ctypes
+
-
# be sure to import gtk before calling osso_abook_init()
+
-
import gtk
+
-
 
+
-
osso_abook = ctypes.CDLL('libosso-abook-1.0.so.0')
+
-
argv_type = ctypes.c_char_p * len(sys.argv)
+
-
argv = argv_type(*sys.argv)
+
-
argc = ctypes.c_int(len(sys.argv))
+
-
osso_abook.osso_abook_init(ctypes.byref(argc), ctypes.byref(argv), hash(osso_ctx))
+
-
</source>
+
-
The byref() function returns a pointer to the given data. The hash() function returns the memory address of the argument.
+
-
 
+
-
== Calling a Function Which Returns a GObject ==
+
-
 
+
-
Every GObject instance created by a C library must have a corresponding Python object, so that it can be manipulated on Python code. This object, which acts like a "wrapper" around the C pointer, is created using the pygobject_new() C function. Unfortunately, pygobject_new() is not a plain function, but a macro which points to a function pointer in a struct (see /usr/include/pygtk-2.0/pygobject.h on the "#define pygobject_new ..." line), making it a little more complex to be called from Python. The snippet of code below, borrowed from [http://faq.pygtk.org/index.py?req=show&file=faq23.041.htp PyGTK FAQ], will take care of this:
+
-
<source lang="python">
+
-
# ctypes wrapper for pygobject_new(), based on code snippet from
+
-
# http://faq.pygtk.org/index.py?req=show&file=faq23.041.htp
+
-
class _PyGObject_Functions(ctypes.Structure):
+
-
    _fields_ = [
+
-
        ('register_class',
+
-
            ctypes.PYFUNCTYPE(ctypes.c_void_p, ctypes.c_char_p,
+
-
            ctypes.c_int, ctypes.py_object, ctypes.py_object)),
+
-
        ('register_wrapper',
+
-
            ctypes.PYFUNCTYPE(ctypes.c_void_p, ctypes.py_object)),
+
-
        ('register_sinkfunc',
+
-
            ctypes.PYFUNCTYPE(ctypes.py_object, ctypes.c_void_p)),
+
-
        ('lookupclass',
+
-
            ctypes.PYFUNCTYPE(ctypes.py_object, ctypes.c_int)),
+
-
        ('newgobj',
+
-
            ctypes.PYFUNCTYPE(ctypes.py_object, ctypes.c_void_p)),
+
-
    ]
+
-
 
+
-
class PyGObjectCPAI(object):
+
-
    def __init__(self):
+
-
        import gobject
+
-
        py_obj = ctypes.py_object(gobject._PyGObject_API)
+
-
        addr = ctypes.pythonapi.PyCObject_AsVoidPtr(py_obj)
+
-
        self._api = _PyGObject_Functions.from_address(addr)
+
-
 
+
-
    def pygobject_new(self, addr):
+
-
        return self._api.newgobj(addr)
+
-
</source>
+
-
Adding this to your code, you will be able to create Python objects from an arbitrary GObject pointer, simply using something like:
+
-
<source lang="python">
+
-
capi = PyGObjectCPAI()
+
-
c_obj = c_function_returning_gobject(...)
+
-
obj = capi.pygobject_new(c_obj)
+
-
</source>
+
-
== Creating a OssoABookContactChooser Instance ==
+
-
 
+
-
As an example of a GObject instantiation, let's call the <code>osso_abook_contact_chooser_new()</code> constructor from Python, which creates a "contact chooser" dialog useful to select one of more contacts:
+
-
<source lang="python">
+
-
capi = PyGObjectCPAI()
+
-
c_chooser = osso_abook.osso_abook_contact_chooser_new(None, "Choose a contact")
+
-
chooser = capi.pygobject_new(c_chooser)
+
-
</source>
+
-
After this, you can use <code>chooser</code> like any other GObject in Python, including calling inherited methods:
+
-
<source lang="python">
+
-
chooser.run()
+
-
chooser.hide()
+
-
</source>
+
-
== Accessing Items in a GList ==
+
-
 
+
-
Once the "contact chooser" dialog has run, you can get the selected contacts using:
+
-
<source lang="python">
+
-
contacts = osso_abook.osso_abook_contact_chooser_get_selection(c_chooser)
+
-
</source>
+
-
Note that you must pass the '''C Pointer''' to [http://maemo.org/api_refs/5.0/5.0-final/libosso-abook/OssoABookContactChooser.html#osso-abook-contact-chooser-get-selection osso_abook_contact_chooser_get_selection()], not the Python object.
+
-
 
+
-
the <code>contacts</code> variable now holds a <code>GList</code> pointer. In order to access the items stored on this list, you need some Python code:
+
-
<source lang="python">
+
-
glib = ctypes.CDLL('libglib-2.0.so.0')
+
-
def glist(addr):
+
-
    class _GList(ctypes.Structure):
+
-
        _fields_ = [('data', ctypes.c_void_p),
+
-
                    ('next', ctypes.c_void_p)]
+
-
    l = addr
+
-
    while l:
+
-
        l = _GList.from_address(l)
+
-
        yield l.data
+
-
        l = l.next
+
-
</source>
+
-
This function uses the yield statement to construct a so called [http://docs.python.org/tutorial/classes.html#generators generator]. The actual GList manipulation is made using functions from libglib library. This generator makes it very easy to iterate over the items:
+
-
<source lang="python">
+
-
for i in glist(contacts):
+
-
    get_display_name = osso_abook.osso_abook_contact_get_display_name
+
-
    get_display_name.restype = ctypes.c_char_p
+
-
    print "%s\n" % get_display_name(i)
+
-
</source>
+
-
Here, we use [http://maemo.org/api_refs/5.0/5.0-final/libosso-abook/OssoABookContact.html#osso-abook-contact-get-display-name osso_abook_contact_get_display_name()] to get the contact's display name, but you can call virtually any function using the same approach.
+
-
Once you are done with the <code>GList</code> manipulation, you should free its memory:
+
Quoting http://docs.python.org/library/ctypes.html#calling-functions:
-
With some functions (NOT this one, see docs), you should also unref the list items first:
+
: None, integers, longs, byte strings and unicode strings are the only native Python objects that can directly be used as parameters in these function calls. None is passed as a C NULL pointer, byte strings and unicode strings are passed as pointer to the memory block that contains their data (char * or wchar_t *). Python integers and Python longs are passed as the platforms default C int type, their value is masked to fit into the C type.
-
<source lang="python">
+
-
for i in glist(stuffs):
+
-
  gobject.g_object_unref(i)
+
-
</source>
+
-
Then free the list itself:
+
For all other types, a <code>ctypes</code> C wrapper must be used; you can find them at http://docs.python.org/library/ctypes.html#fundamental-data-types.
-
<source lang="python">
+
-
glib.g_list_free(contacts)
+
-
</source>
+
-
== Final Words ==
+
An usage example of these wrappers is shown below:
-
This document purpose is to give a basic understanding necessary to use ctypes to explore C libraries, specially ones that manipulate GObject. Notably, we do not describe how to define callbacks, but this is left as an exercise for the reader. Again, be sure to read the [http://docs.python.org/library/ctypes.html#callback-functions ctypes documentation] if you are interested in more advanced techniques.
+
>>> libc.printf("a integer: %d, a double: %f\n", 42, 3.14)
 +
Traceback (most recent call last):
 +
  File "<stdin>", line 1, in <module>
 +
ctypes.ArgumentError: argument 3: <type 'exceptions.TypeError'>: Don't know how  to convert parameter 3
-
See also more usage examples [[/More examples|here]].
+
Integers are fine, but <code>ctypes</code> can't handle Python doubles directly. <code>ctypes.c_double()</code> will solve the problem here:
-
[[Category:Python]]
+
>>> libc.printf("a integer: %d, a double: %f\n", 42, ctypes.c_double(3.14))
 +
a integer: 42, a double: 3.140000

Learn more about Contributing to the wiki.


Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!


Cancel | Editing help (opens in new window)
Retrieved from "https://wiki.maemo.org/PyMaemo/Accessing_APIs_without_Python_bindings"