ctypes.md
1> **Источник:** https://python-all.ru/3.13/library/ctypes.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `ctypes` – библиотека для вызова внешних функций на Python89**Исходный код:** [Lib/ctypes](https://python-all.ru/3.13/library/ctypes.html)1011---1213`ctypes` – это библиотека для вызова внешних функций на Python. Она предоставляет совместимые с C типы данных и позволяет вызывать функции из DLL или разделяемых библиотек. Её можно использовать для обёртывания этих библиотек на чистом Python.1415> **Предупреждение**16>17> `ctypes` предоставляет низкоуровневый доступ к нативным библиотекам и памяти процесса, обходя механизмы безопасности Python и позволяя выполнять произвольный нативный код. Некорректное использование может повредить данные и объекты, раскрыть конфиденциальную информацию, вызвать сбои или иным образом нарушить работу текущего процесса.1819## Руководство по ctypes2021Примечание: примеры кода в этом руководстве используют [`doctest`](https://python-all.ru/3.13/library/doctest.html#module-doctest), чтобы гарантировать их работоспособность. Поскольку некоторые примеры ведут себя по-разному в Linux, Windows или macOS, они содержат директивы doctest в комментариях.2223Примечание: некоторые примеры кода ссылаются на тип [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int) модуля ctypes. На платформах, где `sizeof(long) == sizeof(int)` является псевдонимом для [`c_long`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_long). Поэтому не стоит удивляться, если при ожидании `c_int` выводится `c_long` – на самом деле это один и тот же тип.2425### Загрузка динамически подключаемых библиотек2627`ctypes` экспортирует объекты *cdll*, а в Windows – *windll* и *oledll* для загрузки динамически подключаемых библиотек.2829Библиотеки загружаются через обращение к ним как к атрибутам этих объектов. *cdll* загружает библиотеки, которые экспортируют функции, используя стандартное соглашение о вызовах `cdecl`, в то время как библиотеки *windll* вызывают функции по соглашению `stdcall`. *oledll* также использует соглашение о вызовах `stdcall` и предполагает, что функции возвращают код ошибки Windows `HRESULT`. Этот код ошибки используется для автоматического возбуждения исключения [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError) при неудачном вызове функции.3031Изменено в версии 3.3: раньше ошибки Windows возбуждали [`WindowsError`](https://python-all.ru/3.13/library/exceptions.html#WindowsError), который теперь является псевдонимом [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError).3233Вот несколько примеров для Windows. Обратите внимание, что `msvcrt` – это стандартная библиотека C от MS, содержащая большинство стандартных функций C, и использует соглашение о вызовах `cdecl`:3435```python36>>> from ctypes import *37>>> print(windll.kernel32)38<WinDLL 'kernel32', handle ... at ...>39>>> print(cdll.msvcrt)40<CDLL 'msvcrt', handle ... at ...>41>>> libc = cdll.msvcrt42>>>43```4445Windows автоматически добавляет обычный суффикс файла `.dll`.4647> **Примечание**48>49> Доступ к стандартной библиотеке C через `cdll.msvcrt` приведёт к использованию устаревшей версии библиотеки, которая может быть несовместима с той, которую использует Python. По возможности используйте встроенную функциональность Python или импортируйте и используйте модуль `msvcrt`.5051В Linux необходимо указывать имя файла *вместе с расширением* для загрузки библиотеки, поэтому обращение к атрибутам не может использоваться для загрузки библиотек. Следует использовать либо метод [`LoadLibrary()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.LibraryLoader.LoadLibrary) загрузчиков dll, либо загрузить библиотеку, создав экземпляр CDLL и вызвав конструктор:5253```python54>>> cdll.LoadLibrary("libc.so.6")55<CDLL 'libc.so.6', handle ... at ...>56>>> libc = CDLL("libc.so.6")57>>> libc58<CDLL 'libc.so.6', handle ... at ...>59>>>60```6162### Доступ к функциям из загруженных DLL6364Функции доступны как атрибуты объектов DLL:6566```python67>>> libc.printf68<_FuncPtr object at 0x...>69>>> print(windll.kernel32.GetModuleHandleA)70<_FuncPtr object at 0x...>71>>> print(windll.kernel32.MyOwnFunction)72Traceback (most recent call last):73 File "<stdin>", line 1, in <module>74 File "ctypes.py", line 239, in __getattr__75 func = _StdcallFuncPtr(name, self)76AttributeError: function 'MyOwnFunction' not found77>>>78```7980Обратите внимание, что системные DLL win32, такие как `kernel32` и `user32`, часто экспортируют как ANSI-, так и UNICODE-версии функций. Версия UNICODE экспортируется с добавлением `W` к имени, а версия ANSI – с добавлением `A` к имени. Функция win32 `GetModuleHandle`, которая возвращает *дескриптор модуля* для заданного имени модуля, имеет следующий C-прототип, и макрос используется для того, чтобы предоставить одну из них как `GetModuleHandle` в зависимости от того, определён ли UNICODE:8182```python83/* ANSI version */84HMODULE GetModuleHandleA(LPCSTR lpModuleName);85/* UNICODE version */86HMODULE GetModuleHandleW(LPCWSTR lpModuleName);87```8889*windll* не пытается выбрать одну из них магическим образом; необходимо получить доступ к нужной версии, явно указав `GetModuleHandleA` или `GetModuleHandleW`, и затем вызывать её с объектами bytes или string соответственно.9091Иногда DLL экспортируют функции с именами, которые не являются допустимыми идентификаторами Python, например `"??2@YAPAXI@Z"`. В этом случае нужно использовать [`getattr()`](https://python-all.ru/3.13/library/functions.html#getattr) для получения функции:9293```python94>>> getattr(cdll.msvcrt, "??2@YAPAXI@Z")95<_FuncPtr object at 0x...>96>>>97```9899В Windows некоторые DLL экспортируют функции не по имени, а по порядковому номеру. К таким функциям можно получить доступ, индексируя объект DLL по порядковому номеру:100101```python102>>> cdll.kernel32[1]103<_FuncPtr object at 0x...>104>>> cdll.kernel32[0]105Traceback (most recent call last):106 File "<stdin>", line 1, in <module>107 File "ctypes.py", line 310, in __getitem__108 func = _StdcallFuncPtr(name, self)109AttributeError: function ordinal 0 not found110>>>111```112113### Вызов функций114115Эти функции можно вызывать как любой другой вызываемый объект Python. В этом примере используется функция `rand()`, которая не принимает аргументов и возвращает псевдослучайное целое число:116117```python118>>> print(libc.rand())1191804289383120```121122В Windows можно вызвать функцию `GetModuleHandleA()`, которая возвращает дескриптор модуля win32 (передавая `None` в качестве единственного аргумента, чтобы вызвать её с указателем `NULL`):123124```python125>>> print(hex(windll.kernel32.GetModuleHandleA(None)))1260x1d000000127>>>128```129130[`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError) возбуждается, когда вызывается функция `stdcall` с соглашением о вызовах `cdecl` или наоборот:131132```python133>>> cdll.kernel32.GetModuleHandleA(None)134Traceback (most recent call last):135 File "<stdin>", line 1, in <module>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 <module>142ValueError: Procedure probably called with too many arguments (4 bytes in excess)143>>>144```145146Чтобы узнать правильное соглашение о вызовах, необходимо заглянуть в C-заголовочный файл или документацию вызываемой функции.147148В Windows `ctypes` использует структурированную обработку исключений win32 для предотвращения сбоев из-за ошибок общей защиты при вызове функций с недопустимыми значениями аргументов:149150```python151>>> windll.kernel32.GetModuleHandleA(32)152Traceback (most recent call last):153 File "<stdin>", line 1, in <module>154OSError: exception: access violation reading 0x00000020155>>>156```157158Модуль [`faulthandler`](https://python-all.ru/3.13/library/faulthandler.html#module-faulthandler) может помочь в отладке сбоев, таких как ошибки сегментации, вызванные ошибочными вызовами библиотеки C.159160`None`, целые числа, объекты bytes и (unicode) строки – единственные встроенные объекты Python, которые могут напрямую использоваться в качестве параметров в этих вызовах функций. `None` передаётся как указатель C `NULL`, объекты bytes и строки передаются как указатель на блок памяти, содержащий их данные (char\* или wchar\_t\*). Целые числа Python передаются как тип C int, используемый по умолчанию на платформе, их значение маскируется, чтобы соответствовать типу C.161162Прежде чем перейти к вызову функций с другими типами параметров, нужно узнать больше о типах данных `ctypes`.163164### Фундаментальные типы данных165166`ctypes` определяет несколько примитивных типов данных, совместимых с C:167168| Тип ctypes | Тип C | Тип Python |169| --- | --- | --- |170| [`c_bool`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_bool) | \_Bool | bool (1) |171| [`c_char`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char) | char | односимвольный объект bytes |172| [`c_wchar`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_wchar) | `wchar_t` | односимвольная строка |173| [`c_byte`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_byte) | char | int |174| [`c_ubyte`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ubyte) | unsigned char | int |175| [`c_short`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_short) | short | int |176| [`c_ushort`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ushort) | unsigned short | int |177| [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int) | int | int |178| [`c_int8`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int8) | `int8_t` | int |179| [`c_int16`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int16) | `int16_t` | int |180| [`c_int32`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int32) | `int32_t` | int |181| [`c_int64`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int64) | `int64_t` | int |182| [`c_uint`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint) | unsigned int | int |183| [`c_uint8`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint8) | `uint8_t` | int |184| [`c_uint16`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint16) | `uint16_t` | int |185| [`c_uint32`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint32) | `uint32_t` | int |186| [`c_uint64`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint64) | `uint64_t` | int |187| [`c_long`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_long) | long | int |188| [`c_ulong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ulong) | unsigned long | int |189| [`c_longlong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_longlong) | \_\_int64 or long long | int |190| [`c_ulonglong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ulonglong) | unsigned \_\_int64 or unsigned long long | int |191| [`c_size_t`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_size_t) | `size_t` | int |192| [`c_ssize_t`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ssize_t) | `ssize_t` or [Py\_ssize\_t](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t) | int |193| [`c_time_t`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_time_t) | `time_t` | int |194| [`c_float`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_float) | float | float |195| [`c_double`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_double) | double | float |196| [`c_longdouble`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_longdouble) | long double | float |197| [`c_char_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char_p) | char\* (завершается NUL) | объект bytes или `None` |198| [`c_wchar_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_wchar_p) | wchar\_t\* (завершается NUL) | строка или `None` |199| [`c_void_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_void_p) | void\* | int или `None` |2002011. Конструктор принимает любой объект с истинностным значением.202203Все эти типы можно создать, вызвав их с необязательным инициализатором правильного типа и значения:204205```python206>>> c_int()207c_long(0)208>>> c_wchar_p("Hello, World")209c_wchar_p(140018365411392)210>>> c_ushort(-3)211c_ushort(65533)212>>>213```214215Поскольку эти типы изменяемы, их значение можно изменить и впоследствии:216217```python218>>> i = c_int(42)219>>> print(i)220c_long(42)221>>> print(i.value)22242223>>> i.value = -99224>>> print(i.value)225-99226>>>227```228229Присваивание нового значения экземплярам типов-указателей [`c_char_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char_p), [`c_wchar_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_wchar_p) и [`c_void_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_void_p) изменяет *адрес в памяти*, на который они указывают, *а не содержимое* блока памяти (разумеется, потому что строки Python неизменяемы):230231```python232>>> s = "Hello, World"233>>> c_s = c_wchar_p(s)234>>> print(c_s)235c_wchar_p(139966785747344)236>>> print(c_s.value)237Hello World238>>> c_s.value = "Hi, there"239>>> print(c_s) # расположение в памяти изменилось240c_wchar_p(139966783348904)241>>> print(c_s.value)242Hi, there243>>> print(s) # первый объект не изменился244Hello, World245>>>246```247248Однако следует соблюдать осторожность: не передавайте их функциям, ожидающим указатели на изменяемую память. Если нужны изменяемые блоки памяти, в ctypes есть функция [`create_string_buffer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.create_string_buffer), которая создаёт их разными способами. Текущее содержимое блока памяти можно получить (или изменить) через свойство `raw`; если нужно обратиться к нему как к строке, завершающейся NUL, используйте свойство `value`:249250```python251>>> from ctypes import *252>>> p = create_string_buffer(3) # создать буфер размером 3 байта, инициализированный нулевыми байтами253>>> print(sizeof(p), repr(p.raw))2543 b'\x00\x00\x00'255>>> p = create_string_buffer(b"Hello") # создать буфер, содержащий строку, завершающуюся нулевым байтом256>>> print(sizeof(p), repr(p.raw))2576 b'Hello\x00'258>>> print(repr(p.value))259b'Hello'260>>> p = create_string_buffer(b"Hello", 10) # создать буфер на 10 байт261>>> print(sizeof(p), repr(p.raw))26210 b'Hello\x00\x00\x00\x00\x00'263>>> p.value = b"Hi"264>>> print(sizeof(p), repr(p.raw))26510 b'Hi\x00lo\x00\x00\x00\x00\x00'266>>>267```268269Функция [`create_string_buffer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.create_string_buffer) заменяет старую функцию `c_buffer()` (которая всё ещё доступна как псевдоним). Чтобы создать изменяемый блок памяти, содержащий символы Юникода типа C `wchar_t`, используйте функцию [`create_unicode_buffer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.create_unicode_buffer).270271### Вызов функций, продолжение272273Обратите внимание: printf выводит в реальный стандартный поток вывода, *а не* в [`sys.stdout`](https://python-all.ru/3.13/library/sys.html#sys.stdout), поэтому эти примеры будут работать только в консоли, а не из *IDLE* или *PythonWin*:274275```python276>>> printf = libc.printf277>>> printf(b"Hello, %s\n", b"World!")278Hello, World!27914280>>> printf(b"Hello, %S\n", "World!")281Hello, World!28214283>>> printf(b"%d bottles of beer\n", 42)28442 bottles of beer28519286>>> printf(b"%f bottles of beer\n", 42.5)287Traceback (most recent call last):288 File "<stdin>", line 1, in <module>289ctypes.ArgumentError: argument 2: TypeError: Don't know how to convert parameter 2290>>>291```292293Как уже упоминалось, все типы Python, кроме целых чисел, строк и объектов bytes, должны быть обёрнуты в соответствующий тип `ctypes`, чтобы их можно было преобразовать в требуемый тип данных C:294295```python296>>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))297An int 1234, a double 3.14000029831299>>>300```301302### Вызов функций с переменным числом аргументов303304На многих платформах вызов функций с переменным числом аргументов через ctypes ничем не отличается от вызова функций с фиксированным числом параметров. Однако на некоторых платформах (в частности, ARM64 для Apple) соглашение о вызове для функций с переменным числом аргументов отличается от обычного.305306На этих платформах необходимо указать атрибут [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes) для обычных (невариативных) аргументов функции:307308```python309libc.printf.argtypes = [ctypes.c_char_p]310```311312Поскольку указание этого атрибута не ухудшает переносимость, рекомендуется всегда указывать [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes) для всех вариативных функций.313314### Вызов функций с собственными пользовательскими типами данных315316Можно также настроить преобразование аргументов `ctypes`, чтобы экземпляры собственных классов можно было использовать в качестве аргументов функций. `ctypes` ищет атрибут `_as_parameter_` и использует его как аргумент функции. Этот атрибут должен быть целым числом, строкой, байтами, экземпляром `ctypes` или объектом с атрибутом `_as_parameter_`:317318```python319>>> class Bottles:320... def __init__(self, number):321... self._as_parameter_ = number322...323>>> bottles = Bottles(42)324>>> printf(b"%d bottles of beer\n", bottles)32542 bottles of beer32619327>>>328```329330Если не нужно хранить данные экземпляра в переменной экземпляра `_as_parameter_`, можно определить [`property`](https://python-all.ru/3.13/library/functions.html#property), который делает атрибут доступным по запросу.331332### Указание требуемых типов аргументов (прототипы функций)333334Можно указать требуемые типы аргументов функций, экспортируемых из DLL, задав атрибут [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes).335336[`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes) должен быть последовательностью типов данных C (функция `printf()` вероятно, не лучший пример, поскольку она принимает переменное количество и разные типы параметров в зависимости от строки формата; с другой стороны, это довольно удобно для экспериментов с этой возможностью):337338```python339>>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]340>>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)341String 'Hi', Int 10, Double 2.20000034237343>>>344```345346Указание формата защищает от несовместимых типов аргументов (как прототип для функции C) и пытается преобразовать аргументы в допустимые типы:347348```python349>>> printf(b"%d %d %d", 1, 2, 3)350Traceback (most recent call last):351 File "<stdin>", line 1, in <module>352ctypes.ArgumentError: argument 2: TypeError: 'int' object cannot be interpreted as ctypes.c_char_p353>>> printf(b"%s %d %f\n", b"X", 2, 3)354X 2 3.00000035513356>>>357```358359Если вы определили собственные классы, которые передаёте в вызовы функций, нужно реализовать метод класса [`from_param()`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData.from_param), чтобы их можно было использовать в последовательности [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes). Метод класса `from_param()` получает объект Python, переданный в вызов функции; он должен выполнить проверку типа или всё необходимое, чтобы убедиться, что объект приемлем, а затем вернуть сам объект, его атрибут `_as_parameter_` или то, что нужно передать в качестве аргумента функции C в данном случае. Результат должен быть целым числом, строкой, байтами, экземпляром `ctypes` или объектом с атрибутом `_as_parameter_`.360361### Типы возвращаемых значений362363По умолчанию предполагается, что функции возвращают тип C int. Другие типы возврата можно указать, задав атрибут [`restype`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.restype) объекта функции.364365Прототип C для `time()` – это `time_t time(time_t *)`. Поскольку `time_t` может иметь другой тип, нежели тип возврата по умолчанию int, следует указать атрибут `restype`:366367```python368>>> libc.time.restype = c_time_t369```370371Типы аргументов можно указать с помощью [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes):372373```python374>>> libc.time.argtypes = (POINTER(c_time_t),)375```376377Чтобы вызвать функцию с указателем `NULL` в качестве первого аргумента, используйте `None`:378379```python380>>> print(libc.time(None))3811150640792382```383384Вот более сложный пример: используется функция `strchr()`, которая ожидает указатель на строку и char, а возвращает указатель на строку:385386```python387>>> strchr = libc.strchr388>>> strchr(b"abcdef", ord("d"))3898059983390>>> strchr.restype = c_char_p # c_char_p – указатель на строку391>>> strchr(b"abcdef", ord("d"))392b'def'393>>> print(strchr(b"abcdef", ord("x")))394None395>>>396```397398Чтобы избежать вызовов [`ord("x")`](https://python-all.ru/3.13/library/functions.html#ord) выше, можно задать атрибут [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes), и второй аргумент будет преобразован из одного символа объекта bytes Python в C char:399400```pycon401>>> strchr.restype = c_char_p402>>> strchr.argtypes = [c_char_p, c_char]403>>> strchr(b"abcdef", b"d")404b'def'405>>> strchr(b"abcdef", b"def")406Traceback (most recent call last):407ctypes.ArgumentError: argument 2: TypeError: one character bytes, bytearray or integer expected408>>> print(strchr(b"abcdef", b"x"))409None410>>> strchr(b"abcdef", b"d")411b'def'412>>>413```414415В качестве атрибута [`restype`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.restype) можно также использовать вызываемый объект Python (например, функцию или класс), если внешняя функция возвращает целое число. Этот вызываемый объект будет вызван с *целым числом*, которое вернула функция C, и результат этого вызова будет использован как результат вашего вызова функции. Это полезно для проверки кодов ошибок и автоматического возбуждения исключения:416417```python418>>> GetModuleHandle = windll.kernel32.GetModuleHandleA419>>> def ValidHandle(value):420... if value == 0:421... raise WinError()422... return value423...424>>>425>>> GetModuleHandle.restype = ValidHandle426>>> GetModuleHandle(None)427486539264428>>> GetModuleHandle("something silly")429Traceback (most recent call last):430 File "<stdin>", line 1, in <module>431 File "<stdin>", line 3, in ValidHandle432OSError: [Errno 126] The specified module could not be found.433>>>434```435436`WinError` – это функция, которая вызывает Windows API `FormatMessage()` для получения строкового представления кода ошибки и *возвращает* исключение. `WinError` принимает необязательный параметр – код ошибки; если он не указан, функция вызывает [`GetLastError()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.GetLastError) для его получения.437438Обратите внимание: гораздо более мощный механизм проверки ошибок доступен через атрибут [`errcheck`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.errcheck); подробнее см. в справочном руководстве.439440### Передача указателей (или: передача параметров по ссылке)441442Иногда функция C API ожидает в качестве параметра *указатель* на тип данных, обычно для записи в соответствующее место или если данные слишком велики для передачи по значению. Это также называется *передачей параметров по ссылке*.443444`ctypes` экспортирует функцию [`byref()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.byref), которая используется для передачи параметров по ссылке. Того же эффекта можно достичь с помощью функции [`pointer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.pointer), хотя `pointer()` выполняет гораздо больше работы, так как создает реальный объект указателя, поэтому использовать `byref()` быстрее, если не нужен объект указателя в самом Python:445446```python447>>> i = c_int()448>>> f = c_float()449>>> s = create_string_buffer(b'\000' * 32)450>>> print(i.value, f.value, repr(s.value))4510 0.0 b''452>>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",453... byref(i), byref(f), s)4543455>>> print(i.value, f.value, repr(s.value))4561 3.1400001049 b'Hello'457>>>458```459460### Структуры и объединения461462Структуры и объединения должны наследоваться от базовых классов [`Structure`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure) и [`Union`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Union), которые определены в модуле `ctypes`. Каждый подкласс должен определить атрибут [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_). `_fields_` должен быть списком *2-кортежей*, содержащих *имя поля* и *тип поля*.463464Тип поля должен быть типом `ctypes`, таким как [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int), или любым другим производным типом `ctypes`: структура, объединение, массив, указатель.465466Вот простой пример структуры POINT, которая содержит два целых числа с именами *x* и *y*, а также показывает, как инициализировать структуру в конструкторе:467468```python469>>> from ctypes import *470>>> class POINT(Structure):471... _fields_ = [("x", c_int),472... ("y", c_int)]473...474>>> point = POINT(10, 20)475>>> print(point.x, point.y)47610 20477>>> point = POINT(y=5)478>>> print(point.x, point.y)4790 5480>>> POINT(1, 2, 3)481Traceback (most recent call last):482 File "<stdin>", line 1, in <module>483TypeError: too many initializers484>>>485```486487Однако можно создавать гораздо более сложные структуры. Структура может сама содержать другие структуры, используя структуру в качестве типа поля.488489Вот структура RECT, которая содержит две точки с именами *upperleft* и *lowerright*:490491```python492>>> class RECT(Structure):493... _fields_ = [("upperleft", POINT),494... ("lowerright", POINT)]495...496>>> rc = RECT(point)497>>> print(rc.upperleft.x, rc.upperleft.y)4980 5499>>> print(rc.lowerright.x, rc.lowerright.y)5000 0501>>>502```503504Вложенные структуры также можно инициализировать в конструкторе несколькими способами:505506```python507>>> r = RECT(POINT(1, 2), POINT(3, 4))508>>> r = RECT((1, 2), (3, 4))509```510511полей [descriptor](https://python-all.ru/3.13/glossary.html#term-descriptor) можно получить из *класса*; они полезны для отладки, так как предоставляют полезную информацию:512513```python514>>> print(POINT.x)515<Field type=c_long, ofs=0, size=4>516>>> print(POINT.y)517<Field type=c_long, ofs=4, size=4>518>>>519```520521> **Предупреждение**522>523> `ctypes` не поддерживает передачу объединений или структур с битовыми полями в функции по значению. Хотя это может работать на 32-битной x86, библиотека не гарантирует работу в общем случае. Объединения и структуры с битовыми полями всегда следует передавать в функции по указателю.524525### Выравнивание структур/объединений и порядок байтов526527По умолчанию поля структур и объединений выравниваются так же, как это делает компилятор C. Это поведение можно изменить, указав атрибут класса [`_pack_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._pack_) в определении подкласса. Он должен быть положительным целым числом и задает максимальное выравнивание для полей. Именно это делает `#pragma pack(n)` в MSVC. Также можно задать минимальное выравнивание для того, как сам подкласс упаковывается, тем же способом, которым `#pragma align(n)` работает в MSVC. Для этого нужно указать атрибут класса [`_align_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._align_) в определении подкласса.528529`ctypes` использует собственный порядок байт для Structures и Unions. Для создания структур с нестандартным порядком байт можно использовать один из базовых классов [`BigEndianStructure`](https://python-all.ru/3.13/library/ctypes.html#ctypes.BigEndianStructure), [`LittleEndianStructure`](https://python-all.ru/3.13/library/ctypes.html#ctypes.LittleEndianStructure), [`BigEndianUnion`](https://python-all.ru/3.13/library/ctypes.html#ctypes.BigEndianUnion) и [`LittleEndianUnion`](https://python-all.ru/3.13/library/ctypes.html#ctypes.LittleEndianUnion). Эти классы не могут содержать поля-указатели.530531### Битовые поля в структурах и объединениях532533Можно создавать структуры и объединения, содержащие битовые поля. Битовые поля возможны только для целочисленных полей, ширина бита задается третьим элементом в кортежах [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_):534535```python536>>> class Int(Structure):537... _fields_ = [("first_16", c_int, 16),538... ("second_16", c_int, 16)]539...540>>> print(Int.first_16)541<Field type=c_long, ofs=0:0, bits=16>542>>> print(Int.second_16)543<Field type=c_long, ofs=0:16, bits=16>544>>>545```546547### Массивы548549Массивы – это последовательности, содержащие фиксированное количество экземпляров одного типа.550551Рекомендуемый способ создания типов массивов – умножение типа данных на положительное целое число:552553```python554TenPointsArrayType = POINT * 10555```556557Вот пример несколько искусственного типа данных – структуры, содержащей 4 точки среди прочего:558559```python560>>> from ctypes import *561>>> class POINT(Structure):562... _fields_ = ("x", c_int), ("y", c_int)563...564>>> class MyStruct(Structure):565... _fields_ = [("a", c_int),566... ("b", c_float),567... ("point_array", POINT * 4)]568>>>569>>> print(len(MyStruct().point_array))5704571>>>572```573574Экземпляры создаются обычным способом – вызовом класса:575576```python577arr = TenPointsArrayType()578for pt in arr:579 print(pt.x, pt.y)580```581582Приведенный выше код выводит серию строк `0 0`, потому что содержимое массива инициализируется нулями.583584Можно также указать инициализаторы правильного типа:585586```python587>>> from ctypes import *588>>> TenIntegers = c_int * 10589>>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)590>>> print(ii)591<c_long_Array_10 object at 0x...>592>>> for i in ii: print(i, end=" ")593...5941 2 3 4 5 6 7 8 9 10595>>>596```597598### Указатели599600Экземпляры указателей создаются вызовом функции [`pointer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.pointer) для типа `ctypes`:601602```python603>>> from ctypes import *604>>> i = c_int(42)605>>> pi = pointer(i)606>>>607```608609Экземпляры указателей имеют атрибут [`contents`](https://python-all.ru/3.13/library/ctypes.html#ctypes._Pointer.contents), который возвращает объект, на который указывает указатель, – объект `i` выше:610611```python612>>> pi.contents613c_long(42)614>>>615```616617Обратите внимание, что `ctypes` не поддерживает OOR (возврат исходного объекта); он создает новый, эквивалентный объект каждый раз при получении атрибута:618619```python620>>> pi.contents is i621False622>>> pi.contents is pi.contents623False624>>>625```626627Присваивание другого экземпляра [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int) атрибуту contents указателя заставит указатель указывать на область памяти, где этот экземпляр хранится:628629```python630>>> i = c_int(99)631>>> pi.contents = i632>>> pi.contents633c_long(99)634>>>635```636637Экземпляры указателей также можно индексировать целыми числами:638639```python640>>> pi[0]64199642>>>643```644645Присваивание целочисленному индексу изменяет значение, на которое указывает указатель:646647```python648>>> print(i)649c_long(99)650>>> pi[0] = 22651>>> print(i)652c_long(22)653>>>654```655656It 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.657658Под капотом функция [`pointer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.pointer) делает больше, чем просто создание экземпляров указателей: сначала ей нужно создать *типы* указателей. Это делается с помощью функции [`POINTER()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.POINTER), которая принимает любой тип `ctypes` и возвращает новый тип:659660```python661>>> PI = POINTER(c_int)662>>> PI663<class 'ctypes.LP_c_long'>664>>> PI(42)665Traceback (most recent call last):666 File "<stdin>", line 1, in <module>667TypeError: expected c_long instead of int668>>> PI(c_int(42))669<ctypes.LP_c_long object at 0x...>670>>>671```672673Вызов типа указателя без аргументов создаёт нулевой указатель `NULL`. Нулевые указатели `NULL` имеют `False` ложное булево значение:674675```python676>>> null_ptr = POINTER(c_int)()677>>> print(bool(null_ptr))678False679>>>680```681682`ctypes` проверяет на `NULL` при разыменовании указателей (но разыменование недействительных не-`NULL` указателей приведёт к аварийному завершению Python):683684```python685>>> null_ptr[0]686Traceback (most recent call last):687 ....688ValueError: NULL pointer access689>>>690691>>> null_ptr[0] = 1234692Traceback (most recent call last):693 ....694ValueError: NULL pointer access695>>>696```697698### Преобразования типов699700Обычно ctypes выполняет строгую проверку типов. Это означает, что если `POINTER(c_int)` указан в [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes) списке аргументов функции или в качестве типа поля структуры, принимаются только экземпляры точно того же типа. Из этого правила есть несколько исключений, когда ctypes принимает другие объекты. Например, можно передать совместимые экземпляры массивов вместо типов указателей. Так, для `POINTER(c_int)` ctypes принимает массив c\_int:701702```python703>>> class Bar(Structure):704... _fields_ = [("count", c_int), ("values", POINTER(c_int))]705...706>>> bar = Bar()707>>> bar.values = (c_int * 3)(1, 2, 3)708>>> bar.count = 3709>>> for i in range(bar.count):710... print(bar.values[i])711...712171327143715>>>716```717718Кроме того, если аргумент функции явно объявлен как тип указателя (например, `POINTER(c_int)`) в [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes), в функцию можно передать объект типа, на который указывает указатель (в данном случае `c_int`). В этом случае ctypes автоматически применит необходимое преобразование [`byref()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.byref).719720Чтобы установить поле типа POINTER в `NULL`, можно присвоить `None`:721722```python723>>> bar.values = None724>>>725```726727Иногда встречаются экземпляры несовместимых типов. В C можно привести один тип к другому. `ctypes` предоставляет функцию [`cast()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.cast), которую можно использовать аналогичным образом. Структура `Bar`, определённая выше, принимает указатели `POINTER(c_int)` или массивы [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int) для своего поля `values`, но не экземпляры других типов:728729```python730>>> bar.values = (c_byte * 4)()731Traceback (most recent call last):732 File "<stdin>", line 1, in <module>733TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance734>>>735```736737Для таких случаев удобна функция [`cast()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.cast).738739Функцию [`cast()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.cast) можно использовать для приведения экземпляра ctypes к указателю на другой тип данных ctypes. `cast()` принимает два параметра: объект ctypes, который является или может быть преобразован в указатель какого-либо вида, и тип указателя ctypes. Она возвращает экземпляр второго аргумента, который ссылается на тот же блок памяти, что и первый аргумент:740741```python742>>> a = (c_byte * 4)()743>>> cast(a, POINTER(c_int))744<ctypes.LP_c_long object at ...>745>>>746```747748Таким образом, [`cast()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.cast) можно использовать для присваивания полю `values` структуры `Bar`:749750```python751>>> bar = Bar()752>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))753>>> print(bar.values[0])7540755>>>756```757758### Неполные типы759760*Неполные типы* – это структуры, объединения или массивы, члены которых ещё не определены. В C они задаются опережающими объявлениями, которые определяются позже:761762```python763struct cell; /* forward declaration */764765struct cell {766 char *name;767 struct cell *next;768};769```770771Прямой перевод в код ctypes выглядел бы так, но это не работает:772773```python774>>> class cell(Structure):775... _fields_ = [("name", c_char_p),776... ("next", POINTER(cell))]777...778Traceback (most recent call last):779 File "<stdin>", line 1, in <module>780 File "<stdin>", line 2, in cell781NameError: name 'cell' is not defined782>>>783```784785потому что новый `class cell` недоступен внутри самого определения класса. В `ctypes` можно определить класс `cell` и задать атрибут [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_) позже, после определения класса:786787```python788>>> from ctypes import *789>>> class cell(Structure):790... pass791...792>>> cell._fields_ = [("name", c_char_p),793... ("next", POINTER(cell))]794>>>795```796797Попробуем. Создадим два экземпляра `cell`, заставим их указывать друг на друга и, наконец, пройдём по цепочке указателей несколько раз:798799```python800>>> c1 = cell()801>>> c1.name = b"foo"802>>> c2 = cell()803>>> c2.name = b"bar"804>>> c1.next = pointer(c2)805>>> c2.next = pointer(c1)806>>> p = c1807>>> for i in range(8):808... print(p.name, end=" ")809... p = p.next[0]810...811foo bar foo bar foo bar foo bar812>>>813```814815### Функции обратного вызова816817`ctypes` позволяет создавать указатели на вызываемые функции C из вызываемых объектов Python. Их иногда называют *функциями обратного вызова*.818819Сначала нужно создать класс для функции обратного вызова. Этот класс знает соглашение о вызове, тип возвращаемого значения, а также количество и типы аргументов, которые будет получать эта функция.820821Фабричная функция [`CFUNCTYPE()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.CFUNCTYPE) создаёт типы для функций обратного вызова, используя соглашение о вызове `cdecl`. В Windows фабричная функция [`WINFUNCTYPE()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.WINFUNCTYPE) создаёт типы для функций обратного вызова, используя соглашение о вызове `stdcall`.822823Обе эти фабричные функции вызываются с типом результата в качестве первого аргумента, а ожидаемые типы аргументов функции обратного вызова передаются как остальные аргументы.824825В качестве примера будет показано использование функции `qsort()` из стандартной библиотеки C, которая сортирует элементы с помощью функции обратного вызова. `qsort()` будет использована для сортировки массива целых чисел:826827```python828>>> IntArray5 = c_int * 5829>>> ia = IntArray5(5, 1, 7, 33, 99)830>>> qsort = libc.qsort831>>> qsort.restype = None832>>>833```834835`qsort()` должна вызываться с указателем на сортируемые данные, количеством элементов в массиве данных, размером одного элемента и указателем на функцию сравнения – функцию обратного вызова. Затем функция обратного вызова будет вызвана с двумя указателями на элементы; она должна вернуть отрицательное целое число, если первый элемент меньше второго, ноль – если они равны, и положительное – в противном случае.836837Итак, наша функция обратного вызова получает указатели на целые числа и должна вернуть целое число. Сначала создаётся `type` для функции обратного вызова:838839```python840>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))841>>>842```843844Для начала приведём простую функцию обратного вызова, которая выводит передаваемые ей значения:845846```python847>>> def py_cmp_func(a, b):848... print("py_cmp_func", a[0], b[0])849... return 0850...851>>> cmp_func = CMPFUNC(py_cmp_func)852>>>853```854855```python856>>> qsort(ia, len(ia), sizeof(c_int), cmp_func)857py_cmp_func 5 1858py_cmp_func 33 99859py_cmp_func 7 33860py_cmp_func 5 7861py_cmp_func 1 7862>>>863```864865Теперь можно по-настоящему сравнить два элемента и вернуть полезный результат:866867```python868>>> def py_cmp_func(a, b):869... print("py_cmp_func", a[0], b[0])870... return a[0] - b[0]871...872>>>873>>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func))874py_cmp_func 5 1875py_cmp_func 33 99876py_cmp_func 7 33877py_cmp_func 1 7878py_cmp_func 5 7879>>>880```881882Как легко проверить, наш массив теперь отсортирован:883884```python885>>> for i in ia: print(i, end=" ")886...8871 5 7 33 99888>>>889```890891Фабрики функций могут использоваться как фабрики декораторов, так что можно просто написать:892893```python894>>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))895... def py_cmp_func(a, b):896... print("py_cmp_func", a[0], b[0])897... return a[0] - b[0]898...899>>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func)900py_cmp_func 5 1901py_cmp_func 33 99902py_cmp_func 7 33903py_cmp_func 1 7904py_cmp_func 5 7905>>>906```907908> **Примечание**909>910> Необходимо сохранять ссылки на объекты [`CFUNCTYPE()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.CFUNCTYPE), пока они используются из кода на C. `ctypes` этого не делает, и если не сохранять, они могут быть собраны сборщиком мусора, что приведет к краху программы при вызове колбэка.911>912> Также обратите внимание, что если функция обратного вызова вызывается в потоке, созданном вне контроля Python (например, внешним кодом, вызывающим колбэк), ctypes создает новый фиктивный поток Python при каждом вызове. Такое поведение корректно для большинства целей, но означает, что значения, сохраненные с помощью [`threading.local`](https://python-all.ru/3.13/library/threading.html#threading.local), *не* будут сохраняться между разными колбэками, даже если эти вызовы производятся из одного и того же потока C.913914### Доступ к значениям, экспортируемым из DLL915916Некоторые разделяемые библиотеки экспортируют не только функции, но и переменные. Примером в самой библиотеке Python является [`Py_Version`](https://python-all.ru/3.13/c-api/apiabiversion.html#c.Py_Version) – номер версии среды выполнения Python, закодированный в виде одного целочисленного константного значения.917918`ctypes` может получать доступ к таким значениям с помощью методов класса [`in_dll()`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData.in_dll) соответствующего типа. *pythonapi* – это предопределенный символ, предоставляющий доступ к C API Python:919920```python921>>> version = ctypes.c_int.in_dll(ctypes.pythonapi, "Py_Version")922>>> print(hex(version.value))9230x30c00a0924```925926Расширенный пример, также демонстрирующий использование указателей, обращается к указателю [`PyImport_FrozenModules`](https://python-all.ru/3.13/c-api/import.html#c.PyImport_FrozenModules), экспортируемому Python.927928Цитируя документацию для этого значения:929930> Этот указатель инициализируется так, чтобы указывать на массив записей [`_frozen`](https://python-all.ru/3.13/c-api/import.html#c._frozen), завершающийся записью, все члены которой равны `NULL` или нулю. Когда замороженный модуль импортируется, он ищется в этой таблице. Сторонний код может этим воспользоваться, чтобы предоставить динамически создаваемую коллекцию замороженных модулей.931932Таким образом, манипуляции с этим указателем могут оказаться полезными. Чтобы ограничить размер примера, мы показываем только то, как эту таблицу можно прочитать с помощью `ctypes`:933934```python935>>> from ctypes import *936>>>937>>> class struct_frozen(Structure):938... _fields_ = [("name", c_char_p),939... ("code", POINTER(c_ubyte)),940... ("size", c_int),941... ("get_code", POINTER(c_ubyte)), # Указатель на функцию942... ]943...944>>>945```946947Мы определили тип данных [`_frozen`](https://python-all.ru/3.13/c-api/import.html#c._frozen), поэтому можем получить указатель на таблицу:948949```python950>>> FrozenTable = POINTER(struct_frozen)951>>> table = FrozenTable.in_dll(pythonapi, "_PyImport_FrozenBootstrap")952>>>953```954955Поскольку `table` – это `pointer` на массив записей `struct_frozen`, мы можем выполнять итерацию по нему, но нужно убедиться, что цикл завершается, потому что указатели не имеют размера. Рано или поздно это, вероятно, приведет к краху из-за нарушения доступа или чему-то подобному, поэтому лучше выйти из цикла при достижении записи `NULL`:956957```python958>>> for item in table:959... if item.name is None:960... break961... print(item.name.decode("ascii"), item.size)962...963_frozen_importlib 31764964_frozen_importlib_external 41499965zipimport 12345966>>>967```968969Тот факт, что стандартный Python содержит замороженный модуль и замороженный пакет (обозначаемый отрицательным значением элемента `size`), малоизвестен; это используется только для тестирования. Попробуйте, например, с `import __hello__`.970971### Неожиданности972973В `ctypes` есть некоторые пограничные случаи, где можно ожидать чего-то иного, чем происходит на самом деле.974975Рассмотрим следующий пример:976977```python978>>> from ctypes import *979>>> class POINT(Structure):980... _fields_ = ("x", c_int), ("y", c_int)981...982>>> class RECT(Structure):983... _fields_ = ("a", POINT), ("b", POINT)984...985>>> p1 = POINT(1, 2)986>>> p2 = POINT(3, 4)987>>> rc = RECT(p1, p2)988>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)9891 2 3 4990>>> # теперь поменять точки местами991>>> rc.a, rc.b = rc.b, rc.a992>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)9933 4 3 4994>>>995```996997Хм. Мы, безусловно, ожидали, что последний оператор выведет `3 4 1 2`. Что произошло? Вот шаги выполнения строки `rc.a, rc.b = rc.b, rc.a` выше:998999```python1000>>> temp0, temp1 = rc.b, rc.a1001>>> rc.a = temp01002>>> rc.b = temp11003>>>1004```10051006Обратите внимание, что `temp0` и `temp1` – это объекты, все еще использующие внутренний буфер объекта `rc` выше. Таким образом, выполнение `rc.a = temp0` копирует содержимое буфера `temp0` в буфер `rc`. Это, в свою очередь, изменяет содержимое `temp1`. Поэтому последнее присваивание `rc.b = temp1` не дает ожидаемого эффекта.10071008Имейте в виду, что получение подобъектов из Structure, Unions и Arrays не *копирует* подобъект, а возвращает объект-обертку, обращающийся к базовому буферу корневого объекта.10091010Другой пример, который может вести себя иначе, чем ожидается:10111012```python1013>>> s = c_char_p()1014>>> s.value = b"abc def ghi"1015>>> s.value1016b'abc def ghi'1017>>> s.value is s.value1018False1019>>>1020```10211022> **Примечание**1023>1024> Объекты, созданные из [`c_char_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char_p), могут иметь значение только в виде байтов или целых чисел.10251026Почему выводится `False`? Экземпляры ctypes – это объекты, содержащие блок памяти и несколько [дескрипторов](https://python-all.ru/3.13/glossary.html#term-descriptor), обращающихся к содержимому памяти. Сохранение объекта Python в блоке памяти не сохраняет сам объект, вместо этого сохраняется `contents` объекта. При повторном доступе к содержимому каждый раз создается новый объект Python!10271028### Типы данных переменного размера10291030`ctypes` предоставляет некоторую поддержку массивов и структур переменного размера.10311032Функция [`resize()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.resize) может использоваться для изменения размера буфера памяти существующего объекта ctypes. Функция принимает объект в качестве первого аргумента и запрошенный размер в байтах в качестве второго аргумента. Блок памяти не может быть уменьшен меньше естественного блока памяти, заданного типом объекта; при попытке этого вызывается [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError):10331034```python1035>>> short_array = (c_short * 4)()1036>>> print(sizeof(short_array))103781038>>> resize(short_array, 4)1039Traceback (most recent call last):1040 ...1041ValueError: minimum size is 81042>>> resize(short_array, 32)1043>>> sizeof(short_array)1044321045>>> sizeof(type(short_array))104681047>>>1048```10491050Это хорошо и замечательно, но как получить доступ к дополнительным элементам, содержащимся в этом массиве? Поскольку тип по-прежнему знает только о 4 элементах, при попытке доступа к другим элементам возникают ошибки:10511052```python1053>>> short_array[:]1054[0, 0, 0, 0]1055>>> short_array[7]1056Traceback (most recent call last):1057 ...1058IndexError: invalid index1059>>>1060```10611062Другой способ использования типов данных переменного размера с `ctypes` – воспользоваться динамической природой Python и (пере-)определять тип данных после того, как требуемый размер уже известен, в каждом конкретном случае.10631064## Справочник по ctypes10651066### Поиск разделяемых библиотек10671068При программировании на компилируемом языке к разделяемым библиотекам обращаются при компиляции/компоновке программы и при ее запуске.10691070Назначение функции [`find_library()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.util.find_library) – найти библиотеку способом, аналогичным тому, что делает компилятор или загрузчик времени выполнения (на платформах с несколькими версиями разделяемой библиотеки должна загружаться самая последняя), в то время как загрузчики библиотек ctypes действуют как при запуске программы и вызывают загрузчик времени выполнения напрямую.10711072Модуль `ctypes.util` предоставляет функцию, которая может помочь определить загружаемую библиотеку.10731074#### `ctypes.util.find_library(name)`10751076Пытается найти библиотеку и возвращает путь к файлу. *имя* – это имя библиотеки без префикса, например *lib*, суффикса, например `.so`, `.dylib`, и номера версии (такая форма используется для опции компоновщика POSIX `-l`). Если библиотеку не удается найти, возвращает `None`.10771078Точное поведение зависит от системы.10791080В Linux [`find_library()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.util.find_library) пытается запустить внешние программы (`/sbin/ldconfig`, `gcc`, `objdump` и `ld`) для поиска файла библиотеки. Он возвращает имя файла библиотеки.10811082Обратите внимание: если вывод этих программ не соответствует динамическому компоновщику, используемому Python, результат этой функции может вводить в заблуждение.10831084Изменено в версии 3.6: В Linux значение переменной окружения `LD_LIBRARY_PATH` используется при поиске библиотек, если библиотеку не удаётся найти другими способами.10851086Вот несколько примеров:10871088```python1089>>> from ctypes.util import find_library1090>>> find_library("m")1091'libm.so.6'1092>>> find_library("c")1093'libc.so.6'1094>>> find_library("bz2")1095'libbz2.so.1.0'1096>>>1097```10981099В macOS и Android [`find_library()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.util.find_library) использует стандартные схемы именования и пути системы для поиска библиотеки и в случае успеха возвращает полный путь:11001101```python1102>>> from ctypes.util import find_library1103>>> find_library("c")1104'/usr/lib/libc.dylib'1105>>> find_library("m")1106'/usr/lib/libm.dylib'1107>>> find_library("bz2")1108'/usr/lib/libbz2.dylib'1109>>> find_library("AGL")1110'/System/Library/Frameworks/AGL.framework/AGL'1111>>>1112```11131114В Windows [`find_library()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.util.find_library) выполняет поиск по системному пути поиска и возвращает полный путь, но поскольку нет предопределённой схемы именования, вызов наподобие `find_library("c")` завершится неудачей и вернёт `None`.11151116При обёртывании динамической библиотеки с помощью `ctypes`, возможно, *лучше* определить имя библиотеки на этапе разработки и жёстко задать его в модуле-обёртке, вместо использования [`find_library()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.util.find_library) для поиска библиотеки во время выполнения.11171118### Загрузка динамических библиотек11191120Существует несколько способов загрузить разделяемые библиотеки в процесс Python. Один из способов – создать экземпляр одного из следующих классов:11211122#### `class ctypes.CDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)`11231124Экземпляры этого класса представляют загруженные разделяемые библиотеки. Функции в этих библиотеках используют стандартное соглашение о вызове C и считаются возвращающими int.11251126В Windows создание экземпляра `CDLL` может завершиться неудачей, даже если имя DLL существует. Если зависимая DLL загружаемой DLL не найдена, возникает ошибка [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError) с сообщением *«\[WinError 126\] Указанный модуль не найден».* Это сообщение об ошибке не содержит имени отсутствующей DLL, поскольку Windows API не возвращает эту информацию, что затрудняет диагностику. Чтобы устранить эту ошибку и определить, какая DLL не найдена, необходимо найти список зависимых DLL и выяснить, какая из них отсутствует, с помощью инструментов отладки и трассировки Windows.11271128Изменено в версии 3.12: Параметр *name* теперь может быть [объектом, подобным пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).11291130> **См. также**1131>1132> [Инструмент Microsoft DUMPBIN](https://python-all.ru/3.13/library/ctypes.html) – инструмент для поиска зависимостей DLL.11331134#### `class ctypes.OleDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)`11351136Экземпляры этого класса представляют загруженные разделяемые библиотеки; функции в этих библиотеках используют соглашение о вызове `stdcall` и считаются возвращающими специфический для Windows код [`HRESULT`](https://python-all.ru/3.13/library/ctypes.html#ctypes.HRESULT). Значения `HRESULT` содержат информацию, указывающую, завершился ли вызов функции неудачей или успешно, вместе с дополнительным кодом ошибки. Если возвращаемое значение сигнализирует об ошибке, автоматически возбуждается исключение [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError).11371138[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows11391140Изменено в версии 3.3: [`WindowsError`](https://python-all.ru/3.13/library/exceptions.html#WindowsError) раньше вызывалось, а теперь является псевдонимом [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError).11411142Изменено в версии 3.12: Параметр *name* теперь может быть [объектом, подобным пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).11431144#### `class ctypes.WinDLL(name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)`11451146Экземпляры этого класса представляют загруженные разделяемые библиотеки; функции в этих библиотеках используют соглашение о вызове `stdcall` и по умолчанию считаются возвращающими int.11471148[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows11491150Изменено в версии 3.12: Параметр *name* теперь может быть [объектом, подобным пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).11511152Глобальная блокировка интерпретатора Python [global interpreter lock](https://python-all.ru/3.13/glossary.html#term-global-interpreter-lock) освобождается перед вызовом любой функции, экспортируемой этими библиотеками, и снова захватывается после вызова.11531154#### `class ctypes.PyDLL(name, mode=DEFAULT_MODE, handle=None)`11551156Экземпляры этого класса ведут себя как экземпляры [`CDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.CDLL), за исключением того, что GIL Python *не* освобождается во время вызова функции, и после выполнения функции проверяется флаг ошибки Python. Если флаг ошибки установлен, возбуждается исключение Python.11571158Таким образом, это полезно только для прямого вызова функций Python C API.11591160Изменено в версии 3.12: Параметр *name* теперь может быть [объектом, подобным пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).11611162Все эти классы можно инстанцировать, вызвав их как минимум с одним аргументом – путём к файлу общей библиотеки. Если у вас уже есть дескриптор загруженной общей библиотеки, его можно передать как именованный параметр `handle`, в противном случае используется функция `dlopen()` или `LoadLibrary()` соответствующей платформы для загрузки библиотеки в процесс и получения её дескриптора.11631164Параметр *mode* можно использовать для указания способа загрузки библиотеки. За подробностями обратитесь к man-странице *[dlopen(3)](https://python-all.ru/3.13/library/ctypes.html)*. В Windows *mode* игнорируется. В системах POSIX всегда добавляется RTLD\_NOW, и это не настраивается.11651166Параметр *use\_errno*, если установлен в true, включает механизм ctypes, который позволяет безопасно обращаться к системному номеру ошибки [`errno`](https://python-all.ru/3.13/library/errno.html#module-errno). `ctypes` хранит локальную для потока копию системной переменной `errno`; если вызывать внешние функции, созданные с помощью `use_errno=True`, то значение `errno` перед вызовом функции заменяется приватной копией ctypes, то же самое происходит сразу после вызова функции.11671168Функция [`ctypes.get_errno()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.get_errno) возвращает значение приватной копии ctypes, а функция [`ctypes.set_errno()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.set_errno) изменяет приватную копию ctypes на новое значение и возвращает предыдущее значение.11691170Параметр *use\_last\_error*, если установлен в true, включает тот же механизм для кода ошибки Windows, который управляется функциями Windows API [`GetLastError()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.GetLastError) и `SetLastError()`; [`ctypes.get_last_error()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.get_last_error) и [`ctypes.set_last_error()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.set_last_error) используются для запроса и изменения приватной копии кода ошибки Windows в ctypes.11711172Параметр *winmode* используется в Windows для указания того, как загружается библиотека (поскольку *mode* игнорируется). Он принимает любое значение, допустимое для параметра флагов Win32 API `LoadLibraryEx`. Если он опущен, по умолчанию используются флаги, обеспечивающие наиболее безопасную загрузку DLL, что позволяет избежать проблем, таких как перехват DLL. Передача полного пути к DLL – самый безопасный способ гарантировать загрузку правильной библиотеки и зависимостей.11731174Изменено в версии 3.8: Добавлен параметр *winmode*.11751176#### `ctypes.RTLD_GLOBAL`11771178Флаг, используемый в качестве параметра *mode*. На платформах, где этот флаг недоступен, он определён как целочисленный ноль.11791180#### `ctypes.RTLD_LOCAL`11811182Флаг, используемый в качестве параметра *mode*. На платформах, где он недоступен, он совпадает с *RTLD\_GLOBAL*.11831184#### `ctypes.DEFAULT_MODE`11851186Режим по умолчанию, используемый для загрузки разделяемых библиотек. На OSX 10.3 это *RTLD\_GLOBAL*, в противном случае он совпадает с *RTLD\_LOCAL*.11871188Экземпляры этих классов не имеют открытых методов. Функции, экспортируемые общей библиотекой, можно получить как атрибуты или по индексу. Обратите внимание: доступ к функции через атрибут кэширует результат, поэтому при повторном обращении возвращается тот же самый объект каждый раз. С другой стороны, доступ по индексу каждый раз возвращает новый объект:11891190```python1191>>> from ctypes import CDLL1192>>> libc = CDLL("libc.so.6") # В Linux1193>>> libc.time == libc.time1194True1195>>> libc['time'] == libc['time']1196False1197```11981199Доступны следующие открытые атрибуты, их имена начинаются с подчёркивания, чтобы не конфликтовать с именами экспортируемых функций:12001201#### `PyDLL._handle`12021203Системный дескриптор, используемый для доступа к библиотеке.12041205#### `PyDLL._name`12061207Имя библиотеки, переданное в конструктор.12081209Разделяемые библиотеки также можно загружать с помощью одного из готовых объектов, которые являются экземплярами класса [`LibraryLoader`](https://python-all.ru/3.13/library/ctypes.html#ctypes.LibraryLoader), либо вызывая метод [`LoadLibrary()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.LibraryLoader.LoadLibrary), либо получая библиотеку как атрибут экземпляра загрузчика.12101211#### `class ctypes.LibraryLoader(dlltype)`12121213Класс, который загружает разделяемые библиотеки. *dlltype* должен быть одним из типов [`CDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.CDLL), [`PyDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.PyDLL), [`WinDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.WinDLL) или [`OleDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.OleDLL).12141215`__getattr__()` обладает особым поведением: он позволяет загружать разделяемую библиотеку, обращаясь к ней как к атрибуту экземпляра загрузчика библиотек. Результат кэшируется, поэтому повторные обращения к атрибуту каждый раз возвращают одну и ту же библиотеку.12161217#### `LoadLibrary(name)`12181219Загружает разделяемую библиотеку в процесс и возвращает её. Этот метод всегда возвращает новый экземпляр библиотеки.12201221Доступны следующие готовые загрузчики библиотек:12221223#### `ctypes.cdll`12241225Создаёт экземпляры [`CDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.CDLL).12261227#### `ctypes.windll`12281229Создаёт экземпляры [`WinDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.WinDLL).12301231[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows12321233#### `ctypes.oledll`12341235Создаёт экземпляры [`OleDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.OleDLL).12361237[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows12381239#### `ctypes.pydll`12401241Создаёт экземпляры [`PyDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.PyDLL).12421243Для прямого доступа к C Python API доступен готовый к использованию объект общей библиотеки Python:12441245#### `ctypes.pythonapi`12461247Экземпляр [`PyDLL`](https://python-all.ru/3.13/library/ctypes.html#ctypes.PyDLL), который предоставляет функции Python C API в виде атрибутов. Обратите внимание: предполагается, что все эти функции возвращают C int, что, конечно, не всегда верно, поэтому необходимо назначить правильный атрибут `restype`, чтобы использовать эти функции.12481249Загрузка библиотеки через любой из этих объектов вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.dlopen` со строковым аргументом `name` – именем, используемым для загрузки библиотеки.12501251Доступ к функции загруженной библиотеки вызывает событие аудита `ctypes.dlsym` с аргументами `library` (объект библиотеки) и `name` (имя символа в виде строки или целого числа).12521253В случаях, когда доступен только дескриптор библиотеки, а не сам объект, обращение к функции вызывает событие аудита `ctypes.dlsym/handle` с аргументами `handle` (сырой дескриптор библиотеки) и `name`.12541255### Внешние функции12561257Как было объяснено в предыдущем разделе, к внешним функциям можно обращаться как к атрибутам загруженных общих библиотек. Созданные таким образом объекты функций по умолчанию принимают любое количество аргументов, принимают любые экземпляры данных ctypes в качестве аргументов и возвращают тип результата по умолчанию, заданный загрузчиком библиотеки.12581259Они являются экземплярами закрытого локального класса `_FuncPtr` (не доступного в `ctypes`), который наследуется от закрытого класса [`_CFuncPtr`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr):12601261```pycon1262>>> import ctypes1263>>> lib = ctypes.CDLL(None)1264>>> issubclass(lib._FuncPtr, ctypes._CFuncPtr)1265True1266>>> lib._FuncPtr is ctypes._CFuncPtr1267False1268```12691270#### `class ctypes._CFuncPtr`12711272Базовый класс для внешних функций, вызываемых из C.12731274Экземпляры внешних функций также являются C-совместимыми типами данных; они представляют указатели на функции C.12751276Это поведение можно настроить, присвоив значения специальным атрибутам объекта внешней функции.12771278#### `restype`12791280Назначьте тип ctypes, чтобы указать тип результата внешней функции. Используйте `None` для void – функции, не возвращающей ничего.12811282Можно назначить вызываемый объект Python, который не является типом ctypes; в этом случае предполагается, что функция возвращает C int, и вызываемый объект будет вызван с этим целым числом, что позволяет выполнить дополнительную обработку или проверку ошибок. Использование этого подхода устарело; для более гибкой последующей обработки или проверки ошибок используйте тип данных ctypes в качестве `restype` и назначьте вызываемый объект атрибуту [`errcheck`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.errcheck).12831284#### `argtypes`12851286Назначьте кортеж типов ctypes, чтобы указать типы аргументов, которые принимает функция. Функции, использующие соглашение о вызове `stdcall`, могут быть вызваны только с тем же количеством аргументов, что и длина этого кортежа; функции, использующие C соглашение о вызове, также принимают дополнительные неопределённые аргументы.12871288При вызове внешней функции каждый фактический аргумент передаётся методу класса [`from_param()`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData.from_param) элементов кортежа [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes); этот метод позволяет адаптировать фактический аргумент к объекту, который принимает внешняя функция. Например, элемент [`c_char_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char_p) в кортеже `argtypes` преобразует строку, переданную в качестве аргумента, в объект bytes, используя правила преобразования ctypes.12891290Новое: теперь можно помещать в argtypes элементы, которые не являются типами ctypes, но каждый элемент должен иметь метод [`from_param()`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData.from_param), возвращающий значение, пригодное в качестве аргумента (целое число, строка, экземпляр ctypes). Это позволяет определять адаптеры, которые могут адаптировать пользовательские объекты в качестве параметров функции.12911292#### `errcheck`12931294Этому атрибуту присваивается функция Python или другой вызываемый объект. Вызываемый объект будет вызван с тремя и более аргументами:12951296#### `callable(result, func, arguments)`12971298*result* – это то, что возвращает внешняя функция, как указано атрибутом `restype`.12991300*func* – это сам объект внешней функции; это позволяет повторно использовать один и тот же вызываемый объект для проверки или последующей обработки результатов нескольких функций.13011302*arguments* – это кортеж, содержащий параметры, переданные вызову функции; это позволяет специализировать поведение на основе используемых аргументов.13031304Объект, возвращаемый этой функцией, будет возвращён из вызова внешней функции, но он также может проверить значение результата и возбудить исключение, если вызов внешней функции завершился неудачей.13051306#### `exception ctypes.ArgumentError`13071308Это исключение возникает, когда вызов внешней функции не может преобразовать один из переданных аргументов.13091310В Windows, когда вызов внешней функции вызывает системное исключение (например, из-за нарушения доступа), оно перехватывается и заменяется подходящим исключением Python. Кроме того, возбуждается событие аудита `ctypes.set_exception` с аргументом `code`, позволяя обработчику аудита заменить исключение своим собственным.13111312Некоторые способы вызова внешних функций могут порождать событие аудита `ctypes.call_function` с аргументами `function pointer` и `arguments`.13131314### Прототипы функций13151316Внешние функции также можно создавать, создавая экземпляры прототипов функций. Прототипы функций похожи на прототипы функций в C: они описывают функцию (тип возврата, типы аргументов, соглашение о вызове), не определяя реализацию. Фабричные функции необходимо вызывать с желаемым типом результата и типами аргументов функции; их можно использовать как фабрики декораторов и, следовательно, применять к функциям через синтаксис `@wrapper`. Примеры см. в [функции обратного вызова](https://python-all.ru/3.13/library/ctypes.html#ctypes-callback-functions).13171318#### `ctypes.CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)`13191320Созданный прототип функции создаёт функции, использующие стандартное соглашение о вызове C. Функция освобождает GIL во время вызова. Если *use\_errno* установлен в true, приватная копия переменной [`errno`](https://python-all.ru/3.13/library/errno.html#module-errno) ctypes обменивается с реальным значением `errno` до и после вызова; *use\_last\_error* делает то же самое для кода ошибки Windows.13211322#### `ctypes.WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)`13231324Созданный прототип функции создаёт функции, использующие соглашение о вызове `stdcall`. Функция освобождает GIL во время вызова. *use\_errno* и *use\_last\_error* имеют то же значение, что и выше.13251326[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows13271328#### `ctypes.PYFUNCTYPE(restype, *argtypes)`13291330Созданный прототип функции создаёт функции, использующие соглашение о вызове Python. Функция *не* освобождает GIL во время вызова.13311332Прототипы функций, созданные этими фабричными функциями, могут быть созданы различными способами, в зависимости от типа и количества параметров в вызове:13331334#### `prototype(address)`13351336Возвращает внешнюю функцию по указанному адресу, который должен быть целым числом.13371338#### `prototype(callable)`13391340Создаёт вызываемую функцию C (функцию обратного вызова) из *вызываемого объекта* Python.13411342#### `prototype(func_spec[, paramflags])`13431344Возвращает внешнюю функцию, экспортируемую общей библиотекой. *func\_spec* должен быть 2-кортежем `(name_or_ordinal, library)`. Первый элемент – это имя экспортируемой функции в виде строки или порядковый номер экспортируемой функции в виде небольшого целого числа. Второй элемент – это экземпляр общей библиотеки.13451346#### `prototype(vtbl_index, name[, paramflags[, iid]])`13471348Возвращает внешнюю функцию, которая будет вызывать метод COM. *vtbl\_index* – это индекс в таблице виртуальных функций, небольшое неотрицательное целое число. *name* – это имя метода COM. *iid* – необязательный указатель на идентификатор интерфейса, используемый в расширенном отчёте об ошибках.13491350Методы COM используют специальное соглашение о вызове: в качестве первого аргумента требуется указатель на интерфейс COM, помимо тех параметров, которые указаны в кортеже `argtypes`.13511352Необязательный параметр *paramflags* создаёт обёртки внешних функций с гораздо большей функциональностью, чем описано выше.13531354*paramflags* должен быть кортежем той же длины, что и [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes).13551356Каждый элемент этого кортежа содержит дополнительную информацию о параметре; он должен быть кортежем, содержащим один, два или три элемента.13571358Первый элемент – целое число, содержащее комбинацию флагов направления для параметра:13591360> **1**1361>1362> Задаёт входной параметр функции.1363>1364> **2**1365>1366> Выходной параметр. Внешняя функция заполняет значение.1367>1368> **4**1369>1370> Входной параметр, по умолчанию равный нулю.13711372Необязательный второй элемент – имя параметра в виде строки. Если он указан, внешнюю функцию можно вызывать с именованными параметрами.13731374Необязательный третий элемент – значение по умолчанию для этого параметра.13751376Следующий пример демонстрирует, как обернуть функцию Windows `MessageBoxW` так, чтобы она поддерживала параметры по умолчанию и именованные аргументы. Объявление на C из заголовочного файла Windows выглядит так:13771378```python1379WINUSERAPI int WINAPI1380MessageBoxW(1381 HWND hWnd,1382 LPCWSTR lpText,1383 LPCWSTR lpCaption,1384 UINT uType);1385```13861387Вот обёртка с помощью `ctypes`:13881389```python1390>>> from ctypes import c_int, WINFUNCTYPE, windll1391>>> from ctypes.wintypes import HWND, LPCWSTR, UINT1392>>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT)1393>>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0)1394>>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)1395```13961397Теперь внешнюю функцию `MessageBox` можно вызывать следующими способами:13981399```python1400>>> MessageBox()1401>>> MessageBox(text="Spam, spam, spam")1402>>> MessageBox(flags=2, text="foo bar")1403```14041405Второй пример демонстрирует выходные параметры. Функция win32 `GetWindowRect` получает размеры указанного окна, копируя их в структуру `RECT`, которую должен предоставить вызывающий. Вот объявление на C:14061407```python1408WINUSERAPI BOOL WINAPI1409GetWindowRect(1410 HWND hWnd,1411 LPRECT lpRect);1412```14131414Вот обёртка с помощью `ctypes`:14151416```python1417>>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError1418>>> from ctypes.wintypes import BOOL, HWND, RECT1419>>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))1420>>> paramflags = (1, "hwnd"), (2, "lprect")1421>>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)1422>>>1423```14241425Функции с выходными параметрами автоматически возвращают значение выходного параметра, если он один, или кортеж значений выходных параметров, если их несколько; таким образом, при вызове функция GetWindowRect теперь возвращает экземпляр RECT.14261427Выходные параметры можно комбинировать с протоколом [`errcheck`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.errcheck) для дополнительной обработки выходных данных и проверки ошибок. Функция win32 API `GetWindowRect` возвращает `BOOL`, сигнализируя об успехе или неудаче, поэтому эта функция может выполнять проверку ошибок и возбуждать исключение при сбое вызова API:14281429```python1430>>> def errcheck(result, func, args):1431... if not result:1432... raise WinError()1433... return args1434...1435>>> GetWindowRect.errcheck = errcheck1436>>>1437```14381439Если функция [`errcheck`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.errcheck) возвращает полученный кортеж аргументов без изменений, `ctypes` продолжает обычную обработку выходных параметров. Если же требуется вернуть кортеж координат окна вместо экземпляра `RECT`, можно извлечь поля в функции и вернуть их – тогда обычная обработка выполняться не будет:14401441```python1442>>> def errcheck(result, func, args):1443... if not result:1444... raise WinError()1445... rc = args[1]1446... return rc.left, rc.top, rc.bottom, rc.right1447...1448>>> GetWindowRect.errcheck = errcheck1449>>>1450```14511452### Вспомогательные функции14531454#### `ctypes.addressof(obj)`14551456Возвращает адрес буфера памяти в виде целого числа. *obj* должен быть экземпляром типа ctypes.14571458Вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.addressof` с аргументом `obj`.14591460#### `ctypes.alignment(obj_or_type)`14611462Возвращает требования к выравниванию для типа ctypes. *obj\_or\_type* должен быть типом ctypes или его экземпляром.14631464#### `ctypes.byref(obj[, offset])`14651466Возвращает легковесный указатель на *obj*, который должен быть экземпляром типа ctypes. Параметр *offset* по умолчанию равен нулю и должен быть целым числом, которое будет добавлено к внутреннему значению указателя.14671468`byref(obj, offset)` соответствует следующему коду на C:14691470```python1471(((char *)&obj) + offset)1472```14731474Возвращаемый объект можно использовать только как параметр вызова внешней функции. Он ведёт себя аналогично `pointer(obj)`, но создаётся гораздо быстрее.14751476#### `ctypes.cast(obj, type)`14771478Эта функция аналогична оператору приведения типов в C. Она возвращает новый экземпляр *type*, указывающий на тот же блок памяти, что и *obj*. *type* должен быть типом-указателем, а *obj* – объектом, который можно интерпретировать как указатель.14791480#### `ctypes.create_string_buffer(init, size=None)`14811482#### `ctypes.create_string_buffer(size)`14831484Эта функция создаёт изменяемый символьный буфер. Возвращаемый объект представляет собой массив ctypes из [`c_char`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char).14851486Если *size* указан (и не равен `None`), он должен быть [`int`](https://python-all.ru/3.13/library/functions.html#int). Он задаёт размер возвращаемого массива.14871488Если аргумент *init* указан, он должен быть [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes). Он используется для инициализации элементов массива. Байты, не инициализированные таким образом, устанавливаются в ноль (NUL).14891490Если *size* не указан (или равен `None`), буфер создаётся на один элемент больше, чем *init*, что фактически добавляет завершающий NUL.14911492Если указаны оба аргумента, *size* не должен быть меньше `len(init)`.14931494> **Предупреждение**1495>1496> Если *size* равен `len(init)`, завершающий NUL не добавляется. Не рассматривайте такой буфер как C-строку.14971498Например:14991500```python1501>>> bytes(create_string_buffer(2))1502b'\x00\x00'1503>>> bytes(create_string_buffer(b'ab'))1504b'ab\x00'1505>>> bytes(create_string_buffer(b'ab', 2))1506b'ab'1507>>> bytes(create_string_buffer(b'ab', 4))1508b'ab\x00\x00'1509>>> bytes(create_string_buffer(b'abcdef', 2))1510Traceback (most recent call last):1511 ...1512ValueError: byte string too long1513```15141515Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.create_string_buffer` с аргументами `init`, `size`.15161517#### `ctypes.create_unicode_buffer(init, size=None)`15181519#### `ctypes.create_unicode_buffer(size)`15201521Эта функция создаёт изменяемый буфер символов Unicode. Возвращаемый объект представляет собой массив ctypes из [`c_wchar`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_wchar).15221523Функция принимает те же аргументы, что и [`create_string_buffer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.create_string_buffer), за исключением того, что *init* должен быть строкой, а *size* подсчитывает [`c_wchar`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_wchar).15241525Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.create_unicode_buffer` с аргументами `init`, `size`.15261527#### `ctypes.DllCanUnloadNow()`15281529Эта функция является перехватчиком, который позволяет реализовывать внутрипроцессные COM-серверы с помощью ctypes. Она вызывается из функции DllCanUnloadNow, экспортируемой DLL расширения \_ctypes.15301531[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15321533#### `ctypes.DllGetClassObject()`15341535Эта функция является перехватчиком, который позволяет реализовывать внутрипроцессные COM-серверы с помощью ctypes. Она вызывается из функции DllGetClassObject, экспортируемой DLL расширения `_ctypes`.15361537[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15381539#### `ctypes.util.find_library(name)`15401541Пытается найти библиотеку и возвращает путь. *name* – это имя библиотеки без префиксов вроде `lib`, суффиксов вроде `.so`, `.dylib` или номера версии (именно такая форма используется для опции компоновщика в POSIX `-l`). Если библиотеку не удаётся найти, возвращает `None`.15421543Точное поведение зависит от системы.15441545Полную документацию см. в [Поиск разделяемых библиотек](https://python-all.ru/3.13/library/ctypes.html#ctypes-finding-shared-libraries).15461547#### `ctypes.util.find_msvcrt()`15481549Возвращает имя файла библиотеки времени выполнения VC, используемой Python и модулями расширения. Если имя библиотеки не удаётся определить, возвращается `None`.15501551Если необходимо освободить память, выделенную, например, модулем расширения с помощью вызова `free(void *)`, важно использовать функцию из той же библиотеки, которая выделила память.15521553[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15541555#### `ctypes.FormatError([code])`15561557Возвращает текстовое описание кода ошибки *code*. Если код ошибки не указан, используется последний код ошибки вызовом Windows API функции GetLastError.15581559[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15601561#### `ctypes.GetLastError()`15621563Возвращает последний код ошибки, установленный Windows в вызывающем потоке. Эта функция напрямую вызывает `GetLastError()` Windows, а не возвращает приватную копию кода ошибки из ctypes.15641565[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15661567#### `ctypes.get_errno()`15681569Возвращает текущее значение приватной копии ctypes для системной переменной [`errno`](https://python-all.ru/3.13/library/errno.html#module-errno) в вызывающем потоке.15701571Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.get_errno` без аргументов.15721573#### `ctypes.get_last_error()`15741575Возвращает текущее значение приватной копии ctypes для системной переменной `LastError` в вызывающем потоке.15761577[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows15781579Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.get_last_error` без аргументов.15801581#### `ctypes.memmove(dst, src, count)`15821583Аналогична стандартной библиотечной функции C memmove: копирует *count* байт из *src* в *dst*. *dst* и *src* должны быть целыми числами или экземплярами ctypes, которые можно преобразовать в указатели.15841585#### `ctypes.memset(dst, c, count)`15861587Аналогична стандартной библиотечной функции C memset: заполняет блок памяти по адресу *dst* *count* байтами значения *c*. *dst* должно быть целым числом, задающим адрес, или экземпляром ctypes.15881589#### `ctypes.POINTER(type, /)`15901591Создаёт и возвращает новый тип указателя ctypes. Типы указателей кэшируются и повторно используются внутри, так что многократный вызов этой функции не требует больших затрат. *type* должен быть типом ctypes.15921593#### `ctypes.pointer(obj, /)`15941595Создаёт новый экземпляр указателя, указывающий на *obj*. Возвращаемый объект имеет тип `POINTER(type(obj))`.15961597Примечание: Если требуется просто передать указатель на объект в вызов внешней функции, следует использовать `byref(obj)`, что намного быстрее.15981599#### `ctypes.resize(obj, size)`16001601Эта функция изменяет размер внутреннего буфера памяти *obj*, который должен быть экземпляром типа ctypes. Уменьшить буфер ниже собственного размера типа объекта, заданного `sizeof(type(obj))`, невозможно, но увеличить буфер – можно.16021603#### `ctypes.set_errno(value)`16041605Устанавливает текущее значение приватной копии ctypes для системной переменной [`errno`](https://python-all.ru/3.13/library/errno.html#module-errno) в вызывающем потоке в *value* и возвращает предыдущее значение.16061607Вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.set_errno` с аргументом `errno`.16081609#### `ctypes.set_last_error(value)`16101611Устанавливает текущее значение приватной копии ctypes для системной переменной `LastError` в вызывающем потоке в *value* и возвращает предыдущее значение.16121613[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows16141615Вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.set_last_error` с аргументом `error`.16161617#### `ctypes.sizeof(obj_or_type)`16181619Возвращает размер в байтах буфера памяти типа или экземпляра ctypes. Делает то же, что и оператор C `sizeof`.16201621#### `ctypes.string_at(ptr, size=-1)`16221623Возвращает байтовую строку по адресу *void \*ptr*. Если задан *size*, он используется как размер, иначе строка считается завершающейся нулевым байтом.16241625Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.string_at` с аргументами `ptr`, `size`.16261627#### `ctypes.WinError(code=None, descr=None)`16281629Эта функция, вероятно, получила самое неудачное имя во всём модуле ctypes. Она создаёт экземпляр [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError). Если *code* не указан, вызывается `GetLastError` для определения кода ошибки. Если *descr* не указан, вызывается [`FormatError()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.FormatError) для получения текстового описания ошибки.16301631[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows16321633Изменено в версии 3.3: Ранее создавался экземпляр [`WindowsError`](https://python-all.ru/3.13/library/exceptions.html#WindowsError), который теперь является псевдонимом [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError).16341635#### `ctypes.wstring_at(ptr, size=-1)`16361637Возвращает строку широких символов по адресу *void \*ptr*. Если указан *size*, он используется как количество символов строки, в противном случае строка считается завершающейся нулевым символом.16381639Возбуждает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.wstring_at` с аргументами `ptr`, `size`.16401641### Типы данных16421643#### `class ctypes._CData`16441645Этот непубличный класс является общей базой всех типов данных ctypes. Среди прочего, все экземпляры типов ctypes содержат блок памяти, хранящий C-совместимые данные; адрес этого блока возвращается вспомогательной функцией [`addressof()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.addressof). Ещё одна переменная экземпляра доступна как [`_objects`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData._objects); она содержит другие объекты Python, которые необходимо хранить в живых на случай, если блок памяти содержит указатели.16461647Общие методы типов данных ctypes, все они являются методами класса (если точнее, это методы [метакласса](https://python-all.ru/3.13/glossary.html#term-metaclass)):16481649#### `from_buffer(source[, offset])`16501651Этот метод возвращает экземпляр ctypes, который разделяет буфер объекта *source*. Объект *source* должен поддерживать интерфейс буфера для записи. Необязательный параметр *offset* указывает смещение в буфере источника в байтах; по умолчанию ноль. Если буфер источника недостаточно велик, возникает исключение [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).16521653Вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.cdata/buffer` с аргументами `pointer`, `size`, `offset`.16541655#### `from_buffer_copy(source[, offset])`16561657Этот метод создаёт экземпляр ctypes, копируя буфер из объекта *source*, который должен быть читаемым. Необязательный параметр *offset* задаёт смещение в буфере источника в байтах; по умолчанию ноль. Если буфер источника недостаточно велик, возникает исключение [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).16581659Вызывает [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.cdata/buffer` с аргументами `pointer`, `size`, `offset`.16601661#### `from_address(address)`16621663Этот метод возвращает экземпляр типа ctypes, использующий память, указанную *address*, который должен быть целым числом.16641665Этот метод и другие методы, которые косвенно его вызывают, порождают [событие аудита](https://python-all.ru/3.13/library/sys.html#auditing) `ctypes.cdata` с аргументом `address`.16661667#### `from_param(obj)`16681669Этот метод адаптирует *obj* к типу ctypes. Он вызывается с фактическим объектом, используемым в вызове внешней функции, если этот тип присутствует в кортеже [`argtypes`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.argtypes) этой функции; он должен вернуть объект, который можно использовать как параметр вызова функции.16701671Все типы данных ctypes имеют реализацию этого метода класса по умолчанию, которая обычно возвращает *obj*, если он является экземпляром этого типа. Некоторые типы также принимают другие объекты.16721673#### `in_dll(library, name)`16741675Этот метод возвращает экземпляр типа ctypes, экспортируемый общей библиотекой. *name* – это имя символа, экспортирующего данные; *library* – загруженная общая библиотека.16761677Общие переменные экземпляра типов данных ctypes:16781679#### `_b_base_`16801681Иногда экземпляры данных ctypes не являются владельцами содержащегося в них блока памяти, а разделяют часть блока памяти базового объекта. Атрибут только для чтения [`_b_base_`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData._b_base_) – это корневой объект ctypes, владеющий блоком памяти.16821683#### `_b_needsfree_`16841685Эта переменная только для чтения равна true, когда экземпляр данных ctypes сам выделил блок памяти, и false в противном случае.16861687#### `_objects`16881689Этот элемент может быть `None` или словарём, содержащим объекты Python, которые необходимо удерживать в памяти, чтобы содержимое блока памяти оставалось валидным. Этот объект предоставляется только для отладки; не изменяйте содержимое этого словаря.16901691### Фундаментальные типы данных16921693#### `class ctypes._SimpleCData`16941695Этот непубличный класс является базовым для всех фундаментальных типов данных ctypes. Он упоминается здесь, потому что содержит общие атрибуты фундаментальных типов данных ctypes. `_SimpleCData` является подклассом [`_CData`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CData), поэтому наследует их методы и атрибуты. Типы данных ctypes, которые не являются указателями и не содержат указателей, теперь можно сериализовать с помощью pickle.16961697Экземпляры имеют один атрибут:16981699#### `value`17001701Этот атрибут содержит фактическое значение экземпляра. Для целочисленных типов и типов указателей это целое число, для символьных типов – объект bytes из одного символа или строка, для символьных указателей – объект Python bytes или строка.17021703При получении атрибута `value` из экземпляра ctypes обычно каждый раз возвращается новый объект. `ctypes` *не* реализует возврат исходного объекта, всегда создаётся новый объект. То же самое верно для всех остальных экземпляров объектов ctypes.17041705Фундаментальные типы данных при возврате в качестве результатов вызова внешней функции или, например, при получении полей структур или элементов массивов прозрачно преобразуются в собственные типы Python. Другими словами, если внешняя функция имеет [`restype`](https://python-all.ru/3.13/library/ctypes.html#ctypes._CFuncPtr.restype) с типом [`c_char_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_char_p), вы всегда получите объект Python bytes, *а не* экземпляр `c_char_p`.17061707Подклассы фундаментальных типов данных *не* наследуют это поведение. Так что если `restype` внешней функции является подклассом [`c_void_p`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_void_p), вы получите экземпляр этого подкласса в результате вызова функции. Разумеется, вы можете получить значение указателя, обратившись к атрибуту `value`.17081709Вот фундаментальные типы данных ctypes:17101711#### `class ctypes.c_byte`17121713Представляет тип данных C signed char и интерпретирует значение как небольшое целое число. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.17141715#### `class ctypes.c_char`17161717Представляет тип данных C char и интерпретирует значение как один символ. Конструктор принимает необязательный строковый инициализатор; длина строки должна быть ровно один символ.17181719#### `class ctypes.c_char_p`17201721Представляет тип данных C char\*, когда он указывает на строку, завершающуюся нулевым символом. Для обычного символьного указателя, который может также указывать на двоичные данные, следует использовать `POINTER(c_char)`. Конструктор принимает целочисленный адрес или объект bytes.17221723#### `class ctypes.c_double`17241725Представляет тип данных C double. Конструктор принимает необязательный инициализатор с плавающей запятой.17261727#### `class ctypes.c_longdouble`17281729Представляет тип данных C long double. Конструктор принимает необязательный инициализатор с плавающей запятой. На платформах, где `sizeof(long double) == sizeof(double)`, он является псевдонимом [`c_double`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_double).17301731#### `class ctypes.c_float`17321733Представляет тип данных C float. Конструктор принимает необязательный инициализатор с плавающей запятой.17341735#### `class ctypes.c_int`17361737Представляет тип данных C signed int. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется. На платформах, где `sizeof(int) == sizeof(long)`, он является псевдонимом для [`c_long`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_long).17381739#### `class ctypes.c_int8`17401741Представляет 8-битный тип данных C signed int. Это псевдоним для [`c_byte`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_byte).17421743#### `class ctypes.c_int16`17441745Представляет 16-битный тип данных C signed int. Обычно это псевдоним для [`c_short`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_short).17461747#### `class ctypes.c_int32`17481749Представляет 32-битный тип данных C signed int. Обычно это псевдоним для [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int).17501751#### `class ctypes.c_int64`17521753Представляет 64-битный тип данных C signed int. Обычно это псевдоним для [`c_longlong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_longlong).17541755#### `class ctypes.c_long`17561757Представляет тип данных C signed long. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.17581759#### `class ctypes.c_longlong`17601761Представляет тип данных C signed long long. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.17621763#### `class ctypes.c_short`17641765Представляет тип данных C signed short. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.17661767#### `class ctypes.c_size_t`17681769Представляет тип данных C `size_t`.17701771#### `class ctypes.c_ssize_t`17721773Представляет тип данных C `ssize_t`.17741775Добавлено в версии 3.2.17761777#### `class ctypes.c_time_t`17781779Представляет тип данных C `time_t`.17801781Добавлено в версии 3.12.17821783#### `class ctypes.c_ubyte`17841785Представляет тип данных C unsigned char, который интерпретирует значение как малое целое. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.17861787#### `class ctypes.c_uint`17881789Представляет тип данных C unsigned int. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется. На платформах, где `sizeof(int) == sizeof(long)`, он является псевдонимом для [`c_ulong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ulong).17901791#### `class ctypes.c_uint8`17921793Представляет 8-битный тип данных C unsigned int. Это псевдоним для [`c_ubyte`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ubyte).17941795#### `class ctypes.c_uint16`17961797Представляет 16-битный тип данных C unsigned int. Обычно является псевдонимом для [`c_ushort`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ushort).17981799#### `class ctypes.c_uint32`18001801Представляет 32-битный тип данных C unsigned int. Обычно является псевдонимом для [`c_uint`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_uint).18021803#### `class ctypes.c_uint64`18041805Представляет 64-битный тип данных C unsigned int. Обычно является псевдонимом для [`c_ulonglong`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_ulonglong).18061807#### `class ctypes.c_ulong`18081809Представляет тип данных C unsigned long. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не производится.18101811#### `class ctypes.c_ulonglong`18121813Представляет тип данных C unsigned long long. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не выполняется.18141815#### `class ctypes.c_ushort`18161817Представляет тип данных C unsigned short. Конструктор принимает необязательный целочисленный инициализатор; проверка переполнения не производится.18181819#### `class ctypes.c_void_p`18201821Представляет тип C void\*. Значение представляется как целое число. Конструктор принимает необязательный целочисленный инициализатор.18221823#### `class ctypes.c_wchar`18241825Представляет тип данных C `wchar_t` и интерпретирует значение как строку Unicode из одного символа. Конструктор принимает необязательный строковый инициализатор; длина строки должна быть ровно один символ.18261827#### `class ctypes.c_wchar_p`18281829Представляет тип данных C wchar\_t\*, который должен быть указателем на широкую строку с завершающим нулевым символом. Конструктор принимает целочисленный адрес или строку.18301831#### `class ctypes.c_bool`18321833Представляет тип данных C bool (точнее, \_Bool из C99). Его значением может быть `True` или `False`, а конструктор принимает любой объект, имеющий значение истинности.18341835#### `class ctypes.HRESULT`18361837Представляет значение `HRESULT`, которое содержит информацию об успехе или ошибке для вызова функции или метода.18381839[Доступность](https://python-all.ru/3.13/library/intro.html#availability): Windows18401841#### `class ctypes.py_object`18421843Представляет тип данных C [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*. Вызов без аргументов создает указатель `NULL` PyObject\*.18441845Модуль `ctypes.wintypes` предоставляет еще несколько типов данных, специфичных для Windows, например `HWND`, `WPARAM` или `DWORD`. Также определены некоторые полезные структуры, такие как `MSG` или `RECT`.18461847### Структурированные типы данных18481849#### `class ctypes.Union(*args, **kw)`18501851Абстрактный базовый класс для объединений в собственном порядке байт.18521853#### `class ctypes.BigEndianUnion(*args, **kw)`18541855Абстрактный базовый класс для объединений в *big endian* порядке байтов.18561857Добавлено в версии 3.12.18581859#### `class ctypes.LittleEndianUnion(*args, **kw)`18601861Абстрактный базовый класс для объединений в *little endian* порядке байтов.18621863Добавлено в версии 3.12.18641865#### `class ctypes.BigEndianStructure(*args, **kw)`18661867Абстрактный базовый класс для структур в *big endian* порядке байтов.18681869#### `class ctypes.LittleEndianStructure(*args, **kw)`18701871Абстрактный базовый класс для структур в *little endian* порядке байтов.18721873Структуры и объединения с не нативным порядком байтов не могут содержать поля-указатели или любые другие типы данных, содержащие поля-указатели.18741875#### `class ctypes.Structure(*args, **kw)`18761877Абстрактный базовый класс для структур в *нативном* порядке байтов.18781879Конкретные типы структур и объединений должны создаваться путем наследования одного из этих типов и как минимум определять переменную класса [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_). `ctypes` создаст [дескриптор](https://python-all.ru/3.13/glossary.html#term-descriptor)ы, которые позволяют читать и записывать поля через прямой доступ к атрибутам. Это –18801881#### `_fields_`18821883Последовательность, определяющая поля структуры. Элементы должны быть 2-кортежами или 3-кортежами. Первый элемент – имя поля, второй элемент задает тип поля; это может быть любой тип данных ctypes.18841885Для полей целочисленного типа, таких как [`c_int`](https://python-all.ru/3.13/library/ctypes.html#ctypes.c_int), можно указать третий необязательный элемент. Он должен быть небольшим положительным целым числом, определяющим разрядность поля (битовую ширину).18861887Имена полей должны быть уникальными в пределах одной структуры или объединения. Это не проверяется, но при повторении имен доступно только одно поле.18881889Можно определить переменную класса [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_) *после* оператора class, определяющего подкласс Structure; это позволяет создавать типы данных, которые прямо или косвенно ссылаются сами на себя:18901891```python1892class List(Structure):1893 pass1894List._fields_ = [("pnext", POINTER(List)),1895 ...1896 ]1897```18981899Однако переменная класса [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_) должна быть определена до того, как tип будет впервые использован (создается экземпляр, вызывается [`sizeof()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.sizeof) для него и т.д.). Последующие присваивания переменной класса `_fields_` будут вызывать AttributeError.19001901Можно определять подклассы второго уровня для типов структур; они наследуют поля базового класса, а также [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_), определенный в подклассе второго уровня, если таковой есть.19021903#### `_pack_`19041905Необязательное небольшое целое число, которое позволяет переопределить выравнивание полей структуры в экземпляре. [`_pack_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._pack_) должен быть уже определен на момент присваивания [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_), иначе это не будет иметь эффекта. Установка этого атрибута в 0 равносильна его отсутствию.19061907#### `_align_`19081909Необязательное небольшое целое число, которое позволяет переопределить выравнивание структуры при упаковке или распаковке в/из памяти. Установка этого атрибута в 0 равносильна его отсутствию.19101911Добавлено в версии 3.13.19121913#### `_anonymous_`19141915Необязательная последовательность, перечисляющая имена безымянных (анонимных) полей. [`_anonymous_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._anonymous_) должен быть уже определён, когда присваивается [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_), иначе это не будет иметь эффекта.19161917Поля, перечисленные в этой переменной, должны быть полями структурного или объединённого типа. `ctypes` создаёт дескрипторы в типе структуры, которые позволяют напрямую обращаться к вложенным полям без необходимости создания поля структуры или объединения.19181919Вот пример типа (Windows):19201921```python1922class _U(Union):1923 _fields_ = [("lptdesc", POINTER(TYPEDESC)),1924 ("lpadesc", POINTER(ARRAYDESC)),1925 ("hreftype", HREFTYPE)]19261927class TYPEDESC(Structure):1928 _anonymous_ = ("u",)1929 _fields_ = [("u", _U),1930 ("vt", VARTYPE)]1931```19321933Структура `TYPEDESC` описывает COM-тип данных, поле `vt` указывает, какое из полей объединения является действительным. Поскольку поле `u` определено как анонимное, теперь можно обращаться к членам напрямую через экземпляр TYPEDESC. `td.lptdesc` и `td.u.lptdesc` эквивалентны, но первый вариант быстрее, так как не требует создания временного экземпляра объединения:19341935```python1936td = TYPEDESC()1937td.vt = VT_PTR1938td.lptdesc = POINTER(some_type)1939td.u.lptdesc = POINTER(some_type)1940```19411942Можно определять подклассы структур; они наследуют поля базового класса. Если в определении подкласса есть отдельная переменная [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_), поля, указанные в ней, добавляются к полям базового класса.19431944Конструкторы структур и объединений принимают как позиционные, так и именованные аргументы. Позиционные аргументы используются для инициализации полей-членов в том же порядке, в котором они перечислены в [`_fields_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Structure._fields_). Именованные аргументы в конструкторе интерпретируются как присваивания атрибутов, поэтому они инициализируют `_fields_` с тем же именем или создают новые атрибуты для имён, отсутствующих в `_fields_`.19451946### Массивы и указатели19471948#### `class ctypes.Array(*args)`19491950Абстрактный базовый класс для массивов.19511952Рекомендуемый способ создания конкретных типов массивов – умножение любого `ctypes` типа данных на неотрицательное целое число. В качестве альтернативы можно создать подкласс этого типа и определить переменные класса [`_length_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Array._length_) и [`_type_`](https://python-all.ru/3.13/library/ctypes.html#ctypes.Array._type_). Элементы массива можно читать и записывать с помощью стандартных операций индексирования и срезов; при чтении среза результирующий объект *не* является `Array`.19531954Массивы являются [обобщёнными](https://python-all.ru/3.13/library/typing.html#generics) по типу своих элементов.19551956#### `_length_`19571958Положительное целое число, задающее количество элементов в массиве. Индексы вне диапазона приводят к [`IndexError`](https://python-all.ru/3.13/library/exceptions.html#IndexError). Будет возвращено [`len()`](https://python-all.ru/3.13/library/functions.html#len).19591960#### `_type_`19611962Задаёт тип каждого элемента в массиве.19631964Конструкторы подклассов массивов принимают позиционные аргументы, используемые для инициализации элементов по порядку.19651966#### `ctypes.ARRAY(type, length)`19671968Создание массива. Эквивалентно `type * length`, где *type* – это `ctypes` тип данных, а *length* – целое число.19691970Эта функция [мягко устарела](https://python-all.ru/3.13/glossary.html#term-soft-deprecated) в пользу умножения. Планов по её удалению нет.19711972#### `class ctypes._Pointer`19731974Приватный абстрактный базовый класс для указателей.19751976Конкретные типы указателей создаются вызовом [`POINTER()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.POINTER) с типом, на который будет указываться; это делается автоматически [`pointer()`](https://python-all.ru/3.13/library/ctypes.html#ctypes.pointer).19771978Если указатель указывает на массив, его элементы можно читать и записывать с помощью стандартных операций индексирования и срезов. Объекты-указатели не имеют размера, поэтому [`len()`](https://python-all.ru/3.13/library/functions.html#len) вызовет [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError). Отрицательные индексы будут читать из памяти *до* указателя (как в C), а индексы за пределами диапазона, скорее всего, приведут к сбою с нарушением доступа (если повезёт).19791980#### `_type_`19811982Задаёт тип, на который указывается.19831984#### `contents`19851986Возвращает объект, на который указывает указатель. Присваивание этому атрибуту изменяет указатель так, чтобы он указывал на присвоенный объект.1987