物件協定

PyObject*Py_GetConstant(unsignedintconstant_id)
為穩定 ABI 的一部分 自 3.13 版本開始.

Get astrong reference to a constant.

如果constant_id 無效，則設定一個例外並回傳NULL。

constant_id 必須是這些常數識別字之一：

常數識別字

數值

回傳物件

Py_CONSTANT_NONE

0

None

Py_CONSTANT_FALSE

1

False

Py_CONSTANT_TRUE

2

True

Py_CONSTANT_ELLIPSIS

3

Ellipsis

Py_CONSTANT_NOT_IMPLEMENTED

4

NotImplemented

Py_CONSTANT_ZERO

5

0

Py_CONSTANT_ONE

6

1

Py_CONSTANT_EMPTY_STR

7

''

Py_CONSTANT_EMPTY_BYTES

8

b''

Py_CONSTANT_EMPTY_TUPLE

9

()

Numeric values are only given for projects which cannot use the constantidentifiers.

在 3.13 版被加入.

在 CPython 中，所有這些常數都是不滅的。

PyObject*Py_GetConstantBorrowed(unsignedintconstant_id)
為穩定 ABI 的一部分 自 3.13 版本開始.

Similar toPy_GetConstant(), but return aborrowedreference.

This function is primarily intended for backwards compatibility:usingPy_GetConstant() is recommended for new code.

The reference is borrowed from the interpreter, and is valid until theinterpreter finalization.

在 3.13 版被加入.

PyObject*Py_NotImplemented

TheNotImplemented singleton, used to signal that an operation isnot implemented for the given type combination.

Py_RETURN_NOTIMPLEMENTED

Properly handle returningPy_NotImplemented from within a Cfunction (that is, create a newstrong referencetoNotImplemented and return it).

Py_PRINT_RAW

Flag to be used with multiple functions that print the object (likePyObject_Print() andPyFile_WriteObject()).If passed, these function would use thestr() of the objectinstead of therepr().

intPyObject_Print(PyObject*o,FILE*fp,intflags)

Print an objecto, on filefp. Returns-1 on error. The flags argumentis used to enable certain printing options. The only option currently supportedisPy_PRINT_RAW; if given, thestr() of the object is writteninstead of therepr().

intPyObject_HasAttrWithError(PyObject*o,PyObject*attr_name)
為穩定 ABI 的一部分 自 3.13 版本開始.

Returns1 ifo has the attributeattr_name, and0 otherwise.This is equivalent to the Python expressionhasattr(o,attr_name).On failure, return-1.

在 3.13 版被加入.

intPyObject_HasAttrStringWithError(PyObject*o,constchar*attr_name)
為穩定 ABI 的一部分 自 3.13 版本開始.

