剖析引數與建置數值

在创建你自己的扩展函数和方法时,这些函数是有用的。其它的信息和样例见 擴充和嵌入 Python 直譯器

这些函数描述的前三个,PyArg_ParseTuple()PyArg_ParseTupleAndKeywords(),以及 PyArg_Parse(),它们都使用 格式化字符串 来将函数期待的参数告知函数。这些函数都使用相同语法规则的格式化字符串。

解析参数

一个格式化字符串包含 0 或者更多的格式单元。一个格式单元用来描述一个 Python 对象;它通常是一个字符或者由括号括起来的格式单元序列。除了少数例外,一个非括号序列的格式单元通常对应这些函数的具有单一地址的参数。在接下来的描述中,双引号内的表达式是格式单元;圆括号 () 内的是对应这个格式单元的 Python 对象类型;方括号 [] 内的是传递的 C 变量(变量集)类型。

字符串和缓存区

这些格式允许将对象按照连续的内存块形式进行访问。你没必要提供返回的 unicode 字符或者字节区的原始数据存储。

除非另有说明,缓冲区是不会以空终止的。

有三种办法可以将字符串和缓冲区转换到 C 类型:

  • y*s* 这样的格式会填充一个 Py_buffer 结构体。 这将锁定下层缓冲区以便调用者随后使用这个缓冲区即使是在 Py_BEGIN_ALLOW_THREADS 块中也不会有可变数据因大小调整或销毁所带来的风险。 因此,在你结束处理数据(或任何更早的中止场景)之前 你必须调用 PyBuffer_Release()

  • es, es#, etet# 等格式会分配结果缓冲区。 在你结束处理数据(或任何更早的中止场景)之后 你必须调用 PyMem_Free()

  • 其他格式接受一个 str 或只读的 bytes-like object,如 bytes,并向其缓冲区提供一个 const char * 指针。 在缓冲区是“被借入”的情况下:它将由对应的 Python 对象来管理,并共享此对象的生命期。 你不需要自行释放任何内存。

    为确保下层缓冲区可以安全地被借入,对象的 PyBufferProcs.bf_releasebuffer 字段必须为 NULL。 这将不允许普通的可变对象如 bytearray,以及某些只读对象如 bytesmemoryview

    在这个 bf_releasebuffer 要求以外,没有用于验证输入对象是否为不可变对象的检查(例如它是否会接受可写缓冲区的请求,或者另一个线程是否能改变此数据)。

備註

For all # variants of formats (s#, y#, etc.), the macro PY_SSIZE_T_CLEAN must be defined before including Python.h. On Python 3.9 and older, the type of the length argument is Py_ssize_t if the PY_SSIZE_T_CLEAN macro is defined, or int otherwise.

s (str) [const char *]

将一个 Unicode 对象转换成一个指向字符串的 C 指针。一个指针指向一个已经存在的字符串,这个字符串存储的是传如的字符指针变量。C 字符串是已空结束的。Python 字符串不能包含嵌入的无效的代码点;如果由,一个 ValueError 异常会被引发。Unicode 对象被转化成 'utf-8' 编码的 C 字符串。如果转换失败,一个 UnicodeError 异常被引发。

備註

这个表达式不接受 bytes-like objects。如果你想接受文件系统路径并将它们转化成 C 字符串,建议使用 O& 表达式配合 PyUnicode_FSConverter() 作为 转化函数

在 3.5 版的變更: 以前,当 Python 字符串中遇到了嵌入的 null 代码点会引发 TypeError

s*strbytes-like object)[Py_buffer]

这个表达式既接受 Unicode 对象也接受类字节类型对象。它为由调用者提供的 Py_buffer 结构赋值。这里结果的 C 字符串可能包含嵌入的 NUL 字节。Unicode 对象通过 'utf-8' 编码转化成 C 字符串。

s# (str, read-only bytes-like object) [const char *, Py_ssize_t]

