File Manager

Editing File: /opt/alt/python310/include/python3.10/abstract.h

/* Abstract Object Interface (many thanks to Jim Fulton) */

#ifndef Py_ABSTRACTOBJECT_H
#define Py_ABSTRACTOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

/* === Object Protocol ================================================== */

/* Implemented elsewhere:

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 is Py_Print_RAW.

(What should be said about Py_Print_RAW?). */

/* Implemented elsewhere:

int PyObject_HasAttrString(PyObject *o, const char *attr_name);

Returns 1 if object 'o' has the attribute attr_name, and 0 otherwise.

This is equivalent to the Python expression: hasattr(o,attr_name).

This function always succeeds. */

/* Implemented elsewhere:

PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name);

Retrieve an attributed named attr_name form object o.
   Returns the attribute value on success, or NULL on failure.

This is the equivalent of the Python expression: o.attr_name. */

/* Implemented elsewhere:

int PyObject_HasAttr(PyObject *o, PyObject *attr_name);

Returns 1 if o has the attribute attr_name, and 0 otherwise.

This is equivalent to the Python expression: hasattr(o,attr_name).

This function always succeeds. */

/* Implemented elsewhere:

PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name);

Retrieve an attributed named 'attr_name' form object 'o'.
   Returns the attribute value on success, or NULL on failure.

This is the equivalent of the Python expression: o.attr_name. */

/* Implemented elsewhere:

int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v);

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. */

/* Implemented elsewhere:

int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v);

Set the value of the attribute named attr_name, for object 'o', to the value
   'v'. an exception and return -1 on failure; return 0 on success.

This is the equivalent of the Python statement o.attr_name=v. */

/* Implemented as a macro:

int PyObject_DelAttrString(PyObject *o, const char *attr_name);

Delete attribute named attr_name, for object o. Returns
   -1 on failure.

This is the equivalent of the Python statement: del o.attr_name. */
#define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A), NULL)

/* Implemented as a macro:

int PyObject_DelAttr(PyObject *o, PyObject *attr_name);

Delete attribute named attr_name, for object o. Returns -1
   on failure.  This is the equivalent of the Python
   statement: del o.attr_name. */
#define  PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A), NULL)

/* Implemented elsewhere:

PyObject *PyObject_Repr(PyObject *o);

Compute the 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() built-in function. */

/* Implemented elsewhere:

PyObject *PyObject_Str(PyObject *o);

Compute the 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() and print() built-in functions. */

/* Declared elsewhere

PyAPI_FUNC(int) PyCallable_Check(PyObject *o);

Determine if the object, o, is callable.  Return 1 if the object is callable
   and 0 otherwise.

This function always succeeds. */

#ifdef PY_SSIZE_T_CLEAN
#  define PyObject_CallFunction _PyObject_CallFunction_SizeT
#  define PyObject_CallMethod _PyObject_CallMethod_SizeT
#endif

#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03090000
/* Call a callable Python object without any arguments */
PyAPI_FUNC(PyObject *) PyObject_CallNoArgs(PyObject *func);
#endif

/* Call a callable Python object 'callable' with arguments given by the
   tuple 'args' and keywords 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 be NULL.

This is the equivalent of the Python expression:
   callable(*args, **kwargs). */
PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable,
                                     PyObject *args, PyObject *kwargs);

/* Call a callable Python object 'callable', with arguments given by the
   tuple 'args'.  If no arguments are needed, then 'args' can be NULL.