pyobjc / pyobjc-core / Doc / typemapping.rst

Converting values between Python and Objective-C


PyObjC provides transparant conversion or proxying of values between Python and Objective-C. In general this works as expected, this document provides a detailed guide to how values are converted or proxied.

Basic C types

The Objective-C language not only has classes and objects, but also has the basic C types which are not classes. PyObjC converts between those and the corresponding Python type.

The C type 'char' does not have a unambigous meaning in C, it is used for a number of tasks. In the table below the various tasks have been represented separately: booleans (:c:type:`BOOL`), representing characters in text (:c:type:`char`) and represeting small integers (:c:type:`int8_t`). PyObjC uses metadata in the framework wrappers to know when to use which representation.

C type Python 2.x Python 3.x
:c:type:`int8_t` :class:`int` :class:`int`
:c:type:`BOOL` :class:`bool` :class:`bool`
:c:type:`char` :class:`str` of len(1) :class:`bytes` of len(1)
:c:type:`unsigned char` :class:`int` :class:`int`
:c:type:`short` :class:`int` :class:`int`
:c:type:`unsigned short` :class:`int` :class:`int`
:c:type:`int` :class:`int` :class:`int`
:c:type:`unsigned int` :class:`int` :class:`int`
:c:type:`int` :class:`int` :class:`int`
:c:type:`unsigned int` :class:`int` or :class:`long` :class:`int`
:c:type:`long` :class:`int` :class:`int`
:c:type:`unsigned long` :class:`int` or :class:`long` :class:`int`
:c:type:`long long` :class:`int` or :class:`long` :class:`int`
:c:type:`unsigned long long` :class:`int` or :class:`long` :class:`int`
:c:type:`float` :class:`float` :class:`float`
:c:type:`double` :class:`float` :class:`float`

PyObjC does range checking when converting values to C, and will raise :exc:`ValueError` when the input value is out of range.

PyObjC will accept negative values when converting a Python numeric value to an unsigned integer value. This is done due to limitations in the metadata creation process, sometimes constant values that are used with unsigned integer arguments are represented as negative values in the metadata files. This feature will be fixed in a future version of PyObjC and users should therefore not rely on being able to convert negative values to an unsigned integer type.

Compound C types


C Arrays are represented a lists where all elements are of the right basic type (as described earlier).


C structs are by default represented as Python tuples, and you can always use tuples of the right arity to pass values to a function.

The framework wrappers also provide wrapper types that provide a nicer interface, those wrappers can be used with indexed access (like tuples), but also have named attributes. The wrapper types are mutable, and are comparible with mutable :func:`namedtuple <collections.namedtuple>` objects.


PyObjC cannot convert to and from C union types at the moment.

Classes and instances


Functions and methods