`arg.md`

489 строк · 55.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.6/c-api/arg.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Разбор аргументов и построение значений89Эти функции полезны при создании собственных функций и методов расширений. Дополнительная информация и примеры доступны в [Расширение и встраивание интерпретатора Python](https://python-all.ru/3.6/extending/index.html#extending-index).1011Первые три из описанных функций, [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple), [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) и [`PyArg_Parse()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_Parse), используют *строки формата*, которые сообщают функции об ожидаемых аргументах. Строки формата имеют одинаковый синтаксис для каждой из этих функций.1213## Разбор аргументов1415Строка формата состоит из нуля или более «единиц формата». Единица формата описывает один объект Python; обычно это один символ или заключённая в скобки последовательность единиц формата. За несколькими исключениями, единица формата, не являющаяся последовательностью в скобках, обычно соответствует одному аргументу-адресу этих функций. В следующем описании приведённая в кавычках форма – это единица формата; запись в круглых скобках – тип объекта Python, которому соответствует единица формата; а запись в квадратных скобках – тип переменной(ых) C, чей адрес следует передать.1617### Строки и буферы1819Эти форматы позволяют обращаться к объекту как к непрерывному блоку памяти. Не нужно предоставлять сырое хранилище для возвращаемой области unicode или bytes.2021В целом, когда формат устанавливает указатель на буфер, буфер управляется соответствующим объектом Python и существует в течение его времени жизни. Освобождать память самостоятельно не потребуется. Единственные исключения: `es`, `es#`, `et` и `et#`.2223Однако, когда структура [`Py_buffer`](https://python-all.ru/3.6/c-api/buffer.html#c.Py_buffer) заполняется, нижележащий буфер блокируется, чтобы вызывающий код мог затем использовать буфер даже внутри блока [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.6/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) без риска изменения размера или уничтожения изменяемых данных. Поэтому **необходимо вызвать** [`PyBuffer_Release()`](https://python-all.ru/3.6/c-api/buffer.html#c.PyBuffer_Release) после завершения обработки данных (или при досрочном прерывании).2425Если не указано иное, буферы не завершаются нулевым символом (NUL).2627Некоторые форматы требуют [объекта, подобного байтам](https://python-all.ru/3.6/glossary.html#term-bytes-like-object), доступного только для чтения, и устанавливают указатель вместо структуры буфера. Они работают, проверяя, что поле [`PyBufferProcs.bf_releasebuffer`](https://python-all.ru/3.6/c-api/typeobj.html#c.PyBufferProcs.bf_releasebuffer) объекта равно *NULL*, что запрещает изменяемые объекты, такие как [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray).2829> **Примечание**30>31> Для всех вариантов форматов `#` (`s#`, `y#` и т.д.) тип аргумента длины (int или `Py_ssize_t`) определяется определением макроса `PY_SSIZE_T_CLEAN` перед включением `Python.h`. Если макрос был определен, длина имеет тип `Py_ssize_t`, а не `int`. В будущей версии Python это поведение изменится: будет поддерживаться только `Py_ssize_t`, а поддержка `int` будет удалена. Рекомендуется всегда определять `PY_SSIZE_T_CLEAN`.3233**`s` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[const char \*\]**3435Преобразует объект Unicode в указатель C на строку символов. Указатель на существующую строку сохраняется в переменной-указателе на символ, адрес которой передаётся. Строка C заканчивается нулевым символом (NUL). Строка Python не должна содержать встроенные нулевые кодовые точки; если содержит, возбуждается исключение [`ValueError`](https://python-all.ru/3.6/library/exceptions.html#ValueError). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`. Если это преобразование не удаётся, возбуждается [`UnicodeError`](https://python-all.ru/3.6/library/exceptions.html#UnicodeError).3637> **Примечание**38>39> Этот формат не принимает [байтоподобные объекты](https://python-all.ru/3.6/glossary.html#term-bytes-like-object). Если требуется принимать пути файловой системы и преобразовывать их в строки символов C, предпочтительнее использовать формат `O&` с [`PyUnicode_FSConverter()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_FSConverter) в качестве *конвертера*.4041Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError) возбуждалось, когда в строке Python обнаруживались встроенные нулевые кодовые точки.4243**`s*` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) или [байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**4445Этот формат принимает как объекты Unicode, так и байтоподобные объекты. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.6/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. В этом случае результирующая строка C может содержать встроенные нулевые байты (NUL). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`.4647**`s#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str), только для чтения [байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object)) \[const char \*, int или `Py_ssize_t`\]**4849Как и `s*`, за исключением того, что не принимает изменяемые объекты. Результат сохраняется в две переменные C: первая – указатель на C-строку, вторая – её длина. Строка может содержать встроенные нулевые байты. Объекты Unicode преобразуются в C-строки с использованием кодировки `'utf-8'`.5051**`z` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) или `None`) \[const char \*\]**5253Как `s`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в *NULL*.5455**`z*` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object) или `None`) \[Py\_buffer\]**5657Как `s*`, но объект Python также может быть `None`, и в этом случае элемент `buf` структуры [`Py_buffer`](https://python-all.ru/3.6/c-api/buffer.html#c.Py_buffer) устанавливается в *NULL*.5859**`z#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str), [объект, подобный байтам](https://python-all.ru/3.6/glossary.html#term-bytes-like-object), доступный только для чтения, или `None`) \[const char \*, int\]**6061Как `s#`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в *NULL*.6263**`y` ([байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object) только для чтения) \[const char \*\]**6465Этот формат преобразует байтоподобный объект в указатель C на строку символов; он не принимает объекты Unicode. Буфер байтов не должен содержать встроенные нулевые байты; если это происходит, возбуждается исключение [`ValueError`](https://python-all.ru/3.6/library/exceptions.html#ValueError).6667Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError) возбуждалось, когда в байтовом буфере обнаруживались встроенные нулевые байты.6869**`y*` ([байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**7071Этот вариант `s*` не принимает объекты Unicode, только байтоподобные объекты. **Это рекомендуемый способ приёма двоичных данных.**7273**`y#` ([объект, подобный байтам](https://python-all.ru/3.6/glossary.html#term-bytes-like-object), доступный только для чтения) \[const char \*, int\]**7475Этот вариант `s#` не принимает объекты Unicode, только байтоподобные объекты.7677**`S` ([`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes)) \[PyBytesObject \*\]**7879Требует, чтобы объект Python был объектом [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes), без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError), если объект не является объектом bytes. Переменная C также может быть объявлена как [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject).8081**`Y` ([`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray)) \[PyByteArrayObject \*\]**8283Требует, чтобы объект Python был объектом [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray), без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError), если объект не является объектом [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray). Переменная C также может быть объявлена как [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject).8485**`u` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[Py\_UNICODE \*\]**8687Преобразует объект Unicode Python в указатель C на NUL-завершенный буфер символов Unicode. Необходимо передать адрес переменной-указателя [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE), которая будет заполнена указателем на существующий буфер Unicode. Обратите внимание, что ширина символа [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE) зависит от параметров компиляции (16 или 32 бита). Строка Python не должна содержать встроенных нулевых кодовых точек; если они есть, возбуждается исключение [`ValueError`](https://python-all.ru/3.6/library/exceptions.html#ValueError).8889Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError) возбуждалось, когда в строке Python обнаруживались встроенные нулевые кодовые точки.9091Устарело с версии 3.3, будет удалено в версии 4.0: Часть старого API [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE); переходите на использование [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_AsWideCharString).9293**`u#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[Py\_UNICODE \*, int\]**9495Этот вариант `u` сохраняет значения в две переменные C: первую – указатель на буфер данных Unicode, вторую – его длину. Этот вариант допускает нулевые кодовые точки.9697Устарело с версии 3.3, будет удалено в версии 4.0: Часть старого API [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE); переходите на использование [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_AsWideCharString).9899**`Z` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) или `None`) \[Py\_UNICODE \*\]**100101Как `u`, но объект Python также может быть `None`, и в этом случае указатель [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE) устанавливается в *NULL*.102103Устарело с версии 3.3, будет удалено в версии 4.0: Часть старого API [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE); переходите на использование [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_AsWideCharString).104105**`Z#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) или `None`) \[Py\_UNICODE \*, int\]**106107Как `u#`, но объект Python также может быть `None`, и в этом случае указатель [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE) устанавливается в *NULL*.108109Устарело с версии 3.3, будет удалено в версии 4.0: Часть старого API [`Py_UNICODE`](https://python-all.ru/3.6/c-api/unicode.html#c.Py_UNICODE); переходите на использование [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.6/c-api/unicode.html#c.PyUnicode_AsWideCharString).110111**`U` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[PyObject \*\]**112113Требует, чтобы объект Python был объектом Unicode, без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError), если объект не является объектом Unicode. Переменная C также может быть объявлена как [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject).114115**`w*` ([байтоподобный объект](https://python-all.ru/3.6/glossary.html#term-bytes-like-object) для чтения и записи) \[Py\_buffer\]**116117Этот формат принимает любой объект, реализующий интерфейс буфера для чтения-записи. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.6/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. Буфер может содержать встроенные нулевые байты. Вызывающая сторона должна вызвать [`PyBuffer_Release()`](https://python-all.ru/3.6/c-api/buffer.html#c.PyBuffer_Release), когда закончит работу с буфером.118119**`es` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer\]**120121Этот вариант `s` используется для кодирования Unicode в символьный буфер. Он работает только с закодированными данными без встроенных NUL-байтов.122123Этот формат требует двух аргументов. Первый используется только как входной и должен быть `const char*`, который указывает на имя кодировки в виде строки, завершающейся NUL, или *NULL*, и в этом случае используется кодировка `'utf-8'`. Исключение возбуждается, если указанная кодировка неизвестна Python. Второй аргумент должен быть `char**`; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, указанной первым аргументом.124125[`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple) выделит буфер нужного размера, скопирует закодированные данные в этот буфер и настроит *\*buffer* так, чтобы он ссылался на вновь выделенную память. Вызывающая сторона отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.6/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.126127**`et` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer\]**128129То же, что и `es`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.130131**`es#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer, int \*buffer\_length\]**132133Этот вариант `s#` используется для кодирования Unicode в символьный буфер. В отличие от формата `es`, этот вариант допускает входные данные, содержащие NUL-символы.134135Требуется три аргумента. Первый используется только как входной и должен быть `const char*`, который указывает на имя кодировки в виде строки, завершающейся NUL, или *NULL*, и в этом случае используется кодировка `'utf-8'`. Исключение возбуждается, если указанная кодировка неизвестна Python. Второй аргумент должен быть `char**`; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, указанной первым аргументом. Третий аргумент должен быть указателем на целое число; целое число, на которое он ссылается, будет установлено на количество байтов в выходном буфере.136137Существует два режима работы:138139Если *\*buffer* указывает на указатель *NULL*, функция выделит буфер нужного размера, скопирует закодированные данные в этот буфер и установит *\*buffer* так, чтобы он ссылался на новую выделенную память. Вызывающий отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.6/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.140141Если *\*buffer* указывает на указатель, не равный *NULL* (уже выделенный буфер), [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple) будет использовать это место как буфер и интерпретировать начальное значение *\*buffer\_length* как размер буфера. Затем он скопирует закодированные данные в буфер и завершит его NUL. Если буфер недостаточно велик, будет установлено значение [`ValueError`](https://python-all.ru/3.6/library/exceptions.html#ValueError).142143В обоих случаях *\*buffer\_length* устанавливается в длину закодированных данных без завершающего NUL-байта.144145**`et#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer, int \*buffer\_length\]**146147То же, что и `es#`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.148149### Числа150151**`b` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned char\]**152153Преобразует неотрицательное целое число Python в беззнаковое крошечное целое, хранящееся в C `unsigned char`.154155**`B` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned char\]**156157Преобразует целое число Python в крошечное целое без проверки переполнения, хранящееся в C `unsigned char`.158159**`h` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[short int\]**160161Преобразует целое число Python в C `short int`.162163**`H` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned short int\]**164165Преобразует целое число Python в C `unsigned short int` без проверки переполнения.166167**`i` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[int\]**168169Преобразует целое число Python в обычное C `int`.170171**`I` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned int\]**172173Преобразует целое число Python в C `unsigned int` без проверки переполнения.174175**`l` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[long int\]**176177Преобразует целое число Python в C `long int`.178179**`k` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned long\]**180181Преобразует целое число Python в C `unsigned long` без проверки переполнения.182183**`L` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[long long\]**184185Преобразует целое число Python в C `long long`.186187**`K` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned long long\]**188189Преобразует целое число Python в C-тип `unsigned long long` без проверки переполнения.190191**`n` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[Py\_ssize\_t\]**192193Преобразует целое число Python в C `Py_ssize_t`.194195**`c` ([`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray) длиной 1) \[char\]**196197Преобразует байт Python, представленный как объект [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray) длиной 1, в C-тип `char`.198199Изменено в версии 3.3: Допускаются объекты [`bytearray`](https://python-all.ru/3.6/library/stdtypes.html#bytearray).200201**`C` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) длины 1) \[int\]**202203Преобразует символ Python, представленный как объект [`str`](https://python-all.ru/3.6/library/stdtypes.html#str) длиной 1, в C-тип `int`.204205**`f` ([`float`](https://python-all.ru/3.6/library/functions.html#float)) \[float\]**206207Преобразует число с плавающей точкой Python в C-тип `float`.208209**`d` ([`float`](https://python-all.ru/3.6/library/functions.html#float)) \[double\]**210211Преобразует число с плавающей точкой Python в C-тип `double`.212213**`D` ([`complex`](https://python-all.ru/3.6/library/functions.html#complex)) \[Py\_complex\]**214215Преобразует комплексное число Python в структуру C [`Py_complex`](https://python-all.ru/3.6/c-api/complex.html#c.Py_complex).216217### Другие объекты218219**`O` (объект) \[PyObject \*\]**220221Сохраняет объект Python (без какого-либо преобразования) в указателе на объект C. Таким образом, программа на C получает фактически переданный объект. Счётчик ссылок объекта не увеличивается. Сохранённый указатель не равен *NULL*.222223**`O!` (object) \[*typeobject*, PyObject \*\]**224225Сохраняет объект Python в указателе на объект C. Это похоже на `O`, но принимает два аргумента C: первый – адрес объекта типа Python, второй – адрес C-переменной (типа [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject)), в которую сохраняется указатель на объект. Если объект Python не имеет требуемого типа, возбуждается [`TypeError`](https://python-all.ru/3.6/library/exceptions.html#TypeError).226227**`O&` (object) \[*конвертер*, *что угодно*\]**228229Преобразует объект Python в C-переменную с помощью функции-*преобразователя*. Она принимает два аргумента: первый – функция, второй – адрес C-переменной (произвольного типа), преобразованный в `void *`. Функция-*преобразователь*, в свою очередь, вызывается следующим образом:230231```c232status = converter(object, address);233```234235где *объект* – это преобразуемый объект Python, а *адрес* – это аргумент `void*`, переданный функции [`PyArg_Parse*()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_Parse). Возвращаемый *статус* должен быть `1` при успешном преобразовании и `0` при неудаче. При неудачном преобразовании функция-*преобразователь* должна возбудить исключение и оставить содержимое *адреса* без изменений.236237Если *преобразователь* возвращает `Py_CLEANUP_SUPPORTED`, он может быть вызван повторно в случае, если разбор аргументов в итоге завершится неудачей, что даёт преобразователю возможность освободить уже выделенную память. При этом втором вызове параметр *object* будет равен NULL; *address* будет иметь то же значение, что и в исходном вызове.238239Изменено в версии 3.1: `Py_CLEANUP_SUPPORTED` добавлен.240241**`p` ([`bool`](https://python-all.ru/3.6/library/functions.html#bool)) \[int\]**242243Проверяет переданное значение на истинность (булев предикат **p**) и преобразует результат в эквивалентное целое C true/false. Устанавливает int в `1`, если выражение истинно, и в `0`, если ложно. Принимает любое корректное значение Python. См. [Проверка истинности значений](https://python-all.ru/3.6/library/stdtypes.html#truth) для получения дополнительной информации о том, как Python проверяет значения на истинность.244245Новое в версии 3.3.246247**`(items)` ([`tuple`](https://python-all.ru/3.6/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**248249Объект должен быть последовательностью Python, длина которой равна количеству единиц формата в *элементах*. Аргументы C должны соответствовать отдельным единицам формата в *элементах*. Единицы формата для последовательностей могут быть вложенными.250251Можно передавать «длинные» целые числа (целые, значение которых превышает `LONG_MAX` платформы), однако надлежащая проверка диапазона не выполняется – старшие биты молча отбрасываются, если принимающее поле слишком мало для этого значения (на самом деле семантика унаследована от понижающих приведений в C – результаты могут отличаться).252253Некоторые другие символы имеют значение в строке формата. Они не могут встречаться внутри вложенных скобок. Вот они:254255**`|`**256257Указывает, что остальные аргументы в списке аргументов Python являются необязательными. Переменные C, соответствующие необязательным аргументам, должны быть инициализированы значением по умолчанию – когда необязательный аргумент не указан, [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple) не трогает содержимое соответствующих переменных C.258259**`$`**260261[`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) only: Указывает, что остальные аргументы в списке аргументов Python являются только ключевыми. В настоящее время все только ключевые аргументы также должны быть необязательными, поэтому `|` всегда должен указываться перед `$` в строке формата.262263Новое в версии 3.3.264265**`:`**266267Список единиц форматирования заканчивается здесь; строка после двоеточия используется как имя функции в сообщениях об ошибках («связанное значение» исключения, которое вызывает [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple)).268269**`;`**270271Список единиц форматирования заканчивается здесь; строка после точки с запятой используется как сообщение об ошибке *вместо* сообщения об ошибке по умолчанию. `:` и `;` взаимно исключают друг друга.272273Обратите внимание, что любые ссылки на объекты Python, передаваемые вызывающему, являются *заимствованными* ссылками; уменьшать их счётчик ссылок не следует.274275Дополнительные аргументы, передаваемые этим функциям, должны быть адресами переменных, тип которых определяется строкой формата; они используются для хранения значений из входного кортежа. Есть несколько случаев, как описано в списке единиц форматирования выше, когда эти параметры используются в качестве входных значений; в этом случае они должны соответствовать тому, что указано для соответствующей единицы форматирования.276277Для успешного преобразования объект *arg* должен соответствовать формату, и формат должен быть исчерпан. При успехе функции [`PyArg_Parse*()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_Parse) возвращают true, в противном случае они возвращают false и возбуждают соответствующее исключение. Когда функции [`PyArg_Parse*()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_Parse) завершаются ошибкой из-за неудачи преобразования в одной из единиц форматирования, переменные по адресам, соответствующим этой и последующим единицам форматирования, остаются нетронутыми.278279### API функции280281#### `int PyArg_ParseTuple(PyObject *args, const char *format, ...)`282283Разбирает параметры функции, принимающей только позиционные параметры, в локальные переменные. Возвращает true при успехе; при неудаче возвращает false и возбуждает соответствующее исключение.284285#### `int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)`286287Идентична [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple), за исключением того, что принимает va\_list вместо переменного числа аргументов.288289#### `int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)`290291Разбирает параметры функции, принимающей как позиционные, так и именованные аргументы, в локальные переменные. Аргумент *keywords* – это массив имён именованных параметров, завершающийся *NULL*. Пустые имена обозначают [только позиционные параметры](https://python-all.ru/3.6/glossary.html#positional-only-parameter). Возвращает истину при успехе; при ошибке возвращает ложь и возбуждает соответствующее исключение.292293Изменено в версии 3.6: Добавлена поддержка [только позиционных параметров](https://python-all.ru/3.6/glossary.html#positional-only-parameter).294295#### `int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)`296297Идентична [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTupleAndKeywords), но принимает va\_list вместо переменного числа аргументов.298299#### `int PyArg_ValidateKeywordArguments(PyObject *)`300301Гарантирует, что ключи в словаре аргументов-ключевых слов являются строками. Это нужно только в случае, если [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) не используется, поскольку последняя уже выполняет эту проверку.302303Новое в версии 3.2.304305#### `int PyArg_Parse(PyObject *args, const char *format, ...)`306307Функция, используемая для разбора списков аргументов функций «старого стиля» – это функции, использующие метод разбора параметров `METH_OLDARGS`, который был удалён в Python 3. Не рекомендуется использовать её для разбора параметров в новом коде; большая часть кода в стандартном интерпретаторе была изменена, чтобы больше не использовать её для этой цели. Однако она остаётся удобным способом разложения других кортежей и может продолжать использоваться для этого.308309#### `int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)`310311Упрощённый способ извлечения параметров, не использующий строку формата для указания типов аргументов. Функции, которые получают свои параметры таким образом, должны объявляться как [`METH_VARARGS`](https://python-all.ru/3.6/c-api/structures.html#METH_VARARGS) в таблицах функций или методов. Кортеж с фактическими параметрами должен передаваться как *args*; он обязательно должен быть кортежем. Длина кортежа должна быть не меньше *min* и не больше *max*; *min* и *max* могут быть равны. В функцию необходимо передать дополнительные аргументы, каждый из которых должен быть указателем на переменную типа [`PyObject*`](https://python-all.ru/3.6/c-api/structures.html#c.PyObject); они будут заполнены значениями из *args* и будут содержать заимствованные ссылки. Переменные, соответствующие необязательным параметрам, отсутствующим в *args*, заполнены не будут; их следует инициализировать вызывающей стороне. Эта функция возвращает true при успехе и false, если *args* не является кортежем или содержит неверное количество элементов; в случае ошибки устанавливается исключение.312313Это пример использования этой функции, взятый из исходных кодов вспомогательного модуля для слабых ссылок `_weakref`:314315```c316static PyObject *317weakref_ref(PyObject *self, PyObject *args)318{319    PyObject *object;320    PyObject *callback = NULL;321    PyObject *result = NULL;322323    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {324        result = PyWeakref_NewRef(object, callback);325    }326    return result;327}328```329330Вызов [`PyArg_UnpackTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_UnpackTuple) в этом примере полностью эквивалентен вызову [`PyArg_ParseTuple()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_ParseTuple):331332```c333PyArg_ParseTuple(args, "O|O:ref", &object, &callback)334```335336## Построение значений337338#### `PyObject* Py_BuildValue(const char *format, ...)`339340*Возвращаемое значение: новая ссылка.*341342Создаёт новое значение на основе строки формата, аналогичной используемым в семействе функций [`PyArg_Parse*()`](https://python-all.ru/3.6/c-api/arg.html#c.PyArg_Parse), и последовательности значений. Возвращает значение или *NULL* в случае ошибки; если возвращён *NULL*, будет возбуждено исключение.343344[`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue) не всегда строит кортеж. Он строит кортеж, только если строка формата содержит два или более элемента формата. Если строка формата пуста, возвращается `None`; если она содержит ровно один элемент формата, возвращается объект, описываемый этим элементом. Чтобы принудительно вернуть кортеж размера 0 или 1, заключите строку формата в скобки.345346Когда буферы памяти передаются как параметры для предоставления данных для создания объектов, как для форматов `s` и `s#`, необходимые данные копируются. Буферы, предоставленные вызывающим, никогда не используются напрямую объектами, созданными с помощью [`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue). Другими словами, если ваш код вызывает `malloc()` и передает выделенную память в [`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue), ваш код отвечает за вызов `free()` для этой памяти после того, как [`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue) вернет управление.347348В следующем описании форма в кавычках – это элемент формата; запись в круглых скобках – это тип объекта Python, который вернёт элемент формата; а запись в квадратных скобках – это тип передаваемого(-ых) значения(-ий) C.349350Символы пробела, табуляции, двоеточия и запятой в строках формата игнорируются (но не внутри элементов формата, таких как `s#`). Это можно использовать, чтобы сделать длинные строки формата чуть более читаемыми.351352**`s` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*\]**353354Преобразует C-строку с нулевым символом на конце в объект Python [`str`](https://python-all.ru/3.6/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен *NULL*, используется `None`.355356**`s#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*, int\]**357358Преобразует C-строку и её длину в объект Python [`str`](https://python-all.ru/3.6/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен *NULL*, длина игнорируется и возвращается `None`.359360**`y` ([`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes)) \[char \*\]**361362Преобразует C-строку в объект Python [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes). Если указатель на C-строку равен *NULL*, возвращается `None`.363364**`y#` ([`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes)) \[char \*, int\]**365366Преобразует C-строку и её длину в объект Python. Если указатель на C-строку равен *NULL*, возвращается `None`.367368**`z` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*\]**369370То же, что и `s`.371372**`z#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*, int\]**373374То же, что и `s#`.375376**`u` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[wchar\_t \*\]**377378Преобразует буфер `wchar_t` данных Unicode (UTF-16 или UCS-4) с нулевым символом на конце в объект Python Unicode. Если указатель на буфер Unicode равен *NULL*, возвращается `None`.379380**`u#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str)) \[wchar\_t \*, int\]**381382Преобразует буфер данных Unicode (UTF-16 или UCS-4) и его длину в объект Python Unicode. Если указатель на буфер Unicode равен *NULL*, длина игнорируется и возвращается `None`.383384**`U` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*\]**385386То же, что и `s`.387388**`U#` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) or `None`) \[char \*, int\]**389390То же, что и `s#`.391392**`i` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[int\]**393394Преобразует простой C-тип `int` в объект целого числа Python.395396**`b` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[char\]**397398Преобразует простой C-тип `char` в объект целого числа Python.399400**`h` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[short int\]**401402Преобразует простой C-тип `short int` в объект целого числа Python.403404**`l` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[long int\]**405406Преобразует C `long int` в объект Python int.407408**`B` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned char\]**409410Преобразует C `unsigned char` в объект Python int.411412**`H` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned short int\]**413414Преобразует C `unsigned short int` в объект Python int.415416**`I` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned int\]**417418Преобразует C `unsigned int` в объект Python int.419420**`k` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned long\]**421422Преобразует C `unsigned long` в объект Python int.423424**`L` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[long long\]**425426Преобразует C `long long` в объект Python int.427428**`K` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[unsigned long long\]**429430Преобразует C `unsigned long long` в объект Python int.431432**`n` ([`int`](https://python-all.ru/3.6/library/functions.html#int)) \[Py\_ssize\_t\]**433434Преобразует C `Py_ssize_t` в целое число Python.435436**`c` ([`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) длины 1) \[char\]**437438Преобразует C `int`, представляющий байт, в объект [`bytes`](https://python-all.ru/3.6/library/stdtypes.html#bytes) Python длиной 1.439440**`C` ([`str`](https://python-all.ru/3.6/library/stdtypes.html#str) длины 1) \[int\]**441442Преобразует C `int`, представляющий символ, в объект [`str`](https://python-all.ru/3.6/library/stdtypes.html#str) Python длиной 1.443444**`d` ([`float`](https://python-all.ru/3.6/library/functions.html#float)) \[double\]**445446Преобразует C `double` в Python-число с плавающей запятой.447448**`f` ([`float`](https://python-all.ru/3.6/library/functions.html#float)) \[float\]**449450Преобразует C `float` в Python-число с плавающей запятой.451452**`D` ([`complex`](https://python-all.ru/3.6/library/functions.html#complex)) \[Py\_complex \*\]**453454Преобразует структуру C [`Py_complex`](https://python-all.ru/3.6/c-api/complex.html#c.Py_complex) в комплексное число Python.455456**`O` (объект) \[PyObject \*\]**457458Передаёт Python-объект без изменений (за исключением его счётчика ссылок, который увеличивается на единицу). Если переданный объект является указателем *NULL*, считается, что это произошло из-за того, что вызов, формирующий аргумент, обнаружил ошибку и установил исключение. Следовательно, [`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue) вернёт *NULL*, но не вызовет исключение. Если исключение ещё не было вызвано, устанавливается [`SystemError`](https://python-all.ru/3.6/library/exceptions.html#SystemError).459460**`S` (объект) \[PyObject \*\]**461462То же, что и `O`.463464**`N` (объект) \[PyObject \*\]**465466То же, что и `O`, за исключением того, что не увеличивает счётчик ссылок на объект. Полезно, когда объект создаётся вызовом конструктора объекта в списке аргументов.467468**`O&` (object) \[*конвертер*, *что угодно*\]**469470Преобразует *что угодно* в Python-объект с помощью *функции-преобразователя*. Функция вызывается с *чем угодно* (которое должно быть совместимо с `void *`) в качестве аргумента и должна вернуть «новый» Python-объект или *NULL*, если произошла ошибка.471472**`(items)` ([`tuple`](https://python-all.ru/3.6/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**473474Преобразует последовательность значений C в кортеж Python с тем же количеством элементов.475476**`[items]` ([`list`](https://python-all.ru/3.6/library/stdtypes.html#list)) \[*соответствующие элементы*\]**477478Преобразует последовательность значений C в список Python с тем же количеством элементов.479480**`{items}` ([`dict`](https://python-all.ru/3.6/library/stdtypes.html#dict)) \[*соответствующие элементы*\]**481482Преобразует последовательность значений C в словарь Python. Каждая пара последовательных значений C добавляет один элемент в словарь, выступая в роли ключа и значения соответственно.483484Если в строке формата есть ошибка, устанавливается исключение [`SystemError`](https://python-all.ru/3.6/library/exceptions.html#SystemError) и возвращается *NULL*.485486#### `PyObject* Py_VaBuildValue(const char *format, va_list vargs)`487488Идентична [`Py_BuildValue()`](https://python-all.ru/3.6/c-api/arg.html#c.Py_BuildValue), за исключением того, что принимает va\_list вместо переменного числа аргументов.489