This is the same asPyObject_HasAttrWithError(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

在 3.13 版被加入.

intPyObject_HasAttr(PyObject*o,PyObject*attr_name)
為穩定 ABI 的一部分.

Returns1 ifo has the attributeattr_name, and0 otherwise.This function always succeeds.

備註

Exceptions that occur when this calls__getattr__() and__getattribute__() methods aren't propagated,but instead given tosys.unraisablehook().For proper error handling, usePyObject_HasAttrWithError(),PyObject_GetOptionalAttr() orPyObject_GetAttr() instead.

intPyObject_HasAttrString(PyObject*o,constchar*attr_name)
為穩定 ABI 的一部分.

This is the same asPyObject_HasAttr(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

備註

Exceptions that occur when this calls__getattr__() and__getattribute__() methods or while creating the temporarystr object are silently ignored.For proper error handling, usePyObject_HasAttrStringWithError(),PyObject_GetOptionalAttrString()orPyObject_GetAttrString() instead.

PyObject*PyObject_GetAttr(PyObject*o,PyObject*attr_name)
回傳值：新的參照。 為穩定 ABI 的一部分.

Retrieve an attribute namedattr_name from objecto. Returns the attributevalue on success, orNULL on failure. This is the equivalent of the Pythonexpressiono.attr_name.

If the missing attribute should not be treated as a failure, you can usePyObject_GetOptionalAttr() instead.

PyObject*PyObject_GetAttrString(PyObject*o,constchar*attr_name)
回傳值：新的參照。 為穩定 ABI 的一部分.

This is the same asPyObject_GetAttr(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

If the missing attribute should not be treated as a failure, you can usePyObject_GetOptionalAttrString() instead.

intPyObject_GetOptionalAttr(PyObject*obj,PyObject*attr_name,PyObject**result);
為穩定 ABI 的一部分 自 3.13 版本開始.

Variant ofPyObject_GetAttr() which doesn't raiseAttributeError if the attribute is not found.

If the attribute is found, return1 and set*result to a newstrong reference to the attribute.If the attribute is not found, return0 and set*result toNULL;theAttributeError is silenced.If an error other thanAttributeError is raised, return-1 andset*result toNULL.

在 3.13 版被加入.

intPyObject_GetOptionalAttrString(PyObject*obj,constchar*attr_name,PyObject**result);
為穩定 ABI 的一部分 自 3.13 版本開始.

This is the same asPyObject_GetOptionalAttr(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

在 3.13 版被加入.

PyObject*PyObject_GenericGetAttr(PyObject*o,PyObject*name)
回傳值：新的參照。 為穩定 ABI 的一部分.

Generic attribute getter function that is meant to be put into a typeobject'stp_getattro slot. It looks for a descriptor in the dictionaryof 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-datadescriptors don't. Otherwise, anAttributeError is raised.

intPyObject_SetAttr(PyObject*o,PyObject*attr_name,PyObject*v)
為穩定 ABI 的一部分.

Set the value of the attribute namedattr_name, for objecto, to the valuev. Raise an exception and return-1 on failure;return0 on success. This is the equivalent of the Python statemento.attr_name=v.

Ifv isNULL, the attribute is deleted. This behaviour is deprecatedin favour of usingPyObject_DelAttr(), but there are currently noplans to remove it.

intPyObject_SetAttrString(PyObject*o,constchar*attr_name,PyObject*v)
為穩定 ABI 的一部分.

This is the same asPyObject_SetAttr(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

Ifv isNULL, the attribute is deleted, but this feature isdeprecated in favour of usingPyObject_DelAttrString().

The number of different attribute names passed to this functionshould be kept small, usually by using a statically allocated stringasattr_name.For attribute names that aren't known at compile time, prefer callingPyUnicode_FromString() andPyObject_SetAttr() directly.For more details, seePyUnicode_InternFromString(), which may beused internally to create a key object.

intPyObject_GenericSetAttr(PyObject*o,PyObject*name,PyObject*value)
為穩定 ABI 的一部分.

Generic attribute setter and deleter function that is meantto be put into a type object'stp_setattroslot. It looks for a data descriptor in thedictionary of classes in the object's MRO, and if found it takes preferenceover setting or deleting the attribute in the instance dictionary. Otherwise, theattribute is set or deleted in the object's__dict__ (if present).On success,0 is returned, otherwise anAttributeErroris raised and-1 is returned.

intPyObject_DelAttr(PyObject*o,PyObject*attr_name)
為穩定 ABI 的一部分 自 3.13 版本開始.

Delete attribute namedattr_name, for objecto. Returns-1 on failure.This is the equivalent of the Python statementdelo.attr_name.

intPyObject_DelAttrString(PyObject*o,constchar*attr_name)
為穩定 ABI 的一部分 自 3.13 版本開始.

This is the same asPyObject_DelAttr(), butattr_name isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

The number of different attribute names passed to this functionshould be kept small, usually by using a statically allocated stringasattr_name.For attribute names that aren't known at compile time, prefer callingPyUnicode_FromString() andPyObject_DelAttr() directly.For more details, seePyUnicode_InternFromString(), which may beused internally to create a key object for lookup.

PyObject*PyObject_GenericGetDict(PyObject*o,void*context)
回傳值：新的參照。 為穩定 ABI 的一部分 自 3.10 版本開始.

A generic implementation for the getter of a__dict__ descriptor. Itcreates the dictionary if necessary.

This function may also be called to get the__dict__of the objecto. PassNULL forcontext when calling it.Since this function may need to allocate memory for thedictionary, it may be more efficient to callPyObject_GetAttr()when accessing an attribute on the object.

在失敗時，會回傳NULL 並設定例外。

在 3.3 版被加入.

intPyObject_GenericSetDict(PyObject*o,PyObject*value,void*context)
為穩定 ABI 的一部分 自 3.7 版本開始.

A generic implementation for the setter of a__dict__ descriptor. Thisimplementation does not allow the dictionary to be deleted.

在 3.3 版被加入.

PyObject**_PyObject_GetDictPtr(PyObject*obj)

Return a pointer to__dict__ of the objectobj.If there is no__dict__, returnNULL without setting an exception.

This function may need to allocate memory for thedictionary, so it may be more efficient to callPyObject_GetAttr()when accessing an attribute on the object.

PyObject*PyObject_RichCompare(PyObject*o1,PyObject*o2,intopid)
回傳值：新的參照。 為穩定 ABI 的一部分.

Compare the values ofo1 ando2 using the operation specified byopid,which must be one ofPy_LT,Py_LE,Py_EQ,Py_NE,Py_GT, orPy_GE, corresponding to<,<=,==,!=,>, or>= respectively. This is the equivalent ofthe Python expressiono1opo2, whereop is the operator correspondingtoopid. Returns the value of the comparison on success, orNULL on failure.

intPyObject_RichCompareBool(PyObject*o1,PyObject*o2,intopid)
為穩定 ABI 的一部分.

Compare the values ofo1 ando2 using the operation specified byopid,likePyObject_RichCompare(), but returns-1 on error,0 ifthe result is false,1 otherwise.

備註

Ifo1 ando2 are the same object,PyObject_RichCompareBool()will always return1 forPy_EQ and0 forPy_NE.

PyObject*PyObject_Format(PyObject*obj,PyObject*format_spec)
為穩定 ABI 的一部分.

Formatobj usingformat_spec. This is equivalent to the Pythonexpressionformat(obj,format_spec).

format_spec may beNULL. In this case the call is equivalenttoformat(obj).Returns the formatted string on success,NULL on failure.

PyObject*PyObject_Repr(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

Compute a string representation of objecto. Returns the stringrepresentation on success,NULL on failure. This is the equivalent of thePython expressionrepr(o). Called by therepr() built-in function.

在 3.4 版的變更:This function now includes a debug assertion to help ensure that itdoes not silently discard an active exception.

PyObject*PyObject_ASCII(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

AsPyObject_Repr(), compute a string representation of objecto, butescape the non-ASCII characters in the string returned byPyObject_Repr() with\x,\u or\U escapes. This generatesa string similar to that returned byPyObject_Repr() in Python 2.Called by theascii() built-in function.

PyObject*PyObject_Str(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

Compute a string representation of objecto. Returns the stringrepresentation on success,NULL on failure. This is the equivalent of thePython expressionstr(o). Called by thestr() built-in functionand, therefore, by theprint() function.

在 3.4 版的變更:This function now includes a debug assertion to help ensure that itdoes not silently discard an active exception.

PyObject*PyObject_Bytes(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

Compute a bytes representation of objecto.NULL is returned onfailure and a bytes object on success. This is equivalent to the Pythonexpressionbytes(o), wheno is not an integer. Unlikebytes(o),a TypeError is raised wheno is an integer instead of a zero-initializedbytes object.

intPyObject_IsSubclass(PyObject*derived,PyObject*cls)
為穩定 ABI 的一部分.

Return1 if the classderived is identical to or derived from the classcls, otherwise return0. In case of an error, return-1.

Ifcls is a tuple, the check will be done against every entry incls.The result will be1 when at least one of the checks returns1,otherwise it will be0.

Ifcls has a__subclasscheck__() method, it will be called todetermine the subclass status as described inPEP 3119. Otherwise,derived is a subclass ofcls if it is a direct or indirect subclass,i.e. contained incls.__mro__.

Normally only class objects, i.e. instances oftype or a derivedclass, are considered classes. However, objects can override this by havinga__bases__ attribute (which must be a tuple of base classes).

intPyObject_IsInstance(PyObject*inst,PyObject*cls)
為穩定 ABI 的一部分.

Return1 ifinst is an instance of the classcls or a subclass ofcls, or0 if not. On error, returns-1 and sets an exception.

Ifcls is a tuple, the check will be done against every entry incls.The result will be1 when at least one of the checks returns1,otherwise it will be0.

Ifcls has a__instancecheck__() method, it will be called todetermine the subclass status as described inPEP 3119. Otherwise,instis an instance ofcls if its class is a subclass ofcls.

An instanceinst can override what is considered its class by having a__class__ attribute.

An objectcls can override if it is considered a class, and what its baseclasses are, by having a__bases__ attribute (which must be a tupleof base classes).

Py_hash_tPyObject_Hash(PyObject*o)
為穩定 ABI 的一部分.

Compute and return the hash value of an objecto. On failure, return-1.This is the equivalent of the Python expressionhash(o).

在 3.2 版的變更:The return type is now Py_hash_t. This is a signed integer the same sizeasPy_ssize_t.

Py_hash_tPyObject_HashNotImplemented(PyObject*o)
為穩定 ABI 的一部分.

Set aTypeError indicating thattype(o) is nothashable and return-1.This function receives special treatment when stored in atp_hash slot,allowing a type to explicitly indicate to the interpreter that it is nothashable.

intPyObject_IsTrue(PyObject*o)
為穩定 ABI 的一部分.

Returns1 if the objecto is considered to be true, and0 otherwise.This is equivalent to the Python expressionnotnoto. On failure, return-1.

intPyObject_Not(PyObject*o)
為穩定 ABI 的一部分.

Returns0 if the objecto is considered to be true, and1 otherwise.This is equivalent to the Python expressionnoto. On failure, return-1.

PyObject*PyObject_Type(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

Wheno is non-NULL, returns a type object corresponding to the object typeof objecto. On failure, raisesSystemError and returnsNULL. Thisis equivalent to the Python expressiontype(o).This function creates a newstrong reference to the return value.There's really no reason to use thisfunction instead of thePy_TYPE() function, which returns apointer of typePyTypeObject*, except when a newstrong reference is needed.

intPyObject_TypeCheck(PyObject*o,PyTypeObject*type)

Return non-zero if the objecto is of typetype or a subtype oftype, and0 otherwise. Both parameters must be non-NULL.

Py_ssize_tPyObject_Size(PyObject*o)
Py_ssize_tPyObject_Length(PyObject*o)
為穩定 ABI 的一部分.

Return the length of objecto. If the objecto provides either the sequenceand mapping protocols, the sequence length is returned. On error,-1 isreturned. This is the equivalent to the Python expressionlen(o).

Py_ssize_tPyObject_LengthHint(PyObject*o,Py_ssize_tdefaultvalue)

Return an estimated length for the objecto. First try to return itsactual length, then an estimate using__length_hint__(), andfinally return the default value. On error return-1. This is theequivalent to the Python expressionoperator.length_hint(o,defaultvalue).

在 3.4 版被加入.

PyObject*PyObject_GetItem(PyObject*o,PyObject*key)
回傳值：新的參照。 為穩定 ABI 的一部分.

Return element ofo corresponding to the objectkey orNULL on failure.This is the equivalent of the Python expressiono[key].

intPyObject_SetItem(PyObject*o,PyObject*key,PyObject*v)
為穩定 ABI 的一部分.

Map the objectkey to the valuev. Raise an exception andreturn-1 on failure; return0 on success. This is theequivalent of the Python statemento[key]=v. This functiondoesnot steal a reference tov.

intPyObject_DelItem(PyObject*o,PyObject*key)
為穩定 ABI 的一部分.

Remove the mapping for the objectkey from the objecto. Return-1on failure. This is equivalent to the Python statementdelo[key].

intPyObject_DelItemString(PyObject*o,constchar*key)
為穩定 ABI 的一部分.

This is the same asPyObject_DelItem(), butkey isspecified as aconstchar* UTF-8 encoded bytes string,rather than aPyObject*.

PyObject*PyObject_Dir(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

This is equivalent to the Python expressiondir(o), returning a (possiblyempty) list of strings appropriate for the object argument, orNULL if therewas an error. If the argument isNULL, this is like the Pythondir(),returning the names of the current locals; in this case, if no execution frameis active thenNULL is returned butPyErr_Occurred() will return false.

PyObject*PyObject_GetIter(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分.

This is equivalent to the Python expressioniter(o). It returns a newiterator for the object argument, or the object itself if the object is alreadyan iterator. RaisesTypeError and returnsNULL if the object cannot beiterated.

PyObject*PyObject_SelfIter(PyObject*obj)
回傳值：新的參照。 為穩定 ABI 的一部分.

This is equivalent to the Python__iter__(self):returnself method.It is intended foriterator types, to be used in thePyTypeObject.tp_iter slot.

PyObject*PyObject_GetAIter(PyObject*o)
回傳值：新的參照。 為穩定 ABI 的一部分 自 3.10 版本開始.

This is the equivalent to the Python expressionaiter(o). Takes anAsyncIterable object and returns anAsyncIterator for it.This is typically a new iterator but if the argument is anAsyncIterator, this returns itself. RaisesTypeError andreturnsNULL if the object cannot be iterated.

在 3.10 版被加入.

void*PyObject_GetTypeData(PyObject*o,PyTypeObject*cls)
為穩定 ABI 的一部分 自 3.12 版本開始.

Get a pointer to subclass-specific data reserved forcls.

The objecto must be an instance ofcls, andcls must have beencreated using negativePyType_Spec.basicsize.Python does not check this.

錯誤時設定一個例外並回傳NULL。

在 3.12 版被加入.

Py_ssize_tPyType_GetTypeDataSize(PyTypeObject*cls)
為穩定 ABI 的一部分 自 3.12 版本開始.

Return the size of the instance memory space reserved forcls, i.e. the size of thememoryPyObject_GetTypeData() returns.

This may be larger than requested using-PyType_Spec.basicsize;it is safe to use this larger size (e.g. withmemset()).

The typeclsmust have been created usingnegativePyType_Spec.basicsize.Python does not check this.

錯誤時設定一個例外並回傳一個負值。

在 3.12 版被加入.

void*PyObject_GetItemData(PyObject*o)

Get a pointer to per-item data for a class withPy_TPFLAGS_ITEMS_AT_END.

錯誤時設定一個例外並回傳NULL。如果o 沒有設定Py_TPFLAGS_ITEMS_AT_END，則會引發TypeError。

在 3.12 版被加入.

intPyObject_VisitManagedDict(PyObject*obj,visitprocvisit,void*arg)

Visit the managed dictionary ofobj.

This function must only be called in a traverse function of the type whichhas thePy_TPFLAGS_MANAGED_DICT flag set.

在 3.13 版被加入.

voidPyObject_ClearManagedDict(PyObject*obj)

Clear the managed dictionary ofobj.

This function must only be called in a traverse function of the type whichhas thePy_TPFLAGS_MANAGED_DICT flag set.

在 3.13 版被加入.