`arg.md`

520 строк · 56.6 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.13/c-api/arg.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Разбор аргументов и построение значений89Эти функции полезны при создании собственных функций и методов расширения. Дополнительная информация и примеры доступны в [Extending and Embedding the Python Interpreter](https://python-all.ru/3.13/extending/index.html#extending-index).1011Первые три из описанных функций, [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple), [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) и [`PyArg_Parse()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_Parse), используют *строки формата*, которые сообщают функции об ожидаемых аргументах. Строки формата имеют одинаковый синтаксис для каждой из этих функций.1213## Разбор аргументов1415Строка формата состоит из нуля или более «единиц формата». Единица формата описывает один объект Python; обычно это один символ или заключённая в скобки последовательность единиц формата. За несколькими исключениями, единица формата, не являющаяся последовательностью в скобках, обычно соответствует одному аргументу-адресу этих функций. В следующем описании приведённая в кавычках форма – это единица формата; запись в круглых скобках – тип объекта Python, которому соответствует единица формата; а запись в квадратных скобках – тип переменной(ых) C, чей адрес следует передать.1617### Строки и буферы1819> **Примечание**20>21> В Python 3.12 и старше макрос `PY_SSIZE_T_CLEAN` должен быть определён до включения `Python.h`, чтобы использовать все `#` варианты форматов (`s#`, `y#` и т.д.), описанные ниже. В Python 3.13 и новее это не требуется.2223Эти форматы позволяют обращаться к объекту как к непрерывному блоку памяти. Не нужно предоставлять сырое хранилище для возвращаемой области unicode или bytes.2425Если не указано иное, буферы не завершаются нулевым символом (NUL).2627Существует три способа преобразования строк и буферов в C:2829- Форматы, такие как `y*` и `s*`, заполняют структуру [`Py_buffer`](https://python-all.ru/3.13/c-api/buffer.html#c.Py_buffer). Это блокирует нижележащий буфер, чтобы вызывающий код мог впоследствии использовать буфер даже внутри блока [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.13/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) без риска изменения размера или уничтожения изменяемых данных. В результате **необходимо вызывать** [`PyBuffer_Release()`](https://python-all.ru/3.13/c-api/buffer.html#c.PyBuffer_Release) после завершения обработки данных (или в случае досрочного прерывания).30- Форматы `es`, `es#`, `et` и `et#` выделяют буфер для результата. **Необходимо вызывать** [`PyMem_Free()`](https://python-all.ru/3.13/c-api/memory.html#c.PyMem_Free) после завершения обработки данных (или в случае досрочного прерывания).31- Другие форматы принимают [`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) только для чтения, такой как [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes), и предоставляют указатель `const char *` на его буфер. В этом случае буфер является «заимствованным»: он управляется соответствующим объектом Python и разделяет время жизни этого объекта. Самостоятельно освобождать память не потребуется.3233  Чтобы гарантировать возможность безопасного заимствования базового буфера, поле [`PyBufferProcs.bf_releasebuffer`](https://python-all.ru/3.13/c-api/typeobj.html#c.PyBufferProcs.bf_releasebuffer) объекта должно быть `NULL`. Это исключает обычные изменяемые объекты, такие как [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray), но также и некоторые объекты только для чтения, такие как [`memoryview`](https://python-all.ru/3.13/library/stdtypes.html#memoryview) из [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).3435  Кроме этого требования `bf_releasebuffer`, не существует проверки на то, является ли входной объект неизменяемым (например, будет ли он выполнять запрос на буфер для записи или сможет ли другой поток изменить данные).3637**`s` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[const char \*\]**3839Преобразует объект Unicode в указатель C на строку символов. Указатель на существующую строку сохраняется в переменной-указателе на символ, адрес которой передаётся. Строка C заканчивается нулевым символом (NUL). Строка Python не должна содержать встроенные нулевые кодовые точки; если содержит, возбуждается исключение [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`. Если это преобразование не удаётся, возбуждается [`UnicodeError`](https://python-all.ru/3.13/library/exceptions.html#UnicodeError).4041> **Примечание**42>43> Этот формат не принимает [байтоподобные объекты](https://python-all.ru/3.13/glossary.html#term-bytes-like-object). Если требуется принимать пути файловой системы и преобразовывать их в строки символов C, предпочтительнее использовать формат `O&` с [`PyUnicode_FSConverter()`](https://python-all.ru/3.13/c-api/unicode.html#c.PyUnicode_FSConverter) в качестве *конвертера*.4445Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError) возбуждалось, когда в строке Python обнаруживались встроенные нулевые кодовые точки.4647**`s*` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**4849Этот формат принимает как объекты Unicode, так и байтоподобные объекты. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.13/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. В этом случае результирующая строка C может содержать встроенные нулевые байты (NUL). Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`.5051**`s#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) только для чтения) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**5253Как `s*`, за исключением того, что предоставляет [заимствованный буфер](https://python-all.ru/3.13/c-api/arg.html#c-arg-borrowed-buffer). Результат сохраняется в две переменные C: первая – указатель на строку C, вторая – её длина. Строка может содержать встроенные нулевые байты. Объекты Unicode преобразуются в строки C с использованием кодировки `'utf-8'`.5455**`z` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*\]**5657Как `s`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в `NULL`.5859**`z*` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или `None`) \[Py\_buffer\]**6061Как `s*`, но объект Python также может быть `None`, и в этом случае элемент `buf` структуры [`Py_buffer`](https://python-all.ru/3.13/c-api/buffer.html#c.Py_buffer) устанавливается в `NULL`.6263**`z#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str), [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) только для чтения или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**6465Как `s#`, но объект Python также может быть `None`, и в этом случае указатель C устанавливается в `NULL`.6667**`y` ([байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) только для чтения) \[const char \*\]**6869Этот формат преобразует байтоподобный объект в указатель C на [заимствованную](https://python-all.ru/3.13/c-api/arg.html#c-arg-borrowed-buffer) строку символов; он не принимает объекты Unicode. Байтовый буфер не должен содержать встроенные нулевые байты; если содержит, возбуждается исключение [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).7071Изменено в версии 3.5: Ранее [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError) возбуждалось, когда в байтовом буфере обнаруживались встроенные нулевые байты.7273**`y*` ([байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object)) \[Py\_buffer\]**7475Этот вариант `s*` не принимает объекты Unicode, только байтоподобные объекты. **Это рекомендуемый способ приёма двоичных данных.**7677**`y#` ([байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) только для чтения) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**7879Этот вариант `s#` не принимает объекты Unicode, только байтоподобные объекты.8081**`S` ([`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes)) \[PyBytesObject \*\]**8283Требует, чтобы объект Python был объектом [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes), без попыток какого-либо преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError), если объект не является объектом bytes. Переменная C также может быть объявлена как [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*.8485**`Y` ([`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray)) \[PyByteArrayObject \*\]**8687Требует, чтобы объект Python был объектом [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray), без попыток какого-либо преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError), если объект не является объектом `bytearray`. Переменная C также может быть объявлена как [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*.8889**`U` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[PyObject \*\]**9091Требует, чтобы объект Python был объектом Unicode, без попыток какого-либо преобразования. Возбуждает [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError), если объект не является объектом Unicode. Переменная C также может быть объявлена как [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*.9293**`w*` ([байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) для чтения и записи) \[Py\_buffer\]**9495Этот формат принимает любой объект, реализующий интерфейс буфера чтения-записи. Он заполняет структуру [`Py_buffer`](https://python-all.ru/3.13/c-api/buffer.html#c.Py_buffer), предоставленную вызывающей стороной. Буфер может содержать встроенные нулевые байты. Вызывающая сторона должна вызвать [`PyBuffer_Release()`](https://python-all.ru/3.13/c-api/buffer.html#c.PyBuffer_Release), когда закончит работу с буфером.9697**`es` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer\]**9899Этот вариант `s` используется для кодирования Unicode в символьный буфер. Он работает только с закодированными данными без встроенных NUL-байтов.100101Этот формат требует два аргумента. Первый используется только как входной и должен быть const char\*, указывающим на имя кодировки в виде строки, завершающейся NUL, или `NULL`, в этом случае используется кодировка `'utf-8'`. Исключение возникает, если указанная кодировка неизвестна Python. Второй аргумент должен быть char\*\*; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, заданной первым аргументом.102103[`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple) выделит буфер нужного размера, скопирует закодированные данные в этот буфер и настроит *\*buffer* так, чтобы он ссылался на вновь выделенную память. Вызывающая сторона отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.13/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.104105**`et` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer\]**106107То же, что и `es`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.108109**`es#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[const char \*encoding, char \*\*buffer, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t) \*buffer\_length\]**110111Этот вариант `s#` используется для кодирования Unicode в символьный буфер. В отличие от формата `es`, этот вариант допускает входные данные, содержащие NUL-символы.112113Требуется три аргумента. Первый используется только как входной и должен быть const char\*, указывающим на имя кодировки в виде строки, завершающейся NUL, или `NULL`, в этом случае используется кодировка `'utf-8'`. Исключение возникает, если указанная кодировка неизвестна Python. Второй аргумент должен быть char\*\*; значение указателя, на который он ссылается, будет установлено на буфер с содержимым текста аргумента. Текст будет закодирован в кодировке, заданной первым аргументом. Третий аргумент должен быть указателем на целое число; указанное целое число будет установлено в количество байтов в выходном буфере.114115Существует два режима работы:116117Если *\*buffer* указывает на указатель `NULL`, функция выделит буфер нужного размера, скопирует закодированные данные в этот буфер и установит *\*buffer* так, чтобы он ссылался на вновь выделенную память. Вызывающая сторона отвечает за вызов [`PyMem_Free()`](https://python-all.ru/3.13/c-api/memory.html#c.PyMem_Free) для освобождения выделенного буфера после использования.118119Если *\*buffer* указывает на не-`NULL` указатель (уже выделенный буфер), [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple) будет использовать это место как буфер и интерпретировать начальное значение *\*buffer\_length* как размер буфера. Затем он скопирует закодированные данные в буфер и завершит их NUL. Если буфер недостаточно велик, будет установлено [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).120121В обоих случаях *\*buffer\_length* устанавливается в длину закодированных данных без завершающего NUL-байта.122123**`et#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str), [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray)) \[const char \*encoding, char \*\*buffer, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t) \*buffer\_length\]**124125То же, что и `es#`, за исключением того, что объекты байтовой строки передаются без перекодирования. Вместо этого реализация предполагает, что объект байтовой строки использует кодировку, переданную в качестве параметра.126127Изменено в версии 3.12: `u`, `u#`, `Z` и `Z#` удалены, поскольку они использовали устаревшее представление `Py_UNICODE*`.128129### Числа130131Эти форматы позволяют представлять числа Python или одиночные символы как числа C. Форматы, требующие [`int`](https://python-all.ru/3.13/library/functions.html#int), [`float`](https://python-all.ru/3.13/library/functions.html#float) или [`complex`](https://python-all.ru/3.13/library/functions.html#complex), также могут использовать соответствующие специальные методы [`__index__()`](https://python-all.ru/3.13/reference/datamodel.html#object.__index__), [`__float__()`](https://python-all.ru/3.13/reference/datamodel.html#object.__float__) или [`__complex__()`](https://python-all.ru/3.13/reference/datamodel.html#object.__complex__) для преобразования объекта Python в требуемый тип.132133Для форматов целых чисел со знаком [`OverflowError`](https://python-all.ru/3.13/library/exceptions.html#OverflowError) возбуждается, если значение выходит за пределы диапазона для типа C. Для беззнаковых форматов проверка диапазона не выполняется – старшие биты молча отбрасываются, когда принимающее поле слишком мало для значения.134135**`b` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned char\]**136137Преобразует неотрицательное целое число Python в беззнаковое крошечное целое, хранящееся в C unsigned char.138139**`B` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned char\]**140141Преобразует целое число Python в крошечное целое без проверки переполнения, сохраняемое в C unsigned char.142143**`h` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[short int\]**144145Преобразует целое число Python в C short int.146147**`H` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned short int\]**148149Преобразует целое число Python в C unsigned short int, без проверки переполнения.150151**`i` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[int\]**152153Преобразует целое число Python в обычный C int.154155**`I` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned int\]**156157Преобразует целое число Python в C unsigned int, без проверки переполнения.158159**`l` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[long int\]**160161Преобразует целое число Python в C long int.162163**`k` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned long\]**164165Преобразует целое число Python в C unsigned long без проверки переполнения.166167**`L` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[long long\]**168169Преобразует целое число Python в C long long.170171**`K` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned long long\]**172173Преобразует целое число Python в C unsigned long long без проверки переполнения.174175**`n` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[[`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**176177Преобразует целое число Python в C [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t).178179**`c` ([`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray) длиной 1) \[char\]**180181Преобразует байт Python, представленный как объект [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray) длиной 1, в C char.182183Изменено в версии 3.3: Допускаются объекты [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray).184185**`C` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) длины 1) \[int\]**186187Преобразует символ Python, представленный как объект [`str`](https://python-all.ru/3.13/library/stdtypes.html#str) длиной 1, в C int.188189**`f` ([`float`](https://python-all.ru/3.13/library/functions.html#float)) \[float\]**190191Преобразует число с плавающей запятой Python в C float.192193**`d` ([`float`](https://python-all.ru/3.13/library/functions.html#float)) \[double\]**194195Преобразует число с плавающей запятой Python в C double.196197**`D` ([`complex`](https://python-all.ru/3.13/library/functions.html#complex)) \[Py\_complex\]**198199Преобразует комплексное число Python в структуру C [`Py_complex`](https://python-all.ru/3.13/c-api/complex.html#c.Py_complex).200201### Другие объекты202203**`O` (объект) \[PyObject \*\]**204205Сохраняет объект Python (без преобразования) в указателе на объект C. Таким образом, программа на C получает фактически переданный объект. Новая [сильная ссылка](https://python-all.ru/3.13/glossary.html#term-strong-reference) на объект не создается (т.е. его счетчик ссылок не увеличивается). Сохраненный указатель не является `NULL`.206207**`O!` (object) \[*typeobject*, PyObject \*\]**208209Сохраняет объект Python в указателе на объект C. Это похоже на `O`, но принимает два аргумента C: первый – адрес объекта типа Python, второй – адрес переменной C (типа [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*), в которую сохраняется указатель на объект. Если объект Python не имеет требуемого типа, вызывается [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError).210211**`O&` (object) \[*конвертер*, *address*\]**212213Преобразует объект Python в переменную C с помощью функции *конвертера*. Она принимает два аргумента: первый – функция, второй – адрес переменной C (произвольного типа), преобразованный в void\*. Сама функция *конвертера* вызывается следующим образом:214215```c216status = converter(object, address);217```218219где *object* – преобразуемый объект Python, а *address* – это аргумент void\*, переданный функции `PyArg_Parse*`. Возвращаемое значение *status* должно быть `1` при успешном преобразовании и `0`, если преобразование не удалось. При неудачном преобразовании функция *конвертера* должна вызвать исключение и оставить содержимое *address* без изменений.220221Если *конвертер* возвращает `Py_CLEANUP_SUPPORTED`, он может быть вызван повторно, если в конечном итоге разбор аргументов завершится неудачей, давая конвертеру возможность освободить память, которую он уже выделил. При повторном вызове параметр *object* будет равен `NULL`; *address* будет иметь то же значение, что и при первоначальном вызове.222223Примеры преобразователей: [`PyUnicode_FSConverter()`](https://python-all.ru/3.13/c-api/unicode.html#c.PyUnicode_FSConverter) и [`PyUnicode_FSDecoder()`](https://python-all.ru/3.13/c-api/unicode.html#c.PyUnicode_FSDecoder).224225Изменено в версии 3.1: `Py_CLEANUP_SUPPORTED` добавлен.226227**`p` ([`bool`](https://python-all.ru/3.13/library/functions.html#bool)) \[int\]**228229Проверяет переданное значение на истинность (булев предикат **p**) и преобразует результат в эквивалентное целое C true/false. Устанавливает int в `1`, если выражение истинно, и в `0`, если ложно. Принимает любое корректное значение Python. См. [Проверка истинности значений](https://python-all.ru/3.13/library/stdtypes.html#truth) для получения дополнительной информации о том, как Python проверяет значения на истинность.230231Добавлено в версии 3.3.232233**`(items)` ([`tuple`](https://python-all.ru/3.13/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**234235Объект должен быть последовательностью Python, длина которой равна количеству единиц формата в *элементах*. Аргументы C должны соответствовать отдельным единицам формата в *элементах*. Единицы формата для последовательностей могут быть вложенными.236237Некоторые другие символы имеют значение в строке формата. Они не могут встречаться внутри вложенных скобок. Вот они:238239**`|`**240241Указывает, что остальные аргументы в списке аргументов Python являются необязательными. Переменные C, соответствующие необязательным аргументам, должны быть инициализированы значением по умолчанию – когда необязательный аргумент не указан, [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple) не трогает содержимое соответствующих переменных C.242243**`$`**244245[`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) only: Указывает, что остальные аргументы в списке аргументов Python являются только ключевыми. В настоящее время все только ключевые аргументы также должны быть необязательными, поэтому `|` всегда должен указываться перед `$` в строке формата.246247Добавлено в версии 3.3.248249**`:`**250251Список единиц форматирования заканчивается здесь; строка после двоеточия используется как имя функции в сообщениях об ошибках («связанное значение» исключения, которое вызывает [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple)).252253**`;`**254255Список единиц форматирования заканчивается здесь; строка после точки с запятой используется как сообщение об ошибке *вместо* сообщения об ошибке по умолчанию. `:` и `;` взаимно исключают друг друга.256257Обратите внимание, что все ссылки на объекты Python, предоставляемые вызывающей стороне, являются *заимствованными* ссылками; не освобождайте их (т.е. не уменьшайте их счетчик ссылок)!258259Дополнительные аргументы, передаваемые этим функциям, должны быть адресами переменных, тип которых определяется строкой формата; они используются для хранения значений из входного кортежа. Есть несколько случаев, как описано в списке единиц форматирования выше, когда эти параметры используются в качестве входных значений; в этом случае они должны соответствовать тому, что указано для соответствующей единицы форматирования.260261Для успешного преобразования объект *arg* должен соответствовать формату, и формат должен быть исчерпан. При успехе функции `PyArg_Parse*` возвращают true, в противном случае они возвращают false и возбуждают соответствующее исключение. Когда функции `PyArg_Parse*` завершаются ошибкой из-за неудачи преобразования в одной из единиц форматирования, переменные по адресам, соответствующим этой и последующим единицам форматирования, остаются нетронутыми.262263### API функции264265#### `int PyArg_ParseTuple(PyObject *args, const char *format, ...)`266267*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*268269Разбирает параметры функции, принимающей только позиционные параметры, в локальные переменные. Возвращает true при успехе; при неудаче возвращает false и возбуждает соответствующее исключение.270271#### `int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)`272273*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*274275Идентична [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple), за исключением того, что принимает va\_list вместо переменного числа аргументов.276277#### `int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *const *keywords, ...)`278279*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*280281Разбирает параметры функции, принимающей как позиционные, так и ключевые параметры, в локальные переменные. Аргумент *keywords* представляет собой массив имен ключевых параметров, завершающийся `NULL`, заданных в виде строк C, закодированных в ASCII или UTF-8 с нулевым завершением. Пустые имена обозначают [только позиционные параметры](https://python-all.ru/3.13/glossary.html#positional-only-parameter). Возвращает true при успехе; при неудаче возвращает false и возбуждает соответствующее исключение.282283> **Примечание**284>285> Объявление параметра *keywords* – это char \*const\* в C и const char \*const\* в C++. Это можно переопределить с помощью макроса [`PY_CXX_CONST`](https://python-all.ru/3.13/c-api/arg.html#c.PY_CXX_CONST).286287Изменено в версии 3.6: Добавлена поддержка [только позиционных параметров](https://python-all.ru/3.13/glossary.html#positional-only-parameter).288289Изменено в версии 3.13: Параметр *keywords* теперь имеет тип char \*const\* в C и const char \*const\* в C++, вместо char\*\*. Добавлена поддержка имен не-ASCII для параметров-ключевых слов.290291#### `int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *const *keywords, va_list vargs)`292293*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*294295Идентична [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTupleAndKeywords), но принимает va\_list вместо переменного числа аргументов.296297#### `int PyArg_ValidateKeywordArguments(PyObject*)`298299*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*300301Гарантирует, что ключи в словаре аргументов-ключевых слов являются строками. Это нужно только в случае, если [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) не используется, поскольку последняя уже выполняет эту проверку.302303Добавлено в версии 3.2.304305#### `int PyArg_Parse(PyObject *args, const char *format, ...)`306307*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*308309Разбирает параметр функции, которая принимает один позиционный параметр, в локальную переменную. Возвращает true при успехе; при неудаче возвращает false и возбуждает соответствующее исключение.310311Пример:312313```c314// Функция, использующая соглашение вызова METH_O315static PyObject*316my_function(PyObject *module, PyObject *arg)317{318    int value;319    if (!PyArg_Parse(arg, "i:my_function", &value)) {320        return NULL;321    }322    // ... использовать значение ...323}324```325326#### `int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)`327328*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*329330Более простая форма извлечения параметров, не использующая строку формата для указания типов аргументов. Функции, использующие этот метод для получения своих параметров, должны быть объявлены как [`METH_VARARGS`](https://python-all.ru/3.13/c-api/structures.html#c.METH_VARARGS) в таблицах функций или методов. Кортеж, содержащий фактические параметры, должен передаваться как *args*; он должен быть именно кортежем. Длина кортежа должна быть не менее *min* и не более *max*; *min* и *max* могут быть равны. Дополнительные аргументы должны передаваться в функцию, каждый из которых должен быть указателем на переменную типа [PyObject](https://python-all.ru/3.13/c-api/structures.html#c.PyObject)\*; они будут заполнены значениями из *args*; они будут содержать [заимствованные ссылки](https://python-all.ru/3.13/glossary.html#term-borrowed-reference). Переменные, соответствующие необязательным параметрам, не заданным в *args*, заполнены не будут; их должен инициализировать вызывающий. Эта функция возвращает true при успехе и false, если *args* не является кортежем или содержит неверное количество элементов; в случае неудачи будет установлено исключение.331332Это пример использования этой функции, взятый из исходных кодов вспомогательного модуля для слабых ссылок `_weakref`:333334```c335static PyObject *336weakref_ref(PyObject *self, PyObject *args)337{338    PyObject *object;339    PyObject *callback = NULL;340    PyObject *result = NULL;341342    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {343        result = PyWeakref_NewRef(object, callback);344    }345    return result;346}347```348349Вызов [`PyArg_UnpackTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_UnpackTuple) в этом примере полностью эквивалентен вызову [`PyArg_ParseTuple()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTuple):350351```c352PyArg_ParseTuple(args, "O|O:ref", &object, &callback)353```354355#### `PY_CXX_CONST`356357Значение, которое должно быть вставлено, если есть, перед char \*const\* в объявлении параметра *keywords* функций [`PyArg_ParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_ParseTupleAndKeywords) и [`PyArg_VaParseTupleAndKeywords()`](https://python-all.ru/3.13/c-api/arg.html#c.PyArg_VaParseTupleAndKeywords). По умолчанию пусто для C и `const` для C++ (const char \*const\*). Чтобы переопределить, задайте нужное значение перед включением `Python.h`.358359Добавлено в версии 3.13.360361## Построение значений362363#### `PyObject *Py_BuildValue(const char *format, ...)`364365*Возвращаемое значение: новая ссылка.*366367*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*368369Создает новое значение на основе строки формата, аналогичной тем, что принимаются семейством функций `PyArg_Parse*`, и последовательности значений. Возвращает значение или `NULL` в случае ошибки; будет возбуждено исключение, если возвращается `NULL`.370371[`Py_BuildValue()`](https://python-all.ru/3.13/c-api/arg.html#c.Py_BuildValue) не всегда строит кортеж. Он строит кортеж, только если строка формата содержит два или более элемента формата. Если строка формата пуста, возвращается `None`; если она содержит ровно один элемент формата, возвращается объект, описываемый этим элементом. Чтобы принудительно вернуть кортеж размера 0 или 1, заключите строку формата в скобки.372373Когда буферы памяти передаются как параметры для предоставления данных для создания объектов, как для форматов `s` и `s#`, необходимые данные копируются. Буферы, предоставленные вызывающим, никогда не используются напрямую объектами, созданными с помощью [`Py_BuildValue()`](https://python-all.ru/3.13/c-api/arg.html#c.Py_BuildValue). Другими словами, если ваш код вызывает `malloc()` и передает выделенную память в `Py_BuildValue()`, ваш код отвечает за вызов `free()` для этой памяти после того, как `Py_BuildValue()` вернет управление.374375В следующем описании форма в кавычках – это элемент формата; запись в круглых скобках – это тип объекта Python, который вернёт элемент формата; а запись в квадратных скобках – это тип передаваемого(-ых) значения(-ий) C.376377Символы пробела, табуляции, двоеточия и запятой в строках формата игнорируются (но не внутри элементов формата, таких как `s#`). Это можно использовать, чтобы сделать длинные строки формата чуть более читаемыми.378379**`s` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*\]**380381Преобразует C-строку, завершающуюся нулём, в объект Python [`str`](https://python-all.ru/3.13/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен `NULL`, используется `None`.382383**`s#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**384385Преобразует C-строку и её длину в объект Python [`str`](https://python-all.ru/3.13/library/stdtypes.html#str), используя кодировку `'utf-8'`. Если указатель на C-строку равен `NULL`, длина игнорируется и возвращается `None`.386387**`y` ([`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes)) \[const char \*\]**388389Преобразует C-строку в объект Python [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes). Если указатель на C-строку равен `NULL`, возвращается `None`.390391**`y#` ([`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes)) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**392393Преобразует C-строку и её длину в объект Python. Если указатель на C-строку равен `NULL`, возвращается `None`.394395**`z` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*\]**396397То же, что и `s`.398399**`z#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**400401То же, что и `s#`.402403**`u` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[const wchar\_t \*\]**404405Преобразует буфер `wchar_t` данных Unicode (UTF-16 или UCS-4), завершающийся нулём, в объект Python Unicode. Если указатель на буфер Unicode равен `NULL`, возвращается `None`.406407**`u#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str)) \[const wchar\_t \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**408409Преобразует буфер данных Unicode (UTF-16 или UCS-4) и его длину в объект Python Unicode. Если указатель на буфер Unicode равен `NULL`, длина игнорируется и возвращается `None`.410411**`U` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*\]**412413То же, что и `s`.414415**`U#` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или `None`) \[const char \*, [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**416417То же, что и `s#`.418419**`i` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[int\]**420421Преобразует обычный C int в объект Python целого типа.422423**`b` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[char\]**424425Преобразует обычный C char в объект Python целого типа.426427**`h` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[short int\]**428429Преобразует обычный C short int в объект Python целого типа.430431**`l` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[long int\]**432433Преобразует C long int в объект Python целого типа.434435**`B` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned char\]**436437Преобразует C unsigned char в объект Python целого типа.438439**`H` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned short int\]**440441Преобразует C unsigned short int в объект Python целого числа.442443**`I` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned int\]**444445Преобразует C unsigned int в объект Python целого числа.446447**`k` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned long\]**448449Преобразует C unsigned long в объект Python целого числа.450451**`L` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[long long\]**452453Преобразует C long long в объект Python целого числа.454455**`K` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[unsigned long long\]**456457Преобразует C unsigned long long в объект Python целого числа.458459**`n` ([`int`](https://python-all.ru/3.13/library/functions.html#int)) \[[`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t)\]**460461Преобразует C [`Py_ssize_t`](https://python-all.ru/3.13/c-api/intro.html#c.Py_ssize_t) в целое число Python.462463**`c` ([`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) длины 1) \[char\]**464465Преобразует C int, представляющий байт, в объект Python [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) длины 1.466467**`C` ([`str`](https://python-all.ru/3.13/library/stdtypes.html#str) длины 1) \[int\]**468469Преобразует C int, представляющий символ, в объект Python [`str`](https://python-all.ru/3.13/library/stdtypes.html#str) длины 1.470471**`d` ([`float`](https://python-all.ru/3.13/library/functions.html#float)) \[double\]**472473Преобразует C double в число с плавающей запятой Python.474475**`f` ([`float`](https://python-all.ru/3.13/library/functions.html#float)) \[float\]**476477Преобразует C float в число с плавающей запятой Python.478479**`D` ([`complex`](https://python-all.ru/3.13/library/functions.html#complex)) \[Py\_complex \*\]**480481Преобразует структуру C [`Py_complex`](https://python-all.ru/3.13/c-api/complex.html#c.Py_complex) в комплексное число Python.482483**`O` (объект) \[PyObject \*\]**484485Передаёт объект Python без изменений, но создаёт новую [сильную ссылку](https://python-all.ru/3.13/glossary.html#term-strong-reference) на него (т.е. его счётчик ссылок увеличивается на единицу). Если переданный объект является указателем `NULL`, предполагается, что это произошло потому, что вызов, создавший аргумент, обнаружил ошибку и установил исключение. Поэтому [`Py_BuildValue()`](https://python-all.ru/3.13/c-api/arg.html#c.Py_BuildValue) вернёт `NULL`, но не вызовет исключение. Если ещё не было установлено исключение, устанавливается [`SystemError`](https://python-all.ru/3.13/library/exceptions.html#SystemError).486487**`S` (объект) \[PyObject \*\]**488489То же, что и `O`.490491**`N` (объект) \[PyObject \*\]**492493То же, что и `O`, за исключением того, что не создаёт новую [сильную ссылку](https://python-all.ru/3.13/glossary.html#term-strong-reference). Полезно, когда объект создаётся вызовом конструктора объекта в списке аргументов.494495**`O&` (object) \[*конвертер*, *что угодно*\]**496497Преобразует *любой объект* в объект Python с помощью *функции-преобразователя*. Функция вызывается с *любым объектом* (который должен быть совместим с void\*) в качестве аргумента и должна вернуть «новый» объект Python или `NULL` в случае ошибки.498499**`(items)` ([`tuple`](https://python-all.ru/3.13/library/stdtypes.html#tuple)) \[*соответствующие элементы*\]**500501Преобразует последовательность значений C в кортеж Python с тем же количеством элементов.502503**`[items]` ([`list`](https://python-all.ru/3.13/library/stdtypes.html#list)) \[*соответствующие элементы*\]**504505Преобразует последовательность значений C в список Python с тем же количеством элементов.506507**`{items}` ([`dict`](https://python-all.ru/3.13/library/stdtypes.html#dict)) \[*соответствующие элементы*\]**508509Преобразует последовательность значений C в словарь Python. Каждая пара последовательных значений C добавляет один элемент в словарь, выступая в роли ключа и значения соответственно.510511Если в строке формата есть ошибка, устанавливается исключение [`SystemError`](https://python-all.ru/3.13/library/exceptions.html#SystemError) и возвращается `NULL`.512513#### `PyObject *Py_VaBuildValue(const char *format, va_list vargs)`514515*Возвращаемое значение: новая ссылка.*516517*Часть [Stable ABI](https://python-all.ru/3.13/c-api/stable.html#stable).*518519Идентична [`Py_BuildValue()`](https://python-all.ru/3.13/c-api/arg.html#c.Py_BuildValue), за исключением того, что принимает va\_list вместо переменного числа аргументов.520