"ctypes" — Bibliothèque Python d'appels à des fonctions externes
****************************************************************

======================================================================

"ctypes" est une bibliothèque d'appel à des fonctions externes en
python. Elle fournit des types de données compatibles avec le langage
C et permet d'appeler des fonctions depuis des DLL ou des
bibliothèques partagées, rendant ainsi possible l'interfaçage de ces
bibliothèques avec du pur code Python.


Didacticiel de *ctypes*
=======================

Remarque : Les exemples de code de ce didacticiel utilisent "doctest"
pour s'assurer de leur propre bon fonctionnement. Vu que certains de
ces exemples ont un comportement différent en Linux, Windows ou Mac OS
X, ils contiennent des directives *doctest* dans les commentaires.

Remarque : Le type "c_int" du module apparaît dans certains de ces
exemples. Sur les plates-formes où "sizeof(long) == sizeof(int)", ce
type est un alias de "c_long". Ne soyez donc pas surpris si "c_long"
s'affiche là où vous vous attendiez à "c_int" — il s'agit bien du même
type.


Chargement des DLL
------------------

"ctypes" fournit l'objet *cdll* pour charger des bibliothèques à liens
dynamiques (et les objets *windll* et *oledll* en Windows).

Une bibliothèque se charge en y accédant comme un attribut de ces
objets. *cdll* charge les bibliothèques qui exportent des fonctions
utilisant la convention d'appel standard "cdecl", alors que les
bibliothèques qui se chargent avec *windll* utilisent la convention
d'appel "stdcall". *oledll* utilise elle aussi la convention "stdcall"
et suppose que les fonctions renvoient un code d'erreur "HRESULT" de
Windows. Ce code d'erreur est utilisé pour lever automatiquement une
"OSError" quand l'appel de la fonction échoue.

Modifié dans la version 3.3: En Windows, les erreurs levaient
auparavant une "WindowsError", qui est maintenant un alias de
"OSError".

Voici quelques exemples Windows. "msvcrt" est la bibliothèque standard
C de Microsoft qui contient la plupart des fonctions standards C. Elle
suit la convention d'appel *cdecl* :

   >>> from ctypes import *
   >>> print(windll.kernel32)  
   <WinDLL 'kernel32', handle ... at ...>
   >>> print(cdll.msvcrt)      
   <CDLL 'msvcrt', handle ... at ...>
   >>> libc = cdll.msvcrt      
   >>>

Windows ajoute le suffixe habituel ".dll" automatiquement.

Note:

  Accéder à la bibliothèque standard C par "cdll.msvcrt" utilise une
  version obsolète de la bibliothèque qui peut avoir des problèmes de
  compatibilité avec celle que Python utilise. Si possible, mieux vaut
  utiliser la fonctionnalité native de Python, ou bien importer et
  utiliser le module "msvcrt".

Pour charger une bibliothèque en Linux, il faut passer le nom du
fichier *avec* son extension. Il est donc impossible de charger une
bibliothèque en accédant à un attribut. Il faut utiliser la méthode
"LoadLibrary()" des chargeurs de DLL, ou bien charger la bibliothèque
en créant une instance de *CDLL* en appelant son constructeur :

   >>> cdll.LoadLibrary("libc.so.6")  
   <CDLL 'libc.so.6', handle ... at ...>
   >>> libc = CDLL("libc.so.6")       
   >>> libc                           
   <CDLL 'libc.so.6', handle ... at ...>
   >>>


Accès aux fonctions des DLL chargées
------------------------------------

Les fonctions sont alors des attributs des objets DLL :

   >>> from ctypes import *
   >>> libc.printf
   <_FuncPtr object at 0x...>
   >>> print(windll.kernel32.GetModuleHandleA)  
   <_FuncPtr object at 0x...>
   >>> print(windll.kernel32.MyOwnFunction)     
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "ctypes.py", line 239, in __getattr__
       func = _StdcallFuncPtr(name, self)
   AttributeError: function 'MyOwnFunction' not found
   >>>

Les DLL des systèmes *win32* comme "kernel32" et "user32" exportent
souvent une version ANSI et une version UNICODE d'une fonction. La
version UNICODE est exportée avec un "W" à la fin, et la version ANSI
avec un "A". La fonction *win32* "GetModuleHandle", qui renvoie un
*gestionnaire de module* à partir de son nom, a le prototype C suivant
(c'est une macro qui décide d'exporter l'une ou l'autre à travers
"GetModuleHandle", selon qu'UNICODE est définie ou non) :

   /* ANSI version */
   HMODULE GetModuleHandleA(LPCSTR lpModuleName);
   /* UNICODE version */
   HMODULE GetModuleHandleW(LPCWSTR lpModuleName);

*windll* n'en choisit pas une par magie, il faut accéder à la bonne en
écrivant explicitement "GetModuleHandleA" ou "GetModuleHandleW" et en
les appelant ensuite avec des objets octets ou avec des chaînes de
caractères, respectivement.

Les DLL exportent parfois des fonctions dont les noms ne sont pas des
identifiants Python valides, comme ""??2@YAPAXI@Z"". Dans ce cas, il
faut utiliser "getattr()" pour accéder à la fonction :

   >>> getattr(cdll.msvcrt, "??2@YAPAXI@Z")  
   <_FuncPtr object at 0x...>
   >>>

Sous Windows, certaines DLL exportent des fonctions à travers un
indice plutôt qu'à travers un nom. On accède à une fonction en
indiçant l'objet DLL avec son index :

   >>> cdll.kernel32[1]  
   <_FuncPtr object at 0x...>
   >>> cdll.kernel32[0]  
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "ctypes.py", line 310, in __getitem__
       func = _StdcallFuncPtr(name, self)
   AttributeError: function ordinal 0 not found
   >>>


Appel de fonctions
------------------

Ces fonctions s'appellent comme n'importe quel appelable Python. Cet
exemple utilise la fonction "time()", qui renvoie le temps en secondes
du système depuis l'*epoch* Unix, et la fonction "GetModuleHandleA()",
qui renvoie un gestionnaire de module *win32*.

Cet exemple appelle les deux fonctions avec un pointeur "NULL" (on
utilise "None" pour passer un pointeur "NULL") :

   >>> print(libc.time(None))  
   1150640792
   >>> print(hex(windll.kernel32.GetModuleHandleA(None)))  
   0x1d000000
   >>>

Une "ValueError" est levée quand on appelle une fonction "stdcall"
avec la convention d'appel "cdecl" et vice-versa :

   >>> cdll.kernel32.GetModuleHandleA(None)  
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ValueError: Procedure probably called with not enough arguments (4 bytes missing)
   >>>

   >>> windll.msvcrt.printf(b"spam")  
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ValueError: Procedure probably called with too many arguments (4 bytes in excess)
   >>>

Pour déterminer la convention d'appel, il faut consulter l'en-tête C
ou la documentation de la fonction à appeler.

En Windows, "ctypes" tire profit de la gestion structurée des
exceptions (*structured exception handling*) *win32* pour empêcher les
plantages dus à des interruptions, afin de préserver la protection
globale (*general protection faults*) du système, lorsque des
fonctions sont appelées avec un nombre incorrect d'arguments :

   >>> windll.kernel32.GetModuleHandleA(32)  
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   OSError: exception: access violation reading 0x00000020
   >>>

Cependant, il y a suffisamment de façons de faire planter Python avec
"ctypes", donc il faut être prudent dans tous les cas. Le module
"faulthandler" est pratique pour déboguer les plantages (p. ex. dus à
des erreurs de segmentation produites par des appels erronés à la
bibliothèque C).

"None", les entiers, les objets octets et les chaînes de caractères
(Unicode) sont les seuls types natifs de Python qui peuvent être
directement passés en paramètres de ces appels de fonctions. "None"
est passé comme le pointeur C "NULL", les objets octets et les chaînes
de caractères sont passés comme un pointeur sur le bloc mémoire qui
contient la donnée ("char *" ou "wchar_t *"). Les entiers Python sont
passés comme le type C "int" par défaut de la plate-forme, un masque
étant appliqué pour qu'ils tiennent dans le type C.

Avant de poursuivre sur l'appel de fonctions avec d'autres types de
paramètres, apprenons-en un peu plus sur les types de données de
"ctypes".


Types de données fondamentaux
-----------------------------

"ctypes" définit plusieurs types de donnée de base compatibles avec le
C :

+------------------------+--------------------------------------------+------------------------------+
| Types de *ctypes*      | Type C                                     | Type Python                  |
|========================|============================================|==============================|
| "c_bool"               | "_Bool"                                    | *bool* (1)                   |
+------------------------+--------------------------------------------+------------------------------+
| "c_char"               | "char"                                     | objet octet (*bytes*) de 1   |
|                        |                                            | caractère                    |
+------------------------+--------------------------------------------+------------------------------+
| "c_wchar"              | "wchar_t"                                  | chaîne de caractères         |
|                        |                                            | (*string*) de longueur 1     |
+------------------------+--------------------------------------------+------------------------------+
| "c_byte"               | "char"                                     | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_ubyte"              | "unsigned char"                            | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_short"              | "short"                                    | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_ushort"             | "unsigned short"                           | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_int"                | "int"                                      | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_uint"               | "unsigned int"                             | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_long"               | "long"                                     | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_ulong"              | "unsigned long"                            | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_longlong"           | "__int64" ou "long long"                   | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_ulonglong"          | "unsigned __int64" ou "unsigned long long" | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_size_t"             | "size_t"                                   | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_ssize_t"            | "ssize_t" ou "Py_ssize_t"                  | *int*                        |
+------------------------+--------------------------------------------+------------------------------+
| "c_float"              | "float"                                    | *float*                      |
+------------------------+--------------------------------------------+------------------------------+
| "c_double"             | "double"                                   | *float*                      |
+------------------------+--------------------------------------------+------------------------------+
| "c_longdouble"         | "long double"                              | *float*                      |
+------------------------+--------------------------------------------+------------------------------+
| "c_char_p"             | "char *" (terminé par NUL)                 | objet octet (*bytes*) ou     |
|                        |                                            | "None"                       |
+------------------------+--------------------------------------------+------------------------------+
| "c_wchar_p"            | "wchar_t *" (terminé par NUL)              | chaîne de caractères         |
|                        |                                            | (*string*) ou "None"         |
+------------------------+--------------------------------------------+------------------------------+
| "c_void_p"             | "void *"                                   | *int* ou "None"              |
+------------------------+--------------------------------------------+------------------------------+

1. Le constructeur accepte n'importe quel objet convertible en
   booléen.

Il est possible de créer chacun de ces types en les appelant avec une
valeur d'initialisation du bon type et avec une valeur cohérente :

   >>> c_int()
   c_long(0)
   >>> c_wchar_p("Hello, World")
   c_wchar_p(140018365411392)
   >>> c_ushort(-3)
   c_ushort(65533)
   >>>

Ces types étant des muables, leur valeur peut aussi être modifiée
après coup :

   >>> i = c_int(42)
   >>> print(i)
   c_long(42)
   >>> print(i.value)
   42
   >>> i.value = -99
   >>> print(i.value)
   -99
   >>>

Affecter une nouvelle valeur à une instance de type pointeur —
"c_char_p", "c_wchar_p" et "c_void_p" — change *la zone mémoire* sur
laquelle elle pointe, et non *le contenu* de ce bloc mémoire (c'est
logique parce que les objets octets sont immuables en Python) :

   >>> s = "Hello, World"
   >>> c_s = c_wchar_p(s)
   >>> print(c_s)
   c_wchar_p(139966785747344)
   >>> print(c_s.value)
   Hello World
   >>> c_s.value = "Hi, there"
   >>> print(c_s)              # the memory location has changed
   c_wchar_p(139966783348904)
   >>> print(c_s.value)
   Hi, there
   >>> print(s)                # first object is unchanged
   Hello, World
   >>>

Cependant, prenez garde à ne pas en passer à des fonctions qui
prennent en paramètre des pointeurs sur de la mémoire modifiable. S'il
vous faut de la mémoire modifiable, *ctypes* fournit la fonction
"create_string_buffer()" qui en crée de plusieurs façons. L'attribut
"raw" permet d'accéder à (ou de modifier) un bloc mémoire ; l'attribut
"value" permet d'y accéder comme à une chaîne de caractères terminée
par NUL :

   >>> from ctypes import *
   >>> p = create_string_buffer(3)            # create a 3 byte buffer, initialized to NUL bytes
   >>> print(sizeof(p), repr(p.raw))
   3 b'\x00\x00\x00'
   >>> p = create_string_buffer(b"Hello")     # create a buffer containing a NUL terminated string
   >>> print(sizeof(p), repr(p.raw))
   6 b'Hello\x00'
   >>> print(repr(p.value))
   b'Hello'
   >>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer
   >>> print(sizeof(p), repr(p.raw))
   10 b'Hello\x00\x00\x00\x00\x00'
   >>> p.value = b"Hi"
   >>> print(sizeof(p), repr(p.raw))
   10 b'Hi\x00lo\x00\x00\x00\x00\x00'
   >>>

La fonction "create_string_buffer()" remplace les fonctions
"c_buffer()" (qui en reste un alias) et "c_string()" des versions
antérieures de *ctypes*. La fonction "create_unicode_buffer()" crée un
bloc mémoire modifiable contenant des caractères Unicode du type C
"wchar_t".


Appel de fonctions, suite
-------------------------

*printf* utilise la vraie sortie standard, et non "sys.stdout" ; les
exemples suivants ne fonctionnent donc que dans une invite de commande
et non depuis *IDLE* or *PythonWin* :

   >>> printf = libc.printf
   >>> printf(b"Hello, %s\n", b"World!")
   Hello, World!
   14
   >>> printf(b"Hello, %S\n", "World!")
   Hello, World!
   14
   >>> printf(b"%d bottles of beer\n", 42)
   42 bottles of beer
   19
   >>> printf(b"%f bottles of beer\n", 42.5)
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ArgumentError: argument 2: exceptions.TypeError: Don't know how to convert parameter 2
   >>>

Comme mentionné plus haut, tous les types Python (les entiers, les
chaînes de caractères et les objets octet exceptés) doivent être
encapsulés dans leur type "ctypes" correspondant pour pouvoir être
convertis dans le type C requis :

   >>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))
   An int 1234, a double 3.140000
   31
   >>>


