The
NotImplemented
singleton, used to signal that an operation is not implemented for the given type combination.
Properly 处理返回
Py_NotImplemented
from within a C function (that is, create a new
强引用
to
NotImplemented
and return it).
Flag to be used with multiple functions that print the object (like
PyObject_Print()
and
PyFile_WriteObject()
). If passed, these function would use the
str()
of the object instead of the
repr()
.
打印对象
o
，在文件
fp
。返回
-1
on error. The flags argument is used to enable certain printing options. The only option currently supported is
Py_PRINT_RAW
；若给定，
str()
对象被写入而不是
repr()
.
返回
1
if
o
has the attribute
attr_name
，和
0
otherwise. This is equivalent to the Python expression
hasattr(o, attr_name)
. This function always succeeds.
注意
Exceptions that occur when this calls
__getattr__()
and
__getattribute__()
methods are silently ignored. For proper error handling, use
PyObject_GetAttr()
代替。
这如同
PyObject_HasAttr()
，但
attr_name
is specified as a
const
char
*
UTF-8 encoded bytes string, rather than a
PyObject
*
.
注意
Exceptions that occur when this calls
__getattr__()
and
__getattribute__()
methods or while creating the temporary
str
object are silently ignored. For proper error handling, use
PyObject_GetAttrString()
代替。
Retrieve an attribute named
attr_name
from object
o
. Returns the attribute value on success, or
NULL
on failure. This is the equivalent of the Python expression
o.attr_name
.
这如同
PyObject_GetAttr()
，但
attr_name
is specified as a
const
char
*
UTF-8 encoded bytes string, rather than a
PyObject
*
.
Generic attribute getter function that is meant to be put into a type object’s
tp_getattro
slot. It looks for a descriptor in the dictionary of classes in the object’s MRO as well as an attribute in the object’s
__dict__
(if present). As outlined in
实现描述符
, data descriptors take preference over instance attributes, while non-data descriptors don’t. Otherwise, an
AttributeError
被引发。
Set the value of the attribute named
attr_name
, for object
o
, to the value
v
. Raise an exception and return
-1
on failure; return
0
on success. This is the equivalent of the Python statement
o.attr_name = v
.
若
v
is
NULL
, the attribute is deleted. This behaviour is deprecated in favour of using
PyObject_DelAttr()
, but there are currently no plans to remove it.
这如同
PyObject_SetAttr()
，但
attr_name
is specified as a
const
char
*
UTF-8 encoded bytes string, rather than a
PyObject
*
.
若
v
is
NULL
, the attribute is deleted, but this feature is deprecated in favour of using
PyObject_DelAttrString()
.
Generic attribute setter and deleter function that is meant to be put into a type object’s
tp_setattro
slot. It looks for a data descriptor in the dictionary of classes in the object’s MRO, and if found it takes preference over setting or deleting the attribute in the instance dictionary. Otherwise, the attribute is set or deleted in the object’s
__dict__
(if present). On success,
0
is returned, otherwise an
AttributeError
is raised and
-1
被返回。
Delete attribute named
attr_name
, for object
o
。返回
-1
on failure. This is the equivalent of the Python statement
del o.attr_name
.
这如同
PyObject_DelAttr()
，但
attr_name
is specified as a
const
char
*
UTF-8 encoded bytes string, rather than a
PyObject
*
.
A generic implementation for the getter of a
__dict__
descriptor. It creates the dictionary if necessary.
This function may also be called to get the
__dict__
of the object
o
. Pass
NULL
for
context
when calling it. Since this function may need to allocate memory for the dictionary, it may be more efficient to call
PyObject_GetAttr()
when accessing an attribute on the object.
On failure, returns
NULL
with an exception set.
Added in version 3.3.
A generic implementation for the setter of a
__dict__
descriptor. This implementation does not allow the dictionary to be deleted.
Added in version 3.3.
Return a pointer to
__dict__
of the object
obj
. If there is no
__dict__
，返回
NULL
without setting an exception.
This function may need to allocate memory for the dictionary, so it may be more efficient to call
PyObject_GetAttr()
when accessing an attribute on the object.
Compare the values of
o1
and
o2
using the operation specified by
opid
, which must be one of
Py_LT
,
Py_LE
,
Py_EQ
,
Py_NE
,
Py_GT
，或
Py_GE
, corresponding to
<
,
<=
,
==
,
!=
,
>
，或
>=
respectively. This is the equivalent of the Python expression
o1 op o2
，其中
op
is the operator corresponding to
opid
. Returns the value of the comparison on success, or
NULL
当故障时。
Compare the values of
o1
and
o2
using the operation specified by
opid
，像
PyObject_RichCompare()
，但返回
-1
当出错时，
0
if the result is false,
1
否则。
注意
若
o1
and
o2
are the same object,
PyObject_RichCompareBool()
will always return
1
for
Py_EQ
and
0
for
Py_NE
.
格式
obj
使用
format_spec
. This is equivalent to the Python expression
format(obj, format_spec)
.
format_spec
可以是
NULL
. In this case the call is equivalent to
format(obj)
. Returns the formatted string on success,
NULL
当故障时。
Compute a string representation of object
o
. Returns the string representation on success,
NULL
on failure. This is the equivalent of the Python expression
repr(o)
. Called by the
repr()
内置函数。
3.4 版改变： This function now includes a debug assertion to help ensure that it does not silently discard an active exception.
As
PyObject_Repr()
, compute a string representation of object
o
, but escape the non-ASCII characters in the string returned by
PyObject_Repr()
with
\x
,
\u
or
\U
转义。这生成的字符串类似返回通过
PyObject_Repr()
in Python 2. Called by the
ascii()
内置函数。
Compute a string representation of object
o
. Returns the string representation on success,
NULL
on failure. This is the equivalent of the Python expression
str(o)
. Called by the
str()
built-in function and, therefore, by the
print()
函数。
3.4 版改变： This function now includes a debug assertion to help ensure that it does not silently discard an active exception.
Compute a bytes representation of object
o
.
NULL
is returned on failure and a bytes object on success. This is equivalent to the Python expression
bytes(o)
，当
o
is not an integer. Unlike
bytes(o)
, a TypeError is raised when
o
is an integer instead of a zero-initialized bytes object.
返回
1
if the class
derived
is identical to or derived from the class
cls
，否则返回
0
. In case of an error, return
-1
.
若
cls
is a tuple, the check will be done against every entry in
cls
. The result will be
1
when at least one of the checks returns
1
, otherwise it will be
0
.
若
cls
拥有
__subclasscheck__()
method, it will be called to determine the subclass status as described in
PEP 3119
。否则，
derived
是子类化的
cls
if it is a direct or indirect subclass, i.e. contained in
cls.__mro__
.
Normally only class objects, i.e. instances of
type
or a derived class, are considered classes. However, objects can override this by having a
__bases__
attribute (which must be a tuple of base classes).
返回
1
if
inst
is an instance of the class
cls
或子类化的
cls
，或
0
if not. On error, returns
-1
and sets an exception.
若
cls
is a tuple, the check will be done against every entry in
cls
. The result will be
1
when at least one of the checks returns
1
, otherwise it will be
0
.
若
cls
拥有
__instancecheck__()
method, it will be called to determine the subclass status as described in
PEP 3119
。否则，
inst
是实例化的
cls
if its class is a subclass of
cls
.
An instance
inst
can override what is considered its class by having a
__class__
属性。
An object
cls
can override if it is considered a class, and what its base classes are, by having a
__bases__
attribute (which must be a tuple of base classes).
Compute and return the hash value of an object
o
. On failure, return
-1
. This is the equivalent of the Python expression
hash(o)
.
3.2 版改变：
The return type is now Py_hash_t. This is a signed integer the same size as
Py_ssize_t
.
设置
TypeError
indicating that
type(o)
不是
hashable
并返回
-1
. This function receives special treatment when stored in a
tp_hash
slot, allowing a type to explicitly indicate to the interpreter that it is not hashable.
返回
1
if the object
o
is considered to be true, and
0
otherwise. This is equivalent to the Python expression
not not o
. On failure, return
-1
.
返回
0
if the object
o
is considered to be true, and
1
otherwise. This is equivalent to the Python expression
not o
. On failure, return
-1
.
当
o
为非
NULL
, returns a type object corresponding to the object type of object
o
. On failure, raises
SystemError
并返回
NULL
. This is equivalent to the Python expression
type(o)
. This function creates a new
强引用
to the return value. There’s really no reason to use this function instead of the
Py_TYPE()
function, which returns a pointer of type
PyTypeObject
*
, except when a new
强引用
is needed.
Return non-zero if the object
o
是类型
type
或子类型的
type
，和
0
otherwise. Both parameters must be non-
NULL
.
Return the length of object
o
. If the object
o
provides either the sequence and mapping protocols, the sequence length is returned. On error,
-1
is returned. This is the equivalent to the Python expression
len(o)
.
Return an estimated length for the object
o
. First try to return its actual length, then an estimate using
__length_hint__()
, and finally return the default value. On error return
-1
. This is the equivalent to the Python expression
operator.length_hint(o, defaultvalue)
.
Added in version 3.4.
Return element of
o
corresponding to the object
key
or
NULL
on failure. This is the equivalent of the Python expression
o[key]
.
Map the object
key
to the value
v
. Raise an exception and return
-1
on failure; return
0
on success. This is the equivalent of the Python statement
o[key] = v
. This function
does not
steal a reference to
v
.
Remove the mapping for the object
key
from the object
o
。返回
-1
on failure. This is equivalent to the Python statement
del o[key]
.
This is equivalent to the Python expression
dir(o)
, returning a (possibly empty) list of strings appropriate for the object argument, or
NULL
if there was an error. If the argument is
NULL
, this is like the Python
dir()
, returning the names of the current locals; in this case, if no execution frame is active then
NULL
is returned but
PyErr_Occurred()
will return false.
This is equivalent to the Python expression
iter(o)
. It returns a new iterator for the object argument, or the object itself if the object is already an iterator. Raises
TypeError
并返回
NULL
if the object cannot be iterated.
This is the equivalent to the Python expression
aiter(o)
. Takes an
AsyncIterable
object and returns an
AsyncIterator
for it. This is typically a new iterator but if the argument is an
AsyncIterator
, this returns itself. Raises
TypeError
并返回
NULL
if the object cannot be iterated.
Added in version 3.10.
Get a pointer to subclass-specific data reserved for cls .
The object
o
必须是实例化的
cls
，和
cls
must have been created using negative
PyType_Spec.basicsize
. Python does not check this.
On error, set an exception and return
NULL
.
3.12 版添加。
Return the size of the instance memory space reserved for
cls
, i.e. the size of the memory
PyObject_GetTypeData()
返回。
This may be larger than requested using
-PyType_Spec.basicsize
; it is safe to use this larger size (e.g. with
memset()
).
The type
cls
must
have been created using negative
PyType_Spec.basicsize
. Python does not check this.
On error, set an exception and return a negative value.
3.12 版添加。
Get a pointer to per-item data for a class with
Py_TPFLAGS_ITEMS_AT_END
.
On error, set an exception and return
NULL
.
TypeError
被引发若
o
没有
Py_TPFLAGS_ITEMS_AT_END
set.
3.12 版添加。
