> **Источник:** https://python-all.ru/3.10/c-api/arg.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

# Разбор аргументов и построение значений

Эти функции полезны при создании собственных функций и методов расширений. Дополнительная информация и примеры доступны в [Расширение и встраивание интерпретатора Python](https://python-all.ru/3.10/extending/index.html#extending-index).

Первые три из описанных функций, [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple), [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) и [`PyArg_Parse()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_Parse), используют *строки формата*, которые сообщают функции об ожидаемых аргументах. Строки формата имеют одинаковый синтаксис для каждой из этих функций.

## Разбор аргументов

Строка формата состоит из нуля или более «единиц формата». Единица формата описывает один объект Python; обычно это один символ или заключённая в скобки последовательность единиц формата. За несколькими исключениями, единица формата, не являющаяся последовательностью в скобках, обычно соответствует одному аргументу-адресу этих функций. В следующем описании приведённая в кавычках форма – это единица формата; запись в круглых скобках – тип объекта Python, которому соответствует единица формата; а запись в квадратных скобках – тип переменной(ых) C, чей адрес следует передать.

### Строки и буферы

Эти форматы позволяют обращаться к объекту как к непрерывному блоку памяти. Не нужно предоставлять сырое хранилище для возвращаемой области unicode или bytes.

Если не указано иное, буферы не завершаются нулевым символом (NUL).

Существует три способа преобразования строк и буферов в C:

- Форматы, такие как `y*` и `s*`, заполняют структуру [`Py_buffer`](https://python-all.ru/3.10/c-api/buffer.html#c.Py_buffer). Это блокирует нижележащий буфер, чтобы вызывающий код мог впоследствии использовать буфер даже внутри блока [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.10/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) без риска изменения размера или уничтожения изменяемых данных. В результате **необходимо вызывать** [`PyBuffer_Release()`](https://python-all.ru/3.10/c-api/buffer.html#c.PyBuffer_Release) после завершения обработки данных (или в случае досрочного прерывания).
- Форматы `es`, `es#`, `et` и `et#` выделяют буфер для результата. **Необходимо вызывать** [`PyMem_Free()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_Free) после завершения обработки данных (или в случае досрочного прерывания).
- Другие форматы принимают [`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или [байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) только для чтения, такой как [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes), и предоставляют указатель `const char *` на его буфер. В этом случае буфер является «заимствованным»: он управляется соответствующим объектом Python и разделяет время жизни этого объекта. Самостоятельно освобождать память не потребуется.

  Чтобы гарантировать возможность безопасного заимствования базового буфера, поле [`PyBufferProcs.bf_releasebuffer`](https://python-all.ru/3.10/c-api/typeobj.html#c.PyBufferProcs.bf_releasebuffer) объекта должно быть `NULL`. Это исключает обычные изменяемые объекты, такие как [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray), но также и некоторые объекты только для чтения, такие как [`memoryview`](https://python-all.ru/3.10/library/stdtypes.html#memoryview) из [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes).

  Кроме этого требования `bf_releasebuffer`, не существует проверки на то, является ли входной объект неизменяемым (например, будет ли он выполнять запрос на буфер для записи или сможет ли другой поток изменить данные).

> **Примечание**
>
> Для всех вариантов формата `#` (`s#`, `y#` и т. д.), макрос `PY_SSIZE_T_CLEAN` должен быть определён до включения `Python.h`. На Python 3.9 и старше, тип аргумента длины равен [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t), если определён макрос `PY_SSIZE_T_CLEAN`, иначе int.

**`s` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const char \*\]**

Преобразует объект Unicode в указатель C на строку символов. Указатель на существующую строку сохраняется в переменной-указателе на символ, адрес которой передаётся. Строка C заканчивается нулевым символом (NUL). Строка Python не должна содержать встроенные нулевые кодовые точки; если содержит, возбуждается исключение [`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`. Если это преобразование не удаётся, возбуждается [`UnicodeError`](https://python-all.ru/3.10/library/exceptions.html#UnicodeError).

> **Примечание**
>
> Этот формат не принимает [байтоподобные объекты](https://python-all.ru/3.10/glossary.html#term-bytes-like-object). Если требуется принимать пути файловой системы и преобразовывать их в строки символов C, предпочтительнее использовать формат `O&` с [`PyUnicode_FSConverter()`](https://python-all.ru/3.10/c-api/unicode.html#c.PyUnicode_FSConverter) в качестве *конвертера*.

Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) возбуждалось, когда в строке Python обнаруживались встроенные нулевые кодовые точки.

**`s*` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или [байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**

Этот формат принимает как объекты Unicode, так и байтоподобные объекты. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.10/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. В этом случае результирующая строка C может содержать встроенные нулевые байты (NUL). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`.

**`s#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) только для чтения) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Как `s*`, за исключением того, что предоставляет [заимствованный буфер](https://python-all.ru/3.10/c-api/arg.html#c-arg-borrowed-buffer). Результат сохраняется в две переменные C: первая – указатель на строку C, вторая – её длина. Строка может содержать встроенные нулевые байты. Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`.

**`z` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*\]**

Как `s`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в `NULL`.

**`z*` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) или `None`) \[Py\_buffer\]**

Как `s*`, но объект Python также может быть `None`, и в этом случае элемент `buf` структуры [`Py_buffer`](https://python-all.ru/3.10/c-api/buffer.html#c.Py_buffer) устанавливается в `NULL`.

**`z#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) только для чтения или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Как `s#`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в `NULL`.

**`y` ([байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) только для чтения) \[const char \*\]**

Этот формат преобразует байтоподобный объект в указатель C на [заимствованную](https://python-all.ru/3.10/c-api/arg.html#c-arg-borrowed-buffer) строку символов; он не принимает объекты Unicode. Байтовый буфер не должен содержать встроенные нулевые байты; если содержит, возбуждается исключение [`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError).

Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) возбуждалось, когда в байтовом буфере обнаруживались встроенные нулевые байты.

**`y*` ([байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**

Этот вариант `s*` не принимает объекты Unicode, только байтоподобные объекты. **Это рекомендуемый способ приёма двоичных данных.**

**`y#` ([байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) только для чтения) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Этот вариант `s#` не принимает объекты Unicode, только байтоподобные объекты.

**`S` ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes)) \[PyBytesObject \*\]**

Требует, чтобы объект Python был объектом [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes), без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект не является объектом bytes. Переменная C также может быть объявлена как `PyObject*`.

**`Y` ([`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray)) \[PyByteArrayObject \*\]**

Требует, чтобы объект Python был объектом [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray), без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект не является объектом [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray). Переменная C также может быть объявлена как `PyObject*`.

**`u` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const Py\_UNICODE \*\]**

Преобразует объект Unicode Python в указатель C на NUL-завершенный буфер символов Unicode. Необходимо передать адрес переменной-указателя [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE), которая будет заполнена указателем на существующий буфер Unicode. Обратите внимание, что ширина символа [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE) зависит от параметров компиляции (16 или 32 бита). Строка Python не должна содержать встроенных нулевых кодовых точек; если они есть, возбуждается исключение [`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError).

Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError) возбуждалось, когда в строке Python обнаруживались встроенные нулевые кодовые точки.

Устарело с версии 3.3, будет удалено в версии 3.12: Часть старого стиля API [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE); выполните миграцию на [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.10/c-api/unicode.html#c.PyUnicode_AsWideCharString).

**`u#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const Py\_UNICODE \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Этот вариант `u` сохраняет значения в две переменные C: первую – указатель на буфер данных Unicode, вторую – его длину. Этот вариант допускает нулевые кодовые точки.

Устарело с версии 3.3, будет удалено в версии 3.12: Часть старого стиля API [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE); выполните миграцию на [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.10/c-api/unicode.html#c.PyUnicode_AsWideCharString).

**`Z` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) or `None`) \[const Py\_UNICODE \*\]**

Как `u`, но объект Python также может быть `None`; в этом случае указатель [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE) устанавливается в `NULL`.

Устарело с версии 3.3, будет удалено в версии 3.12: Часть старого стиля API [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE); выполните миграцию на [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.10/c-api/unicode.html#c.PyUnicode_AsWideCharString).

**`Z#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) or `None`) \[const Py\_UNICODE \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Как `u#`, но объект Python также может быть `None`; в этом случае указатель [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE) устанавливается в `NULL`.

Устарело с версии 3.3, будет удалено в версии 3.12: Часть старого стиля API [`Py_UNICODE`](https://python-all.ru/3.10/c-api/unicode.html#c.Py_UNICODE); выполните миграцию на [`PyUnicode_AsWideCharString()`](https://python-all.ru/3.10/c-api/unicode.html#c.PyUnicode_AsWideCharString).

**`U` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[PyObject \*\]**

Требует, чтобы объект Python был объектом Unicode, без попыток преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError), если объект не является объектом Unicode. Переменная C также может быть объявлена как `PyObject*`.

**`w*` ([байтоподобный объект](https://python-all.ru/3.10/glossary.html#term-bytes-like-object) для чтения и записи) \[Py\_buffer\]**

Этот формат принимает любой объект, реализующий интерфейс буфера для чтения-записи. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.10/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. Буфер может содержать встроенные нулевые байты. Вызывающая сторона должна вызвать [`PyBuffer_Release()`](https://python-all.ru/3.10/c-api/buffer.html#c.PyBuffer_Release), когда закончит работу с буфером.

**`es` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer\]**

Этот вариант `s` используется для кодирования Unicode в символьный буфер. Он работает только с закодированными данными без встроенных NUL-байтов.

Этот формат требует два аргумента. Первый используется только как входной и должен быть `const char*`, указывающим на имя кодировки в виде строки, завершающейся нулевым символом, или `NULL`, и в этом случае используется кодировка `'utf-8'`. Исключение возбуждается, если указанная кодировка неизвестна Python. Второй аргумент должен быть `char**`; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, указанной первым аргументом.

[`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple) выделит буфер нужного размера, скопирует закодированные данные в этот буфер и настроит *\*buffer* так, чтобы он ссылался на вновь выделенную память. Вызывающая сторона отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.

**`et` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer\]**

То же, что и `es`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.

**`es#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t) \*buffer\_length\]**

Этот вариант `s#` используется для кодирования Unicode в символьный буфер. В отличие от формата `es`, этот вариант допускает входные данные, содержащие NUL-символы.

Требует три аргумента. Первый используется только как входной и должен быть `const char*`, указывающим на имя кодировки в виде строки, завершающейся нулевым символом, или `NULL`, и в этом случае используется кодировка `'utf-8'`. Исключение возбуждается, если указанная кодировка неизвестна Python. Второй аргумент должен быть `char**`; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, указанной первым аргументом. Третий аргумент должен быть указателем на целое число; указанное целое число будет установлено на количество байтов в выходном буфере.

Существует два режима работы:

Если *\*buffer* указывает на указатель `NULL`, функция выделит буфер нужного размера, скопирует закодированные данные в этот буфер и установит *\*buffer* так, чтобы он ссылался на вновь выделенную память. Вызывающая сторона отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.

Если *\*buffer* указывает на не-`NULL` указатель (уже выделенный буфер), [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple) будет использовать это место как буфер и интерпретировать начальное значение *\*buffer\_length* как размер буфера. Затем он скопирует закодированные данные в буфер и завершит их NUL. Если буфер недостаточно велик, будет установлено [`ValueError`](https://python-all.ru/3.10/library/exceptions.html#ValueError).

В обоих случаях *\*buffer\_length* устанавливается в длину закодированных данных без завершающего NUL-байта.

**`et#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t) \*buffer\_length\]**

То же, что и `es#`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.

### Числа

**`b` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned char\]**

Преобразует неотрицательное целое число Python в беззнаковое крошечное целое, хранящееся в C `unsigned char`.

**`B` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned char\]**

Преобразует целое число Python в крошечное целое без проверки переполнения, хранящееся в C `unsigned char`.

**`h` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[short int\]**

Преобразует целое число Python в C `short int`.

**`H` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned short int\]**

Преобразует целое число Python в C `unsigned short int` без проверки переполнения.

**`i` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[int\]**

Преобразует целое число Python в обычное C `int`.

**`I` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned int\]**

Преобразует целое число Python в C `unsigned int` без проверки переполнения.

**`l` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[long int\]**

Преобразует целое число Python в C `long int`.

**`k` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned long\]**

Преобразует целое число Python в C `unsigned long` без проверки переполнения.

**`L` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[long long\]**

Преобразует целое число Python в C `long long`.

**`K` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned long long\]**

Преобразует целое число Python в C-тип `unsigned long long` без проверки переполнения.

**`n` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[[`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Преобразует целое число Python в C [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t).

**`c` ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray) длиной 1) \[char\]**

Преобразует байт Python, представленный как объект [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray) длиной 1, в C-тип `char`.

Изменено в версии 3.3: Допускаются объекты [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray).

**`C` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) длины 1) \[int\]**

Преобразует символ Python, представленный как объект [`str`](https://python-all.ru/3.10/library/stdtypes.html#str) длиной 1, в C-тип `int`.

**`f` ([`float`](https://python-all.ru/3.10/library/functions.html#float)) \[float\]**

Преобразует число с плавающей точкой Python в C-тип `float`.

**`d` ([`float`](https://python-all.ru/3.10/library/functions.html#float)) \[double\]**

Преобразует число с плавающей точкой Python в C-тип `double`.

**`D` ([`complex`](https://python-all.ru/3.10/library/functions.html#complex)) \[Py\_complex\]**

Преобразует комплексное число Python в структуру C [`Py_complex`](https://python-all.ru/3.10/c-api/complex.html#c.Py_complex).

### Другие объекты

**`O` (объект) \[PyObject \*\]**

Сохраняет объект Python (без преобразования) в указателе на объект C. Таким образом, программа на C получает фактически переданный объект. Новая [сильная ссылка](https://python-all.ru/3.10/glossary.html#term-strong-reference) на объект не создается (т.е. его счетчик ссылок не увеличивается). Сохраненный указатель не является `NULL`.

**`O!` (object) \[*typeobject*, PyObject \*\]**

Сохраняет объект Python в указателе на объект C. Это похоже на `O`, но принимает два аргумента C: первый – адрес объекта типа Python, второй – адрес C-переменной (типа `PyObject*`), в которую сохраняется указатель на объект. Если объект Python не имеет требуемого типа, возбуждается [`TypeError`](https://python-all.ru/3.10/library/exceptions.html#TypeError).

**`O&` (object) \[*конвертер*, *что угодно*\]**

Преобразует объект Python в C-переменную с помощью функции-*преобразователя*. Она принимает два аргумента: первый – функция, второй – адрес C-переменной (произвольного типа), преобразованный в `void*`. Функция-*преобразователь*, в свою очередь, вызывается следующим образом:

```c
status = converter(object, address);
```

где *объект* – это преобразуемый объект Python, а *адрес* – это аргумент `void*`, переданный функции `PyArg_Parse*`. Возвращаемый *статус* должен быть `1` при успешном преобразовании и `0` при неудаче. При неудачном преобразовании функция-*преобразователь* должна возбудить исключение и оставить содержимое *адреса* без изменений.

Если *конвертер* возвращает `Py_CLEANUP_SUPPORTED`, он может быть вызван повторно, если в конечном итоге разбор аргументов завершится неудачей, давая конвертеру возможность освободить память, которую он уже выделил. При повторном вызове параметр *object* будет равен `NULL`; *address* будет иметь то же значение, что и при первоначальном вызове.

Изменено в версии 3.1: `Py_CLEANUP_SUPPORTED` добавлен.

**`p` ([`bool`](https://python-all.ru/3.10/library/functions.html#bool)) \[int\]**

Проверяет переданное значение на истинность (булев предикат **p**) и преобразует результат в эквивалентное целое C true/false. Устанавливает int в `1`, если выражение истинно, и в `0`, если ложно. Принимает любое корректное значение Python. См. [Проверка истинности значений](https://python-all.ru/3.10/library/stdtypes.html#truth) для получения дополнительной информации о том, как Python проверяет значения на истинность.

Новое в версии 3.3.

**`(items)` ([`tuple`](https://python-all.ru/3.10/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**

Объект должен быть последовательностью Python, длина которой равна количеству единиц формата в *элементах*. Аргументы C должны соответствовать отдельным единицам формата в *элементах*. Единицы формата для последовательностей могут быть вложенными.

Можно передавать «длинные» целые числа (целые, значение которых превышает `LONG_MAX` платформы), однако надлежащая проверка диапазона не выполняется – старшие биты молча отбрасываются, если принимающее поле слишком мало для этого значения (на самом деле семантика унаследована от понижающих приведений в C – результаты могут отличаться).

Некоторые другие символы имеют значение в строке формата. Они не могут встречаться внутри вложенных скобок. Вот они:

**`|`**

Указывает, что остальные аргументы в списке аргументов Python являются необязательными. Переменные C, соответствующие необязательным аргументам, должны быть инициализированы значением по умолчанию – когда необязательный аргумент не указан, [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple) не трогает содержимое соответствующих переменных C.

**`$`**

[`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) only: Указывает, что остальные аргументы в списке аргументов Python являются только ключевыми. В настоящее время все только ключевые аргументы также должны быть необязательными, поэтому `|` всегда должен указываться перед `$` в строке формата.

Новое в версии 3.3.

**`:`**

Список единиц форматирования заканчивается здесь; строка после двоеточия используется как имя функции в сообщениях об ошибках («связанное значение» исключения, которое вызывает [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple)).

**`;`**

Список единиц форматирования заканчивается здесь; строка после точки с запятой используется как сообщение об ошибке *вместо* сообщения об ошибке по умолчанию. `:` и `;` взаимно исключают друг друга.

Обратите внимание, что все ссылки на объекты Python, предоставляемые вызывающей стороне, являются *заимствованными* ссылками; не освобождайте их (т.е. не уменьшайте их счетчик ссылок)!

Дополнительные аргументы, передаваемые этим функциям, должны быть адресами переменных, тип которых определяется строкой формата; они используются для хранения значений из входного кортежа. Есть несколько случаев, как описано в списке единиц форматирования выше, когда эти параметры используются в качестве входных значений; в этом случае они должны соответствовать тому, что указано для соответствующей единицы форматирования.

Для успешного преобразования объект *arg* должен соответствовать формату, и формат должен быть исчерпан. При успехе функции `PyArg_Parse*` возвращают true, в противном случае они возвращают false и возбуждают соответствующее исключение. Когда функции `PyArg_Parse*` завершаются ошибкой из-за неудачи преобразования в одной из единиц форматирования, переменные по адресам, соответствующим этой и последующим единицам форматирования, остаются нетронутыми.

### API функции

#### `int PyArg_ParseTuple(PyObject *args, const char *format, ...)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Разбирает параметры функции, принимающей только позиционные параметры, в локальные переменные. Возвращает true при успехе; при неудаче возвращает false и возбуждает соответствующее исключение.

#### `int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Идентична [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple), за исключением того, что принимает va\_list вместо переменного числа аргументов.

#### `int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Разбирает параметры функции, которая принимает как позиционные, так и ключевые параметры, в локальные переменные. Аргумент *keywords* – это массив имён ключевых параметров, завершающийся `NULL`. Пустые имена обозначают [только позиционные параметры](https://python-all.ru/3.10/glossary.html#positional-only-parameter). Возвращает true в случае успеха; в случае неудачи возвращает false и возбуждает соответствующее исключение.

Изменено в версии 3.6: Добавлена поддержка [только позиционных параметров](https://python-all.ru/3.10/glossary.html#positional-only-parameter).

#### `int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Идентична [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTupleAndKeywords), но принимает va\_list вместо переменного числа аргументов.

#### `int PyArg_ValidateKeywordArguments(PyObject*)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Гарантирует, что ключи в словаре аргументов-ключевых слов являются строками. Это нужно только в случае, если [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) не используется, поскольку последняя уже выполняет эту проверку.

Новое в версии 3.2.

#### `int PyArg_Parse(PyObject *args, const char *format, ...)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Функция, используемая для разбора списков аргументов функций «старого стиля» – это функции, использующие метод разбора параметров `METH_OLDARGS`, который был удалён в Python 3. Не рекомендуется использовать её для разбора параметров в новом коде; большая часть кода в стандартном интерпретаторе была изменена, чтобы больше не использовать её для этой цели. Однако она остаётся удобным способом разложения других кортежей и может продолжать использоваться для этого.

#### `int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)`

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Более простая форма извлечения параметров, не использующая строку формата для указания типов аргументов. Функции, использующие этот метод для извлечения своих параметров, должны объявляться как [`METH_VARARGS`](https://python-all.ru/3.10/c-api/structures.html#METH_VARARGS) в таблицах функций или методов. Кортеж, содержащий фактические параметры, должен передаваться как *args*; он должен быть именно кортежем. Длина кортежа должна быть не менее *min* и не более *max*; *min* и *max* могут быть равны. Дополнительные аргументы должны передаваться функции, каждый из которых должен быть указателем на переменную `PyObject*`; они будут заполнены значениями из *args*; они будут содержать [заимствованные ссылки](https://python-all.ru/3.10/glossary.html#term-borrowed-reference). Переменные, соответствующие необязательным параметрам, не указанным в *args*, не будут заполнены; их должен инициализировать вызывающий код. Эта функция возвращает true в случае успеха и false, если *args* не является кортежем или содержит неверное количество элементов; в случае ошибки будет установлено исключение.

Это пример использования этой функции, взятый из исходных кодов вспомогательного модуля для слабых ссылок `_weakref`:

```c
static PyObject *
weakref_ref(PyObject *self, PyObject *args)
{
    PyObject *object;
    PyObject *callback = NULL;
    PyObject *result = NULL;

    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {
        result = PyWeakref_NewRef(object, callback);
    }
    return result;
}
```

Вызов [`PyArg_UnpackTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_UnpackTuple) в этом примере полностью эквивалентен вызову [`PyArg_ParseTuple()`](https://python-all.ru/3.10/c-api/arg.html#c.PyArg_ParseTuple):

```c
PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
```

## Построение значений

#### `PyObject *Py_BuildValue(const char *format, ...)`

*Возвращаемое значение: новая ссылка.*

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Создает новое значение на основе строки формата, аналогичной тем, что принимаются семейством функций `PyArg_Parse*`, и последовательности значений. Возвращает значение или `NULL` в случае ошибки; будет возбуждено исключение, если возвращается `NULL`.

[`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue) не всегда строит кортеж. Он строит кортеж, только если строка формата содержит два или более элемента формата. Если строка формата пуста, возвращается `None`; если она содержит ровно один элемент формата, возвращается объект, описываемый этим элементом. Чтобы принудительно вернуть кортеж размера 0 или 1, заключите строку формата в скобки.

Когда буферы памяти передаются как параметры для предоставления данных для создания объектов, как для форматов `s` и `s#`, необходимые данные копируются. Буферы, предоставленные вызывающим, никогда не используются напрямую объектами, созданными с помощью [`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue). Другими словами, если ваш код вызывает `malloc()` и передает выделенную память в [`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue), ваш код отвечает за вызов `free()` для этой памяти после того, как [`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue) вернет управление.

В следующем описании форма в кавычках – это элемент формата; запись в круглых скобках – это тип объекта Python, который вернёт элемент формата; а запись в квадратных скобках – это тип передаваемого(-ых) значения(-ий) C.

Символы пробела, табуляции, двоеточия и запятой в строках формата игнорируются (но не внутри элементов формата, таких как `s#`). Это можно использовать, чтобы сделать длинные строки формата чуть более читаемыми.

**`s` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*\]**

Преобразует C-строку, завершающуюся нулём, в объект Python [`str`](https://python-all.ru/3.10/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен `NULL`, используется `None`.

**`s#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Преобразует C-строку и её длину в объект Python [`str`](https://python-all.ru/3.10/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен `NULL`, длина игнорируется и возвращается `None`.

**`y` ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes)) \[const char \*\]**

Преобразует C-строку в объект Python [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes). Если указатель на C-строку равен `NULL`, возвращается `None`.

**`y#` ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes)) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Преобразует C-строку и её длину в объект Python. Если указатель на C-строку равен `NULL`, возвращается `None`.

**`z` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*\]**

То же, что и `s`.

**`z#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

То же, что и `s#`.

**`u` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const wchar\_t \*\]**

Преобразует буфер `wchar_t` данных Unicode (UTF-16 или UCS-4), завершающийся нулём, в объект Python Unicode. Если указатель на буфер Unicode равен `NULL`, возвращается `None`.

**`u#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str)) \[const wchar\_t \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Преобразует буфер данных Unicode (UTF-16 или UCS-4) и его длину в объект Python Unicode. Если указатель на буфер Unicode равен `NULL`, длина игнорируется и возвращается `None`.

**`U` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*\]**

То же, что и `s`.

**`U#` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

То же, что и `s#`.

**`i` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[int\]**

Преобразует простой C-тип `int` в объект целого числа Python.

**`b` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[char\]**

Преобразует простой C-тип `char` в объект целого числа Python.

**`h` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[short int\]**

Преобразует простой C-тип `short int` в объект целого числа Python.

**`l` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[long int\]**

Преобразует C `long int` в объект Python int.

**`B` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned char\]**

Преобразует C `unsigned char` в объект Python int.

**`H` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned short int\]**

Преобразует C `unsigned short int` в объект Python int.

**`I` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned int\]**

Преобразует C `unsigned int` в объект Python int.

**`k` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned long\]**