Appel de fonctions avec des types de données personnalisés
----------------------------------------------------------

Il est possible de personnaliser la conversion des arguments effectuée
par "ctypes" pour permettre de passer en argument des instances de vos
propres classes. "ctypes" recherche un attribut "_as_parameter_" et le
prend comme argument à la fonction. Bien entendu, cet attribut doit
être un entier, une chaîne de caractères ou des octets :

   >>> class Bottles:
   ...     def __init__(self, number):
   ...         self._as_parameter_ = number
   ...
   >>> bottles = Bottles(42)
   >>> printf(b"%d bottles of beer\n", bottles)
   42 bottles of beer
   19
   >>>

Si vous ne souhaitez pas stocker les données de l'instance dans la
variable "_as_parameter_" de l'instance, vous pouvez toujours définir
une "propriété" qui rend cet attribut disponible sur demande.


Définition du type des arguments nécessaires (prototypes de fonction)
---------------------------------------------------------------------

Il est possible de définir le type des arguments demandés par une
fonction exportée depuis une DLL en définissant son attribut
"argtypes".

"argtypes" doit être une séquence de types de données C (la fonction
"printf" n'est probablement pas le meilleur exemple pour l'illustrer,
car elle accepte un nombre variable d'arguments de types eux aussi
variables, selon la chaîne de formatage ; cela dit, elle se révèle
pratique pour tester cette fonctionnalité) :

   >>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]
   >>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)
   String 'Hi', Int 10, Double 2.200000
   37
   >>>

Définir un format empêche de passer des arguments de type incompatible
(comme le fait le prototype d'une fonction C) et tente de convertir
les arguments en des types valides :

   >>> printf(b"%d %d %d", 1, 2, 3)
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ArgumentError: argument 2: exceptions.TypeError: wrong type
   >>> printf(b"%s %d %f\n", b"X", 2, 3)
   X 2 3.000000
   13
   >>>

Pour appeler une fonction avec votre propre classe définie dans la
séquence "argtypes", il est nécessaire d'implémenter une méthode de
classe "from_param()". La méthode de classe "from_param()" récupère
l'objet Python passé à la fonction et doit faire une vérification de
type ou tout ce qui est nécessaire pour s'assurer que l'objet est
valide, puis renvoie l'objet lui-même, son attribut "_as_parameter_",
ou tout ce que vous voulez passer comme argument fonction C dans ce
cas. Encore une fois, il convient que le résultat soit un entier, une
chaîne, des octets, une instance "ctypes" ou un objet avec un attribut
"_as_parameter_".


Types de sortie
---------------

Le module suppose que toutes les fonctions renvoient par défaut un
"int" C. Pour préciser un autre type de sortie, il faut définir
l'attribut "restype" de l'objet encapsulant la fonction.

Voici un exemple plus poussé. Celui-ci utilise la fonction "strchr",
qui prend en paramètres un pointeur vers une chaîne et un caractère.
Elle renvoie un pointeur sur une chaîne de caractères :

   >>> strchr = libc.strchr
   >>> strchr(b"abcdef", ord("d"))  
   8059983
   >>> strchr.restype = c_char_p    # c_char_p is a pointer to a string
   >>> strchr(b"abcdef", ord("d"))
   b'def'
   >>> print(strchr(b"abcdef", ord("x")))
   None
   >>>

Pour économiser l'appel "ord("x")", il est possible de définir
l'attribut "argtypes" ; le second argument, un objet octet à un seul
caractère, sera automatiquement converti en un caractère C :

   >>> strchr.restype = c_char_p
   >>> strchr.argtypes = [c_char_p, c_char]
   >>> strchr(b"abcdef", b"d")
   'def'
   >>> strchr(b"abcdef", b"def")
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ArgumentError: argument 2: exceptions.TypeError: one character string expected
   >>> print(strchr(b"abcdef", b"x"))
   None
   >>> strchr(b"abcdef", b"d")
   'def'
   >>>

Si la fonction à interfacer renvoie un entier, l'attribut "restype"
peut aussi être un appelable (une fonction ou une classe par exemple).
Dans ce cas, l'appelable sera appelé avec l'entier renvoyé par la
fonction et le résultat de cet appel sera le résultat final de l'appel
à la fonction. C'est pratique pour vérifier les codes d'erreurs des
valeurs de retour et lever automatiquement des exceptions :

   >>> GetModuleHandle = windll.kernel32.GetModuleHandleA  
   >>> def ValidHandle(value):
   ...     if value == 0:
   ...         raise WinError()
   ...     return value
   ...
   >>>
   >>> GetModuleHandle.restype = ValidHandle  
   >>> GetModuleHandle(None)  
   486539264
   >>> GetModuleHandle("something silly")  
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "<stdin>", line 3, in ValidHandle
   OSError: [Errno 126] The specified module could not be found.
   >>>

"WinError" appelle l'API Windows "FormatMessage()" pour obtenir une
représentation de la chaîne de caractères qui correspond au code
d'erreur, et *renvoie* une exception. "WinError" prend en paramètre —
optionnel — le code d'erreur. Si celui-ci n'est pas passé, elle
appelle "GetLastError()" pour le récupérer.

Notez cependant que l'attribut "errcheck" permet de vérifier bien plus
efficacement les erreurs ; référez-vous au manuel de référence pour
plus de précisions.


Passage de pointeurs (passage de paramètres par référence)
----------------------------------------------------------

Il arrive qu'une fonction C du code à interfacer requière un
*pointeur* vers un certain type de donnée en paramètre, typiquement
pour écrire à l'endroit correspondant ou si la donnée est trop grande
pour pouvoir être passée par valeur. Ce mécanisme est appelé *passage
de paramètres par référence*.

"ctypes" contient la fonction "byref()" qui permet de passer des
paramètres par référence. La fonction "pointer()" a la même utilité,
mais fait plus de travail car "pointer()" construit un véritable objet
pointeur. Ainsi, si vous n'avez pas besoin de cet objet dans votre
code Python, utiliser "byref()" est plus performant :

   >>> i = c_int()
   >>> f = c_float()
   >>> s = create_string_buffer(b'\000' * 32)
   >>> print(i.value, f.value, repr(s.value))
   0 0.0 b''
   >>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",
   ...             byref(i), byref(f), s)
   3
   >>> print(i.value, f.value, repr(s.value))
   1 3.1400001049 b'Hello'
   >>>


Structures et unions
--------------------

Les structures et les unions doivent hériter des classes de base
"Structure" et "Union" définies dans le module "ctypes". Chaque sous-
classe doit définir un attribut "_fields_". "_fields_" doit être une
liste de *paires*, contenant un *nom de champ* et un *type de champ*.

Le type de champ doit être un type "ctypes" comme "c_int" ou un type
"ctypes" dérivé : structure, union, tableau ou pointeur.

Voici un exemple simple : une structure POINT qui contient deux
entiers *x* et *y* et qui montre également comment instancier une
structure avec le constructeur :

   >>> from ctypes import *
   >>> class POINT(Structure):
   ...     _fields_ = [("x", c_int),
   ...                 ("y", c_int)]
   ...
   >>> point = POINT(10, 20)
   >>> print(point.x, point.y)
   10 20
   >>> point = POINT(y=5)
   >>> print(point.x, point.y)
   0 5
   >>> POINT(1, 2, 3)
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   TypeError: too many initializers
   >>>