像是 s*,区别在于它提供了一个 借入的缓冲区。 结果存储在两个 C 变量中,第一个是指向 C 字符串的指针,第二个是其长度。 该字符串可能包含嵌入的空字节。 Unicode 对象会使用 'utf-8' 编码格式转换为 C 字符串。

zstrNone)[const char *]

s 类似,但 Python 对象也可能为 None,在这种情况下,C 指针设置为 NULL

z*strbytes-like objectNone)[Py_buffer]

s* 类似,但 Python 对象也可能为 None,在这种情况下,Py_buffer 结构的 buf 成员设置为 NULL

z# (str, read-only bytes-like object 或者 None) [const char *, Py_ssize_t]

s# 类似,但 Python 对象也可能为 None,在这种情况下,C 指针设置为 NULL

y(唯讀 bytes-like object)[const char *]

这个格式会将一个类字节对象转换为一个指向 借入的 字符串的 C 指针;它不接受 Unicode 对象。 字节缓冲区不可包含嵌入的空字节;如果包含这样的内容,将会引发 ValueError 异常。exception is raised.

在 3.5 版的變更: 以前,当字节缓冲区中遇到了嵌入的 null 字节会引发 TypeError

y* (bytes-like object) [Py_buffer]

s* 的变式,不接受 Unicode 对象,只接受类字节类型变量。这是接受二进制数据的推荐方法。

y# (read-only bytes-like object) [const char *, Py_ssize_t]

s# 的变式,不接受 Unicode 对象,只接受类字节类型变量。

S (bytes) [PyBytesObject *]

要求 Python 对象为 bytes 对象,不尝试进行任何转换。 如果该对象不为 bytes 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*

Y (bytearray) [PyByteArrayObject *]

要求 Python 对象为 bytearray 对象,不尝试进行任何转换。 如果该对象不为 bytearray 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*

U (str) [PyObject *]

要求 Python 对象为 Unicode 对象,不尝试进行任何转换。 如果该对象不为 Unicode 对象则会引发 TypeError。 C 变量也可被声明为 PyObject*

w* (可讀寫 bytes-like object) [Py_buffer]

这个表达式接受任何实现可读写缓存区接口的对象。它为调用者提供的 Py_buffer 结构赋值。缓冲区可能存在嵌入的 null 字节。当缓冲区使用完后调用者需要调用 PyBuffer_Release()

es (str) [const char *encoding, char **buffer]

s 的变式,它将编码后的 Unicode 字符存入字符缓冲区。它只处理没有嵌 NUL 字节的已编码数据。

此格式需要两个参数。 第一个仅用作输入,并且必须为 const char*,它指向一个以 NUL 结束的字符串表示的编码格式名称,或者为 NULL,这种情况会使用 'utf-8' 编码格式。 如果 Python 无法识别指定的编码格式则会引发异常。 第二个参数必须为 char**;它所引用的指针值将被设为带有参数文本内容的缓冲区。 文本将以第一个参数所指定的编码格式进行编码。

PyArg_ParseTuple() 会分配一个足够大小的缓冲区,将编码后的数据拷贝进这个缓冲区并且设置 *buffer 引用这个新分配的内存空间。调用者有责任在使用后调用 PyMem_Free() 去释放已经分配的缓冲区。

et (str, bytes or bytearray) [const char *encoding, char **buffer]

es 相同,除了不用重编码传入的字符串对象。相反,它假设传入的参数是编码后的字符串类型。

es# (str) [const char *encoding, char **buffer, Py_ssize_t *buffer_length]

s# 的变式,它将已编码的 Unicode 字符存入字符缓冲区。不像 es 表达式,它允许传入的数据包含 NUL 字符。

它需要三个参数。 第一个仅用作输入,并且必须为 const char*,它指向一个以 NUL 结束的字符串表示的编码格式名称,或者为 NULL,这种情况会使用 'utf-8' 编码格式。 如果 Python 无法识别指定的编码格式则会引发异常。 第二个参数必须为 char**;它所引用的指针值将被设为带有参数文本内容的缓冲区。 文本将以第一个参数所指定的编码格式进行编码。 第三个参数必须为指向一个整数的指针;被引用的整数将被设为输出缓冲区中的字节数。