Преобразует C `unsigned long` в объект Python int.

**`L` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[long long\]**

Преобразует C `long long` в объект Python int.

**`K` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[unsigned long long\]**

Преобразует C `unsigned long long` в объект Python int.

**`n` ([`int`](https://python-all.ru/3.10/library/functions.html#int)) \[[`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t)\]**

Преобразует C [`Py_ssize_t`](https://python-all.ru/3.10/c-api/intro.html#c.Py_ssize_t) в целое число Python.

**`c` ([`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) длины 1) \[char\]**

Преобразует C `int`, представляющий байт, в объект [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes) Python длиной 1.

**`C` ([`str`](https://python-all.ru/3.10/library/stdtypes.html#str) длины 1) \[int\]**

Преобразует C `int`, представляющий символ, в объект [`str`](https://python-all.ru/3.10/library/stdtypes.html#str) Python длиной 1.

**`d` ([`float`](https://python-all.ru/3.10/library/functions.html#float)) \[double\]**

Преобразует C `double` в Python-число с плавающей запятой.

**`f` ([`float`](https://python-all.ru/3.10/library/functions.html#float)) \[float\]**

Преобразует C `float` в Python-число с плавающей запятой.

**`D` ([`complex`](https://python-all.ru/3.10/library/functions.html#complex)) \[Py\_complex \*\]**

Преобразует структуру C [`Py_complex`](https://python-all.ru/3.10/c-api/complex.html#c.Py_complex) в комплексное число Python.

**`O` (объект) \[PyObject \*\]**

Передаёт объект Python без изменений, но создаёт новую [сильную ссылку](https://python-all.ru/3.10/glossary.html#term-strong-reference) на него (т.е. его счётчик ссылок увеличивается на единицу). Если переданный объект является указателем `NULL`, предполагается, что это произошло потому, что вызов, создавший аргумент, обнаружил ошибку и установил исключение. Поэтому [`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue) вернёт `NULL`, но не вызовет исключение. Если ещё не было установлено исключение, устанавливается [`SystemError`](https://python-all.ru/3.10/library/exceptions.html#SystemError).

**`S` (объект) \[PyObject \*\]**

То же, что и `O`.

**`N` (объект) \[PyObject \*\]**

То же, что и `O`, за исключением того, что не создаёт новую [сильную ссылку](https://python-all.ru/3.10/glossary.html#term-strong-reference). Полезно, когда объект создаётся вызовом конструктора объекта в списке аргументов.

**`O&` (object) \[*конвертер*, *что угодно*\]**

Преобразует *произвольное значение* в объект Python с помощью функции *конвертера*. Функция вызывается с *произвольным значением* (которое должно быть совместимо с `void*`) в качестве аргумента и должна возвращать «новый» объект Python или `NULL`, если произошла ошибка.

**`(items)` ([`tuple`](https://python-all.ru/3.10/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**

Преобразует последовательность значений C в кортеж Python с тем же количеством элементов.

**`[items]` ([`list`](https://python-all.ru/3.10/library/stdtypes.html#list)) \[*соответствующие элементы*\]**

Преобразует последовательность значений C в список Python с тем же количеством элементов.

**`{items}` ([`dict`](https://python-all.ru/3.10/library/stdtypes.html#dict)) \[*соответствующие элементы*\]**

Преобразует последовательность значений C в словарь Python. Каждая пара последовательных значений C добавляет один элемент в словарь, выступая в роли ключа и значения соответственно.

Если в строке формата есть ошибка, устанавливается исключение [`SystemError`](https://python-all.ru/3.10/library/exceptions.html#SystemError) и возвращается `NULL`.

#### `PyObject *Py_VaBuildValue(const char *format, va_list vargs)`

*Возвращаемое значение: новая ссылка.*

*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*

Идентична [`Py_BuildValue()`](https://python-all.ru/3.10/c-api/arg.html#c.Py_BuildValue), за исключением того, что принимает va\_list вместо переменного числа аргументов.