Il est bien entendu possible de créer des structures plus complexes.
Une structure peut elle-même contenir d'autres structures en prenant
une structure comme type de champ.

Voici une structure RECT qui contient deux POINTs *upperleft* et
*lowerright* :

   >>> class RECT(Structure):
   ...     _fields_ = [("upperleft", POINT),
   ...                 ("lowerright", POINT)]
   ...
   >>> rc = RECT(point)
   >>> print(rc.upperleft.x, rc.upperleft.y)
   0 5
   >>> print(rc.lowerright.x, rc.lowerright.y)
   0 0
   >>>

Une structure encapsulée peut être instanciée par un constructeur de
plusieurs façons :

   >>> r = RECT(POINT(1, 2), POINT(3, 4))
   >>> r = RECT((1, 2), (3, 4))

Il est possible de récupérer les *descripteurs* des champs depuis la
*classe*. Ils sont importants pour déboguer car ils contiennent des
informations utiles :

   >>> print(POINT.x)
   <Field type=c_long, ofs=0, size=4>
   >>> print(POINT.y)
   <Field type=c_long, ofs=4, size=4>
   >>>

Avertissement:

  "ctypes" ne prend pas en charge le passage par valeur des unions ou
  des structures avec des champs de bits. Bien que cela puisse
  fonctionner sur des architectures 32 bits avec un jeu d'instructions
  x86, ce n'est pas garanti par la bibliothèque en général. Les unions
  et les structures avec des champs de bits doivent toujours être
  passées par pointeur.


Alignement et boutisme des structures et des unions
---------------------------------------------------

By default, Structure and Union fields are aligned in the same way the
C compiler does it. It is possible to override this behavior by
specifying a "_pack_" class attribute in the subclass definition. This
must be set to a positive integer and specifies the maximum alignment
for the fields. This is what "#pragma pack(n)" also does in MSVC.

"ctypes" suit le boutisme natif pour les *Structure* et les *Union*.
Pour construire des structures avec un boutisme différent, utilisez
les classes de base "BigEndianStructure", "LittleEndianStructure",
"BigEndianUnion" ou "LittleEndianUnion". Ces classes ne peuvent pas
avoir de champ pointeur.


Champs de bits dans les structures et les unions
------------------------------------------------

Il est possible de créer des structures et des unions contenant des
champs de bits. Seuls les entiers peuvent être des champs de bits, le
nombre de bits est défini dans le troisième champ du n-uplet
"_fields_" :

   >>> class Int(Structure):
   ...     _fields_ = [("first_16", c_int, 16),
   ...                 ("second_16", c_int, 16)]
   ...
   >>> print(Int.first_16)
   <Field type=c_long, ofs=0:0, bits=16>
   >>> print(Int.second_16)
   <Field type=c_long, ofs=0:16, bits=16>
   >>>


Tableaux
--------

Les tableaux sont des séquences qui contiennent un nombre fixe
d'instances du même type.

La meilleure façon de créer des tableaux consiste à multiplier le type
de donnée par un entier positif :

   TenPointsArrayType = POINT * 10

Voici un exemple — un peu artificiel — d'une structure contenant,
entre autres, 4 POINTs :

   >>> from ctypes import *
   >>> class POINT(Structure):
   ...     _fields_ = ("x", c_int), ("y", c_int)
   ...
   >>> class MyStruct(Structure):
   ...     _fields_ = [("a", c_int),
   ...                 ("b", c_float),
   ...                 ("point_array", POINT * 4)]
   >>>
   >>> print(len(MyStruct().point_array))
   4
   >>>

Comme d'habitude, on crée les instances en appelant la classe :

   arr = TenPointsArrayType()
   for pt in arr:
       print(pt.x, pt.y)

Le code précédent affiche une suite de "0 0" car le contenu du tableau
est initialisé avec des zéros.

Des valeurs d'initialisation du bon type peuvent être passées :

   >>> from ctypes import *
   >>> TenIntegers = c_int * 10
   >>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
   >>> print(ii)
   <c_long_Array_10 object at 0x...>
   >>> for i in ii: print(i, end=" ")
   ...
   1 2 3 4 5 6 7 8 9 10
   >>>


Pointeurs
---------

On crée une instance de pointeur en appelant la fonction "pointer()"
sur un type "ctypes" :

   >>> from ctypes import *
   >>> i = c_int(42)
   >>> pi = pointer(i)
   >>>

Les instances de pointeurs ont un attribut "contents" qui renvoie
l'objet pointé (l'objet "i" ci-dessus) :

   >>> pi.contents
   c_long(42)
   >>>

Attention, "ctypes" ne fait pas de ROI (retour de l'objet initial). Il
crée un nouvel objet à chaque fois qu'on accède à un attribut :

   >>> pi.contents is i
   False
   >>> pi.contents is pi.contents
   False
   >>>

Affecter une autre instance de "c_int" à l'attribut *contents* du
pointeur fait pointer le pointeur vers l'adresse mémoire de cette
nouvelle instance :

   >>> i = c_int(99)
   >>> pi.contents = i
   >>> pi.contents
   c_long(99)
   >>>

Il est possible d'indexer les pointeurs par des entiers :

   >>> pi[0]
   99
   >>>

Affecter à travers un indice change la valeur pointée :

   >>> print(i)
   c_long(99)
   >>> pi[0] = 22
   >>> print(i)
   c_long(22)
   >>>

Si vous êtes sûr de vous, vous pouvez utiliser d'autres valeurs que 0,
comme en C : il est ainsi possible de modifier une zone mémoire de
votre choix. De manière générale cette fonctionnalité ne s'utilise que
sur un pointeur renvoyé par une fonction C, pointeur que vous *savez*
pointer vers un tableau et non sur un seul élément.

Sous le capot, la fonction "pointer()" fait plus que simplement créer
une instance de pointeur ; elle doit d'abord créer un type « pointeur
sur… ». Cela s'effectue avec la fonction "POINTER()", qui prend en
paramètre n'importe quel type "ctypes" et renvoie un nouveau type :

   >>> PI = POINTER(c_int)
   >>> PI
   <class 'ctypes.LP_c_long'>
   >>> PI(42)
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   TypeError: expected c_long instead of int
   >>> PI(c_int(42))
   <ctypes.LP_c_long object at 0x...>
   >>>

Appeler le pointeur sur type sans arguments crée un pointeur "NULL".
Les pointeurs "NULL" s'évaluent à "False" :

   >>> null_ptr = POINTER(c_int)()
   >>> print(bool(null_ptr))
   False
   >>>

"ctypes" vérifie que le pointeur n'est pas "NULL" quand il en
déréférence un (mais déréférencer des pointeurs non "NULL" invalides
fait planter Python) :

   >>> null_ptr[0]
   Traceback (most recent call last):
       ....
   ValueError: NULL pointer access
   >>>

   >>> null_ptr[0] = 1234
   Traceback (most recent call last):
       ....
   ValueError: NULL pointer access
   >>>


Conversions de type
-------------------

En général, *ctypes* respecte un typage fort. Cela signifie que si un
"POINTER(c_int)" est présent dans la liste des "argtypes" d'une
fonction ou est le type d'un attribut membre dans une définition de
structure, seules des instances de ce type seront valides. Cette règle
comporte quelques exceptions pour lesquelles *ctypes* accepte d'autres
objets. Par exemple il est possible de passer des instances de tableau
à place de pointeurs, s'ils sont compatibles. Dans le cas de
"POINTER(c_int)", *ctypes* accepte des tableaux de *c_int* :

   >>> class Bar(Structure):
   ...     _fields_ = [("count", c_int), ("values", POINTER(c_int))]
   ...
   >>> bar = Bar()
   >>> bar.values = (c_int * 3)(1, 2, 3)
   >>> bar.count = 3
   >>> for i in range(bar.count):
   ...     print(bar.values[i])
   ...
   1
   2
   3
   >>>

De plus, si un paramètre de fonction est déclaré explicitement de type
pointeur (comme "POINTER(c_int)") dans les "argtypes", il est aussi
possible de passer un objet du type pointé — ici, "c_int" — à la
fonction. *ctypes* appelle alors automatiquement la fonction de
conversion "byref()".

Pour mettre un champ de type *POINTER* à "NULL", il faut lui affecter
"None" :

   >>> bar.values = None
   >>>

Parfois il faut gérer des incompatibilités entre les types. En C, il
est possible de convertir un type en un autre. "ctypes" fournit la
fonction "cast()" qui permet la même chose. La structure "Bar" ci-
dessus accepte des pointeurs "POINTER(c_int)" ou des tableaux de
"c_int" comme valeur pour le champ "values", mais pas des instances
d'autres types :

   >>> bar.values = (c_byte * 4)()
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance
   >>>

C'est là que la fonction "cast()" intervient.

La fonction "cast()" permet de convertir une instance de *ctypes* en
un pointeur vers un type de données *ctypes* différent. "cast()" prend
deux paramètres : un objet *ctypes* qui est, ou qui peut être converti
en, un certain pointeur et un type pointeur de *ctypes*. Elle renvoie
une instance du second argument, qui pointe sur le même bloc mémoire
que le premier argument :

   >>> a = (c_byte * 4)()
   >>> cast(a, POINTER(c_int))
   <ctypes.LP_c_long object at ...>
   >>>

Ainsi, la fonction "cast()" permet de remplir le champ "values" de la
structure "Bar" :

   >>> bar = Bar()
   >>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
   >>> print(bar.values[0])
   0
   >>>


Types incomplets
----------------

Un *type incomplet* est une structure, une union ou un tableau dont
les membres ne sont pas encore définis. C'est l'équivalent d'une
déclaration avancée en C, où la définition est fournie plus tard :

   struct cell; /* forward declaration */

   struct cell {
       char *name;
       struct cell *next;
   };

Une traduction naïve, mais invalide, en code *ctypes* ressemblerait à
ça :

   >>> class cell(Structure):
   ...     _fields_ = [("name", c_char_p),
   ...                 ("next", POINTER(cell))]
   ...
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "<stdin>", line 2, in cell
   NameError: name 'cell' is not defined
   >>>

Cela ne fonctionne pas parce que la nouvelle "class cell" n'est pas
accessible dans la définition de la classe elle-même. Dans le module
"ctypes", on définit la classe "cell" et on définira les "_fields_"
plus tard, après avoir défini la classe :

   >>> from ctypes import *
   >>> class cell(Structure):
   ...     pass
   ...
   >>> cell._fields_ = [("name", c_char_p),
   ...                  ("next", POINTER(cell))]
   >>>

Let's try it. We create two instances of "cell", and let them point to
each other, and finally follow the pointer chain a few times:

   >>> c1 = cell()
   >>> c1.name = b"foo"
   >>> c2 = cell()
   >>> c2.name = b"bar"
   >>> c1.next = pointer(c2)
   >>> c2.next = pointer(c1)
   >>> p = c1
   >>> for i in range(8):
   ...     print(p.name, end=" ")
   ...     p = p.next[0]
   ...
   foo bar foo bar foo bar foo bar
   >>>


Fonctions de rappel
-------------------

"ctypes" permet de créer des pointeurs de fonctions appelables par des
appelables Python. On les appelle parfois *fonctions de rappel*.

Tout d'abord, il faut créer une classe pour la fonction de rappel. La
classe connaît la convention d'appel, le type de retour ainsi que le
nombre et le type de paramètres que la fonction accepte.

La fabrique "CFUNCTYPE()" crée un type pour les fonctions de rappel
qui suivent la convention d'appel "cdecl". En Windows, c'est la
fabrique "WINFUNCTYPE()" qui crée un type pour les fonctions de rappel
qui suivent la convention d'appel "stdcall".

Le premier paramètre de ces deux fonctions est le type de retour, et
les suivants sont les types des arguments qu'attend la fonction de
rappel.

Intéressons-nous à un exemple tiré de la bibliothèque standard C : la
fonction "qsort()". Celle-ci permet de classer des éléments par
l'emploi d'une fonction de rappel. Nous allons utiliser "qsort()" pour
ordonner un tableau d'entiers :

   >>> IntArray5 = c_int * 5
   >>> ia = IntArray5(5, 1, 7, 33, 99)
   >>> qsort = libc.qsort
   >>> qsort.restype = None
   >>>

"qsort()" doit être appelée avec un pointeur vers la donnée à
ordonner, le nombre d'éléments dans la donnée, la taille d'un élément
et un pointeur vers le comparateur, c.-à-d. la fonction de rappel.
Cette fonction sera invoquée avec deux pointeurs sur deux éléments et
doit renvoyer un entier négatif si le premier élément est plus petit
que le second, zéro s'ils sont égaux et un entier positif sinon.

Ainsi notre fonction de rappel reçoit des pointeurs vers des entiers
et doit renvoyer un entier. Créons d'abord le "type" pour la fonction
de rappel :

   >>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
   >>>

Pour commencer, voici une fonction de rappel simple qui affiche les
valeurs qu'on lui passe :

   >>> def py_cmp_func(a, b):
   ...     print("py_cmp_func", a[0], b[0])
   ...     return 0
   ...
   >>> cmp_func = CMPFUNC(py_cmp_func)
   >>>

Résultat :

   >>> qsort(ia, len(ia), sizeof(c_int), cmp_func)  
   py_cmp_func 5 1
   py_cmp_func 33 99
   py_cmp_func 7 33
   py_cmp_func 5 7
   py_cmp_func 1 7
   >>>

À présent, comparons pour de vrai les deux entiers et renvoyons un
résultat utile :

   >>> def py_cmp_func(a, b):
   ...     print("py_cmp_func", a[0], b[0])
   ...     return a[0] - b[0]
   ...
   >>>
   >>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func)) 
   py_cmp_func 5 1
   py_cmp_func 33 99
   py_cmp_func 7 33
   py_cmp_func 1 7
   py_cmp_func 5 7
   >>>