有两种操作方式:

如果 *buffer 指向 NULL 指针,则函数将分配所需大小的缓冲区,将编码的数据复制到此缓冲区,并设置 *buffer 以引用新分配的存储。 呼叫者负责调用 PyMem_Free() 以在使用后释放分配的缓冲区。

如果 *buffer 指向非 NULL 指针(已分配的缓冲区),则 PyArg_ParseTuple() 将使用此位置作为缓冲区,并将 *buffer_length 的初始值解释为缓冲区大小。 然后,它将将编码的数据复制到缓冲区,并终止它。 如果缓冲区不够大,将设置一个 ValueError

在这两个例子中,*buffer_length 被设置为编码后结尾不为 NUL 的数据的长度。

et# (str, bytesbytearray) [const char *encoding, char **buffer, Py_ssize_t *buffer_length]

es# 相同,除了不用重编码传入的字符串对象。相反,它假设传入的参数是编码后的字符串类型。

在 3.12 版的變更: u, u#, ZZ# 已被移除因为它们只用于旧式的 Py_UNICODE* 表示形式。

數字

b (int) [unsigned char]

将非负的 Python 整数转换为无符号的微整数,存储为一个 C unsigned char

B (int) [unsigned char]

将 Python 整数转换为微整数并且不进行溢出检查,存储为一个 C unsigned char

h (int) [short int]

將一個 Python 整數轉換成 C 的 short int

H (int) [unsigned short int]

將一個 Python 整數轉換成 C 的 unsigned short int,轉換過程無溢位檢查。

i (int) [int]

將一個 Python 整數轉換成 C 的 int

I (int) [unsigned int]

將一個 Python 整數轉換成 C 的 unsigned int,轉換過程無溢位檢查。

l (int) [long int]

將一個 Python 整數轉換成 C 的 long int

k (int) [unsigned long]

將一個 Python 整數轉換成 C 的 unsigned long,轉換過程無溢位檢查。

L (int) [long long]

將一個 Python 整數轉換成 C 的 long long

K (int) [unsigned long long]

將一個 Python 整數轉換成 C 的 unsigned long long,轉換過程無溢位檢查。

n (int) [Py_ssize_t]

將一個 Python 整數轉換成 C 的 Py_ssize_t

cbytes 或長度為 1 的 bytearray)[char]

将一个 Python 字节类型,如一个长度为 1 的 bytesbytearray 对象,转换为 C char

在 3.3 版的變更: 允許 bytearray 物件。

C(長度為 1 的 str)[int]

将一个 Python 字符,如一个长度为 1 的 str 对象,转换为 C int

f (float) [float]

將一個 Python 浮點數轉換成 C 的 :c:type:float

d (float) [double]

將一個 Python 浮點數轉換成 C 的 :c:type:double

D (complex) [Py_complex]

將一個 Python 複數轉換成 C 的 Py_complex 結構。

其他物件

O(物件)[PyObject *]

将 Python 对象(未经任何转换)存储到一个 C 对象指针中。 这样 C 程序就能接收到实际传递的对象。 对象的新 strong reference 不会被创建(即其引用计数不会增加)。 存储的指针将不为 NULL

O!(物件)[typeobject, PyObject *]

将一个 Python 对象存入一个 C 对象指针。 这类似于 O,但是接受两个 C 参数:第一个是 Python 类型对象的地址,第二个是存储对象指针的 C 变量 (类型为 PyObject*)。 如果 Python 对象不具有所要求的类型,则会引发 TypeError

O&(物件)[converter, anything]

通过 converter 函数将 Python 对象转换为 C 变量。这需要两个参数:第一个是函数,第二个是 C 变量(任意类型)的地址,转换为 void*转换器 函数依次调用如下:

status = converter(object, address);

其中 object 是待转换的 Python 对象而 address 为传给 PyArg_Parse* 函数的 void* 参数。 返回的 status 应当以 1 代表转换成功而以 0 代表转换失败。 当转换失败时,converter 函数应当引发异常并让 address 的内容保持未修改状态。

