Об’єктний протокол¶
-
PyObject*
Py_NotImplemented
¶ Синглтон
NotImplemented
, який використовується для сигналу про те, що операція не реалізована для даної комбінації типів.
-
Py_RETURN_NOTIMPLEMENTED
¶ Properly handle returning
Py_NotImplemented
from within a C function (that is, increment the reference count of NotImplemented and return it).
-
int
PyObject_Print
(PyObject *o, FILE *fp, int flags)¶ Print an object o, on file fp. Returns
-1
on error. The flags argument is used to enable certain printing options. The only option currently supported isPy_PRINT_RAW
; if given, thestr()
of the object is written instead of therepr()
.
-
int
PyObject_HasAttr
(PyObject *o, PyObject *attr_name)¶ Returns
1
if o has the attribute attr_name, and0
otherwise. This is equivalent to the Python expressionhasattr(o, attr_name)
. This function always succeeds.Note that exceptions which occur while calling
__getattr__()
and__getattribute__()
methods will get suppressed. To get error reporting usePyObject_GetAttr()
instead.
-
int
PyObject_HasAttrString
(PyObject *o, const char *attr_name)¶ Returns
1
if o has the attribute attr_name, and0
otherwise. This is equivalent to the Python expressionhasattr(o, attr_name)
. This function always succeeds.Note that exceptions which occur while calling
__getattr__()
and__getattribute__()
methods and creating a temporary string object will get suppressed. To get error reporting usePyObject_GetAttrString()
instead.
-
PyObject*
PyObject_GetAttr
(PyObject *o, PyObject *attr_name)¶ - Return value: New reference.
Отримати атрибут з назвою attr_name з об’єкта o. Повертає значення атрибута в разі успіху або
NULL
у разі невдачі. Це еквівалент виразу Pythono.attr_name
.
-
PyObject*
PyObject_GetAttrString
(PyObject *o, const char *attr_name)¶ - Return value: New reference.
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 expressiono.attr_name
.
-
PyObject*
PyObject_GenericGetAttr
(PyObject *o, PyObject *name)¶ - Return value: New reference.
Загальна функція отримання атрибутів, яка призначена для розміщення в слоті
tp_getattro
об’єкта типу. Він шукає дескриптор у словнику класів у MRO об’єкта, а також атрибут у__dict__
об’єкта (якщо є). Як зазначено в Реалізація дескрипторів, дескриптори даних мають перевагу над атрибутами екземплярів, тоді як дескриптори, що не є даними, ні. В іншому випадку виникає помилкаAttributeError
.
-
int
PyObject_SetAttr
(PyObject *o, PyObject *attr_name, PyObject *v)¶ Установіть значення атрибута attr_name для об’єкта o на значення v. Викликати виняток і повертати
-1
у разі помилки; повернути0
в разі успіху. Це еквівалент оператора Pythono.attr_name = v
.If v is
NULL
, the attribute is deleted, however this feature is deprecated in favour of usingPyObject_DelAttr()
.
-
int
PyObject_SetAttrString
(PyObject *o, const char *attr_name, PyObject *v)¶ Установіть значення атрибута attr_name для об’єкта o на значення v. Викликати виняток і повертати
-1
у разі помилки; повернути0
в разі успіху. Це еквівалент оператора Pythono.attr_name = v
.If v is
NULL
, the attribute is deleted, however this feature is deprecated in favour of usingPyObject_DelAttrString()
.
-
int
PyObject_GenericSetAttr
(PyObject *o, PyObject *name, PyObject *value)¶ Загальна функція встановлення та видалення атрибутів, яка призначена для розміщення в слоті
tp_setattro
об’єкта типу. Він шукає дескриптор даних у словнику класів у MRO об’єкта, і якщо його знайдено, він надає перевагу над налаштуванням або видаленням атрибута в словнику екземпляра. В іншому випадку атрибут встановлюється або видаляється в об’єкті__dict__
(якщо є). У разі успіху повертається0
, інакше виникаєAttributeError
і повертається-1
.
-
int
PyObject_DelAttr
(PyObject *o, PyObject *attr_name)¶ Видалити атрибут з назвою attr_name для об’єкта o. Повертає
-1
у разі помилки. Це еквівалент оператора Pythondel o.attr_name
.
-
int
PyObject_DelAttrString
(PyObject *o, const char *attr_name)¶ Видалити атрибут з назвою attr_name для об’єкта o. Повертає
-1
у разі помилки. Це еквівалент оператора Pythondel o.attr_name
.
-
PyObject*
PyObject_GenericGetDict
(PyObject *o, void *context)¶ - Return value: New reference.
Загальна реалізація засобу отримання дескриптора
__dict__
. Він створює словник, якщо це необхідно.Нове в версії 3.3.
-
int
PyObject_GenericSetDict
(PyObject *o, PyObject *value, void *context)¶ Загальна реалізація засобу налаштування дескриптора
__dict__
. Ця реалізація не дозволяє видаляти словник.Нове в версії 3.3.
-
PyObject*
PyObject_RichCompare
(PyObject *o1, PyObject *o2, int opid)¶ - Return value: New reference.
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
, orPy_GE
, corresponding to<
,<=
,==
,!=
,>
, or>=
respectively. This is the equivalent of the Python expressiono1 op o2
, whereop
is the operator corresponding to opid. Returns the value of the comparison on success, orNULL
on failure.
-
int
PyObject_RichCompareBool
(PyObject *o1, PyObject *o2, int opid)¶ 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
, orPy_GE
, corresponding to<
,<=
,==
,!=
,>
, or>=
respectively. Returns-1
on error,0
if the result is false,1
otherwise. This is the equivalent of the Python expressiono1 op o2
, whereop
is the operator corresponding to opid.
Примітка
If o1 and o2 are the same object, PyObject_RichCompareBool()
will always return 1
for Py_EQ
and 0
for Py_NE
.
-
PyObject*
PyObject_Repr
(PyObject *o)¶ - Return value: New reference.
Обчислити рядкове представлення об’єкта o. Повертає рядкове представлення в разі успіху,
NULL
у разі невдачі. Це еквівалент виразу Pythonrepr(o)
. Викликається вбудованою функцієюrepr()
.Змінено в версії 3.4: Ця функція тепер включає твердження налагодження, щоб гарантувати, що вона не відкидає мовчки активний виняток.
-
PyObject*
PyObject_ASCII
(PyObject *o)¶ - Return value: New reference.
Як
PyObject_Repr()
, обчислити рядкове представлення об’єкта o, але екранувати символи, відмінні від ASCII, у рядку, який повертаєPyObject_Repr()
, за допомогою\x
,\u
або\U
екранується. Це створює рядок, подібний до того, який повертаєPyObject_Repr()
у Python 2. Викликається вбудованою функцієюascii()
.
-
PyObject*
PyObject_Str
(PyObject *o)¶ - Return value: New reference.
Обчислити рядкове представлення об’єкта o. Повертає рядкове представлення в разі успіху,
NULL
у разі невдачі. Це еквівалент виразу Pythonstr(o)
. Викликається вбудованою функцієюstr()
і, отже, функцієюprint()
.Змінено в версії 3.4: Ця функція тепер включає твердження налагодження, щоб гарантувати, що вона не відкидає мовчки активний виняток.
-
PyObject*
PyObject_Bytes
(PyObject *o)¶ - Return value: New reference.
Обчисліть байтове представлення об’єкта o. У разі помилки повертається
NULL
, а в разі успіху — об’єкт bytes. Це еквівалентно виразу Pythonbytes(o)
, коли o не є цілим числом. На відміну відbytes(o)
, помилка TypeError виникає, коли o є цілим числом замість об’єкта bytes, ініціалізованого нулем.
-
int
PyObject_IsSubclass
(PyObject *derived, PyObject *cls)¶ Повертає
1
, якщо клас derived ідентичний або походить від класу cls, інакше повертає0
. У разі помилки поверніть-1
.Якщо cls є кортежем, перевірятиметься кожен запис у cls. Результатом буде
1
, якщо хоча б одна з перевірок повертає1
, інакше він буде0
.Якщо cls має метод
__subclasscheck__()
, його буде викликано для визначення статусу підкласу, як описано в PEP 3119. В іншому випадку derived є підкласом cls, якщо він є прямим або непрямим підкласом, тобто міститься в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).
-
int
PyObject_IsInstance
(PyObject *inst, PyObject *cls)¶ Повертає
1
, якщо inst є екземпляром класу cls або підкласом cls, або0
, якщо ні. У разі помилки повертає-1
і встановлює виняток.Якщо cls є кортежем, перевірятиметься кожен запис у cls. Результатом буде
1
, якщо хоча б одна з перевірок повертає1
, інакше він буде0
.Якщо cls має метод
__instancecheck__()
, його буде викликано для визначення статусу підкласу, як описано в PEP 3119. В іншому випадку inst є екземпляром cls, якщо його клас є підкласом cls.An instance inst can override what is considered its class by having a
__class__
attribute.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).
-
int
PyCallable_Check
(PyObject *o)¶ Determine if the object o is callable. Return
1
if the object is callable and0
otherwise. This function always succeeds.
-
PyObject*
PyObject_Call
(PyObject *callable, PyObject *args, PyObject *kwargs)¶ - Return value: New reference.
Call a callable Python object callable, with arguments given by the tuple args, and named arguments given by the dictionary kwargs.
args must not be
NULL
, use an empty tuple if no arguments are needed. If no named arguments are needed, kwargs can beNULL
.Return the result of the call on success, or raise an exception and return
NULL
on failure.This is the equivalent of the Python expression:
callable(*args, **kwargs)
.
-
PyObject*
PyObject_CallObject
(PyObject *callable, PyObject *args)¶ - Return value: New reference.
Call a callable Python object callable, with arguments given by the tuple args. If no arguments are needed, then args can be
NULL
.Return the result of the call on success, or raise an exception and return
NULL
on failure.This is the equivalent of the Python expression:
callable(*args)
.
-
PyObject*
PyObject_CallFunction
(PyObject *callable, const char *format, ...)¶ - Return value: New reference.
Call a callable Python object callable, with a variable number of C arguments. The C arguments are described using a
Py_BuildValue()
style format string. The format can beNULL
, indicating that no arguments are provided.Return the result of the call on success, or raise an exception and return
NULL
on failure.This is the equivalent of the Python expression:
callable(*args)
.Note that if you only pass
PyObject *
args,PyObject_CallFunctionObjArgs()
is a faster alternative.Змінено в версії 3.4: The type of format was changed from
char *
.
-
PyObject*
PyObject_CallMethod
(PyObject *obj, const char *name, const char *format, ...)¶ - Return value: New reference.
Call the method named name of object obj with a variable number of C arguments. The C arguments are described by a
Py_BuildValue()
format string that should produce a tuple.The format can be
NULL
, indicating that no arguments are provided.Return the result of the call on success, or raise an exception and return
NULL
on failure.This is the equivalent of the Python expression:
obj.name(arg1, arg2, ...)
.Note that if you only pass
PyObject *
args,PyObject_CallMethodObjArgs()
is a faster alternative.Змінено в версії 3.4: The types of name and format were changed from
char *
.
-
PyObject*
PyObject_CallFunctionObjArgs
(PyObject *callable, ...)¶ - Return value: New reference.
Call a callable Python object callable, with a variable number of
PyObject*
arguments. The arguments are provided as a variable number of parameters followed byNULL
.Return the result of the call on success, or raise an exception and return
NULL
on failure.This is the equivalent of the Python expression:
callable(arg1, arg2, ...)
.
-
PyObject*
PyObject_CallMethodObjArgs
(PyObject *obj, PyObject *name, ...)¶ - Return value: New reference.
Calls a method of the Python object obj, where the name of the method is given as a Python string object in name. It is called with a variable number of
PyObject*
arguments. The arguments are provided as a variable number of parameters followed byNULL
.Return the result of the call on success, or raise an exception and return
NULL
on failure.
-
PyObject*
_PyObject_Vectorcall
(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)¶ Call a callable Python object callable, using
vectorcall
if possible.args is a C array with the positional arguments.
nargsf is the number of positional arguments plus optionally the flag
PY_VECTORCALL_ARGUMENTS_OFFSET
(see below). To get actual number of arguments, usePyVectorcall_NARGS(nargsf)
.kwnames can be either
NULL
(no keyword arguments) or a tuple of keyword names. In the latter case, the values of the keyword arguments are stored in args after the positional arguments. The number of keyword arguments does not influence nargsf.kwnames must contain only objects of type
str
(not a subclass), and all keys must be unique.Return the result of the call on success, or raise an exception and return
NULL
on failure.This uses the vectorcall protocol if the callable supports it; otherwise, the arguments are converted to use
tp_call
.Примітка
This function is provisional and expected to become public in Python 3.9, with a different name and, possibly, changed semantics. If you use the function, plan for updating your code for Python 3.9.
Нове в версії 3.8.
-
PY_VECTORCALL_ARGUMENTS_OFFSET
¶ If set in a vectorcall nargsf argument, the callee is allowed to temporarily change
args[-1]
. In other words, args points to argument 1 (not 0) in the allocated vector. The callee must restore the value ofargs[-1]
before returning.Whenever they can do so cheaply (without additional allocation), callers are encouraged to use
PY_VECTORCALL_ARGUMENTS_OFFSET
. Doing so will allow callables such as bound methods to make their onward calls (which include a prepended self argument) cheaply.Нове в версії 3.8.
-
Py_ssize_t
PyVectorcall_NARGS
(size_t nargsf)¶ Given a vectorcall nargsf argument, return the actual number of arguments. Currently equivalent to
nargsf & ~PY_VECTORCALL_ARGUMENTS_OFFSET
.Нове в версії 3.8.
-
PyObject*
_PyObject_FastCallDict
(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)¶ Same as
_PyObject_Vectorcall()
except that the keyword arguments are passed as a dictionary in kwdict. This may beNULL
if there are no keyword arguments.For callables supporting
vectorcall
, the arguments are internally converted to the vectorcall convention. Therefore, this function adds some overhead compared to_PyObject_Vectorcall()
. It should only be used if the caller already has a dictionary ready to use.Примітка
This function is provisional and expected to become public in Python 3.9, with a different name and, possibly, changed semantics. If you use the function, plan for updating your code for Python 3.9.
Нове в версії 3.8.
-
Py_hash_t
PyObject_Hash
(PyObject *o)¶ Обчислити та повернути хеш-значення об’єкта o. У разі помилки поверніть
-1
. Це еквівалент виразу Pythonhash(o)
.Змінено в версії 3.2: The return type is now Py_hash_t. This is a signed integer the same size as Py_ssize_t.
-
Py_hash_t
PyObject_HashNotImplemented
(PyObject *o)¶ Set a
TypeError
indicating thattype(o)
is not hashable 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 not hashable.
-
int
PyObject_IsTrue
(PyObject *o)¶ Повертає
1
, якщо об’єкт o вважається істинним, і0
в іншому випадку. Це еквівалентно виразу Pythonnot not o
. У разі помилки поверніть-1
.
-
int
PyObject_Not
(PyObject *o)¶ Повертає
0
, якщо об’єкт o вважається істинним, і1
інакше. Це еквівалентно виразу Pythonnot o
. У разі помилки поверніть-1
.
-
PyObject*
PyObject_Type
(PyObject *o)¶ - Return value: New reference.
When o is non-
NULL
, returns a type object corresponding to the object type of object o. On failure, raisesSystemError
and returnsNULL
. This is equivalent to the Python expressiontype(o)
. This function increments the reference count of the return value. There’s really no reason to use this function instead of the common expressiono->ob_type
, which returns a pointer of typePyTypeObject*
, except when the incremented reference count is needed.
-
int
PyObject_TypeCheck
(PyObject *o, PyTypeObject *type)¶ Return true if the object o is of type type or a subtype of type. Both parameters must be non-
NULL
.
-
Py_ssize_t
PyObject_Size
(PyObject *o)¶ -
Py_ssize_t
PyObject_Length
(PyObject *o)¶ Повертає довжину об’єкта o. Якщо об’єкт o надає протоколи послідовності та відображення, повертається довжина послідовності. У разі помилки повертається
-1
. Це еквівалент виразу Pythonlen(o)
.
-
Py_ssize_t
PyObject_LengthHint
(PyObject *o, Py_ssize_t default)¶ 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 expressionoperator.length_hint(o, default)
.Нове в версії 3.4.
-
PyObject*
PyObject_GetItem
(PyObject *o, PyObject *key)¶ - Return value: New reference.
Повертає елемент o, що відповідає об’єкту key або
NULL
у разі помилки. Це еквівалент виразу Pythono[key]
.
-
int
PyObject_SetItem
(PyObject *o, PyObject *key, PyObject *v)¶ Зіставте об’єкт key на значення v. Викликати виняток і повертати
-1
у разі помилки; повернути0
в разі успіху. Це еквівалент оператора Pythono[key] = v
. Ця функція не викрадає посилання на v.
-
int
PyObject_DelItem
(PyObject *o, PyObject *key)¶ Видаліть зіставлення для об’єкта key з об’єкта o. Повернути
-1
у разі помилки. Це еквівалентно оператору Pythondel o[key]
.
-
PyObject*
PyObject_Dir
(PyObject *o)¶ - Return value: New reference.
Це еквівалентно виразу Python
dir(o)
, який повертає (можливо, порожній) список рядків, відповідних для аргументу об’єкта, абоNULL
, якщо була помилка. Якщо аргументNULL
, це схоже наdir()
Python, що повертає імена поточних локальних систем; у цьому випадку, якщо жоден кадр виконання не активний, повертаєтьсяNULL
, алеPyErr_Occurred()
повертатиме false.