Et comme il est facile de le voir, notre tableau est désormais classé
:

   >>> for i in ia: print(i, end=" ")
   ...
   1 5 7 33 99
   >>>

Ces fonctions peuvent aussi être utilisées comme des décorateurs ; il
est donc possible d'écrire :

   >>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
   ... def py_cmp_func(a, b):
   ...     print("py_cmp_func", a[0], b[0])
   ...     return a[0] - b[0]
   ...
   >>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func)
   py_cmp_func 5 1
   py_cmp_func 33 99
   py_cmp_func 7 33
   py_cmp_func 1 7
   py_cmp_func 5 7
   >>>

Note:

  Prenez garde à bien conserver une référence à un objet "CFUNCTYPE()"
  tant que celui-ci est utilisé par le code C. "ctypes" ne le fait pas
  tout seul et, si vous ne le faites pas, le ramasse-miette pourrait
  les libérer, ce qui fera planter votre programme quand un appel sera
  fait.Notez aussi que si la fonction de rappel est appelée dans un
  fil d'exécution créé hors de Python (p. ex. par du code externe qui
  appelle la fonction de rappel), *ctypes* crée un nouveau fil Python
  « creux » à chaque fois. Ce comportement est acceptable pour la
  plupart des cas d'utilisation, mais cela implique que les valeurs
  stockées avec "threading.local" ne seront *pas* persistantes d'un
  appel à l'autre, même si les appels proviennent du même fil
  d'exécution C.


Accès aux variables exportées depuis une DLL
--------------------------------------------

Certaines bibliothèques ne se contentent pas d'exporter des fonctions,
elles exportent aussi des variables. Par exemple, la bibliothèque
Python exporte "Py_OptimizeFlag", un entier valant 0, 1, ou 2 selon
que l'option "-O" ou "-OO" soit donnée au démarrage.

"ctypes" peut accéder à ce type de valeurs avec les méthodes de classe
"in_dll()" du type considéré. *pythonapi* est un symbole prédéfini qui
donne accès à l'API C Python :

   >>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag")
   >>> print(opt_flag)
   c_long(0)
   >>>

Si l'interpréteur est lancé avec "-O", l'exemple affiche "c_long(1)"
et "c_long(2)" avec "-OO".

Le pointeur "PyImport_FrozenModules" exposé par Python est un autre
exemple complet de l'utilisation de pointeurs.

Citons la documentation :

   Ce pointeur est initialisé de manière à pointer sur un tableau
   d'entrées de "struct _frozen", dont tous les membres de la dernière
   valent "NULL" ou zéro. Quand un module gelé est importé, il est
   cherché dans ce tableau. Du code tiers peut jouer avec pour
   construire dynamiquement une collection de module gelés.

Donc manipuler ce pointeur peut même se révéler utile. Pour limiter la
taille de l'exemple, nous nous bornons à montrer comment lire ce
tableau avec "ctypes" :

   >>> from ctypes import *
   >>>
   >>> class struct_frozen(Structure):
   ...     _fields_ = [("name", c_char_p),
   ...                 ("code", POINTER(c_ubyte)),
   ...                 ("size", c_int)]
   ...
   >>>

Le type de donnée "struct _frozen" ayant été défini, nous pouvons
récupérer le pointeur vers le tableau :

   >>> FrozenTable = POINTER(struct_frozen)
   >>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules")
   >>>

Puisque "table" est un "pointer" vers un tableau d'entrées de
"struct_frozen", il est possible d'itérer dessus, mais il faut être
certain que la boucle se termine, car les pointeurs n'ont pas de
taille. Tôt ou tard, il planterait probablement avec une erreur de
segmentation ou autre, donc mieux vaut sortir de la boucle quand on
lit l'entrée "NULL" :

   >>> for item in table:
   ...     if item.name is None:
   ...         break
   ...     print(item.name.decode("ascii"), item.size)
   ...
   _frozen_importlib 31764
   _frozen_importlib_external 41499
   __hello__ 161
   __phello__ -161
   __phello__.spam 161
   >>>

Le fait que le standard Python possède un module et un paquet figés
(indiqués par la valeur négative du membre *size*) est peu connu, cela
ne sert qu'aux tests. Essayez avec "import __hello__" par exemple.


Pièges
------

Il y a quelques cas tordus dans "ctypes" où on peut s'attendre à un
résultat différent de la réalité.

Examinons l'exemple suivant :

   >>> from ctypes import *
   >>> class POINT(Structure):
   ...     _fields_ = ("x", c_int), ("y", c_int)
   ...
   >>> class RECT(Structure):
   ...     _fields_ = ("a", POINT), ("b", POINT)
   ...
   >>> p1 = POINT(1, 2)
   >>> p2 = POINT(3, 4)
   >>> rc = RECT(p1, p2)
   >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
   1 2 3 4
   >>> # now swap the two points
   >>> rc.a, rc.b = rc.b, rc.a
   >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
   3 4 3 4
   >>>

Diantre. On s'attendait certainement à ce que le dernier résultat
affiche "3 4 1 2". Que s'est-il passé ? Les étapes de la ligne "rc.a,
rc.b = rc.b, rc.a" ci-dessus sont les suivantes :

   >>> temp0, temp1 = rc.b, rc.a
   >>> rc.a = temp0
   >>> rc.b = temp1
   >>>

Les objets "temp0" et "temp1" utilisent encore le tampon interne de
l'objet "rc" ci-dessus. Donc exécuter "rc.a = temp0" copie le contenu
du tampon de "temp0" dans celui de "rc". Ce qui, par ricochet, modifie
le contenu de "temp1". Et donc, la dernière affectation, "rc.b =
temp1", n'a pas l'effet escompté.

Gardez en tête qu'accéder au sous-objet depuis une *Structure*, une
*Union* ou un *Array* ne copie *pas* le sous-objet, mais crée un objet
interface qui accède au tampon sous-jacent de l'objet initial.

Un autre exemple de comportement *a priori* inattendu est le suivant :

   >>> s = c_char_p()
   >>> s.value = b"abc def ghi"
   >>> s.value
   b'abc def ghi'
   >>> s.value is s.value
   False
   >>>

Note:

  La valeur d'une instance de "c_char_p" ne peut être initialisée
  qu'avec un octet ou un entier.

Pourquoi cela affiche-t'il "False" ? Les instances *ctypes* sont des
objets qui contiennent un bloc mémoire et des *descriptor* qui donnent
accès au contenu du ce bloc. Stocker un objet Python dans le bloc
mémoire ne stocke pas l'objet même ; seuls ses "contents" le sont.
Accéder au "contents" crée un nouvel objet Python à chaque fois !


Types de données à taille flottante
-----------------------------------

"ctypes" assure la prise en charge des tableaux et des structures à
taille flottante.

La fonction "resize()" permet de redimensionner la taille du tampon
mémoire d'un objet *ctypes* existant. Cette fonction prend l'objet
comme premier argument et la taille en octets désirée comme second. La
taille du tampon mémoire ne peut pas être inférieure à celle occupée
par un objet unitaire du type considéré. Une "ValueError" est levée si
c'est le cas :

   >>> short_array = (c_short * 4)()
   >>> print(sizeof(short_array))
   8
   >>> resize(short_array, 4)
   Traceback (most recent call last):
       ...
   ValueError: minimum size is 8
   >>> resize(short_array, 32)
   >>> sizeof(short_array)
   32
   >>> sizeof(type(short_array))
   8
   >>>

Cela dit, comment accéder aux éléments supplémentaires contenus dans
le tableau ? Vu que le type ne connaît que 4 éléments, on obtient une
erreur si l'on accède aux suivants :

   >>> short_array[:]
   [0, 0, 0, 0]
   >>> short_array[7]
   Traceback (most recent call last):
       ...
   IndexError: invalid index
   >>>

Une autre approche pour utiliser des types de donnée à taille
flottante avec "ctypes" consiste à tirer profit de la nature
intrinsèquement dynamique de Python et de (re)définir le type de
donnée une fois que la taille demandée est connue, au cas-par-cas.