如果 converter 返回 Py_CLEANUP_SUPPORTED ,则如果参数解析最终失败,它可能会再次调用该函数,从而使转换器有机会释放已分配的任何内存。在第二个调用中,object 参数将为 NULL ;因此,该参数将为 NULL ;因此,该参数将为 NULL ,因此,该参数将为 NULL (如果值)为 NULL address 的值与原始呼叫中的值相同。

在 3.1 版的變更: 加入 Py_CLEANUP_SUPPORTED

p (bool) [int]

测试传入的值是否为真(一个布尔判断)并且将结果转化为相对应的 C true/false 整型值。如果表达式为真置 1,假则置 0。它接受任何合法的 Python 值。参见 真值檢測 获取更多关于 Python 如何测试值为真的信息。

Added in version 3.3.

(items) (tuple) [matching-items]

对象必须是 Python 序列,它的长度是 items 中格式单元的数量。C 参数必须对应 items 中每一个独立的格式单元。序列中的格式单元可能有嵌套。

传递 "long" 整型 (取值超出平台的 LONG_MAX 限制的整形) 是可能的,然而不会进行适当的范围检测 --- 当接受字段太小而接收不到值时,最高有效比特位会被静默地截断 (实际上,该语义是继承自 C 的向下转换 --- 你的计数可能会发生变化)。

格式化字符串中还有一些其他的字符具有特殊的涵义。这些可能并不嵌套在圆括号中。它们是:

|

表明在 Python 参数列表中剩下的参数都是可选的。C 变量对应的可选参数需要初始化为默认值——当一个可选参数没有指定时, PyArg_ParseTuple() 不能访问相应的 C 变量(变量集)的内容。

$

PyArg_ParseTupleAndKeywords() only:表明在 Python 参数列表中剩下的参数都是强制关键字参数。当前,所有强制关键字参数都必须也是可选参数,所以格式化字符串中 | 必须一直在 $ 前面。

Added in version 3.3.

:

格式单元的列表结束标志;冒号后的字符串被用来作为错误消息中的函数名(PyArg_ParseTuple() 函数引发的“关联值”异常)。

;

格式单元的列表结束标志;分号后的字符串被用来作为错误消息取代默认的错误消息。 :; 相互排斥。

请注意提供给调用者的任何 Python 对象引用都是 借入 引用;不要释放它们(即不要递减它们的引用计数)!

传递给这些函数的附加参数必须是由格式化字符串确定的变量的地址;这些都是用来存储输入元组的值。有一些情况,如上面的格式单元列表中所描述的,这些参数作为输入值使用;在这种情况下,它们应该匹配指定的相应的格式单元。

为了让转换成功,arg 对象必须匹配格式并且格式必须被用尽。 当成功时,PyArg_Parse* 函数将返回真值,否则将返回假值并引发适当的异常。 当 PyArg_Parse* 函数由于某个格式单元转换出错而失败时,该格式单元及其后续格式单元对应的地址上的变量都将保持原样。

API 函式

int PyArg_ParseTuple(PyObject *args, const char *format, ...)
穩定 ABI 的一部分.

解析一个函数的参数,表达式中的参数按参数位置顺序存入局部变量中。成功返回 true;失败返回 false 并且引发相应的异常。

int PyArg_VaParse(PyObject *args, const char *format, va_list vargs)
穩定 ABI 的一部分.

PyArg_ParseTuple() 相同,然而它接受一个 va_list 类型的参数而不是可变数量的参数集。

int PyArg_ParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], ...)
穩定 ABI 的一部分.

Parse the parameters of a function that takes both positional and keyword parameters into local variables. The keywords argument is a NULL-terminated array of keyword parameter names. Empty names denote positional-only parameters. Returns true on success; on failure, it returns false and raises the appropriate exception.

在 3.6 版的變更: 添加了 positional-only parameters 的支持。

