ctypes.md
1> **Источник:** https://python-all.ru/3.4/library/ctypes.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 16.16. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) – библиотека вызова внешних функций для Python89[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) – это библиотека вызова внешних функций для Python. Она предоставляет типы данных, совместимые с C, и позволяет вызывать функции из DLL или разделяемых библиотек. Её можно использовать для обёртывания этих библиотек на чистом Python.1011## 16.16.1. Руководство по ctypes1213Примечание: примеры кода в этом руководстве используют [`doctest`](https://python-all.ru/3.4/library/doctest.html#module-doctest), чтобы убедиться, что они действительно работают. Поскольку некоторые примеры ведут себя по-разному в Linux, Windows или Mac OS X, они содержат директивы doctest в комментариях.1415Примечание: некоторые примеры кода ссылаются на тип ctypes [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int). Этот тип является псевдонимом для типа [`c_long`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_long) в 32-битных системах. Так что не стоит путаться, если выводится [`c_long`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_long), когда вы ожидаете [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int) – на самом деле это один и тот же тип.1617### 16.16.1.1. Загрузка библиотек динамической компоновки1819[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) exports the *cdll*, and on Windows *windll* and *oledll* objects, for loading dynamic link libraries.2021Библиотеки загружаются через обращение к ним как к атрибутам этих объектов. *cdll* загружает библиотеки, которые экспортируют функции, использующие стандартное соглашение о вызове `cdecl`, в то время как библиотеки *windll* вызывают функции с соглашением о вызове `stdcall`. *oledll* также использует соглашение о вызове `stdcall` и предполагает, что функции возвращают код ошибки Windows `HRESULT`. Этот код ошибки используется для автоматического возбуждения исключения [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError) при неудачном вызове функции.2223Изменено в версии 3.3: Раньше ошибки Windows возбуждали [`WindowsError`](https://python-all.ru/3.4/library/exceptions.html#WindowsError), который теперь является псевдонимом [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError).2425Вот несколько примеров для Windows. `msvcrt` – это стандартная библиотека C от Microsoft. Она содержит большинство стандартных функций C и использует соглашение о вызовах cdecl.2627```python28>>> from ctypes import *29>>> print(windll.kernel32) 30<WinDLL 'kernel32', handle ... at ...>31>>> print(cdll.msvcrt) 32<CDLL 'msvcrt', handle ... at ...>33>>> libc = cdll.msvcrt 34>>>35```3637Windows автоматически добавляет обычный суффикс файла `.dll`.3839В Linux необходимо указывать имя файла *с расширением* для загрузки библиотеки, поэтому обращение через атрибуты не может использоваться для загрузки библиотек. Следует использовать либо метод `LoadLibrary()` загрузчиков DLL, либо загружать библиотеку, создавая экземпляр CDLL через вызов конструктора:4041```python42>>> cdll.LoadLibrary("libc.so.6") 43<CDLL 'libc.so.6', handle ... at ...>44>>> libc = CDLL("libc.so.6") 45>>> libc 46<CDLL 'libc.so.6', handle ... at ...>47>>>48```4950### 16.16.1.2. Доступ к функциям из загруженных DLL5152Функции доступны как атрибуты объектов DLL:5354```python55>>> from ctypes import *56>>> libc.printf57<_FuncPtr object at 0x...>58>>> print(windll.kernel32.GetModuleHandleA) 59<_FuncPtr object at 0x...>60>>> print(windll.kernel32.MyOwnFunction) 61Traceback (most recent call last):62 File "<stdin>", line 1, in ?63 File "ctypes.py", line 239, in __getattr__64 func = _StdcallFuncPtr(name, self)65AttributeError: function 'MyOwnFunction' not found66>>>67```6869Обратите внимание, что системные DLL win32, такие как `kernel32` и `user32`, часто экспортируют как ANSI-, так и UNICODE-версии функций. Версия UNICODE экспортируется с добавлением `W` к имени, а версия ANSI – с добавлением `A`. Функция win32 `GetModuleHandle`, которая возвращает *дескриптор модуля* для заданного имени модуля, имеет следующий прототип на C, и макрос используется для предоставления одной из них как `GetModuleHandle` в зависимости от того, определён ли UNICODE:7071```python72/* ANSI version */73HMODULE GetModuleHandleA(LPCSTR lpModuleName);74/* UNICODE version */75HMODULE GetModuleHandleW(LPCWSTR lpModuleName);76```7778*windll* не пытается выбрать одну из них магическим образом; необходимо явно указывать нужную версию, обращаясь к `GetModuleHandleA` или `GetModuleHandleW`, и затем вызывать её с объектами bytes или string соответственно.7980Иногда DLL экспортируют функции с именами, которые не являются допустимыми идентификаторами Python, например, `"??2@YAPAXI@Z"`. В этом случае для получения функции приходится использовать [`getattr()`](https://python-all.ru/3.4/library/functions.html#getattr):8182```python83>>> getattr(cdll.msvcrt, "??2@YAPAXI@Z") 84<_FuncPtr object at 0x...>85>>>86```8788В Windows некоторые DLL экспортируют функции не по имени, а по порядковому номеру. К таким функциям можно получить доступ, индексируя объект DLL по порядковому номеру:8990```python91>>> cdll.kernel32[1] 92<_FuncPtr object at 0x...>93>>> cdll.kernel32[0] 94Traceback (most recent call last):95 File "<stdin>", line 1, in ?96 File "ctypes.py", line 310, in __getitem__97 func = _StdcallFuncPtr(name, self)98AttributeError: function ordinal 0 not found99>>>100```101102### 16.16.1.3. Вызов функций103104Эти функции можно вызывать как любые другие вызываемые объекты Python. В этом примере используется функция `time()`, возвращающая системное время в секундах с начала эпохи Unix, и функция `GetModuleHandleA()`, возвращающая дескриптор модуля win32.105106В этом примере обе функции вызываются с нулевым указателем (в качестве нулевого указателя следует использовать `None`):107108```python109>>> print(libc.time(None)) 1101150640792111>>> print(hex(windll.kernel32.GetModuleHandleA(None))) 1120x1d000000113>>>114```115116[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) пытается защитить от вызова функций с неверным количеством аргументов или неверным соглашением о вызове. К сожалению, это работает только в Windows. Это делается путём проверки стека после возврата функции, так что, хотя и возбуждается ошибка, функция *была* вызвана:117118```python119>>> windll.kernel32.GetModuleHandleA() 120Traceback (most recent call last):121 File "<stdin>", line 1, in ?122ValueError: Procedure probably called with not enough arguments (4 bytes missing)123>>> windll.kernel32.GetModuleHandleA(0, 0) 124Traceback (most recent call last):125 File "<stdin>", line 1, in ?126ValueError: Procedure probably called with too many arguments (4 bytes in excess)127>>>128```129130То же исключение возбуждается при вызове функции с соглашением `stdcall` с использованием соглашения о вызове `cdecl`, или наоборот:131132```python133>>> cdll.kernel32.GetModuleHandleA(None) 134Traceback (most recent call last):135 File "<stdin>", line 1, in ?136ValueError: Procedure probably called with not enough arguments (4 bytes missing)137>>>138139>>> windll.msvcrt.printf(b"spam") 140Traceback (most recent call last):141 File "<stdin>", line 1, in ?142ValueError: Procedure probably called with too many arguments (4 bytes in excess)143>>>144```145146Чтобы узнать правильное соглашение о вызовах, необходимо заглянуть в C-заголовочный файл или документацию вызываемой функции.147148В Windows [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) использует структурированную обработку исключений win32 для предотвращения сбоев из-за ошибок защиты при вызовах функций с недопустимыми значениями аргументов:149150```python151>>> windll.kernel32.GetModuleHandleA(32) 152Traceback (most recent call last):153 File "<stdin>", line 1, in ?154OSError: exception: access violation reading 0x00000020155>>>156```157158Тем не менее, существует достаточно способов аварийно завершить Python с помощью [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes), так что следует быть внимательным. Модуль [`faulthandler`](https://python-all.ru/3.4/library/faulthandler.html#module-faulthandler) может помочь при отладке сбоев (например, из-за ошибок сегментации, вызванных некорректными вызовами библиотек C).159160`None`, целые числа, объекты bytes и (юникодные) строки – единственные нативные объекты Python, которые можно напрямую использовать в качестве параметров при вызовах этих функций. `None` передаётся как указатель C `NULL`, объекты bytes и строки передаются как указатель на блок памяти, содержащий их данные (`char *` или `wchar_t *`). Целые числа Python передаются как тип C `int`, используемый по умолчанию на данной платформе, их значение маскируется, чтобы поместиться в тип C.161162Прежде чем перейти к вызову функций с другими типами параметров, необходимо узнать больше о типах данных [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes).163164### 16.16.1.4. Базовые типы данных165166[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) определяет ряд примитивных типов данных, совместимых с C:167168| Тип ctypes | Тип C | Тип Python |169| --- | --- | --- |170| [`c_bool`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_bool) | `_Bool` | bool (1) |171| [`c_char`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char) | `char` | односимвольный объект bytes |172| [`c_wchar`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_wchar) | `wchar_t` | односимвольная строка |173| [`c_byte`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_byte) | `char` | int |174| [`c_ubyte`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ubyte) | `unsigned char` | int |175| [`c_short`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_short) | `short` | int |176| [`c_ushort`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ushort) | `unsigned short` | int |177| [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int) | `int` | int |178| [`c_uint`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_uint) | `unsigned int` | int |179| [`c_long`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_long) | `long` | int |180| [`c_ulong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ulong) | `unsigned long` | int |181| [`c_longlong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_longlong) | `__int64` или `long long` | int |182| [`c_ulonglong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ulonglong) | `unsigned __int64` или `unsigned long long` | int |183| [`c_size_t`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_size_t) | `size_t` | int |184| [`c_ssize_t`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ssize_t) | `ssize_t` или `Py_ssize_t` | int |185| [`c_float`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_float) | `float` | float |186| [`c_double`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_double) | `double` | float |187| [`c_longdouble`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_longdouble) | `long double` | float |188| [`c_char_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char_p) | `char *` (с завершающим NUL) | объект bytes или `None` |189| [`c_wchar_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_wchar_p) | `wchar_t *` (с завершающим NUL) | строка или `None` |190| [`c_void_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_void_p) | `void *` | int или `None` |1911921. Конструктор принимает любой объект с истинностным значением.193194Все эти типы можно создать, вызвав их с необязательным инициализатором правильного типа и значения:195196```python197>>> c_int()198c_long(0)199>>> c_wchar_p("Hello, World")200c_wchar_p('Hello, World')201>>> c_ushort(-3)202c_ushort(65533)203>>>204```205206Поскольку эти типы изменяемы, их значение можно изменить и впоследствии:207208```python209>>> i = c_int(42)210>>> print(i)211c_long(42)212>>> print(i.value)21342214>>> i.value = -99215>>> print(i.value)216-99217>>>218```219220Присваивание нового значения экземплярам типов-указателей [`c_char_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char_p), [`c_wchar_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_wchar_p) и [`c_void_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_void_p) изменяет *адрес памяти*, на который они указывают, *а не содержимое* блока памяти (конечно, нет, потому что объекты bytes в Python неизменяемы):221222```python223>>> s = "Hello, World"224>>> c_s = c_wchar_p(s)225>>> print(c_s)226c_wchar_p('Hello, World')227>>> c_s.value = "Hi, there"228>>> print(c_s)229c_wchar_p('Hi, there')230>>> print(s) # первый объект не изменился231Hello, World232>>>233```234235Однако следует быть осторожным и не передавать их функциям, ожидающим указатели на изменяемую память. Если нужны изменяемые блоки памяти, в ctypes есть функция [`create_string_buffer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.create_string_buffer), которая создаёт их разными способами. Получить доступ к текущему содержимому блока памяти (или изменить его) можно через свойство `raw` ; если требуется обращаться к нему как к строке с завершающим NUL, используйте свойство `value` :236237```python238>>> from ctypes import *239>>> p = create_string_buffer(3) # создать буфер размером 3 байта, инициализированный нулевыми байтами240>>> print(sizeof(p), repr(p.raw))2413 b'\x00\x00\x00'242>>> p = create_string_buffer(b"Hello") # создать буфер, содержащий строку, завершающуюся нулевым байтом243>>> print(sizeof(p), repr(p.raw))2446 b'Hello\x00'245>>> print(repr(p.value))246b'Hello'247>>> p = create_string_buffer(b"Hello", 10) # создать буфер на 10 байт248>>> print(sizeof(p), repr(p.raw))24910 b'Hello\x00\x00\x00\x00\x00'250>>> p.value = b"Hi"251>>> print(sizeof(p), repr(p.raw))25210 b'Hi\x00lo\x00\x00\x00\x00\x00'253>>>254```255256Функция [`create_string_buffer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.create_string_buffer) заменила функцию `c_buffer()` (которая всё ещё доступна как псевдоним), а также функцию `c_string()` из более ранних выпусков ctypes. Чтобы создать изменяемый блок памяти, содержащий символы Unicode типа C `wchar_t`, используйте функцию [`create_unicode_buffer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.create_unicode_buffer).257258### 16.16.1.5. Вызов функций, продолжение259260Обратите внимание, что printf выводит в реальный канал стандартного вывода, *а не* в [`sys.stdout`](https://python-all.ru/3.4/library/sys.html#sys.stdout), поэтому эти примеры будут работать только в командной строке, а не из *IDLE* или *PythonWin*:261262```python263>>> printf = libc.printf264>>> printf(b"Hello, %s\n", b"World!")265Hello, World!26614267>>> printf(b"Hello, %S\n", "World!")268Hello, World!26914270>>> printf(b"%d bottles of beer\n", 42)27142 bottles of beer27219273>>> printf(b"%f bottles of beer\n", 42.5)274Traceback (most recent call last):275 File "<stdin>", line 1, in ?276ArgumentError: argument 2: exceptions.TypeError: Don't know how to convert parameter 2277>>>278```279280Как уже упоминалось, все типы Python, кроме целых чисел, строк и объектов bytes, должны быть обёрнуты в соответствующий тип [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes), чтобы их можно было преобразовать в требуемый тип C:281282```python283>>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))284An int 1234, a double 3.14000028531286>>>287```288289### 16.16.1.6. Вызов функций с собственными пользовательскими типами данных290291Вы также можете настроить преобразование аргументов [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes), чтобы экземпляры ваших собственных классов можно было использовать в качестве аргументов функций. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) ищет атрибут `_as_parameter_` и использует его в качестве аргумента функции. Разумеется, это должно быть целое число, строка или bytes:292293```python294>>> class Bottles:295... def __init__(self, number):296... self._as_parameter_ = number297...298>>> bottles = Bottles(42)299>>> printf(b"%d bottles of beer\n", bottles)30042 bottles of beer30119302>>>303```304305Если вы не хотите хранить данные экземпляра в переменной экземпляра `_as_parameter_`, можно определить [`свойство`](https://python-all.ru/3.4/library/functions.html#property), которое делает этот атрибут доступным по запросу.306307### 16.16.1.7. Указание требуемых типов аргументов (прототипы функций)308309Можно указать требуемые типы аргументов функций, экспортируемых из DLL, с помощью установки атрибута `argtypes`.310311`argtypes` должен быть последовательностью типов C (функция `printf`, вероятно, не самый удачный пример, потому что она принимает переменное количество параметров разных типов в зависимости от строки формата, но с другой стороны это довольно удобно для экспериментов с этой возможностью):312313```python314>>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]315>>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)316String 'Hi', Int 10, Double 2.20000031737318>>>319```320321Указание формата защищает от несовместимых типов аргументов (как прототип для функции C) и пытается преобразовать аргументы в допустимые типы:322323```python324>>> printf(b"%d %d %d", 1, 2, 3)325Traceback (most recent call last):326 File "<stdin>", line 1, in ?327ArgumentError: argument 2: exceptions.TypeError: wrong type328>>> printf(b"%s %d %f\n", b"X", 2, 3)329X 2 3.00000033013331>>>332```333334Если вы определили собственные классы, которые передаёте в вызовы функций, вам нужно реализовать метод класса `from_param()`, чтобы можно было использовать их в последовательности `argtypes`. Метод класса `from_param()` получает объект Python, переданный в вызов функции; он должен выполнить проверку типа или всё необходимое, чтобы убедиться, что этот объект приемлем, а затем вернуть сам объект, его атрибут `_as_parameter_` или то, что вы хотите передать в качестве аргумента функции C в данном случае. Опять же, результатом должно быть целое число, строка, bytes, экземпляр [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) или объект с атрибутом `_as_parameter_`.335336### 16.16.1.8. Типы возвращаемых значений337338По умолчанию считается, что функции возвращают тип C `int`. Другие типы возвращаемых значений можно указать, задав атрибут `restype` объекта функции.339340Вот более сложный пример: в нём используется функция `strchr`, которая ожидает указатель на строку и символ (char) и возвращает указатель на строку:341342```python343>>> strchr = libc.strchr344>>> strchr(b"abcdef", ord("d")) 3458059983346>>> strchr.restype = c_char_p # c_char_p – указатель на строку347>>> strchr(b"abcdef", ord("d"))348b'def'349>>> print(strchr(b"abcdef", ord("x")))350None351>>>352```353354Если вы хотите избежать вызовов `ord("x")` выше, можно установить атрибут `argtypes`, и второй аргумент будет преобразован из объекта Python bytes, содержащего один символ, в C char:355356```python357>>> strchr.restype = c_char_p358>>> strchr.argtypes = [c_char_p, c_char]359>>> strchr(b"abcdef", b"d")360'def'361>>> strchr(b"abcdef", b"def")362Traceback (most recent call last):363 File "<stdin>", line 1, in ?364ArgumentError: argument 2: exceptions.TypeError: one character string expected365>>> print(strchr(b"abcdef", b"x"))366None367>>> strchr(b"abcdef", b"d")368'def'369>>>370```371372Также можно использовать вызываемый объект Python (например, функцию или класс) в качестве атрибута `restype`, если внешняя функция возвращает целое число. Вызываемый объект будет вызван с *целым числом*, которое возвращает C-функция, и результат этого вызова будет использоваться как результат вызова вашей функции. Это полезно для проверки возвращаемых значений ошибок и автоматического возбуждения исключения:373374```python375>>> GetModuleHandle = windll.kernel32.GetModuleHandleA 376>>> def ValidHandle(value):377... if value == 0:378... raise WinError()379... return value380...381>>>382>>> GetModuleHandle.restype = ValidHandle 383>>> GetModuleHandle(None) 384486539264385>>> GetModuleHandle("something silly") 386Traceback (most recent call last):387 File "<stdin>", line 1, in ?388 File "<stdin>", line 3, in ValidHandle389OSError: [Errno 126] The specified module could not be found.390>>>391```392393`WinError` – это функция, которая вызывает Windows API `FormatMessage()` для получения строкового представления кода ошибки и *возвращает* исключение. `WinError` принимает необязательный параметр – код ошибки; если он не передан, функция вызывает [`GetLastError()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.GetLastError) для его получения.394395Обратите внимание, что гораздо более мощный механизм проверки ошибок доступен через атрибут `errcheck`; подробности см. в справочном руководстве.396397### 16.16.1.9. Передача указателей (или передача параметров по ссылке)398399Иногда функция C API ожидает в качестве параметра *указатель* на тип данных, обычно для записи в соответствующее место или если данные слишком велики для передачи по значению. Это также называется *передачей параметров по ссылке*.400401[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) предоставляет функцию [`byref()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.byref), которая используется для передачи параметров по ссылке. Того же эффекта можно достичь с помощью функции [`pointer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.pointer), хотя [`pointer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.pointer) выполняет гораздо больше работы, так как конструирует реальный объект-указатель, поэтому быстрее использовать [`byref()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.byref), если вам не нужен объект-указатель в самом Python:402403```python404>>> i = c_int()405>>> f = c_float()406>>> s = create_string_buffer(b'\000' * 32)407>>> print(i.value, f.value, repr(s.value))4080 0.0 b''409>>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",410... byref(i), byref(f), s)4113412>>> print(i.value, f.value, repr(s.value))4131 3.1400001049 b'Hello'414>>>415```416417### 16.16.1.10. Структуры и объединения418419Структуры и объединения должны наследоваться от базовых классов [`Structure`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure) и [`Union`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Union), которые определены в модуле [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes). Каждый подкласс должен определять атрибут `_fields_`. `_fields_` должен быть списком *2-кортежей*, содержащих *имя поля* и *тип поля*.420421Тип поля должен быть типом [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes), таким как [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int), или любым другим производным типом [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes): структура, объединение, массив, указатель.422423Вот простой пример структуры POINT, которая содержит два целых числа с именами *x* и *y*, а также показывает, как инициализировать структуру в конструкторе:424425```python426>>> from ctypes import *427>>> class POINT(Structure):428... _fields_ = [("x", c_int),429... ("y", c_int)]430...431>>> point = POINT(10, 20)432>>> print(point.x, point.y)43310 20434>>> point = POINT(y=5)435>>> print(point.x, point.y)4360 5437>>> POINT(1, 2, 3)438Traceback (most recent call last):439 File "<stdin>", line 1, in ?440ValueError: too many initializers441>>>442```443444Однако можно создавать гораздо более сложные структуры. Структура может сама содержать другие структуры, используя структуру в качестве типа поля.445446Вот структура RECT, которая содержит две точки с именами *upperleft* и *lowerright*:447448```python449>>> class RECT(Structure):450... _fields_ = [("upperleft", POINT),451... ("lowerright", POINT)]452...453>>> rc = RECT(point)454>>> print(rc.upperleft.x, rc.upperleft.y)4550 5456>>> print(rc.lowerright.x, rc.lowerright.y)4570 0458>>>459```460461Вложенные структуры также можно инициализировать в конструкторе несколькими способами:462463```python464>>> r = RECT(POINT(1, 2), POINT(3, 4))465>>> r = RECT((1, 2), (3, 4))466```467468полей [*descriptor*](https://python-all.ru/3.4/glossary.html#term-descriptor) можно получить из *класса*; они полезны для отладки, так как предоставляют полезную информацию:469470```python471>>> print(POINT.x)472<Field type=c_long, ofs=0, size=4>473>>> print(POINT.y)474<Field type=c_long, ofs=4, size=4>475>>>476```477478> **Предупреждение**479>480> [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) не поддерживает передачу объединений или структур с битовыми полями в функции по значению. Хотя на 32-битной x86 это может работать, библиотека не гарантирует работу в общем случае. Объединения и структуры с битовыми полями всегда следует передавать в функции по указателю.481482### 16.16.1.11. Выравнивание структур и объединений, порядок байтов483484По умолчанию поля Structure и Union выравниваются так же, как это делает компилятор C. Можно переопределить это поведение, указав атрибут класса `_pack_` в определении подкласса. Он должен быть установлен в положительное целое число и задает максимальное выравнивание для полей. Это то же самое, что делает `#pragma pack(n)` в MSVC.485486[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) использует собственный порядок байтов для структур и объединений. Для создания структур с нестандартным порядком байтов можно использовать один из базовых классов: [`BigEndianStructure`](https://python-all.ru/3.4/library/ctypes.html#ctypes.BigEndianStructure), [`LittleEndianStructure`](https://python-all.ru/3.4/library/ctypes.html#ctypes.LittleEndianStructure), `BigEndianUnion` и `LittleEndianUnion`. Эти классы не могут содержать поля-указатели.487488### 16.16.1.12. Битовые поля в структурах и объединениях489490Можно создавать структуры и объединения, содержащие битовые поля. Битовые поля возможны только для целочисленных полей; ширина битового поля задается третьим элементом в кортежах `_fields_`:491492```python493>>> class Int(Structure):494... _fields_ = [("first_16", c_int, 16),495... ("second_16", c_int, 16)]496...497>>> print(Int.first_16)498<Field type=c_long, ofs=0:0, bits=16>499>>> print(Int.second_16)500<Field type=c_long, ofs=0:16, bits=16>501>>>502```503504### 16.16.1.13. Массивы505506Массивы – это последовательности, содержащие фиксированное количество экземпляров одного типа.507508Рекомендуемый способ создания типов массивов – умножение типа данных на положительное целое число:509510```python511TenPointsArrayType = POINT * 10512```513514Вот пример несколько искусственного типа данных – структуры, содержащей 4 точки POINT среди прочего:515516```python517>>> from ctypes import *518>>> class POINT(Structure):519... _fields_ = ("x", c_int), ("y", c_int)520...521>>> class MyStruct(Structure):522... _fields_ = [("a", c_int),523... ("b", c_float),524... ("point_array", POINT * 4)]525>>>526>>> print(len(MyStruct().point_array))5274528>>>529```530531Экземпляры создаются обычным способом – вызовом класса:532533```python534arr = TenPointsArrayType()535for pt in arr:536 print(pt.x, pt.y)537```538539Приведенный выше код выводит серию строк `0 0`, потому что содержимое массива инициализируется нулями.540541Можно также указать инициализаторы правильного типа:542543```python544>>> from ctypes import *545>>> TenIntegers = c_int * 10546>>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)547>>> print(ii)548<c_long_Array_10 object at 0x...>549>>> for i in ii: print(i, end=" ")550...5511 2 3 4 5 6 7 8 9 10552>>>553```554555### 16.16.1.14. Указатели556557Экземпляры указателей создаются вызовом функции [`pointer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.pointer) для типа [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes):558559```python560>>> from ctypes import *561>>> i = c_int(42)562>>> pi = pointer(i)563>>>564```565566Экземпляры указателей имеют атрибут `contents`, который возвращает объект, на который указывает указатель – объект `i` из примера выше:567568```python569>>> pi.contents570c_long(42)571>>>572```573574Обратите внимание, что [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) не имеет OOR (original object return); каждый раз при получении атрибута создается новый эквивалентный объект:575576```python577>>> pi.contents is i578False579>>> pi.contents is pi.contents580False581>>>582```583584Присвоение другого экземпляра [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int) атрибуту contents указателя приведет к тому, что указатель будет указывать на область памяти, где этот экземпляр хранится:585586```python587>>> i = c_int(99)588>>> pi.contents = i589>>> pi.contents590c_long(99)591>>>592```593594Экземпляры указателей также можно индексировать целыми числами:595596```python597>>> pi[0]59899599>>>600```601602Присваивание целочисленному индексу изменяет значение, на которое указывает указатель:603604```python605>>> print(i)606c_long(99)607>>> pi[0] = 22608>>> print(i)609c_long(22)610>>>611```612613It is also possible to use indexes different from 0, but you must know what you’re doing, just as in C: You can access or change arbitrary memory locations. Generally you only use this feature if you receive a pointer from a C function, and you *know* that the pointer actually points to an array instead of a single item.614615За кулисами функция [`pointer()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.pointer) делает больше, чем просто создание экземпляров указателей; сначала она должна создать *типы* указателей. Это делается с помощью функции [`POINTER()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.POINTER), которая принимает любой тип [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) и возвращает новый тип:616617```python618>>> PI = POINTER(c_int)619>>> PI620<class 'ctypes.LP_c_long'>621>>> PI(42)622Traceback (most recent call last):623 File "<stdin>", line 1, in ?624TypeError: expected c_long instead of int625>>> PI(c_int(42))626<ctypes.LP_c_long object at 0x...>627>>>628```629630Вызов типа указателя без аргумента создает нулевой указатель `NULL`. Нулевые указатели `NULL` имеют булево значение `False`:631632```python633>>> null_ptr = POINTER(c_int)()634>>> print(bool(null_ptr))635False636>>>637```638639[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) проверяет на `NULL` при разыменовании указателей (но разыменование недопустимых ненулевых указателей `NULL` приведет к аварийному завершению Python):640641```python642>>> null_ptr[0]643Traceback (most recent call last):644 ....645ValueError: NULL pointer access646>>>647648>>> null_ptr[0] = 1234649Traceback (most recent call last):650 ....651ValueError: NULL pointer access652>>>653```654655### 16.16.1.15. Преобразования типов656657Обычно ctypes выполняет строгую проверку типов. Это означает, что если у вас есть `POINTER(c_int)` в списке `argtypes` функции или в качестве типа поля-члена в определении структуры, принимаются только экземпляры точно того же типа. Из этого правила есть некоторые исключения, когда ctypes принимает другие объекты. Например, можно передавать совместимые экземпляры массивов вместо типов указателей. Так, для `POINTER(c_int)` ctypes принимает массив c\_int:658659```python660>>> class Bar(Structure):661... _fields_ = [("count", c_int), ("values", POINTER(c_int))]662...663>>> bar = Bar()664>>> bar.values = (c_int * 3)(1, 2, 3)665>>> bar.count = 3666>>> for i in range(bar.count):667... print(bar.values[i])668...669167026713672>>>673```674675Кроме того, если аргумент функции явно объявлен как тип указателя (например, `POINTER(c_int)`) в `argtypes`, в функцию можно передать объект указываемого типа (в данном случае `c_int`). В этом случае ctypes автоматически применит необходимое преобразование [`byref()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.byref).676677Чтобы установить поле типа POINTER в `NULL`, можно присвоить `None`:678679```python680>>> bar.values = None681>>>682```683684Иногда встречаются экземпляры несовместимых типов. В C можно привести один тип к другому. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) предоставляет функцию [`cast()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.cast), которую можно использовать аналогично. Структура `Bar`, определенная выше, принимает указатели `POINTER(c_int)` или массивы [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int) для своего поля `values`, но не экземпляры других типов:685686```python687>>> bar.values = (c_byte * 4)()688Traceback (most recent call last):689 File "<stdin>", line 1, in ?690TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance691>>>692```693694Для таких случаев полезна функция [`cast()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.cast).695696Функцию [`cast()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.cast) можно использовать для приведения экземпляра ctypes к указателю на другой тип данных ctypes. [`cast()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.cast) принимает два параметра: объект ctypes, который является или может быть преобразован в указатель некоторого вида, и тип указателя ctypes. Она возвращает экземпляр второго аргумента, который ссылается на тот же блок памяти, что и первый аргумент:697698```python699>>> a = (c_byte * 4)()700>>> cast(a, POINTER(c_int))701<ctypes.LP_c_long object at ...>702>>>703```704705Таким образом, [`cast()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.cast) можно использовать для присвоения полю `values` структуры `Bar`:706707```python708>>> bar = Bar()709>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))710>>> print(bar.values[0])7110712>>>713```714715### 16.16.1.16. Неполные типы716717*Неполные типы* – это структуры, объединения или массивы, члены которых ещё не определены. В C они задаются опережающими объявлениями, которые определяются позже:718719```python720struct cell; /* forward declaration */721722struct cell {723 char *name;724 struct cell *next;725};726```727728Прямой перевод в код ctypes выглядел бы так, но это не работает:729730```python731>>> class cell(Structure):732... _fields_ = [("name", c_char_p),733... ("next", POINTER(cell))]734...735Traceback (most recent call last):736 File "<stdin>", line 1, in ?737 File "<stdin>", line 2, in cell738NameError: name 'cell' is not defined739>>>740```741742потому что новый класс `class cell` недоступен в самом определении класса. В [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) мы можем определить класс `cell` и установить атрибут `_fields_` позже, после определения класса:743744```python745>>> from ctypes import *746>>> class cell(Structure):747... pass748...749>>> cell._fields_ = [("name", c_char_p),750... ("next", POINTER(cell))]751>>>752```753754Попробуем. Создадим два экземпляра `cell`, заставим их указывать друг на друга и, наконец, пройдем по цепочке указателей несколько раз:755756```python757>>> c1 = cell()758>>> c1.name = "foo"759>>> c2 = cell()760>>> c2.name = "bar"761>>> c1.next = pointer(c2)762>>> c2.next = pointer(c1)763>>> p = c1764>>> for i in range(8):765... print(p.name, end=" ")766... p = p.next[0]767...768foo bar foo bar foo bar foo bar769>>>770```771772### 16.16.1.17. Функции обратного вызова773774[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) позволяет создавать указатели на функции, вызываемые из C, на основе вызываемых объектов Python. Иногда их называют *функциями обратного вызова*.775776Сначала нужно создать класс для функции обратного вызова. Этот класс знает соглашение о вызове, тип возвращаемого значения, а также количество и типы аргументов, которые будет получать эта функция.777778Функция-фабрика [`CFUNCTYPE()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CFUNCTYPE) создает типы для функций обратного вызова, используя соглашение о вызове `cdecl`. В Windows функция-фабрика [`WINFUNCTYPE()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.WINFUNCTYPE) создает типы для функций обратного вызова, используя соглашение о вызове `stdcall`.779780Обе эти фабричные функции вызываются с типом результата в качестве первого аргумента, а ожидаемые типы аргументов функции обратного вызова передаются как остальные аргументы.781782Я приведу пример, в котором используется функция `qsort()` из стандартной библиотеки C, применяемая для сортировки элементов с помощью функции обратного вызова. `qsort()` будет использована для сортировки массива целых чисел:783784```python785>>> IntArray5 = c_int * 5786>>> ia = IntArray5(5, 1, 7, 33, 99)787>>> qsort = libc.qsort788>>> qsort.restype = None789>>>790```791792`qsort()` должна вызываться с указателем на сортируемые данные, количеством элементов в массиве данных, размером одного элемента и указателем на функцию сравнения – обратный вызов. Затем обратный вызов будет вызван с двумя указателями на элементы и должен вернуть отрицательное целое число, если первый элемент меньше второго, ноль, если они равны, и положительное целое число в противном случае.793794Итак, наша функция обратного вызова получает указатели на целые числа и должна возвращать целое число. Сначала создадим `тип` для функции обратного вызова:795796```python797>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))798>>>799```800801Для начала приведём простую функцию обратного вызова, которая выводит передаваемые ей значения:802803```python804>>> def py_cmp_func(a, b):805... print("py_cmp_func", a[0], b[0])806... return 0807...808>>> cmp_func = CMPFUNC(py_cmp_func)809>>>810```811812```python813>>> qsort(ia, len(ia), sizeof(c_int), cmp_func) 814py_cmp_func 5 1815py_cmp_func 33 99816py_cmp_func 7 33817py_cmp_func 5 7818py_cmp_func 1 7819>>>820```821822Теперь можно по-настоящему сравнить два элемента и вернуть полезный результат:823824```python825>>> def py_cmp_func(a, b):826... print("py_cmp_func", a[0], b[0])827... return a[0] - b[0]828...829>>>830>>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func)) 831py_cmp_func 5 1832py_cmp_func 33 99833py_cmp_func 7 33834py_cmp_func 1 7835py_cmp_func 5 7836>>>837```838839Как легко проверить, наш массив теперь отсортирован:840841```python842>>> for i in ia: print(i, end=" ")843...8441 5 7 33 99845>>>846```847848> **Примечание**849>850> Следите за тем, чтобы ссылки на объекты [`CFUNCTYPE()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CFUNCTYPE) сохранялись до тех пор, пока они используются из кода на C. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) этого не делает, и если не сохранять, они могут быть удалены сборщиком мусора, что приведёт к аварийному завершению программы при вызове обратного вызова.851>852> Также обратите внимание, что если функция обратного вызова вызывается в потоке, созданном вне контроля Python (например, во внешнем коде, который вызывает обратный вызов), ctypes создаёт новый фиктивный поток Python при каждом таком вызове. Такое поведение корректно для большинства случаев, но означает, что значения, сохранённые с помощью [`threading.local`](https://python-all.ru/3.4/library/threading.html#threading.local), *не* сохранятся между разными обратными вызовами, даже если эти вызовы происходят из одного и того же потока C.853854### 16.16.1.18. Доступ к значениям, экспортируемым из DLL855856Некоторые разделяемые библиотеки не только экспортируют функции, но и экспортируют переменные. Примером в самой библиотеке Python является `Py_OptimizeFlag` – целое число, принимающее значения 0, 1 или 2 в зависимости от флага [*-O*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-O) или [*-OO*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-OO), заданного при запуске.857858[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) может получать доступ к таким значениям с помощью методов класса `in_dll()` соответствующего типа. *pythonapi* – это предопределённый символ, предоставляющий доступ к C API Python:859860```python861>>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag")862>>> print(opt_flag)863c_long(0)864>>>865```866867Если бы интерпретатор был запущен с флагом [*-O*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-O), пример вывел бы `c_long(1)`, или `c_long(2)`, если бы был указан [*-OO*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-OO).868869Расширенный пример, который также демонстрирует использование указателей, обращается к указателю [`PyImport_FrozenModules`](https://python-all.ru/3.4/c-api/import.html#c.PyImport_FrozenModules), экспортируемому Python.870871Цитируя документацию для этого значения:872873> Этот указатель инициализируется так, чтобы указывать на массив записей874>875> `struct _frozen`876>877> , заканчивающийся записью, все члены которой равны878>879> *NULL*880>881> или нулю. Когда замороженный модуль импортируется, он ищется в этой таблице. Сторонний код может использовать это для предоставления динамически созданной коллекции замороженных модулей.882883Таким образом, манипуляции с этим указателем могут оказаться полезными. Чтобы не увеличивать размер примера, мы покажем только, как эту таблицу можно прочитать с помощью [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes):884885```python886>>> from ctypes import *887>>>888>>> class struct_frozen(Structure):889... _fields_ = [("name", c_char_p),890... ("code", POINTER(c_ubyte)),891... ("size", c_int)]892...893>>>894```895896Мы определили тип данных `struct _frozen`, поэтому можем получить указатель на таблицу:897898```python899>>> FrozenTable = POINTER(struct_frozen)900>>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules")901>>>902```903904Поскольку `table` – это `указатель` на массив записей `struct_frozen`, мы можем выполнять итерацию по нему, но нужно убедиться, что цикл завершится, ведь у указателей нет размера. Рано или поздно это, вероятно, приведёт к ошибке доступа или чему-то подобному, так что лучше выйти из цикла, когда мы достигнем NULL-записи:905906```python907>>> for item in table:908... print(item.name, item.size)909... if item.name is None:910... break911...912__hello__ 104913__phello__ -104914__phello__.spam 104915None 0916>>>917```918919То, что в стандартном Python есть frozen-модуль и frozen-пакет (обозначаемый отрицательным значением поля size), малоизвестно; это используется только для тестирования. Попробуйте, например, `import __hello__`.920921### 16.16.1.19. Неожиданности922923В [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) есть несколько граничных случаев, где ожидаемое поведение может отличаться от фактического.924925Рассмотрим следующий пример:926927```python928>>> from ctypes import *929>>> class POINT(Structure):930... _fields_ = ("x", c_int), ("y", c_int)931...932>>> class RECT(Structure):933... _fields_ = ("a", POINT), ("b", POINT)934...935>>> p1 = POINT(1, 2)936>>> p2 = POINT(3, 4)937>>> rc = RECT(p1, p2)938>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)9391 2 3 4940>>> # теперь поменять точки местами941>>> rc.a, rc.b = rc.b, rc.a942>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)9433 4 3 4944>>>945```946947Хм. Мы, конечно, ожидали, что последний оператор выведет `3 4 1 2`. Что произошло? Вот шаги строки `rc.a, rc.b = rc.b, rc.a` выше:948949```python950>>> temp0, temp1 = rc.b, rc.a951>>> rc.a = temp0952>>> rc.b = temp1953>>>954```955956Обратите внимание, что `temp0` и `temp1` – это объекты, всё ещё использующие внутренний буфер объекта `rc` выше. Таким образом, выполнение `rc.a = temp0` копирует содержимое буфера `temp0` в буфер `rc`. Это, в свою очередь, изменяет содержимое `temp1`. Поэтому последнее присваивание `rc.b = temp1` не даёт ожидаемого эффекта.957958Имейте в виду, что получение подобъектов из Structure, Unions и Arrays не *копирует* подобъект, а возвращает объект-обертку, обращающийся к базовому буферу корневого объекта.959960Еще один пример, который может вести себя не так, как ожидается:961962```python963>>> s = c_char_p()964>>> s.value = "abc def ghi"965>>> s.value966'abc def ghi'967>>> s.value is s.value968False969>>>970```971972Почему выводится `False`? Экземпляры ctypes – это объекты, содержащие блок памяти и несколько [*дескрипторов*](https://python-all.ru/3.4/glossary.html#term-descriptor) для доступа к содержимому памяти. При сохранении объекта Python в блоке памяти сохраняется не сам объект, а его `содержимое`. При каждом обращении к содержимому создаётся новый объект Python!973974### 16.16.1.20. Типы данных переменного размера975976[`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) предоставляет некоторую поддержку массивов и структур переменного размера.977978Функция [`resize()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.resize) может использоваться для изменения размера буфера памяти существующего объекта ctypes. Функция принимает объект в качестве первого аргумента и запрошенный размер в байтах в качестве второго. Блок памяти нельзя сделать меньше, чем естественный блок памяти, заданный типом объекта; при попытке такого изменения возникает исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError):979980```python981>>> short_array = (c_short * 4)()982>>> print(sizeof(short_array))9838984>>> resize(short_array, 4)985Traceback (most recent call last):986 ...987ValueError: minimum size is 8988>>> resize(short_array, 32)989>>> sizeof(short_array)99032991>>> sizeof(type(short_array))9928993>>>994```995996Это хорошо и замечательно, но как получить доступ к дополнительным элементам, содержащимся в этом массиве? Поскольку тип по-прежнему знает только о 4 элементах, при попытке доступа к другим элементам возникают ошибки:997998```python999>>> short_array[:]1000[0, 0, 0, 0]1001>>> short_array[7]1002Traceback (most recent call last):1003 ...1004IndexError: invalid index1005>>>1006```10071008Другой способ использования типов данных переменного размера с [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) – воспользоваться динамической природой Python и (пере)определять тип данных после того, как требуемый размер уже известен, для каждого конкретного случая.10091010## 16.16.2. Справочник по ctypes10111012### 16.16.2.1. Поиск разделяемых библиотек10131014При программировании на компилируемом языке к разделяемым библиотекам обращаются при компиляции/компоновке программы и при ее запуске.10151016Назначение функции `find_library()` – найти библиотеку способом, аналогичным тому, как это делает компилятор (на платформах с несколькими версиями разделяемой библиотеки должна загружаться самая новая), в то время как загрузчики библиотек ctypes действуют как при запуске программы и вызывают загрузчик времени выполнения напрямую.10171018Модуль `ctypes.util` предоставляет функцию, которая может помочь определить, какую библиотеку загрузить.10191020#### `ctypes.util.find_library(name)`10211022Пытается найти библиотеку и возвращает путь к ней. *name* – это имя библиотеки без префикса вроде *lib*, суффикса вроде `.so`, `.dylib` или номера версии (это форма, используемая для опции компоновщика posix [*-l*](https://python-all.ru/3.4/library/tarfile.html#cmdoption-l)). Если библиотека не найдена, возвращается `None`.10231024Точное поведение зависит от системы.10251026В Linux `find_library()` пытается запустить внешние программы (`/sbin/ldconfig`, `gcc` и `objdump`), чтобы найти файл библиотеки. Возвращается имя файла библиотеки. Вот несколько примеров:10271028```python1029>>> from ctypes.util import find_library1030>>> find_library("m")1031'libm.so.6'1032>>> find_library("c")1033'libc.so.6'1034>>> find_library("bz2")1035'libbz2.so.1.0'1036>>>1037```10381039В OS X `find_library()` пробует несколько предопределённых схем именования и путей для поиска библиотеки и возвращает полный путь в случае успеха:10401041```python1042>>> from ctypes.util import find_library1043>>> find_library("c")1044'/usr/lib/libc.dylib'1045>>> find_library("m")1046'/usr/lib/libm.dylib'1047>>> find_library("bz2")1048'/usr/lib/libbz2.dylib'1049>>> find_library("AGL")1050'/System/Library/Frameworks/AGL.framework/AGL'1051>>>1052```10531054В Windows `find_library()` выполняет поиск по системному пути поиска и возвращает полный путь, но поскольку нет предопределённой схемы именования, вызов вроде `find_library("c")` завершится ошибкой и вернёт `None`.10551056Если вы оборачиваете разделяемую библиотеку с помощью [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes), возможно, *лучше* определить имя разделяемой библиотеки на этапе разработки и жёстко прописать его в модуле-обёртке, вместо использования `find_library()` для поиска библиотеки во время выполнения.10571058### 16.16.2.2. Загрузка разделяемых библиотек10591060Существует несколько способов загрузить разделяемые библиотеки в процесс Python. Один из способов – создать экземпляр одного из следующих классов:10611062#### `class ctypes.CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)`10631064Экземпляры этого класса представляют загруженные разделяемые библиотеки. Функции в этих библиотеках используют стандартное соглашение о вызове C и считаются возвращающими `int`.10651066#### `class ctypes.OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)`10671068Только для Windows: экземпляры этого класса представляют загруженные разделяемые библиотеки, функции в этих библиотеках используют соглашение о вызовах `stdcall` и, как предполагается, возвращают код [`HRESULT`](https://python-all.ru/3.4/library/ctypes.html#ctypes.HRESULT), специфичный для Windows. Значения [`HRESULT`](https://python-all.ru/3.4/library/ctypes.html#ctypes.HRESULT) содержат информацию, указывающую, был ли вызов функции успешным или неудачным, вместе с дополнительным кодом ошибки. Если возвращаемое значение сигнализирует об ошибке, автоматически возбуждается исключение [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError).10691070Изменено в версии 3.3: [`WindowsError`](https://python-all.ru/3.4/library/exceptions.html#WindowsError) ранее возбуждалось.10711072#### `class ctypes.WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False)`10731074Только для Windows: экземпляры этого класса представляют загруженные разделяемые библиотеки, функции в этих библиотеках используют соглашение о вызове `stdcall` и по умолчанию предполагается, что они возвращают `int`.10751076На Windows CE используется только стандартное соглашение о вызове; для удобства [`WinDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.WinDLL) и [`OleDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.OleDLL) на этой платформе используют стандартное соглашение о вызове.10771078Глобальная блокировка интерпретатора Python [*global interpreter lock*](https://python-all.ru/3.4/glossary.html#term-global-interpreter-lock) освобождается перед вызовом любой функции, экспортируемой этими библиотеками, и снова захватывается после вызова.10791080#### `class ctypes.PyDLL(name, mode=DEFAULT_MODE, handle=None)`10811082Экземпляры этого класса ведут себя как экземпляры [`CDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CDLL), за исключением того, что GIL Python *не* освобождается при вызове функции, а после выполнения функции проверяется флаг ошибок Python. Если флаг ошибок установлен, возбуждается исключение Python.10831084Таким образом, это полезно только для прямого вызова функций Python C API.10851086Все эти классы можно создать, вызвав их с хотя бы одним аргументом – именем пути разделяемой библиотеки. Если у вас уже есть дескриптор загруженной разделяемой библиотеки, его можно передать в качестве именованного параметра `handle`; в противном случае для загрузки библиотеки в процесс и получения её дескриптора используются функции базовой платформы `dlopen` или `LoadLibrary`.10871088Параметр *mode* можно использовать для указания способа загрузки библиотеки. Подробнее см. страницу руководства *dlopen(3)*; в Windows параметр *mode* игнорируется.10891090Параметр *use\_errno*, если установлен в True, включает механизм ctypes, позволяющий безопасно обращаться к системному номеру ошибки [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno). [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) хранит локальную для потока копию системной переменной [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno); если вызвать внешнюю функцию, созданную с `use_errno=True`, то значение [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno) перед вызовом функции заменяется на частную копию ctypes; то же происходит сразу после вызова функции.10911092Функция [`ctypes.get_errno()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.get_errno) возвращает значение частной копии ctypes, а функция [`ctypes.set_errno()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.set_errno) изменяет частную копию ctypes на новое значение и возвращает предыдущее значение.10931094Параметр *use\_last\_error*, если установлен в True, включает тот же механизм для кода ошибки Windows, который управляется функциями Windows API [`GetLastError()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.GetLastError) и `SetLastError()`; функции [`ctypes.get_last_error()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.get_last_error) и [`ctypes.set_last_error()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.set_last_error) используются для получения и изменения частной копии кода ошибки Windows в ctypes.10951096#### `ctypes.RTLD_GLOBAL`10971098Флаг, используемый в качестве параметра *mode*. На платформах, где этот флаг недоступен, он определён как целочисленный ноль.10991100#### `ctypes.RTLD_LOCAL`11011102Флаг, используемый в качестве параметра *mode*. На платформах, где он недоступен, он совпадает с *RTLD\_GLOBAL*.11031104#### `ctypes.DEFAULT_MODE`11051106Режим по умолчанию, используемый для загрузки разделяемых библиотек. На OSX 10.3 это *RTLD\_GLOBAL*, в противном случае он совпадает с *RTLD\_LOCAL*.11071108Экземпляры этих классов не имеют открытых методов. Функции, экспортируемые общей библиотекой, можно получить как атрибуты или по индексу. Обратите внимание: доступ к функции через атрибут кэширует результат, поэтому при повторном обращении возвращается тот же самый объект каждый раз. С другой стороны, доступ по индексу каждый раз возвращает новый объект:11091110```python1111>>> libc.time == libc.time1112True1113>>> libc['time'] == libc['time']1114False1115```11161117Доступны следующие открытые атрибуты, их имена начинаются с подчёркивания, чтобы не конфликтовать с именами экспортируемых функций:11181119#### `PyDLL._handle`11201121Системный дескриптор, используемый для доступа к библиотеке.11221123#### `PyDLL._name`11241125Имя библиотеки, переданное в конструктор.11261127Разделяемые библиотеки также можно загружать с помощью одного из предварительно созданных объектов, которые являются экземплярами класса [`LibraryLoader`](https://python-all.ru/3.4/library/ctypes.html#ctypes.LibraryLoader), либо вызывая метод `LoadLibrary()`, либо получая библиотеку как атрибут экземпляра загрузчика.11281129#### `class ctypes.LibraryLoader(dlltype)`11301131Класс, который загружает разделяемые библиотеки. *dlltype* должен быть одним из типов [`CDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CDLL), [`PyDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.PyDLL), [`WinDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.WinDLL) или [`OleDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.OleDLL).11321133[`__getattr__()`](https://python-all.ru/3.4/reference/datamodel.html#object.__getattr__) обладает особым поведением: позволяет загрузить разделяемую библиотеку, обращаясь к ней как к атрибуту экземпляра загрузчика библиотек. Результат кэшируется, поэтому повторные обращения к атрибуту каждый раз возвращают ту же библиотеку.11341135#### `LoadLibrary(name)`11361137Загружает разделяемую библиотеку в процесс и возвращает её. Этот метод всегда возвращает новый экземпляр библиотеки.11381139Доступны следующие готовые загрузчики библиотек:11401141#### `ctypes.cdll`11421143Создаёт экземпляры [`CDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CDLL).11441145#### `ctypes.windll`11461147Только для Windows: создаёт экземпляры [`WinDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.WinDLL).11481149#### `ctypes.oledll`11501151Только для Windows: создаёт экземпляры [`OleDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.OleDLL).11521153#### `ctypes.pydll`11541155Создаёт экземпляры [`PyDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.PyDLL).11561157Для прямого доступа к C Python API доступен готовый к использованию объект общей библиотеки Python:11581159#### `ctypes.pythonapi`11601161Экземпляр [`PyDLL`](https://python-all.ru/3.4/library/ctypes.html#ctypes.PyDLL), который предоставляет функции C API Python в качестве атрибутов. Обратите внимание, что все эти функции предполагаются возвращающими `int` (C int), что, конечно, не всегда верно, поэтому для их использования необходимо задать правильный атрибут `restype`.11621163### 16.16.2.3. Внешние функции11641165Как объяснялось в предыдущем разделе, внешние функции можно получить как атрибуты загруженных разделяемых библиотек. Созданные таким образом объекты функций по умолчанию принимают любое количество аргументов, принимают любые экземпляры данных ctypes в качестве аргументов и возвращают тип результата по умолчанию, указанный загрузчиком библиотеки. Они являются экземплярами закрытого класса:11661167#### `class ctypes._FuncPtr`11681169Базовый класс для внешних функций, вызываемых из C.11701171Экземпляры внешних функций также являются C-совместимыми типами данных; они представляют указатели на функции C.11721173Это поведение можно настроить, присвоив значения специальным атрибутам объекта внешней функции.11741175#### `restype`11761177Присваивает тип ctypes для указания типа результата внешней функции. Используйте `None` для `void` – функции, ничего не возвращающей.11781179Можно назначить вызываемый объект Python, который не является типом ctypes; в этом случае предполагается, что функция возвращает C `int`, и вызываемый объект будет вызван с этим целым числом, что позволяет выполнить дальнейшую обработку или проверку ошибок. Использование этого устарело; для более гибкой постобработки или проверки ошибок используйте тип данных ctypes как [`restype`](https://python-all.ru/3.4/library/ctypes.html#ctypes._FuncPtr.restype) и назначьте вызываемый объект атрибуту [`errcheck`](https://python-all.ru/3.4/library/ctypes.html#ctypes._FuncPtr.errcheck).11801181#### `argtypes`11821183Назначьте кортеж типов ctypes, чтобы указать типы аргументов, которые принимает функция. Функции, использующие соглашение о вызове `stdcall`, могут быть вызваны только с тем же количеством аргументов, что и длина этого кортежа; функции, использующие соглашение о вызове C, также принимают дополнительные неуказанные аргументы.11841185Когда вызывается внешняя функция, каждый фактический аргумент передаётся методу класса `from_param()` элементов кортежа [`argtypes`](https://python-all.ru/3.4/library/ctypes.html#ctypes._FuncPtr.argtypes); этот метод позволяет адаптировать фактический аргумент к объекту, который принимает внешняя функция. Например, элемент [`c_char_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char_p) в кортеже [`argtypes`](https://python-all.ru/3.4/library/ctypes.html#ctypes._FuncPtr.argtypes) преобразует строку, переданную как аргумент, в объект bytes, используя правила преобразования ctypes.11861187Новое: теперь можно помещать в argtypes элементы, которые не являются типами ctypes, но каждый элемент должен иметь метод `from_param()`, возвращающий значение, пригодное для использования в качестве аргумента (целое число, строка, экземпляр ctypes). Это позволяет определять адаптеры, которые могут адаптировать пользовательские объекты как параметры функции.11881189#### `errcheck`11901191Этому атрибуту присваивается функция Python или другой вызываемый объект. Вызываемый объект будет вызван с тремя и более аргументами:11921193#### `callable(result, func, arguments)`11941195*result* – это то, что возвращает внешняя функция, как указано атрибутом [`restype`](https://python-all.ru/3.4/library/ctypes.html#ctypes._FuncPtr.restype).11961197*func* – это сам объект внешней функции; это позволяет повторно использовать один и тот же вызываемый объект для проверки или постобработки результатов нескольких функций.11981199*arguments* – это кортеж, содержащий параметры, изначально переданные при вызове функции; это позволяет специализировать поведение в зависимости от использованных аргументов.12001201Объект, возвращаемый этой функцией, будет возвращён из вызова внешней функции, но он также может проверить значение результата и возбудить исключение, если вызов внешней функции завершился неудачей.12021203#### `exception ctypes.ArgumentError`12041205Это исключение возникает, когда вызов внешней функции не может преобразовать один из переданных аргументов.12061207### 16.16.2.4. Прототипы функций12081209Внешние функции также можно создать, инстанцируя прототипы функций. Прототипы функций аналогичны прототипам функций в C; они описывают функцию (тип возвращаемого значения, типы аргументов, соглашение о вызове) без определения реализации. Фабричные функции необходимо вызывать с желаемым типом результата и типами аргументов функции.12101211#### `ctypes.CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)`12121213Возвращаемый прототип функции создаёт функции, использующие стандартное соглашение о вызове C. Функция освобождает GIL во время вызова. Если *use\_errno* установлено в True, частная копия системной переменной [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno) в ctypes обменивается с реальным значением [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno) до и после вызова; *use\_last\_error* делает то же самое для кода ошибки Windows.12141215#### `ctypes.WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)`12161217Только для Windows: возвращаемый прототип функции создаёт функции, использующие соглашение о вызове `stdcall`, за исключением Windows CE, где [`WINFUNCTYPE()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.WINFUNCTYPE) совпадает с [`CFUNCTYPE()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.CFUNCTYPE). Функция освобождает GIL во время вызова. *use\_errno* и *use\_last\_error* имеют тот же смысл, что и выше.12181219#### `ctypes.PYFUNCTYPE(restype, *argtypes)`12201221Созданный прототип функции создаёт функции, использующие соглашение о вызове Python. Функция *не* освобождает GIL во время вызова.12221223Прототипы функций, созданные этими фабричными функциями, могут быть созданы различными способами, в зависимости от типа и количества параметров в вызове:12241225> #### `prototype(address)`1226>1227> Возвращает внешнюю функцию по указанному адресу, который должен быть целым числом.1228>1229> #### `prototype(callable)`1230>1231> Создаёт вызываемую функцию C (функцию обратного вызова) из *вызываемого объекта* Python.1232>1233> #### `prototype(func_spec[, paramflags])`1234>1235> Возвращает внешнюю функцию, экспортируемую общей библиотекой. *func\_spec* должен быть кортежем из двух элементов `(name_or_ordinal, library)`. Первый элемент – это имя экспортируемой функции в виде строки или её порядковый номер (ординал) в виде небольшого целого числа. Второй элемент – это экземпляр общей библиотеки.1236>1237> #### `prototype(vtbl_index, name[, paramflags[, iid]])`1238>1239> Возвращает внешнюю функцию, которая будет вызывать метод COM. *vtbl\_index* – это индекс в таблице виртуальных функций, небольшое неотрицательное целое число. *name* – это имя метода COM. *iid* – необязательный указатель на идентификатор интерфейса, используемый в расширенном отчёте об ошибках.1240>1241> Методы COM используют специальное соглашение о вызове: они требуют указатель на интерфейс COM в качестве первого аргумента, в дополнение к тем параметрам, которые указаны в кортеже `argtypes`.1242>1243> Необязательный параметр *paramflags* создаёт обёртки внешних функций с гораздо большей функциональностью, чем описано выше.1244>1245> *paramflags* должен быть кортежем той же длины, что и `argtypes`.1246>1247> Каждый элемент этого кортежа содержит дополнительную информацию о параметре; он должен быть кортежем, содержащим один, два или три элемента.1248>1249> Первый элемент – целое число, содержащее комбинацию флагов направления для параметра:1250>1251> > **1**1252> >1253> > Задаёт входной параметр функции.1254> >1255> > **2**1256> >1257> > Выходной параметр. Внешняя функция заполняет значение.1258> >1259> > **4**1260> >1261> > Входной параметр, по умолчанию равный нулю.1262>1263> Необязательный второй элемент – имя параметра в виде строки. Если он указан, внешнюю функцию можно вызывать с именованными параметрами.1264>1265> Необязательный третий элемент – значение по умолчанию для этого параметра.12661267Этот пример демонстрирует, как обернуть функцию Windows `MessageBoxA` так, чтобы она поддерживала параметры по умолчанию и именованные аргументы. Объявление C из заголовочного файла Windows выглядит так:12681269```python1270WINUSERAPI int WINAPI1271MessageBoxA(1272 HWND hWnd,1273 LPCSTR lpText,1274 LPCSTR lpCaption,1275 UINT uType);1276```12771278Вот обёртка с помощью [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes):12791280```python1281>>> from ctypes import c_int, WINFUNCTYPE, windll1282>>> from ctypes.wintypes import HWND, LPCSTR, UINT1283>>> prototype = WINFUNCTYPE(c_int, HWND, LPCSTR, LPCSTR, UINT)1284>>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", None), (1, "flags", 0)1285>>> MessageBox = prototype(("MessageBoxA", windll.user32), paramflags)1286>>>1287```12881289Теперь внешнюю функцию MessageBox можно вызывать следующими способами:12901291```python1292>>> MessageBox()1293>>> MessageBox(text="Spam, spam, spam")1294>>> MessageBox(flags=2, text="foo bar")1295>>>1296```12971298Второй пример демонстрирует выходные параметры. Функция win32 `GetWindowRect` получает размеры указанного окна, копируя их в структуру `RECT`, которую должен предоставить вызывающий код. Вот объявление C:12991300```python1301WINUSERAPI BOOL WINAPI1302GetWindowRect(1303 HWND hWnd,1304 LPRECT lpRect);1305```13061307Вот обёртка с помощью [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes):13081309```python1310>>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError1311>>> from ctypes.wintypes import BOOL, HWND, RECT1312>>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))1313>>> paramflags = (1, "hwnd"), (2, "lprect")1314>>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)1315>>>1316```13171318Функции с выходными параметрами автоматически возвращают значение выходного параметра, если он один, или кортеж значений выходных параметров, если их несколько; таким образом, при вызове функция GetWindowRect теперь возвращает экземпляр RECT.13191320Выходные параметры можно комбинировать с протоколом `errcheck` для дальнейшей обработки вывода и проверки ошибок. Функция win32 API `GetWindowRect` возвращает `BOOL` для сигнализации об успехе или неудаче, поэтому эта функция могла бы выполнять проверку ошибок и возбуждать исключение при сбое вызова API:13211322```python1323>>> def errcheck(result, func, args):1324... if not result:1325... raise WinError()1326... return args1327...1328>>> GetWindowRect.errcheck = errcheck1329>>>1330```13311332Если функция `errcheck` возвращает полученный кортеж аргументов без изменений, [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) продолжает обычную обработку выходных параметров. Если требуется вернуть кортеж координат окна вместо экземпляра `RECT`, можно извлечь поля в функции и вернуть их вместо этого; обычная обработка выполняться не будет.13331334```python1335>>> def errcheck(result, func, args):1336... if not result:1337... raise WinError()1338... rc = args[1]1339... return rc.left, rc.top, rc.bottom, rc.right1340...1341>>> GetWindowRect.errcheck = errcheck1342>>>1343```13441345### 16.16.2.5. Утилитарные функции13461347#### `ctypes.addressof(obj)`13481349Возвращает адрес буфера памяти в виде целого числа. *obj* должен быть экземпляром типа ctypes.13501351#### `ctypes.alignment(obj_or_type)`13521353Возвращает требования к выравниванию для типа ctypes. *obj\_or\_type* должен быть типом ctypes или его экземпляром.13541355#### `ctypes.byref(obj[, offset])`13561357Возвращает легковесный указатель на *obj*, который должен быть экземпляром типа ctypes. Параметр *offset* по умолчанию равен нулю и должен быть целым числом, которое будет добавлено к внутреннему значению указателя.13581359`byref(obj, offset)` соответствует следующему коду на C:13601361```python1362(((char *)&obj) + offset)1363```13641365Возвращаемый объект можно использовать только как параметр вызова внешней функции. Он ведёт себя аналогично `pointer(obj)`, но создаётся намного быстрее.13661367#### `ctypes.cast(obj, type)`13681369Эта функция аналогична оператору приведения типов в C. Она возвращает новый экземпляр *type*, указывающий на тот же блок памяти, что и *obj*. *type* должен быть типом-указателем, а *obj* – объектом, который можно интерпретировать как указатель.13701371#### `ctypes.create_string_buffer(init_or_size, size=None)`13721373Эта функция создаёт изменяемый символьный буфер. Возвращаемый объект – это массив ctypes из [`c_char`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char).13741375*init\_or\_size* должен быть целым числом, задающим размер массива, или объектом bytes, который будет использоваться для инициализации элементов массива.13761377Если первым аргументом указан объект bytes, буфер создаётся на один элемент больше его длины, чтобы последним элементом массива был нулевой символ (NUL). Вторым аргументом можно передать целое число, которое позволяет задать размер массива, если длина bytes не должна использоваться.13781379#### `ctypes.create_unicode_buffer(init_or_size, size=None)`13801381Эта функция создаёт изменяемый буфер символов Unicode. Возвращаемый объект – это массив ctypes из [`c_wchar`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_wchar).13821383*init\_or\_size* должен быть целым числом, задающим размер массива, или строкой, которая будет использоваться для инициализации элементов массива.13841385Если первым аргументом указана строка, буфер создаётся на один элемент больше её длины, чтобы последним элементом массива был нулевой символ (NUL). Вторым аргументом можно передать целое число, которое позволяет задать размер массива, если длина строки не должна использоваться.13861387#### `ctypes.DllCanUnloadNow()`13881389Только Windows: эта функция является хуком, который позволяет реализовать внутрипроцессные COM-серверы с помощью ctypes. Она вызывается из функции DllCanUnloadNow, которую экспортирует DLL расширения \_ctypes.13901391#### `ctypes.DllGetClassObject()`13921393Только Windows: эта функция является хуком, который позволяет реализовать внутрипроцессные COM-серверы с помощью ctypes. Она вызывается из функции DllGetClassObject, которую экспортирует DLL расширения `_ctypes`.13941395#### `ctypes.util.find_library(name)`13961397Пытается найти библиотеку и возвращает путь к ней. *name* – это имя библиотеки без префикса вроде `lib`, суффикса вроде `.so`, `.dylib` или номера версии (такая форма используется для опции компоновщика POSIX [*-l*](https://python-all.ru/3.4/library/tarfile.html#cmdoption-l)). Если библиотека не найдена, возвращается `None`.13981399Точное поведение зависит от системы.14001401#### `ctypes.util.find_msvcrt()`14021403Только Windows: возвращает имя файла библиотеки времени выполнения VC, используемой Python и модулями расширения. Если имя библиотеки не удаётся определить, возвращается `None`.14041405Если необходимо освободить память, выделенную, например, модулем расширения с помощью вызова `free(void *)`, важно использовать функцию из той же библиотеки, которая выделила память.14061407#### `ctypes.FormatError([code])`14081409Только для Windows: возвращает текстовое описание кода ошибки *code*. Если код ошибки не указан, используется последний код ошибки, полученный вызовом функции Windows API GetLastError.14101411#### `ctypes.GetLastError()`14121413Только для Windows: Возвращает последний код ошибки, установленный Windows в вызывающем потоке. Эта функция вызывает непосредственно функцию Windows *GetLastError()*; она не возвращает внутреннюю для ctypes копию кода ошибки.14141415#### `ctypes.get_errno()`14161417Возвращает текущее значение переменной [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno) (приватной копии ctypes системной переменной errno) в вызывающем потоке.14181419#### `ctypes.get_last_error()`14201421Только Windows: возвращает текущее значение переменной `LastError` (приватной копии ctypes системной переменной LastError) в вызывающем потоке.14221423#### `ctypes.memmove(dst, src, count)`14241425Аналогична стандартной библиотечной функции C memmove: копирует *count* байт из *src* в *dst*. *dst* и *src* должны быть целыми числами или экземплярами ctypes, которые можно преобразовать в указатели.14261427#### `ctypes.memset(dst, c, count)`14281429Аналогична стандартной библиотечной функции C memset: заполняет блок памяти по адресу *dst* *count* байтами значения *c*. *dst* должно быть целым числом, задающим адрес, или экземпляром ctypes.14301431#### `ctypes.POINTER(type)`14321433Эта фабричная функция создаёт и возвращает новый тип указателя ctypes. Типы указателей кэшируются и повторно используются внутри, поэтому многократный вызов этой функции не требует больших затрат. *type* должен быть типом ctypes.14341435#### `ctypes.pointer(obj)`14361437Эта функция создаёт новый экземпляр указателя, указывающий на *obj*. Возвращаемый объект имеет тип `POINTER(type(obj))`.14381439Примечание: если нужно просто передать указатель на объект в вызов внешней функции, используйте `byref(obj)` – это намного быстрее.14401441#### `ctypes.resize(obj, size)`14421443Эта функция изменяет размер внутреннего буфера памяти объекта *obj*, который должен быть экземпляром типа ctypes. Невозможно сделать буфер меньше, чем собственный размер типа объекта, задаваемый выражением `sizeof(type(obj))`, но можно его увеличить.14441445#### `ctypes.set_errno(value)`14461447Устанавливает текущее значение приватной копии системной переменной [`errno`](https://python-all.ru/3.4/library/errno.html#module-errno) в вызывающем потоке в *value* и возвращает предыдущее значение.14481449#### `ctypes.set_last_error(value)`14501451Только для Windows: устанавливает текущее значение приватной копии системной переменной `LastError` в вызывающем потоке в *value* и возвращает предыдущее значение.14521453#### `ctypes.sizeof(obj_or_type)`14541455Возвращает размер в байтах буфера памяти типа ctypes или экземпляра. Делает то же самое, что и оператор `sizeof` в языке C.14561457#### `ctypes.string_at(address, size=-1)`14581459Эта функция возвращает C-строку, начинающуюся по адресу памяти *address*, в виде объекта bytes. Если указан параметр size, он используется как размер; в противном случае строка считается завершающейся нулевым символом.14601461#### `ctypes.WinError(code=None, descr=None)`14621463Только для Windows: эта функция, вероятно, имеет самое неудачное название в ctypes. Она создаёт экземпляр OSError. Если *code* не указан, вызывается `GetLastError` для определения кода ошибки. Если *descr* не указан, вызывается [`FormatError()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.FormatError) для получения текстового описания ошибки.14641465Изменено в версии 3.3: Ранее создавался экземпляр [`WindowsError`](https://python-all.ru/3.4/library/exceptions.html#WindowsError).14661467#### `ctypes.wstring_at(address, size=-1)`14681469Эта функция возвращает строку широких символов, начинающуюся по адресу памяти *address*, в виде строки. Если указан *size*, он используется как количество символов строки, в противном случае строка считается завершающейся нулевым символом.14701471### 16.16.2.6. Типы данных14721473#### `class ctypes._CData`14741475Этот непубличный класс является общим базовым классом для всех типов данных ctypes. Среди прочего, все экземпляры типов ctypes содержат блок памяти, который хранит данные, совместимые с C; адрес блока памяти возвращается вспомогательной функцией [`addressof()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.addressof). Ещё одна переменная экземпляра представлена как [`_objects`](https://python-all.ru/3.4/library/ctypes.html#ctypes._CData._objects); она содержит другие объекты Python, которые необходимо сохранять в памяти на случай, если блок памяти содержит указатели.14761477Общие методы типов данных ctypes, все они являются методами класса (если точнее, это методы [*метакласса*](https://python-all.ru/3.4/glossary.html#term-metaclass)):14781479#### `from_buffer(source[, offset])`14801481Этот метод возвращает экземпляр ctypes, который использует тот же буфер, что и объект *source*. Объект *source* должен поддерживать интерфейс буфера с возможностью записи. Необязательный параметр *offset* задаёт смещение в байтах внутри буфера источника; по умолчанию – ноль. Если буфер источника недостаточно велик, возникает исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError).14821483#### `from_buffer_copy(source[, offset])`14841485Этот метод создаёт экземпляр ctypes, копируя буфер из объекта *source*, который должен быть доступен для чтения. Необязательный параметр *offset* задаёт смещение в байтах внутри буфера источника; по умолчанию – ноль. Если буфер источника недостаточно велик, возникает исключение [`ValueError`](https://python-all.ru/3.4/library/exceptions.html#ValueError).14861487#### `from_address(address)`14881489Этот метод возвращает экземпляр типа ctypes, использующий память, указанную *address*, который должен быть целым числом.14901491#### `from_param(obj)`14921493Этот метод приводит *obj* к типу ctypes. Он вызывается с фактическим объектом, используемым в вызове внешней функции, когда тип присутствует в кортеже `argtypes` этой функции; он должен вернуть объект, который можно использовать в качестве параметра вызова функции.14941495Все типы данных ctypes имеют реализацию этого метода класса по умолчанию, которая обычно возвращает *obj*, если он является экземпляром этого типа. Некоторые типы также принимают другие объекты.14961497#### `in_dll(library, name)`14981499Этот метод возвращает экземпляр типа ctypes, экспортируемый общей библиотекой. *name* – это имя символа, экспортирующего данные; *library* – загруженная общая библиотека.15001501Общие переменные экземпляра типов данных ctypes:15021503#### `_b_base_`15041505Иногда экземпляры данных ctypes не владеют блоком памяти, который содержат, а вместо этого разделяют часть блока памяти базового объекта. Член только для чтения [`_b_base_`](https://python-all.ru/3.4/library/ctypes.html#ctypes._CData._b_base_) является корневым объектом ctypes, которому принадлежит блок памяти.15061507#### `_b_needsfree_`15081509Эта переменная только для чтения равна true, когда экземпляр данных ctypes сам выделил блок памяти, и false в противном случае.15101511#### `_objects`15121513Этот член может быть либо `None`, либо словарём, содержащим объекты Python, которые необходимо сохранять в памяти, чтобы содержимое блока памяти оставалось корректным. Этот объект предоставляется только для отладки; никогда не изменяйте содержимое этого словаря.15141515### 16.16.2.7. Фундаментальные типы данных15161517#### `class ctypes._SimpleCData`15181519Этот непубличный класс является базовым классом для всех фундаментальных типов данных ctypes. Он упоминается здесь, потому что содержит общие атрибуты фундаментальных типов данных ctypes. [`_SimpleCData`](https://python-all.ru/3.4/library/ctypes.html#ctypes._SimpleCData) является подклассом [`_CData`](https://python-all.ru/3.4/library/ctypes.html#ctypes._CData), поэтому наследует их методы и атрибуты. Типы данных ctypes, которые не являются указателями и не содержат указателей, теперь можно сериализовать.15201521Экземпляры имеют один атрибут:15221523#### `value`15241525Этот атрибут содержит фактическое значение экземпляра. Для целочисленных типов и типов указателей это целое число, для символьных типов – объект bytes из одного символа или строка, для символьных указателей – объект Python bytes или строка.15261527When the `value` attribute is retrieved from a ctypes instance, usually a new object is returned each time. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) does *not* implement original object return, always a new object is constructed. The same is true for all other ctypes object instances.15281529Базовые типы данных при возврате из вызовов внешних функций или, например, при получении полей структур или элементов массивов прозрачно преобразуются в нативные типы Python. Иными словами, если внешняя функция имеет `restype` [`c_char_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char_p), вы всегда получите объект Python bytes, *а не* экземпляр [`c_char_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_char_p).15301531Подклассы базовых типов данных *не* наследуют это поведение. Так, если `restype` внешней функции является подклассом [`c_void_p`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_void_p), то из вызова функции вы получите экземпляр этого подкласса. Разумеется, значение указателя можно получить, обратившись к атрибуту `value`.15321533Вот фундаментальные типы данных ctypes:15341535#### `class ctypes.c_byte`15361537Представляет тип данных C `signed char` и интерпретирует значение как небольшое целое число. Конструктор принимает необязательный инициализатор целого типа; проверка переполнения не выполняется.15381539#### `class ctypes.c_char`15401541Представляет тип данных C `char` и интерпретирует значение как один символ. Конструктор принимает необязательный строковый инициализатор; длина строки должна быть ровно один символ.15421543#### `class ctypes.c_char_p`15441545Представляет тип данных C `char *`, когда он указывает на строку, завершающуюся нулевым символом. Для обычного указателя на символ, который может также указывать на бинарные данные, следует использовать `POINTER(c_char)`. Конструктор принимает целочисленный адрес или объект bytes.15461547#### `class ctypes.c_double`15481549Представляет тип данных C `double`. Конструктор принимает необязательный инициализатор с плавающей запятой.15501551#### `class ctypes.c_longdouble`15521553Представляет тип данных C `long double`. Конструктор принимает необязательный инициализатор с плавающей запятой. На платформах, где `sizeof(long double) == sizeof(double)`, он является псевдонимом [`c_double`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_double).15541555#### `class ctypes.c_float`15561557Представляет тип данных C `float`. Конструктор принимает необязательный инициализатор с плавающей запятой.15581559#### `class ctypes.c_int`15601561Представляет тип данных C `signed int`. Конструктор принимает необязательный инициализатор целого типа; проверка переполнения не выполняется. На платформах, где `sizeof(int) == sizeof(long)`, он является псевдонимом [`c_long`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_long).15621563#### `class ctypes.c_int8`15641565Представляет 8-битный тип данных C `signed int`. Обычно является псевдонимом [`c_byte`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_byte).15661567#### `class ctypes.c_int16`15681569Представляет 16-битный тип данных C `signed int`. Обычно является псевдонимом [`c_short`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_short).15701571#### `class ctypes.c_int32`15721573Представляет 32-битный тип данных C `signed int`. Обычно является псевдонимом [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int).15741575#### `class ctypes.c_int64`15761577Представляет 64-битный тип данных C `signed int`. Обычно является псевдонимом [`c_longlong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_longlong).15781579#### `class ctypes.c_long`15801581Представляет тип данных C `signed long`. Конструктор принимает необязательный инициализатор целого типа; проверка переполнения не выполняется.15821583#### `class ctypes.c_longlong`15841585Представляет тип данных C `signed long long`. Конструктор принимает необязательный инициализатор целого типа; проверка переполнения не выполняется.15861587#### `class ctypes.c_short`15881589Представляет тип данных C `signed short`. Конструктор принимает необязательный инициализатор целого типа; проверка переполнения не выполняется.15901591#### `class ctypes.c_size_t`15921593Представляет тип данных C `size_t`.15941595#### `class ctypes.c_ssize_t`15961597Представляет тип данных C `ssize_t`.15981599Новое в версии 3.2.16001601#### `class ctypes.c_ubyte`16021603Представляет тип данных C `unsigned char`, интерпретирует значение как целое число небольшого размера. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.16041605#### `class ctypes.c_uint`16061607Представляет тип данных C `unsigned int`. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется. На платформах, где `sizeof(int) == sizeof(long)`, это псевдоним для [`c_ulong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ulong).16081609#### `class ctypes.c_uint8`16101611Представляет 8-битный тип данных C `unsigned int`. Обычно это псевдоним для [`c_ubyte`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ubyte).16121613#### `class ctypes.c_uint16`16141615Представляет 16-битный тип данных C `unsigned int`. Обычно это псевдоним для [`c_ushort`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ushort).16161617#### `class ctypes.c_uint32`16181619Представляет 32-битный тип данных C `unsigned int`. Обычно это псевдоним для [`c_uint`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_uint).16201621#### `class ctypes.c_uint64`16221623Представляет 64-битный тип данных C `unsigned int`. Обычно это псевдоним для [`c_ulonglong`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_ulonglong).16241625#### `class ctypes.c_ulong`16261627Представляет тип данных C `unsigned long`. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.16281629#### `class ctypes.c_ulonglong`16301631Представляет тип данных C `unsigned long long`. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.16321633#### `class ctypes.c_ushort`16341635Представляет тип данных C `unsigned short`. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.16361637#### `class ctypes.c_void_p`16381639Представляет тип C `void *`. Значение представляется как целое число. Конструктор принимает необязательный целочисленный инициализатор.16401641#### `class ctypes.c_wchar`16421643Представляет тип данных C `wchar_t`, интерпретирует значение как строку unicode из одного символа. Конструктор принимает необязательный строковый инициализатор; длина строки должна быть ровно один символ.16441645#### `class ctypes.c_wchar_p`16461647Представляет тип данных C `wchar_t *`, который должен быть указателем на завершающуюся нулём строку широких символов. Конструктор принимает целочисленный адрес или строку.16481649#### `class ctypes.c_bool`16501651Представляет тип данных C `bool` (точнее, `_Bool` из C99). Его значением может быть `True` или `False`, а конструктор принимает любой объект, имеющий истинностное значение.16521653#### `class ctypes.HRESULT`16541655Только Windows: представляет значение `HRESULT`, содержащее информацию об успехе или ошибке вызова функции или метода.16561657#### `class ctypes.py_object`16581659Представляет тип данных C [`PyObject *`](https://python-all.ru/3.4/c-api/structures.html#c.PyObject). Вызов без аргумента создаёт указатель `NULL` [`PyObject *`](https://python-all.ru/3.4/c-api/structures.html#c.PyObject).16601661Модуль `ctypes.wintypes` предоставляет ряд других специфичных для Windows типов данных, например `HWND`, `WPARAM` или `DWORD`. Также определены некоторые полезные структуры, такие как `MSG` или `RECT`.16621663### 16.16.2.8. Структурированные типы данных16641665#### `class ctypes.Union(*args, **kw)`16661667Абстрактный базовый класс для объединений в собственном порядке байт.16681669#### `class ctypes.BigEndianStructure(*args, **kw)`16701671Абстрактный базовый класс для структур в *big endian* порядке байтов.16721673#### `class ctypes.LittleEndianStructure(*args, **kw)`16741675Абстрактный базовый класс для структур в *little endian* порядке байтов.16761677Структуры с нестандартным порядком байтов не могут содержать поля типа указателя или любые другие типы данных, содержащие поля типа указателя.16781679#### `class ctypes.Structure(*args, **kw)`16801681Абстрактный базовый класс для структур в *нативном* порядке байтов.16821683Конкретные типы структур и объединений должны создаваться через создание подкласса одного из этих tипов и как минимум определить переменную класса [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_). [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) создаст [*дескрипторы*](https://python-all.ru/3.4/glossary.html#term-descriptor), которые позволяют читать и записывать поля через прямой доступ к атрибутам. Это16841685#### `_fields_`16861687Последовательность, определяющая поля структуры. Элементы должны быть 2-кортежами или 3-кортежами. Первый элемент – имя поля, второй элемент задает тип поля; это может быть любой тип данных ctypes.16881689Для полей целочисленных типов, таких как [`c_int`](https://python-all.ru/3.4/library/ctypes.html#ctypes.c_int), может быть указан третий необязательный элемент. Он должен быть небольшим положительным целым числом, определяющим разрядность поля.16901691Имена полей должны быть уникальными в пределах одной структуры или объединения. Это не проверяется, но при повторении имен доступно только одно поле.16921693Переменную класса [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_) можно определить *после* оператора class, который определяет подкласс Structure; это позволяет создавать типы данных, которые прямо или косвенно ссылаются сами на себя:16941695```python1696class List(Structure):1697 pass1698List._fields_ = [("pnext", POINTER(List)),1699 ...1700 ]1701```17021703Однако переменная класса [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_) должна быть определена до первого использования типа (создания экземпляра, вызова [`sizeof()`](https://python-all.ru/3.4/library/ctypes.html#ctypes.sizeof) для него и т.д.). Последующие присваивания переменной класса [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_) вызовут AttributeError.17041705Можно определять подподклассы типов структур; они наследуют поля базового класса плюс поля из [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_), определённые в подподклассе, если таковые имеются.17061707#### `_pack_`17081709Необязательное небольшое целое число, позволяющее переопределить выравнивание полей структуры в экземпляре. [`_pack_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._pack_) должен быть уже определён, когда присваивается [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_), иначе это не будет иметь эффекта.17101711#### `_anonymous_`17121713Необязательная последовательность, перечисляющая имена безымянных (анонимных) полей. [`_anonymous_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._anonymous_) должен быть уже определён, когда присваивается [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_), иначе это не будет иметь эффекта.17141715Поля, перечисленные в этой переменной, должны быть полями типа структуры или объединения. [`ctypes`](https://python-all.ru/3.4/library/ctypes.html#module-ctypes) создаст в типе структуры дескрипторы, которые позволяют напрямую обращаться к вложенным полям без необходимости создавать поле структуры или объединения.17161717Вот пример типа (Windows):17181719```python1720class _U(Union):1721 _fields_ = [("lptdesc", POINTER(TYPEDESC)),1722 ("lpadesc", POINTER(ARRAYDESC)),1723 ("hreftype", HREFTYPE)]17241725class TYPEDESC(Structure):1726 _anonymous_ = ("u",)1727 _fields_ = [("u", _U),1728 ("vt", VARTYPE)]1729```17301731Структура `TYPEDESC` описывает тип данных COM; поле `vt` определяет, какое из полей объединения является действительным. Поскольку поле `u` определено как анонимное, теперь можно обращаться к членам напрямую через экземпляр TYPEDESC. `td.lptdesc` и `td.u.lptdesc` эквивалентны, но первый вариант быстрее, так как не требует создания временного экземпляра объединения:17321733```python1734td = TYPEDESC()1735td.vt = VT_PTR1736td.lptdesc = POINTER(some_type)1737td.u.lptdesc = POINTER(some_type)1738```17391740Можно определять подподклассы структур; они наследуют поля базового класса. Если в определении подкласса есть отдельная переменная [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_), то поля, указанные в ней, добавляются к полям базового класса.17411742Конструкторы структур и объединений принимают как позиционные, так и именованные аргументы. Позиционные аргументы используются для инициализации полей-членов в том же порядке, в котором они появляются в [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_). Именованные аргументы в конструкторе интерпретируются как присваивания атрибутов, поэтому они инициализируют [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_) с тем же именем или создают новые атрибуты для имён, отсутствующих в [`_fields_`](https://python-all.ru/3.4/library/ctypes.html#ctypes.Structure._fields_).17431744### 16.16.2.9. Массивы и указатели17451746Пока не написано – пожалуйста, обратитесь к разделам [*Pointers*](https://python-all.ru/3.4/library/ctypes.html#ctypes-pointers) и [*Arrays*](https://python-all.ru/3.4/library/ctypes.html#ctypes-arrays) в руководстве.1747