Référence du module
===================


Recherche de bibliothèques partagées
------------------------------------

Les langages compilés ont besoin d'accéder aux bibliothèques partagées
au moment de la compilation, de l'édition de liens et pendant
l'exécution du programme.

Le but de la fonction "find_library()" est de trouver une bibliothèque
de la même façon que le ferait le compilateur ou le chargeur (sur les
plates-formes avec plusieurs versions de la même bibliothèque, la plus
récente est chargée), alors que les chargeurs de bibliothèques de
*ctypes* se comportent de la même façon qu'un programme qui s'exécute,
et appellent directement le chargeur.

Le module "ctypes.util" fournit une fonction pour déterminer quelle
bibliothèque charger.

ctypes.util.find_library(name)

   Tente de trouver une bibliothèque et en renvoie le chemin. *name*
   est le nom de la bibliothèque sans préfixe — comme *lib* — ni
   suffixe — comme ".so", ".dylib" ou un numéro de version (c.-à-d. la
   même forme que l'option POSIX de l'éditeur de lien "-l"). Si la
   fonction ne parvient pas à trouver de bibliothèque, elle renvoie
   "None".

Le mode opératoire exact dépend du système.

Sous Linux, "find_library()" essaye de lancer des programmes externes
("/sbin/ldconfig", "gcc", "objdump" et "ld") pour trouver la
bibliothèque. Elle renvoie le nom de la bibliothèque sur le disque.

Modifié dans la version 3.6: Sous Linux, si les autres moyens
échouent, la fonction utilise la variable d'environnement
"LD_LIBRARY_PATH" pour trouver la bibliothèque.

Voici quelques exemples :

   >>> from ctypes.util import find_library
   >>> find_library("m")
   'libm.so.6'
   >>> find_library("c")
   'libc.so.6'
   >>> find_library("bz2")
   'libbz2.so.1.0'
   >>>

Sous OS X, "find_library()" regarde dans des chemins et conventions de
chemins prédéfinies pour trouver la bibliothèque et en renvoie le
chemin complet si elle la trouve :

   >>> from ctypes.util import find_library
   >>> find_library("c")
   '/usr/lib/libc.dylib'
   >>> find_library("m")
   '/usr/lib/libm.dylib'
   >>> find_library("bz2")
   '/usr/lib/libbz2.dylib'
   >>> find_library("AGL")
   '/System/Library/Frameworks/AGL.framework/AGL'
   >>>

Sous Windows, "find_library()" examine le chemin de recherche du
système et renvoie le chemin complet de la bibliothèque, mais comme il
n'existe pas de convention de nommage, des appels comme
"find_library("c")" échouent et renvoient "None".

Si vous encapsulez une bibliothèque partagée avec "ctypes", il est
*probablement* plus judicieux de déterminer le chemin de cette
bibliothèque lors du développement et de l'écrire en dur dans le
module d'encapsulation, plutôt que d'utiliser "find_library()" pour la
trouver lors de l'exécution.


Chargement des bibliothèques partagées
--------------------------------------

Il y a plusieurs moyens de charger une bibliothèque partagée dans un
processus Python. L'un d'entre eux consiste à instancier une des
classes suivantes :

class ctypes.CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=0)

   Une instance de cette classe représente une bibliothèque partagée
   déjà chargée. Les fonctions de cette bibliothèque utilisent la
   convention d'appel C standard et doivent renvoyer un "int".

   En Windows, créer une instance de "CDLL" peut échouer, même si une
   DLL du bon nom existe. Quand une des dépendances de la DLL à
   charger ne peut pas être trouvée, une "OSError" est levée avec le
   message *"[WinError 126] The specified module could not be found".*
   Ce message d'erreur ne contient pas le nom de la DLL manquante car
   l'API Windows ne fournit pas cette information. Cela rend l'erreur
   délicate à analyser ; pour la résoudre, il faut lister toutes les
   dépendances de la DLL et trouver celle qui manque en utilisant des
   outils de débogage et de traçage Windows.

Voir aussi:

  DUMPBIN — un utilitaire Microsoft pour lister les dépendances d'une
  DLL.

class ctypes.OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=0)

   En Windows seulement : une instance de cette classe représente une
   bibliothèque partagée déjà chargée. Les fonctions de cette
   bibliothèque utilisent la convention d'appel *stdcall*, et doivent
   renvoyer un code "HRESULT" (propre à Windows). Les valeurs de
   "HRESULT" contiennent des informations précisant si l'appel de la
   fonction a échoué ou s'il a réussi, ainsi qu'un code d'erreur
   supplémentaire. Si la valeur de retour signale un échec, une
   "OSError" est levée automatiquement.

   Modifié dans la version 3.3: "WindowsError" était levée auparavant.

class ctypes.WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=0)

   En Windows seulement : une instance de cette classe représente une
   bibliothèque partagée déjà chargée. Les fonctions de cette
   bibliothèque utilisent la convention d'appel *stdcall* et doivent
   renvoyer par défaut un "int".

   Sous Windows CE, seule la convention d'appel standard est utilisée.
   Pour des raisons pratiques, "WinDLL" et "OleDLL" utilisent la
   convention d'appel standard sur cette plate-forme.

Le *verrou global de l'interpréteur* Python est relâché avant chaque
appel d'une fonction exposée par ces bibliothèques et ré-activé après.

class ctypes.PyDLL(name, mode=DEFAULT_MODE, handle=None)

   Cette classe est identique à "CDLL", à ceci près que le GIL n'est
   *pas* relâché pendant l'appel de la fonction, et, qu'au terme de
   l'appel, le drapeau d'erreur Python est vérifié. Si celui-ci est
   activé, une exception Python est levée.

   Donc, cette classe ne sert qu'à appeler les fonctions de l'API C de
   Python.

Toutes ces classes peuvent être instanciées en les appelant avec le
chemin de la bibliothèque partagée comme unique argument. Il est aussi
possible de passer un lien vers une bibliothèque déjà chargée en
utilisant le paramètre "handle". Sinon, les fonctions "dlopen" ou
"LoadLibrary" de la plate-forme sous-jacente permettent de charger la
bibliothèque dans le processus, et d'en obtenir un lien.

Le mode de chargement de la bibliothèque est défini par le paramètre
*mode*. Pour plus de détails, référez-vous à l'entrée *dlopen(3)* du
manuel. En Windows, *mode* est ignoré. Sur les systèmes POSIX,
RTLD_NOW y est toujours ajouté. Ceci n'est pas configurable.

Le paramètre *use_errno*, lorsque défini à vrai, active un mécanisme
de *ctypes* qui permet d'accéder au numéro d'erreur "errno" du système
de manière sécurisée. "ctypes" maintient une copie de "errno" du
système dans chaque fil d'exécution. Si vous appelez des fonctions
externes créées avec "use_errno=True", la valeur de "errno" avant
l'appel de la fonction est échangée avec la copie privée de *ctypes*.
La même chose se produit juste après l'appel de la fonction.

La fonction "ctypes.get_errno()" renvoie la valeur de la copie privée
de *ctypes*. La fonction "ctypes.set_errno()" affecte une nouvelle
valeur à la copie privée et renvoie l'ancienne valeur.

Définir le paramètre *use_last_error* à vrai active le même mécanisme
pour le code d'erreur de Windows qui est géré par les fonctions
"GetLastError()" et "SetLastError()" de l'API Windows ;
"ctypes.get_last_error()" et "ctypes.set_last_error()" servent à
obtenir et modifier la copie privée *ctypes* de ce code d'erreur.

Sous Windows, le paramètre *winmode* définit comment charger la
bibliothèque (puisque *mode* est ignoré). Il accepte toute valeur
compatible avec le drapeau "LoadLibraryEx" de l'API Win32. Lorsqu'il
est omis, les drapeaux par défaut sont ceux qui chargent la DLL de la
manière la plus sécurisée possible, afin d'éviter des problèmes comme
le détournement de DLL. Passer le chemin complet à la DLL reste le
moyen le plus sûr de s'assurer que la bonne bibliothèque et les bonnes
dépendances sont chargées.

Modifié dans la version 3.8: Ajout du paramètre *winmode*.

ctypes.RTLD_GLOBAL

   Valeur possible pour le paramètre *mode*. Vaut zéro sur les plates-
   formes où ce drapeau n'est pas disponible.

ctypes.RTLD_LOCAL

   Valeur possible pour le paramètre *mode*. Vaut *RTLD_GLOBAL* sur
   les plates-formes où ce drapeau n'est pas disponible.

ctypes.DEFAULT_MODE

   Mode de chargement par défaut des bibliothèques partagées. Vaut
   *RTLD_GLOBAL* sur OSX 10.3 et *RTLD_LOCAL* sur les autres systèmes
   d'exploitation.

Les instances de ces classes n'ont pas de méthodes publiques ; on
accède aux fonctions de la bibliothèque partagée par attribut ou par
indiçage. Notez que les résultats des accès par attribut sont mis en
cache, et donc des accès consécutifs renvoient à chaque fois le même
objet. Accéder à une fonction par indice renvoie cependant chaque fois
un nouvel objet :

   >>> from ctypes import CDLL
   >>> libc = CDLL("libc.so.6")  # On Linux
   >>> libc.time == libc.time
   True
   >>> libc['time'] == libc['time']
   False

Les attributs publics suivants sont disponibles, leur nom commence par
un tiret bas pour éviter les conflits avec les noms des fonctions
exportées :

PyDLL._handle

   Le lien système d'accès à la bibliothèque.

PyDLL._name

   Nom de la bibliothèque donné au constructeur.

Il est possible de charger une bibliothèque partagée soit en utilisant
une instance de la classe "LibraryLoader", soit en appelant la méthode
"LoadLibrary()", soit en récupérant la bibliothèque comme attribut de
l'instance du chargeur.

class ctypes.LibraryLoader(dlltype)

   Classe pour charger une bibliothèque partagée. *dlltype* doit être
   de type "CDLL", "PyDLL", "WinDLL" ou "OleDLL".

   "__getattr__()" a un comportement particulier : elle charge une
   bibliothèque quand on accède à un attribut du chargeur. Le résultat
   est mis en cache, donc des accès consécutifs renvoient la même
   bibliothèque à chaque fois.

   LoadLibrary(name)

      Charge une bibliothèque partagée dans le processus et la
      renvoie. Cette méthode renvoie toujours une nouvelle instance de
      la bibliothèque.

Plusieurs chargeurs sont fournis :

ctypes.cdll

   Pour créer des instances de "CDLL".

ctypes.windll

   Pour créer des instances de "WinDLL" (uniquement en Windows).

ctypes.oledll

   Pour créer des instances de "OleDLL" (uniquement en Windows).

ctypes.pydll

   Pour créer des instances de "PyDLL".

Il existe un moyen rapide d'accéder directement à l'API C Python :