int PyArg_VaParseTupleAndKeywords(PyObject *args, PyObject *kw, const char *format, char *keywords[], va_list vargs)
穩定 ABI 的一部分.

PyArg_ParseTupleAndKeywords() 相同,然而它接受一个va_list类型的参数而不是可变数量的参数集。

int PyArg_ValidateKeywordArguments(PyObject*)
穩定 ABI 的一部分.

确保字典中的关键字参数都是字符串。这个函数只被使用于 PyArg_ParseTupleAndKeywords() 不被使用的情况下,后者已经不再做这样的检查。

Added in version 3.2.

int PyArg_Parse(PyObject *args, const char *format, ...)
穩定 ABI 的一部分.

Function used to deconstruct the argument lists of "old-style" functions --- these are functions which use the METH_OLDARGS parameter parsing method, which has been removed in Python 3. This is not recommended for use in parameter parsing in new code, and most code in the standard interpreter has been modified to no longer use this for that purpose. It does remain a convenient way to decompose other tuples, however, and may continue to be used for that purpose.

int PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
穩定 ABI 的一部分.

一个更简单的形参提取形式,它不使用格式字符串来指定参数类型。 使用此方法来提取其形参的函数应当在函数或方法表中声明为 METH_VARARGS。 包含实际形参的元组应当作为 args 传入;它必须确实是一个元组。 该元组的长度必须至少为 min 且不超过 maxminmax 可能相等。 额外的参数必须被传给函数,每个参数应当是一个指向 PyObject* 变量的指针;它们将以来自 args 的值来填充; 它们将包含 借入引用。 对应于 args 未给出的可选形参的变量不会被填充; 它们应当由调用方来初始化。 此函数在执行成功时返回真值而在 args 不为元组或包含错误数量的元素时返回假值;如果执行失败则还将设置一个异常。

这是一个使用该函数的示例,取自 _weakref 弱引用辅助模块的源代码:

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() 完全等价于调用 PyArg_ParseTuple():

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

创建变量

PyObject *Py_BuildValue(const char *format, ...)
回傳值:新的參照。穩定 ABI 的一部分.

基于类似 PyArg_Parse* 函数族所接受内容的格式字符串和一个值序列来创建一个新值。 返回该值或在发生错误的情况下返回 NULL;如果返回 NULL 则将引发一个异常。

Py_BuildValue() 并不一直创建一个元组。只有当它的格式化字符串包含两个或更多的格式单元才会创建一个元组。如果格式化字符串是空,它返回 None;如果它包含一个格式单元,它返回由格式单元描述的的任一对象。用圆括号包裹格式化字符串可以强制它返回一个大小为 0 或者 1 的元组。

当内存缓存区的数据以参数形式传递用来构建对象时,如 ss# 格式单元,会拷贝需要的数据。调用者提供的缓冲区从来都不会被由 Py_BuildValue() 创建的对象来引用。换句话说,如果你的代码调用 malloc() 并且将分配的内存空间传递给 Py_BuildValue(),你的代码就有责任在 Py_BuildValue() 返回时调用 free()

在下面的描述中,双引号的表达式使格式单元;圆括号 () 内的是格式单元将要返回的 Python 对象类型;方括号 [] 内的是传递的 C 变量(变量集)的类型。

字符例如空格,制表符,冒号和逗号在格式化字符串中会被忽略(但是不包括格式单元,如 s#)。这可以使很长的格式化字符串具有更好的可读性。

sstrNone)[const char *]

使用 'utf-8' 编码将空终止的 C 字符串转换为 Python str 对象。如果 C 字符串指针为 NULL,则使用 None

s#strNone)[const char *, Py_ssize_t]

使用 'utf-8' 编码将 C 字符串及其长度转换为 Python str 对象。如果 C 字符串指针为 NULL,则长度将被忽略,并返回 None

y (bytes) [const char *]

这将 C 字符串转换为 Python bytes 对象。 如果 C 字符串指针为 NULL,则返回 None

y# (bytes) [const char *, Py_ssize_t]

