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

---

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

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

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

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

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

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

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

В целом, когда формат устанавливает указатель на буфер, буфер управляется соответствующим объектом Python и существует в течение его времени жизни. Освобождать память самостоятельно не потребуется. Единственные исключения: `es`, `es#`, `et` и `et#`.

Однако, когда структура [`Py_buffer`](https://python-all.ru/3.5/c-api/buffer.html#c.Py_buffer) заполняется, нижележащий буфер блокируется, чтобы вызывающий код мог затем использовать буфер даже внутри блока [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.5/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) без риска изменения размера или уничтожения изменяемых данных. Поэтому **необходимо вызвать** [`PyBuffer_Release()`](https://python-all.ru/3.5/c-api/buffer.html#c.PyBuffer_Release) после завершения обработки данных (или при досрочном прерывании).

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

Некоторые форматы требуют [объекта, подобного байтам](https://python-all.ru/3.5/glossary.html#term-bytes-like-object), доступного только для чтения, и устанавливают указатель вместо структуры буфера. Они работают, проверяя, что поле [`PyBufferProcs.bf_releasebuffer`](https://python-all.ru/3.5/c-api/typeobj.html#c.PyBufferProcs.bf_releasebuffer) объекта равно *NULL*, что запрещает изменяемые объекты, такие как [`bytearray`](https://python-all.ru/3.5/library/functions.html#bytearray).

> **Примечание**
>
> Для всех вариантов форматов `#` (`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`.

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

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

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

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

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

Этот формат принимает как объекты Unicode, так и байтоподобные объекты. Он заполняет структуру

[`Py_buffer`](https://python-all.ru/3.5/c-api/buffer.html#c.Py_buffer)

, предоставленную вызывающей стороной. В этом случае результирующая строка C может содержать встроенные нулевые байты (NUL). Объекты Unicode преобразуются в строки C с использованием кодировки

`'utf-8'`

.

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

Как и

`s*`

, за исключением того, что не принимает изменяемые объекты. Результат сохраняется в две переменные C: первая – указатель на C-строку, вторая – её длина. Строка может содержать встроенные нулевые байты. Объекты Unicode преобразуются в C-строки с использованием кодировки

`'utf-8'`

.

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

Как

`s`

, но объект Python также может быть

`None`

, и в этом случае указатель C устанавливается в

*NULL*

.

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

Как

`s*`

, но объект Python также может быть

`None`

, и в этом случае элемент

`buf`

структуры

[`Py_buffer`](https://python-all.ru/3.5/c-api/buffer.html#c.Py_buffer)

устанавливается в

*NULL*

.

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

Как

`s#`

, но объект Python также может быть

`None`

, и в этом случае указатель C устанавливается в

*NULL*

.

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

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

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

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

Этот вариант

`s*`

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

**Это рекомендуемый способ приёма двоичных данных.**

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

Этот вариант

`s#`

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

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

Требует, чтобы объект Python был объектом

[`bytes`](https://python-all.ru/3.5/library/functions.html#bytes)

, без попыток преобразования. Возбуждает

[`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError)

, если объект не является объектом bytes. Переменная C также может быть объявлена как

[`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject)

.

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

Требует, чтобы объект Python был объектом

[`bytearray`](https://python-all.ru/3.5/library/functions.html#bytearray)

, без попыток преобразования. Возбуждает

[`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError)

, если объект не является объектом

[`bytearray`](https://python-all.ru/3.5/library/functions.html#bytearray)

. Переменная C также может быть объявлена как

[`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject)

.

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

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

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

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

Этот вариант

`u`

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

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

Как

`u`

, но объект Python также может быть

`None`

, и в этом случае указатель

[`Py_UNICODE`](https://python-all.ru/3.5/c-api/unicode.html#c.Py_UNICODE)

устанавливается в

*NULL*

.

**`Z#` ([`str`](https://python-all.ru/3.5/library/stdtypes.html#str) или `None`) \[Py\_UNICODE \*, int\]**

Как

`u#`

, но объект Python также может быть

`None`

, и в этом случае указатель

[`Py_UNICODE`](https://python-all.ru/3.5/c-api/unicode.html#c.Py_UNICODE)

устанавливается в

*NULL*

.

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

Требует, чтобы объект Python был объектом Unicode, без попыток преобразования. Возбуждает

[`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError)

, если объект не является объектом Unicode. Переменная C также может быть объявлена как

[`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject)

.

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

Этот формат принимает любой объект, реализующий интерфейс буфера для чтения-записи. Он заполняет структуру

[`Py_buffer`](https://python-all.ru/3.5/c-api/buffer.html#c.Py_buffer)

, предоставленную вызывающей стороной. Буфер может содержать встроенные нулевые байты. Вызывающая сторона должна вызвать

[`PyBuffer_Release()`](https://python-all.ru/3.5/c-api/buffer.html#c.PyBuffer_Release)

, когда закончит работу с буфером.

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

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

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

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

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

То же, что и

`es`

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

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

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

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

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

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

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

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

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

То же, что и

`es#`

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

### Числа

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

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

`unsigned char`

.

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

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

`unsigned char`

.

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

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

`short int`

.

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

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

`unsigned short int`

без проверки переполнения.

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

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

`int`

.

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

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

`unsigned int`

без проверки переполнения.

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

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

`long int`

.

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

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

`unsigned long`

без проверки переполнения.

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

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

`long long`

. Этот формат доступен только на платформах, поддерживающих

`long long`

(или

`_int64`

на Windows).

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

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

`unsigned long long`

без проверки переполнения. Этот формат доступен только на платформах, поддерживающих

`unsigned long long`

(или

`unsigned _int64`

на Windows).

**`n` ([`int`](https://python-all.ru/3.5/library/functions.html#int)) \[Py\_ssize\_t\]**

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

`Py_ssize_t`

.

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

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

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

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

Преобразует символ Python, представленный как объект

[`str`](https://python-all.ru/3.5/library/stdtypes.html#str)

длиной 1, в C-тип

`int`

.

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

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

`float`

.

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

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

`double`

.

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

Преобразует комплексное число Python в структуру C

[`Py_complex`](https://python-all.ru/3.5/c-api/complex.html#c.Py_complex)

.

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

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

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

*NULL*

.

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

Сохраняет объект Python в указателе на объект C. Это похоже на

`O`

, но принимает два аргумента C: первый – адрес объекта типа Python, второй – адрес C-переменной (типа

[`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject)

), в которую сохраняется указатель на объект. Если объект Python не имеет требуемого типа, возбуждается

[`TypeError`](https://python-all.ru/3.5/library/exceptions.html#TypeError)

.

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

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

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

где *объект* – это преобразуемый объект Python, а *адрес* – это аргумент `void*`, переданный функции [`PyArg_Parse*()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_Parse). Возвращаемый *статус* должен быть `1` при успешном преобразовании и `0` при неудаче. При неудачном преобразовании функция-*преобразователь* должна возбудить исключение и оставить содержимое *адреса* без изменений.

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

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

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

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

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

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

Объект должен быть последовательностью Python, длина которой равна количеству единиц формата в

*элементах*

. Аргументы C должны соответствовать отдельным единицам формата в

*элементах*

. Единицы формата для последовательностей могут быть вложенными.

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

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

**`|`**

Указывает, что остальные аргументы в списке аргументов Python являются необязательными. Переменные C, соответствующие необязательным аргументам, должны быть инициализированы значением по умолчанию – когда необязательный аргумент не указан,

[`PyArg_ParseTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTuple)

не трогает содержимое соответствующих переменных C.

**`$`**

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

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

**`:`**

Список единиц форматирования заканчивается здесь; строка после двоеточия используется как имя функции в сообщениях об ошибках («связанное значение» исключения, которое вызывает

[`PyArg_ParseTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTuple)

).

**`;`**

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

*вместо*

сообщения об ошибке по умолчанию.

`:`

и

`;`

взаимно исключают друг друга.

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

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

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

### API функции

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Упрощённый способ извлечения параметров, не использующий строку формата для указания типов аргументов. Функции, которые получают свои параметры таким образом, должны объявляться как [`METH_VARARGS`](https://python-all.ru/3.5/c-api/structures.html#METH_VARARGS) в таблицах функций или методов. Кортеж с фактическими параметрами должен передаваться как *args*; он обязательно должен быть кортежем. Длина кортежа должна быть не меньше *min* и не больше *max*; *min* и *max* могут быть равны. В функцию необходимо передать дополнительные аргументы, каждый из которых должен быть указателем на переменную типа [`PyObject*`](https://python-all.ru/3.5/c-api/structures.html#c.PyObject); они будут заполнены значениями из *args* и будут содержать заимствованные ссылки. Переменные, соответствующие необязательным параметрам, отсутствующим в *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.5/c-api/arg.html#c.PyArg_UnpackTuple) в этом примере полностью эквивалентен вызову [`PyArg_ParseTuple()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_ParseTuple):

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

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

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

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

Создаёт новое значение на основе строки формата, аналогичной используемым в семействе функций [`PyArg_Parse*()`](https://python-all.ru/3.5/c-api/arg.html#c.PyArg_Parse), и последовательности значений. Возвращает значение или *NULL* в случае ошибки; если возвращён *NULL*, будет возбуждено исключение.

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

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

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

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

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

Преобразует C-строку с нулевым символом на конце в объект Python

[`str`](https://python-all.ru/3.5/library/stdtypes.html#str)

, используя кодировку

`'utf-8'`

. Если указатель на C-строку равен

*NULL*

, используется

`None`

.

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

Преобразует C-строку и её длину в объект Python

[`str`](https://python-all.ru/3.5/library/stdtypes.html#str)

, используя кодировку

`'utf-8'`

. Если указатель на C-строку равен

*NULL*

, длина игнорируется и возвращается

`None`

.

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

Преобразует C-строку в объект Python

[`bytes`](https://python-all.ru/3.5/library/functions.html#bytes)

. Если указатель на C-строку равен

*NULL*

, возвращается

`None`

.

**`y#` ([`bytes`](https://python-all.ru/3.5/library/functions.html#bytes)) \[char \*, int\]**

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

*NULL*

, возвращается

`None`

.

**`z` ([`str`](https://python-all.ru/3.5/library/stdtypes.html#str) or `None`) \[char \*\]**

То же, что и

`s`

.

**`z#` ([`str`](https://python-all.ru/3.5/library/stdtypes.html#str) or `None`) \[char \*, int\]**

То же, что и

`s#`

.

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

Convert a null-terminated buffer of Unicode (UCS-2 or UCS-4) data to a Python Unicode object. If the Unicode buffer pointer is

*NULL*

,

`None`

is returned.

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

Convert a Unicode (UCS-2 or UCS-4) data buffer and its length to a Python Unicode object. If the Unicode buffer pointer is

*NULL*

, the length is ignored and

`None`

is returned.

**`U` ([`str`](https://python-all.ru/3.5/library/stdtypes.html#str) or `None`) \[char \*\]**

То же, что и

`s`

.

**`U#` ([`str`](https://python-all.ru/3.5/library/stdtypes.html#str) or `None`) \[char \*, int\]**

То же, что и

`s#`

.

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

Преобразует простой C-тип

`int`

в объект целого числа Python.

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

Преобразует простой C-тип

`char`

в объект целого числа Python.

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

Преобразует простой C-тип

`short int`

в объект целого числа Python.

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

Преобразует C

`long int`

в объект Python int.

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

Преобразует C

`unsigned char`

в объект Python int.

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

Преобразует C

`unsigned short int`

в объект Python int.

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

Преобразует C

`unsigned int`

в объект Python int.

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

Преобразует C

`unsigned long`

в объект Python int.

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

Преобразует

`long long`

языка C в объект целого числа Python. Доступно только на платформах, поддерживающих

`long long`

(или

`_int64`

в Windows).

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

Преобразует

`unsigned long long`

языка C в объект целого числа Python. Доступно только на платформах, поддерживающих

`unsigned long long`

(или

`unsigned _int64`

в Windows).

**`n` ([`int`](https://python-all.ru/3.5/library/functions.html#int)) \[Py\_ssize\_t\]**

Преобразует C

`Py_ssize_t`

в целое число Python.

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

Преобразует C

`int`

, представляющий байт, в объект

[`bytes`](https://python-all.ru/3.5/library/functions.html#bytes)

Python длиной 1.

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

Преобразует C

`int`

, представляющий символ, в объект

[`str`](https://python-all.ru/3.5/library/stdtypes.html#str)

Python длиной 1.

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

Преобразует C

`double`

в Python-число с плавающей запятой.

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

Преобразует C

`float`

в Python-число с плавающей запятой.

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

Преобразует структуру C

[`Py_complex`](https://python-all.ru/3.5/c-api/complex.html#c.Py_complex)

в комплексное число Python.

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

Передаёт Python-объект без изменений (за исключением его счётчика ссылок, который увеличивается на единицу). Если переданный объект является указателем

*NULL*

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

[`Py_BuildValue()`](https://python-all.ru/3.5/c-api/arg.html#c.Py_BuildValue)

вернёт

*NULL*

, но не вызовет исключение. Если исключение ещё не было вызвано, устанавливается

[`SystemError`](https://python-all.ru/3.5/library/exceptions.html#SystemError)

.

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

То же, что и

`O`

.

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

То же, что и

`O`

, за исключением того, что не увеличивает счётчик ссылок на объект. Полезно, когда объект создаётся вызовом конструктора объекта в списке аргументов.

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

Преобразует

*что угодно*

в Python-объект с помощью

*функции-преобразователя*

. Функция вызывается с

*чем угодно*

(которое должно быть совместимо с

`void *`

) в качестве аргумента и должна вернуть «новый» Python-объект или

*NULL*

, если произошла ошибка.

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

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

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

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

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

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

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

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

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