ctypes.pythonapi

   Une instance de "PyDLL" dont les attributs sont les fonctions
   exportées par l'API C Python. Toutes ces fonctions sont supposées
   renvoyer un "int" C, ce qui n'est bien entendu pas toujours le cas.
   Il faut donc définir vous-même le bon attribut "restype" pour
   pouvoir les utiliser.

Lève un évènement d'audit "ctypes.dlopen" avec l'argument "name".

Accéder à une fonction d'une bibliothèque lève un évènement d'audit
"ctypes.dlsym" avec "library" (l'objet bibliothèque) et "name" (le nom
du symbole — une chaîne de caractères ou un entier) comme arguments.

Si seul le lien sur la bibliothèque, et non l'objet, est disponible,
accéder à une fonction lève l'évènement d'audit "ctypes.dlsym/handle"
avec "handle" (le lien vers la bibliothèque) et "name" comme
arguments.


Fonctions externes
------------------

Comme expliqué dans la section précédente, on peut accéder aux
fonctions externes au travers des attributs des bibliothèques
partagées. Un objet fonction créé de cette façon accepte par défaut un
nombre quelconque d'arguments qui peuvent être de n'importe quel type
de données *ctypes*. Il renvoie le type par défaut du chargeur de la
bibliothèque. Ce sont des instances de la classe privée :

class ctypes._FuncPtr

   Classe de base pour les fonctions externes C.

   Une instance de fonction externe est également un type de donnée
   compatible avec le C ; elle représente un pointeur vers une
   fonction.

   Son comportement peut-être personnalisé en réaffectant les
   attributs spécifiques de l'objet représentant la fonction externe.

   restype

      Fait correspondre le type de retour de la fonction externe à un
      type *ctypes*. Dans le cas où la fonction ne renvoie rien
      ("void"), utilisez "None".

      Il est aussi possible de passer n'importe quel un objet Python
      qui n'est pas un type *ctypes* pourvu qu'il soit appelable. Dans
      ce cas, la fonction est censée renvoyer un "int" C et
      l'appelable sera appelé avec cet entier, ce qui permet ainsi de
      faire des actions supplémentaires comme vérifier un code
      d'erreur. Ce mécanisme est obsolète ; une façon plus souple de
      faire des actions supplémentaires ou de la vérification consiste
      à affecter un type *ctypes* à "restype" et à affecter un
      appelable à l'attribut "errcheck".

   argtypes

      Fait correspondre le type des arguments que la fonction accepte
      avec un *n*-uplet de types *ctypes*. Les fonctions qui utilisent
      la convention d'appel "stdcall" ne peuvent être appelées qu'avec
      le même nombre d'arguments que la taille du *n*-uplet mais les
      fonctions qui utilisent la convention d'appel C acceptent aussi
      des arguments additionnels non-définis.

      À l'appel d'une fonction externe, chaque argument est passé à la
      méthode de classe "from_param()" de l'élément correspondant dans
      le *n*-uplet des "argtypes". Cette méthode convertit l'argument
      initial en un objet que la fonction externe peut comprendre. Par
      exemple, un "c_char_p" dans le *n*-uplet des "argtypes" va
      transformer la chaîne de caractères passée en argument en un
      objet chaîne d'octets selon les règles de conversion *ctypes*.

      Nouveau : il est maintenant possible de mettre des objets qui ne
      sont pas des types de *ctypes* dans les *argtypes*, mais ceux-ci
      doivent avoir une méthode "from_param()" renvoyant une valeur
      qui peut être utilisée comme un argument (entier, chaîne de
      caractères ou instance *ctypes*). Ceci permet de créer des
      adaptateurs qui convertissent des objets arbitraires en des
      paramètres de fonction.

   errcheck

      Définit une fonction Python ou tout autre appelable qui sera
      appelé avec trois arguments ou plus :

      callable(result, func, arguments)

         *result* est la valeur de retour de la fonction externe,
         comme défini par l'attribut "restype".

         *func* est l'objet représentant la fonction externe elle-
         même. Cet accesseur permet de réutiliser le même appelable
         pour vérifier le résultat de plusieurs fonctions ou de faire
         des actions supplémentaires après leur exécution.

         *arguments* est le *n*-uplet qui contient les paramètres
         initiaux passés à la fonction, ceci permet de spécialiser le
         comportement des arguments utilisés.

      L'objet renvoyé par cette fonction est celui renvoyé par l'appel
      de la fonction externe, mais il peut aussi vérifier la valeur du
      résultat et lever une exception si l'appel a échoué.

exception ctypes.ArgumentError

   Exception levée quand un appel à la fonction externe ne peut pas
   convertir un des arguments qu'elle a reçus.

En Windows, quand un appel à une fonction externe lève une exception
système (par exemple, une erreur de segmentation), celle-ci est
interceptée pour être remplacée par l'exception Python correspondante.
De plus, un évènement d'audit "ctypes.seh_exception" est levé avec
"code" en argument, ce qui permet à un point d'entrée (*hook* en
anglais) d'audit de remplacer l'exception par une des siennes.

Certaines manières d'appeler des fonction externes peuvent lever des
évènements d'audit "ctypes.call_function" avec "function pointer" et
"arguments" comme arguments.


Prototypes de fonction
----------------------

Il est aussi possible de créer des fonctions externes en instanciant
des prototypes de fonction. Les prototypes de fonction ressemblent
beaucoup aux prototypes de fonctions en C ; ils décrivent une fonction
(type de retour, type des arguments, convention d'appel) sans préciser
son implémentation. Les fabriques de fonctions prennent en entrée le
type de retour et le type des arguments de la fonction, et peuvent
être utilisées comme des décorateurs-fabrique et ainsi s'appliquer à
des fonctions avec la syntaxe "@décorateur". Ceci est illustré dans la
section Fonctions de rappel.

ctypes.CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

   Renvoie un prototype de fonction qui crée des fonctions qui suivent
   la convention d'appel standard C. Les fonctions libèreront le GIL
   lors de leur exécution. Si *use_errno* est vrai, la copie privée
   *ctypes* de la variable système "errno" est échangée avec la vraie
   valeur de "errno" avant et après l'appel ; *use_last_error* a le
   même effet sous Windows.

ctypes.WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

   Windows only: The returned function prototype creates functions
   that use the "stdcall" calling convention, except on Windows CE
   where "WINFUNCTYPE()" is the same as "CFUNCTYPE()".  The function
   will release the GIL during the call.  *use_errno* and
   *use_last_error* have the same meaning as above.

ctypes.PYFUNCTYPE(restype, *argtypes)

   Renvoie un prototype de fonction qui crée des fonctions qui suivent
   la convention d'appel Python. Les fonctions ne libèreront *pas* le
   GIL lors de leur exécution.

Il y a plusieurs façons d'instancier les prototypes de fonction créés
par ces fabriques, selon le type et le nombre de paramètres de l'appel
:

   prototype(address)

      Renvoie une fonction externe sur l'adresse donnée sous la forme
      d'un entier.

   prototype(callable)

      Crée une fonction appelable depuis du code C (une fonction de
      rappel) d'un appelable Python donné en paramètre.

   prototype(func_spec[, paramflags])

      Renvoie une fonction externe exposée par une bibliothèque
      partagée. *func_spec* est un couple "(nom_ou_indice,
      bibliothèque)". Le premier élément est le nom de la fonction à
      passer comme une chaîne ou bien son indice (dans la table des
      symboles) à passer comme un entier. Le second élément est
      l'instance de la bibliothèque partagée.

   prototype(vtbl_index, name[, paramflags[, iid]])

      Renvoie une fonction qui appelle une méthode COM. *vtbl_index*
      est l'indice de la fonction dans la table virtuelle, un petit
      entier positif. *name* est le nom de la méthode COM. *iid* est
      un pointeur optionnel vers l'identificateur de plateforme, qui
      est utilisé dans la remontée d'erreurs étendue.

      Les méthodes COM ont une convention d'appel particulière : elles
      requièrent de passer un pointeur vers l'interface COM en premier
      argument, en sus des arguments passés dans le *n*-uplet
      "argtypes".

   Le paramètre optionnel *paramflags* crée une fabrique de fonction
   externes avec des fonctionnalités supplémentaires par rapport à
   celles décrites ci-dessus.

   *paramflags* est un *n*-uplet de la même taille que "argtypes".

   Chaque élément de ce *n*-uplet contient des informations
   supplémentaires sur le paramètre correspondant. Ce doit être aussi
   un *n*-uplet, avec un, deux ou trois éléments.

   Le premier élément est un entier qui contient une combinaison de
   drapeaux qui précisent le sens des paramètres (entrée ou sortie) :

      1
         Paramètre d'entrée.

      2
         Paramètre de sortie. La fonction externe va modifier cette
         valeur.

      4
         Paramètre d'entrée, valant 0 par défaut.

   Le deuxième élément (optionnel) est une chaîne de caractères
   représentant le nom du paramètre. Si cet élément est donné, la
   fonction externe pourra être appelée avec des paramètres nommés.

   Le troisième élément (optionnel) est la valeur par défaut du
   paramètre.

L'exemple suivant montre comment encapsuler la fonction Windows
"MessageBoxW" afin que celle-ci prenne en charge des paramètres par
défaut et des arguments nommés. Sa déclaration C dans le fichier d'en-
tête des fenêtres est :

   WINUSERAPI int WINAPI
   MessageBoxW(
       HWND hWnd,
       LPCWSTR lpText,
       LPCWSTR lpCaption,
       UINT uType);

L'encapsulation "ctypes" correspondante est alors :

   >>> from ctypes import c_int, WINFUNCTYPE, windll
   >>> from ctypes.wintypes import HWND, LPCWSTR, UINT
   >>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT)
   >>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0)
   >>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)

La fonction "MessageBox" peut désormais être appelée des manières
suivantes :

   >>> MessageBox()
   >>> MessageBox(text="Spam, spam, spam")
   >>> MessageBox(flags=2, text="foo bar")

L'exemple qui suit traite des paramètres en sortie. La fonction win32
"GetWindowRect" donne les dimensions d'une fenêtre en les copiant dans
une structure "RECT" que l'appelant doit fournir. Sa déclaration en C
est :

   WINUSERAPI BOOL WINAPI
   GetWindowRect(
        HWND hWnd,
        LPRECT lpRect);

L'encapsulation "ctypes" correspondante est alors :

   >>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError
   >>> from ctypes.wintypes import BOOL, HWND, RECT
   >>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))
   >>> paramflags = (1, "hwnd"), (2, "lprect")
   >>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)
   >>>

Les fonctions avec des paramètres en sortie renvoient automatiquement
la valeur du paramètre de sortie s'il n'y en a qu'un seul, ou un
*n*-uplet avec les valeurs de sortie de chaque paramètre s'il y en a
plusieurs. Ici, la fonction *GetWindowRect* renvoie donc une instance
de *RECT* quand elle est appelée.