这会将 C 字符串及其长度转换为一个 Python 对象。 如果该 C 字符串指针为 NULL,则返回 None

zstrNone)[const char *]

s 相同。

z#strNone)[const char *, Py_ssize_t]

s# 相同。

u (str) [const wchar_t *]

将空终止的 wchar_t 的 Unicode (UTF-16 或 UCS-4) 数据缓冲区转换为 Python Unicode 对象。 如果 Unicode 缓冲区指针为 NULL,则返回 None

u# (str) [const wchar_t *, Py_ssize_t]

将 Unicode (UTF-16 或 UCS-4) 数据缓冲区及其长度转换为 Python Unicode 对象。 如果 Unicode 缓冲区指针为 NULL,则长度将被忽略,并返回 None

UstrNone)[const char *]

s 相同。

U#strNone)[const char *, Py_ssize_t]

s# 相同。

i (int) [int]

將一個 C 的 int 轉換成 Python 整數物件。

b (int) [char]

將一個 C 的 char 轉換成 Python 整數物件。

h (int) [short int]

將一個 C 的 short int 轉換成 Python 整數物件。

l (int) [long int]

將一個 C 的 long int 轉換成 Python 整數物件。

B (int) [unsigned char]

將一個 C 的 unsigned char 轉換成 Python 整數物件。

H (int) [unsigned short int]

將一個 C 的 unsigned short int 轉換成 Python 整數物件。

I (int) [unsigned int]

將一個 C 的 unsigned int 轉換成 Python 整數物件。

k (int) [unsigned long]

將一個 C 的 unsigned long 轉換成 Python 整數物件。

L (int) [long long]

將一個 C 的 long long 轉換成 Python 整數物件。

K (int) [unsigned long long]

將一個 C 的 unsigned long long 轉換成 Python 整數物件。

n (int) [Py_ssize_t]

將一個 C 的 Py_ssize_t 轉換成 Python 整數。

c(長度為 1 的 bytes)[char]

將一個 C 中代表一個位元組的 int 轉換成 Python 中長度為一的 bytes

C(長度為 1 的 str)[int]

將一個 C 中代表一個字元的 int 轉換成 Python 中長度為一的 str

d (float) [double]

將一個 C 的 double 轉換成 Python 浮點數。

f (float) [float]

將一個 C 的 float 轉換成 Python 浮點數。

D (complex) [Py_complex *]

將一個 C 的 Py_complex 結構轉換成 Python 複數。

O(物件)[PyObject *]

原封不动地传递一个 Python 对象,但为其创建一个新的 strong reference (即其引用计数加一)。 如果传入的对象是一个 NULL 指针,则会假定这是因为产生该参数的调用发现了错误并设置了异常。 因此,Py_BuildValue() 将返回 NULL 但不会引发异常。 如果尚未引发异常,则会设置 SystemError

S(物件)[PyObject *]

O 相同。

N(物件)[PyObject *]

O 相同,但它不会创建新的 strong reference。 如果对象是通过调用参数列表中的对象构造器来创建的则该方法将很有用处。

O&(物件)[converter, anything]

通过 converter 函数将 anything 转换为 Python 对象。 该函数在调用时附带 anything (它应当兼容 void*) 作为其参数并且应返回一个 "新的" Python 对象,或者如果发生错误则返回 NULL

(items) (tuple) [matching-items]

将一个 C 变量序列转换成 Python 元组并保持相同的元素数量。

[items] (list) [matching-items]

将一个 C 变量序列转换成 Python 列表并保持相同的元素数量。

{items} (dict) [matching-items]

将一个C变量序列转换成 Python 字典。每一对连续的 C 变量对作为一个元素插入字典中,分别作为关键字和值。

如果格式字符串中出现错误,则设置 SystemError 异常并返回 NULL

PyObject *Py_VaBuildValue(const char *format, va_list vargs)
回傳值:新的參照。穩定 ABI 的一部分.

Py_BuildValue() 相同,然而它接受一个 va_list 类型的参数而不是可变数量的参数集。