Il est possible de combiner des paramètres en sortie avec le protocole
"errcheck" pour post-traiter les sorties et faire de la vérification
d'erreur. La fonction de l'API win32 "GetWindowRect" renvoie un "BOOL"
pour indiquer le succès ou l'échec de l'exécution, donc cette fonction
peut vérifier le résultat et lever une exception quand l'appel à l'API
a échoué :

   >>> def errcheck(result, func, args):
   ...     if not result:
   ...         raise WinError()
   ...     return args
   ...
   >>> GetWindowRect.errcheck = errcheck
   >>>

Si la fonction "errcheck" renvoie le *n*-uplet passé en paramètre sans
rien y changer, "ctypes" continue l'exécution habituelle des
paramètres en sortie. Si on préfère renvoyer un *n*-uplet de
coordonnées au lieu de renvoyer une instance de "RECT", il faut
récupérer les champs correspondants et les renvoyer en retour. Dans ce
cas, l'exécution habituelle n'a plus lieu :

   >>> def errcheck(result, func, args):
   ...     if not result:
   ...         raise WinError()
   ...     rc = args[1]
   ...     return rc.left, rc.top, rc.bottom, rc.right
   ...
   >>> GetWindowRect.errcheck = errcheck
   >>>


Fonctions utilitaires
---------------------

ctypes.addressof(obj)

   Returns the address of the memory buffer as integer.  *obj* must be
   an instance of a ctypes type.

   Raises an auditing event "ctypes.addressof" with argument "obj".

ctypes.alignment(obj_or_type)

   Returns the alignment requirements of a ctypes type. *obj_or_type*
   must be a ctypes type or instance.

ctypes.byref(obj[, offset])

   Returns a light-weight pointer to *obj*, which must be an instance
   of a ctypes type.  *offset* defaults to zero, and must be an
   integer that will be added to the internal pointer value.

   "byref(obj, offset)" corresponds to this C code:

      (((char *)&obj) + offset)

   The returned object can only be used as a foreign function call
   parameter. It behaves similar to "pointer(obj)", but the
   construction is a lot faster.

ctypes.cast(obj, type)

   This function is similar to the cast operator in C. It returns a
   new instance of *type* which points to the same memory block as
   *obj*.  *type* must be a pointer type, and *obj* must be an object
   that can be interpreted as a pointer.

ctypes.create_string_buffer(init_or_size, size=None)

   This function creates a mutable character buffer. The returned
   object is a ctypes array of "c_char".

   *init_or_size* must be an integer which specifies the size of the
   array, or a bytes object which will be used to initialize the array
   items.

   If a bytes object is specified as first argument, the buffer is
   made one item larger than its length so that the last element in
   the array is a NUL termination character. An integer can be passed
   as second argument which allows specifying the size of the array if
   the length of the bytes should not be used.

   Raises an auditing event "ctypes.create_string_buffer" with
   arguments "init", "size".

ctypes.create_unicode_buffer(init_or_size, size=None)

   This function creates a mutable unicode character buffer. The
   returned object is a ctypes array of "c_wchar".

   *init_or_size* must be an integer which specifies the size of the
   array, or a string which will be used to initialize the array
   items.

   If a string is specified as first argument, the buffer is made one
   item larger than the length of the string so that the last element
   in the array is a NUL termination character. An integer can be
   passed as second argument which allows specifying the size of the
   array if the length of the string should not be used.

   Raises an auditing event "ctypes.create_unicode_buffer" with
   arguments "init", "size".

ctypes.DllCanUnloadNow()

   Windows only: This function is a hook which allows implementing in-
   process COM servers with ctypes.  It is called from the
   DllCanUnloadNow function that the _ctypes extension dll exports.

ctypes.DllGetClassObject()

   Windows only: This function is a hook which allows implementing in-
   process COM servers with ctypes.  It is called from the
   DllGetClassObject function that the "_ctypes" extension dll
   exports.

ctypes.util.find_library(name)

   Try to find a library and return a pathname.  *name* is the library
   name without any prefix like "lib", suffix like ".so", ".dylib" or
   version number (this is the form used for the posix linker option
   "-l").  If no library can be found, returns "None".

   Le mode opératoire exact dépend du système.

ctypes.util.find_msvcrt()

   Windows only: return the filename of the VC runtime library used by
   Python, and by the extension modules.  If the name of the library
   cannot be determined, "None" is returned.

   If you need to free memory, for example, allocated by an extension
   module with a call to the "free(void *)", it is important that you
   use the function in the same library that allocated the memory.

ctypes.FormatError([code])

   Windows only: Returns a textual description of the error code
   *code*.  If no error code is specified, the last error code is used
   by calling the Windows api function GetLastError.

ctypes.GetLastError()

   Windows only: Returns the last error code set by Windows in the
   calling thread. This function calls the Windows *GetLastError()*
   function directly, it does not return the ctypes-private copy of
   the error code.

ctypes.get_errno()

   Returns the current value of the ctypes-private copy of the system
   "errno" variable in the calling thread.

   Raises an auditing event "ctypes.get_errno" with no arguments.

ctypes.get_last_error()

   Windows only: returns the current value of the ctypes-private copy
   of the system "LastError" variable in the calling thread.

   Raises an auditing event "ctypes.get_last_error" with no arguments.

ctypes.memmove(dst, src, count)

   Same as the standard C memmove library function: copies *count*
   bytes from *src* to *dst*. *dst* and *src* must be integers or
   ctypes instances that can be converted to pointers.

ctypes.memset(dst, c, count)

   Same as the standard C memset library function: fills the memory
   block at address *dst* with *count* bytes of value *c*. *dst* must
   be an integer specifying an address, or a ctypes instance.

ctypes.POINTER(type)

   This factory function creates and returns a new ctypes pointer
   type. Pointer types are cached and reused internally, so calling
   this function repeatedly is cheap. *type* must be a ctypes type.

ctypes.pointer(obj)

   This function creates a new pointer instance, pointing to *obj*.
   The returned object is of the type "POINTER(type(obj))".

   Note: If you just want to pass a pointer to an object to a foreign
   function call, you should use "byref(obj)" which is much faster.

ctypes.resize(obj, size)

   This function resizes the internal memory buffer of *obj*, which
   must be an instance of a ctypes type.  It is not possible to make
   the buffer smaller than the native size of the objects type, as
   given by "sizeof(type(obj))", but it is possible to enlarge the
   buffer.

ctypes.set_errno(value)

   Set the current value of the ctypes-private copy of the system
   "errno" variable in the calling thread to *value* and return the
   previous value.

   Raises an auditing event "ctypes.set_errno" with argument "errno".

ctypes.set_last_error(value)

   Windows only: set the current value of the ctypes-private copy of
   the system "LastError" variable in the calling thread to *value*
   and return the previous value.

   Raises an auditing event "ctypes.set_last_error" with argument
   "error".

ctypes.sizeof(obj_or_type)

   Returns the size in bytes of a ctypes type or instance memory
   buffer. Does the same as the C "sizeof" operator.

ctypes.string_at(address, size=-1)

   This function returns the C string starting at memory address
   *address* as a bytes object. If size is specified, it is used as
   size, otherwise the string is assumed to be zero-terminated.

   Raises an auditing event "ctypes.string_at" with arguments
   "address", "size".

ctypes.WinError(code=None, descr=None)

   Windows only: this function is probably the worst-named thing in
   ctypes. It creates an instance of OSError.  If *code* is not
   specified, "GetLastError" is called to determine the error code. If
   *descr* is not specified, "FormatError()" is called to get a
   textual description of the error.

   Modifié dans la version 3.3: An instance of "WindowsError" used to
   be created.

ctypes.wstring_at(address, size=-1)

   This function returns the wide character string starting at memory
   address *address* as a string.  If *size* is specified, it is used
   as the number of characters of the string, otherwise the string is
   assumed to be zero-terminated.

   Raises an auditing event "ctypes.wstring_at" with arguments
   "address", "size".


Types de données
----------------

class ctypes._CData

   This non-public class is the common base class of all ctypes data
   types. Among other things, all ctypes type instances contain a
   memory block that hold C compatible data; the address of the memory
   block is returned by the "addressof()" helper function. Another
   instance variable is exposed as "_objects"; this contains other
   Python objects that need to be kept alive in case the memory block
   contains pointers.

   Common methods of ctypes data types, these are all class methods
   (to be exact, they are methods of the *metaclass*):

   from_buffer(source[, offset])

      This method returns a ctypes instance that shares the buffer of
      the *source* object.  The *source* object must support the
      writeable buffer interface.  The optional *offset* parameter
      specifies an offset into the source buffer in bytes; the default
      is zero.  If the source buffer is not large enough a
      "ValueError" is raised.

      Raises an auditing event "ctypes.cdata/buffer" with arguments
      "pointer", "size", "offset".

   from_buffer_copy(source[, offset])

      This method creates a ctypes instance, copying the buffer from
      the *source* object buffer which must be readable.  The optional
      *offset* parameter specifies an offset into the source buffer in
      bytes; the default is zero.  If the source buffer is not large
      enough a "ValueError" is raised.

      Raises an auditing event "ctypes.cdata/buffer" with arguments
      "pointer", "size", "offset".

   from_address(address)

      This method returns a ctypes type instance using the memory
      specified by *address* which must be an integer.

      This method, and others that indirectly call this method, raises
      an auditing event "ctypes.cdata" with argument "address".

   from_param(obj)

      This method adapts *obj* to a ctypes type.  It is called with
      the actual object used in a foreign function call when the type
      is present in the foreign function's "argtypes" tuple; it must
      return an object that can be used as a function call parameter.

      All ctypes data types have a default implementation of this
      classmethod that normally returns *obj* if that is an instance
      of the type.  Some types accept other objects as well.

   in_dll(library, name)

      This method returns a ctypes type instance exported by a shared
      library. *name* is the name of the symbol that exports the data,
      *library* is the loaded shared library.

   Common instance variables of ctypes data types:

   _b_base_

      Sometimes ctypes data instances do not own the memory block they
      contain, instead they share part of the memory block of a base
      object.  The "_b_base_" read-only member is the root ctypes
      object that owns the memory block.

   _b_needsfree_

      This read-only variable is true when the ctypes data instance
      has allocated the memory block itself, false otherwise.

   _objects

      This member is either "None" or a dictionary containing Python
      objects that need to be kept alive so that the memory block
      contents is kept valid.  This object is only exposed for
      debugging; never modify the contents of this dictionary.


Types de données fondamentaux
-----------------------------

class ctypes._SimpleCData

   This non-public class is the base class of all fundamental ctypes
   data types. It is mentioned here because it contains the common
   attributes of the fundamental ctypes data types.  "_SimpleCData" is
   a subclass of "_CData", so it inherits their methods and
   attributes. ctypes data types that are not and do not contain
   pointers can now be pickled.

   Instances have a single attribute:

   value

      This attribute contains the actual value of the instance. For
      integer and pointer types, it is an integer, for character
      types, it is a single character bytes object or string, for
      character pointer types it is a Python bytes object or string.

      When the "value" attribute is retrieved from a ctypes instance,
      usually a new object is returned each time.  "ctypes" does *not*
      implement original object return, always a new object is
      constructed.  The same is true for all other ctypes object
      instances.

Fundamental data types, when returned as foreign function call
results, or, for example, by retrieving structure field members or
array items, are transparently converted to native Python types.  In
other words, if a foreign function has a "restype" of "c_char_p", you
will always receive a Python bytes object, *not* a "c_char_p"
instance.

Subclasses of fundamental data types do *not* inherit this behavior.
So, if a foreign functions "restype" is a subclass of "c_void_p", you
will receive an instance of this subclass from the function call. Of
course, you can get the value of the pointer by accessing the "value"
attribute.

These are the fundamental ctypes data types:

class ctypes.c_byte

   Represents the C "signed char" datatype, and interprets the value
   as small integer.  The constructor accepts an optional integer
   initializer; no overflow checking is done.

class ctypes.c_char

   Represents the C "char" datatype, and interprets the value as a
   single character.  The constructor accepts an optional string
   initializer, the length of the string must be exactly one
   character.

class ctypes.c_char_p

   Represents the C "char *" datatype when it points to a zero-
   terminated string.  For a general character pointer that may also
   point to binary data, "POINTER(c_char)" must be used.  The
   constructor accepts an integer address, or a bytes object.

class ctypes.c_double

   Represents the C "double" datatype.  The constructor accepts an
   optional float initializer.

class ctypes.c_longdouble

   Represents the C "long double" datatype.  The constructor accepts
   an optional float initializer.  On platforms where "sizeof(long
   double) == sizeof(double)" it is an alias to "c_double".

class ctypes.c_float

   Represents the C "float" datatype.  The constructor accepts an
   optional float initializer.

class ctypes.c_int

   Represents the C "signed int" datatype.  The constructor accepts an
   optional integer initializer; no overflow checking is done.  On
   platforms where "sizeof(int) == sizeof(long)" it is an alias to
   "c_long".

class ctypes.c_int8

   Represents the C 8-bit "signed int" datatype.  Usually an alias for
   "c_byte".

class ctypes.c_int16

   Represents the C 16-bit "signed int" datatype.  Usually an alias
   for "c_short".

class ctypes.c_int32

   Represents the C 32-bit "signed int" datatype.  Usually an alias
   for "c_int".

class ctypes.c_int64

   Represents the C 64-bit "signed int" datatype.  Usually an alias
   for "c_longlong".

class ctypes.c_long

   Represents the C "signed long" datatype.  The constructor accepts
   an optional integer initializer; no overflow checking is done.

class ctypes.c_longlong

   Represents the C "signed long long" datatype.  The constructor
   accepts an optional integer initializer; no overflow checking is
   done.

class ctypes.c_short

   Represents the C "signed short" datatype.  The constructor accepts
   an optional integer initializer; no overflow checking is done.

class ctypes.c_size_t

   Represents the C "size_t" datatype.

class ctypes.c_ssize_t

   Represents the C "ssize_t" datatype.

   Nouveau dans la version 3.2.

class ctypes.c_ubyte

   Represents the C "unsigned char" datatype, it interprets the value
   as small integer.  The constructor accepts an optional integer
   initializer; no overflow checking is done.

class ctypes.c_uint

   Represents the C "unsigned int" datatype.  The constructor accepts
   an optional integer initializer; no overflow checking is done.  On
   platforms where "sizeof(int) == sizeof(long)" it is an alias for
   "c_ulong".

class ctypes.c_uint8

   Represents the C 8-bit "unsigned int" datatype.  Usually an alias
   for "c_ubyte".

class ctypes.c_uint16

   Represents the C 16-bit "unsigned int" datatype.  Usually an alias
   for "c_ushort".

class ctypes.c_uint32

   Represents the C 32-bit "unsigned int" datatype.  Usually an alias
   for "c_uint".

class ctypes.c_uint64

   Represents the C 64-bit "unsigned int" datatype.  Usually an alias
   for "c_ulonglong".

class ctypes.c_ulong

   Represents the C "unsigned long" datatype.  The constructor accepts
   an optional integer initializer; no overflow checking is done.

class ctypes.c_ulonglong

   Represents the C "unsigned long long" datatype.  The constructor
   accepts an optional integer initializer; no overflow checking is
   done.

class ctypes.c_ushort

   Represents the C "unsigned short" datatype.  The constructor
   accepts an optional integer initializer; no overflow checking is
   done.

class ctypes.c_void_p

   Represents the C "void *" type.  The value is represented as
   integer. The constructor accepts an optional integer initializer.

class ctypes.c_wchar

   Represents the C "wchar_t" datatype, and interprets the value as a
   single character unicode string.  The constructor accepts an
   optional string initializer, the length of the string must be
   exactly one character.

class ctypes.c_wchar_p

   Represents the C "wchar_t *" datatype, which must be a pointer to a
   zero-terminated wide character string.  The constructor accepts an
   integer address, or a string.

class ctypes.c_bool

   Represent the C "bool" datatype (more accurately, "_Bool" from
   C99).  Its value can be "True" or "False", and the constructor
   accepts any object that has a truth value.

class ctypes.HRESULT

   Windows only: Represents a "HRESULT" value, which contains success
   or error information for a function or method call.

class ctypes.py_object

   Represents the C "PyObject *" datatype.  Calling this without an
   argument creates a "NULL" "PyObject *" pointer.

The "ctypes.wintypes" module provides quite some other Windows
specific data types, for example "HWND", "WPARAM", or "DWORD".  Some
useful structures like "MSG" or "RECT" are also defined.


Types de données dérivés de Structure
-------------------------------------

class ctypes.Union(*args, **kw)

   Abstract base class for unions in native byte order.

class ctypes.BigEndianStructure(*args, **kw)

   Abstract base class for structures in *big endian* byte order.

class ctypes.LittleEndianStructure(*args, **kw)

   Abstract base class for structures in *little endian* byte order.

Structures with non-native byte order cannot contain pointer type
fields, or any other data types containing pointer type fields.

class ctypes.Structure(*args, **kw)

   Abstract base class for structures in *native* byte order.

   Concrete structure and union types must be created by subclassing
   one of these types, and at least define a "_fields_" class
   variable. "ctypes" will create *descriptor*s which allow reading
   and writing the fields by direct attribute accesses.  These are the

   _fields_

      A sequence defining the structure fields.  The items must be
      2-tuples or 3-tuples.  The first item is the name of the field,
      the second item specifies the type of the field; it can be any
      ctypes data type.

      For integer type fields like "c_int", a third optional item can
      be given.  It must be a small positive integer defining the bit
      width of the field.

      Field names must be unique within one structure or union.  This
      is not checked, only one field can be accessed when names are
      repeated.

      It is possible to define the "_fields_" class variable *after*
      the class statement that defines the Structure subclass, this
      allows creating data types that directly or indirectly reference
      themselves:

         class List(Structure):
             pass
         List._fields_ = [("pnext", POINTER(List)),
                          ...
                         ]

      The "_fields_" class variable must, however, be defined before
      the type is first used (an instance is created, "sizeof()" is
      called on it, and so on).  Later assignments to the "_fields_"
      class variable will raise an AttributeError.

      It is possible to define sub-subclasses of structure types, they
      inherit the fields of the base class plus the "_fields_" defined
      in the sub-subclass, if any.

   _pack_

      An optional small integer that allows overriding the alignment
      of structure fields in the instance.  "_pack_" must already be
      defined when "_fields_" is assigned, otherwise it will have no
      effect.

   _anonymous_

      An optional sequence that lists the names of unnamed (anonymous)
      fields. "_anonymous_" must be already defined when "_fields_" is
      assigned, otherwise it will have no effect.

      The fields listed in this variable must be structure or union
      type fields. "ctypes" will create descriptors in the structure
      type that allows accessing the nested fields directly, without
      the need to create the structure or union field.

      Here is an example type (Windows):

         class _U(Union):
             _fields_ = [("lptdesc", POINTER(TYPEDESC)),
                         ("lpadesc", POINTER(ARRAYDESC)),
                         ("hreftype", HREFTYPE)]

         class TYPEDESC(Structure):
             _anonymous_ = ("u",)
             _fields_ = [("u", _U),
                         ("vt", VARTYPE)]

      The "TYPEDESC" structure describes a COM data type, the "vt"
      field specifies which one of the union fields is valid.  Since
      the "u" field is defined as anonymous field, it is now possible
      to access the members directly off the TYPEDESC instance.
      "td.lptdesc" and "td.u.lptdesc" are equivalent, but the former
      is faster since it does not need to create a temporary union
      instance:

         td = TYPEDESC()
         td.vt = VT_PTR
         td.lptdesc = POINTER(some_type)
         td.u.lptdesc = POINTER(some_type)

   It is possible to define sub-subclasses of structures, they inherit
   the fields of the base class.  If the subclass definition has a
   separate "_fields_" variable, the fields specified in this are
   appended to the fields of the base class.

   Structure and union constructors accept both positional and keyword
   arguments.  Positional arguments are used to initialize member
   fields in the same order as they are appear in "_fields_".  Keyword
   arguments in the constructor are interpreted as attribute
   assignments, so they will initialize "_fields_" with the same name,
   or create new attributes for names not present in "_fields_".


Tableaux et pointeurs
---------------------

class ctypes.Array(*args)

   Classe de base abstraite pour les *arrays*.

   The recommended way to create concrete array types is by
   multiplying any "ctypes" data type with a positive integer.
   Alternatively, you can subclass this type and define "_length_" and
   "_type_" class variables. Array elements can be read and written
   using standard subscript and slice accesses; for slice reads, the
   resulting object is *not* itself an "Array".

   _length_

      A positive integer specifying the number of elements in the
      array. Out-of-range subscripts result in an "IndexError". Will
      be returned by "len()".

   _type_

      Spécifie le type de chaque élément de l'*array*.

   Array subclass constructors accept positional arguments, used to
   initialize the elements in order.

class ctypes._Pointer

   Private, abstract base class for pointers.

   Concrete pointer types are created by calling "POINTER()" with the
   type that will be pointed to; this is done automatically by
   "pointer()".

   If a pointer points to an array, its elements can be read and
   written using standard subscript and slice accesses.  Pointer
   objects have no size, so "len()" will raise "TypeError".  Negative
   subscripts will read from the memory *before* the pointer (as in
   C), and out-of-range subscripts will probably crash with an access
   violation (if you're lucky).

   _type_

      Specifies the type pointed to.

   contents

      Returns the object to which to pointer points.  Assigning to
      this attribute changes the pointer to point to the assigned
      object.
