aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2016-12-06 16:55:39 +0100
committerVictor Stinner <victor.stinner@gmail.com>2016-12-06 16:55:39 +0100
commit2a358f862bb24ddfb26c45d7e4af87c073d4bc1f (patch)
tree17813ab378c634838e943e00842f1711c63ab168 /Include/abstract.h
parentMerge documentation for issue #27030 from 3.6. (diff)
downloadcpython-2a358f862bb24ddfb26c45d7e4af87c073d4bc1f.tar.gz
cpython-2a358f862bb24ddfb26c45d7e4af87c073d4bc1f.tar.bz2
cpython-2a358f862bb24ddfb26c45d7e4af87c073d4bc1f.zip
Issue #28838: Fix weird indentation of abstract.h
Remove most indentation to move code at the left.
Diffstat (limited to 'Include/abstract.h')
-rw-r--r--Include/abstract.h1706
1 files changed, 859 insertions, 847 deletions
diff --git a/Include/abstract.h b/Include/abstract.h
index 95f6569f9be..09efd119bf3 100644
--- a/Include/abstract.h
+++ b/Include/abstract.h
@@ -5,11 +5,11 @@ extern "C" {
#endif
#ifdef PY_SSIZE_T_CLEAN
-#define PyObject_CallFunction _PyObject_CallFunction_SizeT
-#define PyObject_CallMethod _PyObject_CallMethod_SizeT
-#ifndef Py_LIMITED_API
-#define _PyObject_CallMethodId _PyObject_CallMethodId_SizeT
-#endif /* !Py_LIMITED_API */
+# define PyObject_CallFunction _PyObject_CallFunction_SizeT
+# define PyObject_CallMethod _PyObject_CallMethod_SizeT
+# ifndef Py_LIMITED_API
+# define _PyObject_CallMethodId _PyObject_CallMethodId_SizeT
+# endif /* !Py_LIMITED_API */
#endif
/* Abstract Object Interface (many thanks to Jim Fulton) */
@@ -28,10 +28,10 @@ Problem
the programmer must determine whether the sequence is a list or a
tuple:
- if(is_tupleobject(o))
- e=gettupleitem(o,i)
- else if(is_listitem(o))
- e=getlistitem(o,i)
+ if (is_tupleobject(o))
+ e = gettupleitem(o, i)
+ else if (is_listitem(o))
+ e = getlistitem(o, i)
If the programmer wants to get an item from another type of object
that provides sequence behavior, there is no clear way to do it
@@ -127,220 +127,223 @@ Memory Management
built-in types.
Protocols
+*/
-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/
-/* Object Protocol: */
+/* === Object Protocol ================================================== */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- int PyObject_Print(PyObject *o, FILE *fp, int flags);
+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.
+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?)
+(What should be said about Py_Print_RAW?)
- */
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- int PyObject_HasAttrString(PyObject *o, const char *attr_name);
+int PyObject_HasAttrString(PyObject *o, const char *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).
+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.
+This function always succeeds.
- */
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name);
+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.
+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:
+/* Implemented elsewhere:
- int PyObject_HasAttr(PyObject *o, PyObject *attr_name);
+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).
+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.
+This function always succeeds.
- */
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name);
+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.
+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:
+/* Implemented elsewhere:
- int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v);
+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.
+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:
+/* Implemented elsewhere:
- int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v);
+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. Raise an exception and return -1 on failure; return 0 on
- success. This is the equivalent of the Python statement o.attr_name=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 as a macro:
+/* implemented as a macro:
- int PyObject_DelAttrString(PyObject *o, const char *attr_name);
+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.
+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:
+/* implemented as a macro:
- int PyObject_DelAttr(PyObject *o, PyObject *attr_name);
+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.
+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:
+/* Implemented elsewhere:
- PyObject *PyObject_Repr(PyObject *o);
+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).
+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.
+Called by the repr() built-in function.
- */
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- PyObject *PyObject_Str(PyObject *o);
+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).)
+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.
+Called by the str() and print() built-in functions.
- */
+ */
- /* Declared elsewhere
+ /* Declared elsewhere
- PyAPI_FUNC(int) PyCallable_Check(PyObject *o);
+PyAPI_FUNC(int) PyCallable_Check(PyObject *o);
- Determine if the object, o, is callable. Return 1 if the
- object is callable and 0 otherwise.
+Determine if the object, o, is callable. Return 1 if the
+object is callable and 0 otherwise.
- This function always succeeds.
- */
+This function always succeeds.
+ */
+
+/* Call a callable Python object 'callable' with arguments given by the
+ tuple 'args' and keywords arguments given by the dictionary 'kwargs'.
- /* 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.
- '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);
- This is the equivalent of the Python expression:
- callable(*args, **kwargs). */
- PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable,
- PyObject *args, PyObject *kwargs);
#ifndef Py_LIMITED_API
- PyAPI_FUNC(PyObject*) _PyStack_AsTuple(
- PyObject **stack,
- Py_ssize_t nargs);
-
- /* Convert keyword arguments from the (stack, kwnames) format to a Python
- dictionary.
-
- kwnames must only contains str strings, no subclass, and all keys must
- be unique. kwnames is not checked, usually these checks are done before or later
- calling _PyStack_AsDict(). For example, _PyArg_ParseStack() raises an
- error if a key is not a string. */
- PyAPI_FUNC(PyObject *) _PyStack_AsDict(
- PyObject **values,
- PyObject *kwnames);
-
- /* Convert (args, nargs, kwargs) into a (stack, nargs, kwnames).
-
- Return a new stack which should be released by PyMem_Free(), or return
- args unchanged if kwargs is NULL or an empty dictionary.
-
- The stack uses borrowed references.
-
- The type of keyword keys is not checked, these checks should be done
- later (ex: _PyArg_ParseStack). */
- PyAPI_FUNC(PyObject **) _PyStack_UnpackDict(
- PyObject **args,
- Py_ssize_t nargs,
- PyObject *kwargs,
- PyObject **kwnames,
- PyObject *func);
-
- /* Call the callable object 'callable' with the "fast call" calling convention:
- args is a C array for positional arguments (nargs is the number of
- positional arguments), kwargs is a dictionary for keyword arguments.
-
- If nargs is equal to zero, args can be NULL. kwargs can be NULL.
- nargs must be greater or equal to zero.
-
- Return the result on success. Raise an exception on return NULL on
- error. */
- PyAPI_FUNC(PyObject *) _PyObject_FastCallDict(PyObject *callable,
- PyObject **args, Py_ssize_t nargs,
- PyObject *kwargs);
-
- /* Call the callable object 'callable' with the "fast call" calling convention:
- args is a C array for positional arguments followed by values of
- keyword arguments. Keys of keyword arguments are stored as a tuple
- of strings in kwnames. nargs is the number of positional parameters at
- the beginning of stack. The size of kwnames gives the number of keyword
- values in the stack after positional arguments.
-
- kwnames must only contains str strings, no subclass, and all keys must
- be unique.
-
- If nargs is equal to zero and there is no keyword argument (kwnames is
- NULL or its size is zero), args can be NULL.
-
- Return the result on success. Raise an exception and return NULL on
- error. */
- PyAPI_FUNC(PyObject *) _PyObject_FastCallKeywords
- (PyObject *callable,
- PyObject **args,
- Py_ssize_t nargs,
- PyObject *kwnames);
+PyAPI_FUNC(PyObject*) _PyStack_AsTuple(
+ PyObject **stack,
+ Py_ssize_t nargs);
+
+/* Convert keyword arguments from the (stack, kwnames) format to a Python
+ dictionary.
+
+ kwnames must only contains str strings, no subclass, and all keys must
+ be unique. kwnames is not checked, usually these checks are done before or later
+ calling _PyStack_AsDict(). For example, _PyArg_ParseStack() raises an
+ error if a key is not a string. */
+PyAPI_FUNC(PyObject *) _PyStack_AsDict(
+ PyObject **values,
+ PyObject *kwnames);
+
+/* Convert (args, nargs, kwargs) into a (stack, nargs, kwnames).
+
+ Return a new stack which should be released by PyMem_Free(), or return
+ args unchanged if kwargs is NULL or an empty dictionary.
+
+ The stack uses borrowed references.
+
+ The type of keyword keys is not checked, these checks should be done
+ later (ex: _PyArg_ParseStack). */
+PyAPI_FUNC(PyObject **) _PyStack_UnpackDict(
+ PyObject **args,
+ Py_ssize_t nargs,
+ PyObject *kwargs,
+ PyObject **kwnames,
+ PyObject *func);
+
+/* Call the callable object 'callable' with the "fast call" calling convention:
+ args is a C array for positional arguments (nargs is the number of
+ positional arguments), kwargs is a dictionary for keyword arguments.
+
+ If nargs is equal to zero, args can be NULL. kwargs can be NULL.
+ nargs must be greater or equal to zero.
+
+ Return the result on success. Raise an exception on return NULL on
+ error. */
+PyAPI_FUNC(PyObject *) _PyObject_FastCallDict(
+ PyObject *callable,
+ PyObject **args,
+ Py_ssize_t nargs,
+ PyObject *kwargs);
+
+/* Call the callable object 'callable' with the "fast call" calling convention:
+ args is a C array for positional arguments followed by values of
+ keyword arguments. Keys of keyword arguments are stored as a tuple
+ of strings in kwnames. nargs is the number of positional parameters at
+ the beginning of stack. The size of kwnames gives the number of keyword
+ values in the stack after positional arguments.
+
+ kwnames must only contains str strings, no subclass, and all keys must
+ be unique.
+
+ If nargs is equal to zero and there is no keyword argument (kwnames is
+ NULL or its size is zero), args can be NULL.
+
+ Return the result on success. Raise an exception and return NULL on
+ error. */
+PyAPI_FUNC(PyObject *) _PyObject_FastCallKeywords(
+ PyObject *callable,
+ PyObject **args,
+ Py_ssize_t nargs,
+ PyObject *kwnames);
#define _PyObject_FastCall(func, args, nargs) \
_PyObject_FastCallDict((func), (args), (nargs), NULL)
@@ -348,793 +351,801 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/
#define _PyObject_CallNoArg(func) \
_PyObject_FastCallDict((func), NULL, 0, NULL)
- PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *callable,
- PyObject *obj, PyObject *args,
- PyObject *kwargs);
+PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(
+ PyObject *callable,
+ PyObject *obj,
+ PyObject *args,
+ PyObject *kwargs);
- PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *callable,
- PyObject *result,
- const char *where);
+PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *callable,
+ PyObject *result,
+ const char *where);
#endif /* Py_LIMITED_API */
- /* Call a callable Python object 'callable', with arguments given by the
- tuple 'args'. If no arguments are needed, then 'args' can be *NULL*.
- Returns the result of the call on success, or *NULL* on failure.
+/* Call a callable Python object 'callable', with arguments given by the
+ tuple 'args'. If no arguments are needed, then 'args' can be *NULL*.
- This is the equivalent of the Python expression:
- callable(*args) */
- PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable,
- PyObject *args);
+ Returns the result of the call on success, or *NULL* on failure.
- /* Call a callable Python object, callable, with a variable number of C
- arguments. The C arguments are described using a mkvalue-style format
- string.
+ This is the equivalent of the Python expression:
+ callable(*args) */
+PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable,
+ PyObject *args);
- The format may be NULL, indicating that no arguments are provided.
+/* Call a callable Python object, callable, with a variable number of C
+ arguments. The C arguments are described using a mkvalue-style format
+ string.
- Returns the result of the call on success, or NULL on failure.
+ The format may be NULL, indicating that no arguments are provided.
- This is the equivalent of the Python expression:
- callable(arg1, arg2, ...) */
- PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable,
- const char *format, ...);
+ Returns the result of the call on success, or NULL on failure.
- /* Call the method named 'name' of object 'obj' with a variable number of
- C arguments. The C arguments are described by a mkvalue format string.
+ This is the equivalent of the Python expression:
+ callable(arg1, arg2, ...) */
+PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable,
+ const char *format, ...);
- The format can be NULL, indicating that no arguments are provided.
+/* Call the method named 'name' of object 'obj' with a variable number of
+ C arguments. The C arguments are described by a mkvalue format string.
- Returns the result of the call on success, or NULL on failure.
+ The format can be NULL, indicating that no arguments are provided.
- This is the equivalent of the Python expression:
- obj.name(arg1, arg2, ...) */
- PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj,
- const char *name,
- const char *format, ...);
+ Returns the result of the call on success, or NULL on failure.
+
+ This is the equivalent of the Python expression:
+ obj.name(arg1, arg2, ...) */
+PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj,
+ const char *name,
+ const char *format, ...);
#ifndef Py_LIMITED_API
- PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj,
- _Py_Identifier *name,
- const char *format, ...);
+PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj,
+ _Py_Identifier *name,
+ const char *format, ...);
- /*
- Like PyObject_CallMethod, but expect a _Py_Identifier* as the
- method name.
- */
+/*
+ Like PyObject_CallMethod, but expect a _Py_Identifier* as the
+ method name.
+*/
#endif /* !Py_LIMITED_API */
- PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable,
- const char *format,
- ...);
- PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *obj,
- const char *name,
- const char *format,
- ...);
+PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable,
+ const char *format,
+ ...);
+
+PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *obj,
+ const char *name,
+ const char *format,
+ ...);
+
#ifndef Py_LIMITED_API
- PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj,
- _Py_Identifier *name,
- const char *format,
- ...);
+PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj,
+ _Py_Identifier *name,
+ const char *format,
+ ...);
#endif /* !Py_LIMITED_API */
- /* Call a callable Python object 'callable' with a variable number of C
- arguments. The C arguments are provided as PyObject* values, terminated
- by a NULL.
+/* Call a callable Python object 'callable' with a variable number of C
+ arguments. The C arguments are provided as PyObject* values, terminated
+ by a NULL.
- Returns the result of the call on success, or NULL on failure.
+ Returns the result of the call on success, or NULL on failure.
- This is the equivalent of the Python expression:
- callable(arg1, arg2, ...) */
- PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable,
- ...);
+ This is the equivalent of the Python expression:
+ callable(arg1, arg2, ...) */
+PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable,
+ ...);
- /*
- Call the method named 'name' of object 'obj' with a variable number of
- C arguments. The C arguments are provided as PyObject *
- values, terminated by NULL. Returns the result of the call
- on success, or NULL on failure. This is the equivalent of
- the Python expression: obj.name(args).
- */
+ /*
+Call the method named 'name' of object 'obj' with a variable number of
+C arguments. The C arguments are provided as PyObject *
+values, terminated by NULL. Returns the result of the call
+on success, or NULL on failure. This is the equivalent of
+the Python expression: obj.name(args).
+ */
+
+PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(
+ PyObject *obj,
+ PyObject *name,
+ ...);
- PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *obj,
- PyObject *name,
- ...);
#ifndef Py_LIMITED_API
- PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *obj,
- struct _Py_Identifier *name,
- ...);
+PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(
+ PyObject *obj,
+ struct _Py_Identifier *name,
+ ...);
#endif /* !Py_LIMITED_API */
+/* Implemented elsewhere:
- /* Implemented elsewhere:
+long PyObject_Hash(PyObject *o);
- long PyObject_Hash(PyObject *o);
-
- Compute and return the hash, hash_value, of an object, o. On
- failure, return -1. This is the equivalent of the Python
- expression: hash(o).
- */
+Compute and return the hash, hash_value, of an object, o. On
+failure, return -1. This is the equivalent of the Python
+expression: hash(o).
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- int PyObject_IsTrue(PyObject *o);
+int PyObject_IsTrue(PyObject *o);
- Returns 1 if the object, o, is considered to be true, 0 if o is
- considered to be false and -1 on failure. This is equivalent to the
- Python expression: not not o
- */
+Returns 1 if the object, o, is considered to be true, 0 if o is
+considered to be false and -1 on failure. This is equivalent to the
+Python expression: not not o
+ */
- /* Implemented elsewhere:
+/* Implemented elsewhere:
- int PyObject_Not(PyObject *o);
+int PyObject_Not(PyObject *o);
- Returns 0 if the object, o, is considered to be true, 1 if o is
- considered to be false and -1 on failure. This is equivalent to the
- Python expression: not o
- */
+Returns 0 if the object, o, is considered to be true, 1 if o is
+considered to be false and -1 on failure. This is equivalent to the
+Python expression: not o
+ */
- PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o);
+PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o);
- /*
- On success, returns a type object corresponding to the object
- type of object o. On failure, returns NULL. This is
- equivalent to the Python expression: type(o).
- */
+ /*
+On success, returns a type object corresponding to the object
+type of object o. On failure, returns NULL. This is
+equivalent to the Python expression: type(o).
+ */
- PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o);
- /*
- Return the size of object o. If the object, o, provides
- both sequence and mapping protocols, the sequence size is
- returned. On error, -1 is returned. This is the equivalent
- to the Python expression: len(o).
- */
+ /*
+Return the size of object o. If the object, o, provides
+both sequence and mapping protocols, the sequence size is
+returned. On error, -1 is returned. This is the equivalent
+to the Python expression: len(o).
+ */
- /* For DLL compatibility */
+/* For DLL compatibility */
#undef PyObject_Length
- PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o);
#define PyObject_Length PyObject_Size
#ifndef Py_LIMITED_API
- PyAPI_FUNC(int) _PyObject_HasLen(PyObject *o);
- PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t);
+PyAPI_FUNC(int) _PyObject_HasLen(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t);
#endif
- /*
- Guess the size of object o using len(o) or o.__length_hint__().
- If neither of those return a non-negative value, then return the
- default value. If one of the calls fails, this function returns -1.
- */
-
- PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key);
-
- /*
- Return element of o corresponding to the object, key, or NULL
- on failure. This is the equivalent of the Python expression:
- o[key].
- */
-
- PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v);
-
- /*
- 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.
- */
+ /*
+Guess the size of object o using len(o) or o.__length_hint__().
+If neither of those return a non-negative value, then return the
+default value. If one of the calls fails, this function returns -1.
+ */
- PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, const char *key);
+PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key);
- /*
- Remove the mapping for object, key, from the object *o.
- Returns -1 on failure. This is equivalent to
- the Python statement: del o[key].
- */
-
- PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key);
+ /*
+Return element of o corresponding to the object, key, or NULL
+on failure. This is the equivalent of the Python expression:
+o[key].
+ */
- /*
- Delete the mapping for key from *o. Returns -1 on failure.
- This is the equivalent of the Python statement: del o[key].
- */
+PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v);
- /* old buffer API
- FIXME: usage of these should all be replaced in Python itself
- but for backwards compatibility we will implement them.
- Their usage without a corresponding "unlock" mechanism
- may create issues (but they would already be there). */
+ /*
+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.
+ */
- PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj,
- const char **buffer,
- Py_ssize_t *buffer_len)
- Py_DEPRECATED(3.0);
+PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, const char *key);
- /*
- Takes an arbitrary object which must support the (character,
- single segment) buffer interface and returns a pointer to a
- read-only memory location useable as character based input
- for subsequent processing.
-
- 0 is returned on success. buffer and buffer_len are only
- set in case no error occurs. Otherwise, -1 is returned and
- an exception set.
- */
+ /*
+Remove the mapping for object, key, from the object *o.
+Returns -1 on failure. This is equivalent to
+the Python statement: del o[key].
+ */
- PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj)
- Py_DEPRECATED(3.0);
+PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key);
- /*
- Checks whether an arbitrary object supports the (character,
- single segment) buffer interface. Returns 1 on success, 0
- on failure.
- */
+ /*
+Delete the mapping for key from *o. Returns -1 on failure.
+This is the equivalent of the Python statement: del o[key].
+ */
- PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj,
- const void **buffer,
- Py_ssize_t *buffer_len)
- Py_DEPRECATED(3.0);
+/* old buffer API
+ FIXME: usage of these should all be replaced in Python itself
+ but for backwards compatibility we will implement them.
+ Their usage without a corresponding "unlock" mechanism
+ may create issues (but they would already be there). */
- /*
- Same as PyObject_AsCharBuffer() except that this API expects
- (readable, single segment) buffer interface and returns a
- pointer to a read-only memory location which can contain
- arbitrary data.
-
- 0 is returned on success. buffer and buffer_len are only
- set in case no error occurs. Otherwise, -1 is returned and
- an exception set.
- */
+PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj,
+ const char **buffer,
+ Py_ssize_t *buffer_len)
+ Py_DEPRECATED(3.0);
- PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj,
- void **buffer,
- Py_ssize_t *buffer_len)
- Py_DEPRECATED(3.0);
+ /*
+Takes an arbitrary object which must support the (character,
+single segment) buffer interface and returns a pointer to a
+read-only memory location useable as character based input
+for subsequent processing.
- /*
- Takes an arbitrary object which must support the (writable,
- single segment) buffer interface and returns a pointer to a
- writable memory location in buffer of size buffer_len.
+0 is returned on success. buffer and buffer_len are only
+set in case no error occurs. Otherwise, -1 is returned and
+an exception set.
+ */
- 0 is returned on success. buffer and buffer_len are only
- set in case no error occurs. Otherwise, -1 is returned and
- an exception set.
- */
+PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj)
+ Py_DEPRECATED(3.0);
- /* new buffer API */
+/*
+Checks whether an arbitrary object supports the (character,
+single segment) buffer interface. Returns 1 on success, 0
+on failure.
+*/
+
+PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj,
+ const void **buffer,
+ Py_ssize_t *buffer_len)
+ Py_DEPRECATED(3.0);
+
+ /*
+Same as PyObject_AsCharBuffer() except that this API expects
+(readable, single segment) buffer interface and returns a
+pointer to a read-only memory location which can contain
+arbitrary data.
+
+0 is returned on success. buffer and buffer_len are only
+set in case no error occurs. Otherwise, -1 is returned and
+an exception set.
+ */
+
+PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj,
+ void **buffer,
+ Py_ssize_t *buffer_len)
+ Py_DEPRECATED(3.0);
+
+ /*
+Takes an arbitrary object which must support the (writable,
+single segment) buffer interface and returns a pointer to a
+writable memory location in buffer of size buffer_len.
+
+0 is returned on success. buffer and buffer_len are only
+set in case no error occurs. Otherwise, -1 is returned and
+an exception set.
+ */
+
+/* new buffer API */
#ifndef Py_LIMITED_API
#define PyObject_CheckBuffer(obj) \
(((obj)->ob_type->tp_as_buffer != NULL) && \
((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL))
- /* Return 1 if the getbuffer function is available, otherwise
- return 0 */
+/* Return 1 if the getbuffer function is available, otherwise
+ return 0 */
- PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view,
- int flags);
+PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view,
+ int flags);
- /* This is a C-API version of the getbuffer function call. It checks
- to make sure object has the required function pointer and issues the
- call. Returns -1 and raises an error on failure and returns 0 on
- success
- */
+/* This is a C-API version of the getbuffer function call. It checks
+ to make sure object has the required function pointer and issues the
+ call. Returns -1 and raises an error on failure and returns 0 on
+ success
+*/
+PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices);
- PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices);
+/* Get the memory area pointed to by the indices for the buffer given.
+ Note that view->ndim is the assumed size of indices
+*/
- /* Get the memory area pointed to by the indices for the buffer given.
- Note that view->ndim is the assumed size of indices
- */
+PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *);
- PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *);
+/* Return the implied itemsize of the data-format area from a
+ struct-style description */
- /* Return the implied itemsize of the data-format area from a
- struct-style description */
+/* Implementation in memoryobject.c */
+PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view,
+ Py_ssize_t len, char order);
- /* Implementation in memoryobject.c */
- PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view,
- Py_ssize_t len, char order);
+PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf,
+ Py_ssize_t len, char order);
- PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf,
- Py_ssize_t len, char order);
+/* Copy len bytes of data from the contiguous chunk of memory
+ pointed to by buf into the buffer exported by obj. Return
+ 0 on success and return -1 and raise a PyBuffer_Error on
+ error (i.e. the object does not have a buffer interface or
+ it is not working).
- /* Copy len bytes of data from the contiguous chunk of memory
- pointed to by buf into the buffer exported by obj. Return
- 0 on success and return -1 and raise a PyBuffer_Error on
- error (i.e. the object does not have a buffer interface or
- it is not working).
+ If fort is 'F', then if the object is multi-dimensional,
+ then the data will be copied into the array in
+ Fortran-style (first dimension varies the fastest). If
+ fort is 'C', then the data will be copied into the array
+ in C-style (last dimension varies the fastest). If fort
+ is 'A', then it does not matter and the copy will be made
+ in whatever way is more efficient.
- If fort is 'F', then if the object is multi-dimensional,
- then the data will be copied into the array in
- Fortran-style (first dimension varies the fastest). If
- fort is 'C', then the data will be copied into the array
- in C-style (last dimension varies the fastest). If fort
- is 'A', then it does not matter and the copy will be made
- in whatever way is more efficient.
+*/
- */
+PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);
- PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);
+/* Copy the data from the src buffer to the buffer of destination
+ */
- /* Copy the data from the src buffer to the buffer of destination
- */
+PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char fort);
- PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char fort);
+PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims,
+ Py_ssize_t *shape,
+ Py_ssize_t *strides,
+ int itemsize,
+ char fort);
- PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims,
- Py_ssize_t *shape,
- Py_ssize_t *strides,
- int itemsize,
- char fort);
+/* Fill the strides array with byte-strides of a contiguous
+ (Fortran-style if fort is 'F' or C-style otherwise)
+ array of the given shape with the given number of bytes
+ per element.
+*/
- /* Fill the strides array with byte-strides of a contiguous
- (Fortran-style if fort is 'F' or C-style otherwise)
- array of the given shape with the given number of bytes
- per element.
- */
+PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,
+ Py_ssize_t len, int readonly,
+ int flags);
- PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,
- Py_ssize_t len, int readonly,
- int flags);
+/* Fills in a buffer-info structure correctly for an exporter
+ that can only share a contiguous chunk of memory of
+ "unsigned bytes" of the given length. Returns 0 on success
+ and -1 (with raising an error) on error.
+ */
- /* Fills in a buffer-info structure correctly for an exporter
- that can only share a contiguous chunk of memory of
- "unsigned bytes" of the given length. Returns 0 on success
- and -1 (with raising an error) on error.
- */
+PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);
- PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);
-
- /* Releases a Py_buffer obtained from getbuffer ParseTuple's s*.
- */
+/* Releases a Py_buffer obtained from getbuffer ParseTuple's s*.
+ */
#endif /* Py_LIMITED_API */
- PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj,
- PyObject *format_spec);
- /*
- Takes an arbitrary object and returns the result of
- calling obj.__format__(format_spec).
- */
+PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj,
+ PyObject *format_spec);
+ /*
+Takes an arbitrary object and returns the result of
+calling obj.__format__(format_spec).
+ */
/* Iterators */
- PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);
- /* Takes an object and returns an iterator for it.
- This is typically a new iterator but if the argument
- is an iterator, this returns itself. */
+PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);
+ /* Takes an object and returns an iterator for it.
+This is typically a new iterator but if the argument
+is an iterator, this returns itself. */
#define PyIter_Check(obj) \
((obj)->ob_type->tp_iternext != NULL && \
(obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented)
- PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *);
- /* Takes an iterator object and calls its tp_iternext slot,
- returning the next value. If the iterator is exhausted,
- this returns NULL without setting an exception.
- NULL with an exception means an error occurred. */
+PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *);
+ /* Takes an iterator object and calls its tp_iternext slot,
+returning the next value. If the iterator is exhausted,
+this returns NULL without setting an exception.
+NULL with an exception means an error occurred. */
-/* Number Protocol:*/
- PyAPI_FUNC(int) PyNumber_Check(PyObject *o);
+/* === Number Protocol ================================================== */
- /*
- Returns 1 if the object, o, provides numeric protocols, and
- false otherwise.
+PyAPI_FUNC(int) PyNumber_Check(PyObject *o);
- This function always succeeds.
- */
+ /*
+Returns 1 if the object, o, provides numeric protocols, and
+false otherwise.
- PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2);
+This function always succeeds.
+ */
- /*
- Returns the result of adding o1 and o2, or null on failure.
- This is the equivalent of the Python expression: o1+o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of adding o1 and o2, or null on failure.
+This is the equivalent of the Python expression: o1+o2.
+ */
- /*
- Returns the result of subtracting o2 from o1, or null on
- failure. This is the equivalent of the Python expression:
- o1-o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of subtracting o2 from o1, or null on
+failure. This is the equivalent of the Python expression:
+o1-o2.
+ */
- /*
- Returns the result of multiplying o1 and o2, or null on
- failure. This is the equivalent of the Python expression:
- o1*o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of multiplying o1 and o2, or null on
+failure. This is the equivalent of the Python expression:
+o1*o2.
+ */
- /*
- This is the equivalent of the Python expression: o1 @ o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2);
+ /*
+This is the equivalent of the Python expression: o1 @ o2.
+ */
- /*
- Returns the result of dividing o1 by o2 giving an integral result,
- or null on failure.
- This is the equivalent of the Python expression: o1//o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of dividing o1 by o2 giving an integral result,
+or null on failure.
+This is the equivalent of the Python expression: o1//o2.
+ */
- /*
- Returns the result of dividing o1 by o2 giving a float result,
- or null on failure.
- This is the equivalent of the Python expression: o1/o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of dividing o1 by o2 giving a float result,
+or null on failure.
+This is the equivalent of the Python expression: o1/o2.
+ */
- /*
- Returns the remainder of dividing o1 by o2, or null on
- failure. This is the equivalent of the Python expression:
- o1%o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2);
+ /*
+Returns the remainder of dividing o1 by o2, or null on
+failure. This is the equivalent of the Python expression:
+o1%o2.
+ */
- /*
- See the built-in function divmod. Returns NULL on failure.
- This is the equivalent of the Python expression:
- divmod(o1,o2).
- */
+PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2,
- PyObject *o3);
+ /*
+See the built-in function divmod. Returns NULL on failure.
+This is the equivalent of the Python expression:
+divmod(o1,o2).
+ */
- /*
- See the built-in function pow. Returns NULL on failure.
- This is the equivalent of the Python expression:
- pow(o1,o2,o3), where o3 is optional.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2,
+ PyObject *o3);
- PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o);
+ /*
+See the built-in function pow. Returns NULL on failure.
+This is the equivalent of the Python expression:
+pow(o1,o2,o3), where o3 is optional.
+ */
- /*
- Returns the negation of o on success, or null on failure.
- This is the equivalent of the Python expression: -o.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o);
- PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o);
+ /*
+Returns the negation of o on success, or null on failure.
+This is the equivalent of the Python expression: -o.
+ */
- /*
- Returns the (what?) of o on success, or NULL on failure.
- This is the equivalent of the Python expression: +o.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o);
- PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o);
+ /*
+Returns the (what?) of o on success, or NULL on failure.
+This is the equivalent of the Python expression: +o.
+ */
- /*
- Returns the absolute value of o, or null on failure. This is
- the equivalent of the Python expression: abs(o).
- */
+PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o);
- PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o);
+ /*
+Returns the absolute value of o, or null on failure. This is
+the equivalent of the Python expression: abs(o).
+ */
- /*
- Returns the bitwise negation of o on success, or NULL on
- failure. This is the equivalent of the Python expression:
- ~o.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o);
- PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2);
+ /*
+Returns the bitwise negation of o on success, or NULL on
+failure. This is the equivalent of the Python expression:
+~o.
+ */
- /*
- Returns the result of left shifting o1 by o2 on success, or
- NULL on failure. This is the equivalent of the Python
- expression: o1 << o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of left shifting o1 by o2 on success, or
+NULL on failure. This is the equivalent of the Python
+expression: o1 << o2.
+ */
- /*
- Returns the result of right shifting o1 by o2 on success, or
- NULL on failure. This is the equivalent of the Python
- expression: o1 >> o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2);
+ /*
+Returns the result of right shifting o1 by o2 on success, or
+NULL on failure. This is the equivalent of the Python
+expression: o1 >> o2.
+ */
- /*
- Returns the result of bitwise and of o1 and o2 on success, or
- NULL on failure. This is the equivalent of the Python
- expression: o1&o2.
+PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2);
- */
+ /*
+Returns the result of bitwise and of o1 and o2 on success, or
+NULL on failure. This is the equivalent of the Python
+expression: o1&o2.
- PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2);
+ */
- /*
- Returns the bitwise exclusive or of o1 by o2 on success, or
- NULL on failure. This is the equivalent of the Python
- expression: o1^o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2);
- PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2);
+ /*
+Returns the bitwise exclusive or of o1 by o2 on success, or
+NULL on failure. This is the equivalent of the Python
+expression: o1^o2.
+ */
- /*
- Returns the result of bitwise or on o1 and o2 on success, or
- NULL on failure. This is the equivalent of the Python
- expression: o1|o2.
- */
+PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2);
+
+ /*
+Returns the result of bitwise or on o1 and o2 on success, or
+NULL on failure. This is the equivalent of the Python
+expression: o1|o2.
+ */
#define PyIndex_Check(obj) \
((obj)->ob_type->tp_as_number != NULL && \
(obj)->ob_type->tp_as_number->nb_index != NULL)
- PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o);
+PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o);
- /*
- Returns the object converted to a Python int
- or NULL with an error raised on failure.
- */
+ /*
+Returns the object converted to a Python int
+or NULL with an error raised on failure.
+ */
- PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc);
+PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc);
- /*
- Returns the object converted to Py_ssize_t by going through
- PyNumber_Index first. If an overflow error occurs while
- converting the int to Py_ssize_t, then the second argument
- is the error-type to return. If it is NULL, then the overflow error
- is cleared and the value is clipped.
- */
+ /*
+Returns the object converted to Py_ssize_t by going through
+PyNumber_Index first. If an overflow error occurs while
+converting the int to Py_ssize_t, then the second argument
+is the error-type to return. If it is NULL, then the overflow error
+is cleared and the value is clipped.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o);
+PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o);
- /*
- Returns the o converted to an integer object on success, or
- NULL on failure. This is the equivalent of the Python
- expression: int(o).
- */
+ /*
+Returns the o converted to an integer object on success, or
+NULL on failure. This is the equivalent of the Python
+expression: int(o).
+ */
- PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o);
+PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o);
+
+ /*
+Returns the o converted to a float object on success, or NULL
+on failure. This is the equivalent of the Python expression:
+float(o).
+ */
- /*
- Returns the o converted to a float object on success, or NULL
- on failure. This is the equivalent of the Python expression:
- float(o).
- */
/* In-place variants of (some of) the above number protocol functions */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2);
- /*
- Returns the result of adding o2 to o1, possibly in-place, or null
- on failure. This is the equivalent of the Python expression:
- o1 += o2.
- */
+ /*
+Returns the result of adding o2 to o1, possibly in-place, or null
+on failure. This is the equivalent of the Python expression:
+o1 += o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2);
- /*
- Returns the result of subtracting o2 from o1, possibly in-place or
- null on failure. This is the equivalent of the Python expression:
- o1 -= o2.
- */
+ /*
+Returns the result of subtracting o2 from o1, possibly in-place or
+null on failure. This is the equivalent of the Python expression:
+o1 -= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2);
- /*
- Returns the result of multiplying o1 by o2, possibly in-place, or
- null on failure. This is the equivalent of the Python expression:
- o1 *= o2.
- */
+ /*
+Returns the result of multiplying o1 by o2, possibly in-place, or
+null on failure. This is the equivalent of the Python expression:
+o1 *= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2);
- /*
- This is the equivalent of the Python expression: o1 @= o2.
- */
+ /*
+This is the equivalent of the Python expression: o1 @= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1,
- PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1,
+ PyObject *o2);
- /*
- Returns the result of dividing o1 by o2 giving an integral result,
- possibly in-place, or null on failure.
- This is the equivalent of the Python expression:
- o1 /= o2.
- */
+ /*
+Returns the result of dividing o1 by o2 giving an integral result,
+possibly in-place, or null on failure.
+This is the equivalent of the Python expression:
+o1 /= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1,
- PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1,
+ PyObject *o2);
- /*
- Returns the result of dividing o1 by o2 giving a float result,
- possibly in-place, or null on failure.
- This is the equivalent of the Python expression:
- o1 /= o2.
- */
+ /*
+Returns the result of dividing o1 by o2 giving a float result,
+possibly in-place, or null on failure.
+This is the equivalent of the Python expression:
+o1 /= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2);
- /*
- Returns the remainder of dividing o1 by o2, possibly in-place, or
- null on failure. This is the equivalent of the Python expression:
- o1 %= o2.
- */
+ /*
+Returns the remainder of dividing o1 by o2, possibly in-place, or
+null on failure. This is the equivalent of the Python expression:
+o1 %= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2,
- PyObject *o3);
+PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2,
+ PyObject *o3);
- /*
- Returns the result of raising o1 to the power of o2, possibly
- in-place, or null on failure. This is the equivalent of the Python
- expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present.
- */
+ /*
+Returns the result of raising o1 to the power of o2, possibly
+in-place, or null on failure. This is the equivalent of the Python
+expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2);
- /*
- Returns the result of left shifting o1 by o2, possibly in-place, or
- null on failure. This is the equivalent of the Python expression:
- o1 <<= o2.
- */
+ /*
+Returns the result of left shifting o1 by o2, possibly in-place, or
+null on failure. This is the equivalent of the Python expression:
+o1 <<= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2);
- /*
- Returns the result of right shifting o1 by o2, possibly in-place or
- null on failure. This is the equivalent of the Python expression:
- o1 >>= o2.
- */
+ /*
+Returns the result of right shifting o1 by o2, possibly in-place or
+null on failure. This is the equivalent of the Python expression:
+o1 >>= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2);
- /*
- Returns the result of bitwise and of o1 and o2, possibly in-place,
- or null on failure. This is the equivalent of the Python
- expression: o1 &= o2.
- */
+ /*
+Returns the result of bitwise and of o1 and o2, possibly in-place,
+or null on failure. This is the equivalent of the Python
+expression: o1 &= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2);
- /*
- Returns the bitwise exclusive or of o1 by o2, possibly in-place, or
- null on failure. This is the equivalent of the Python expression:
- o1 ^= o2.
- */
+ /*
+Returns the bitwise exclusive or of o1 by o2, possibly in-place, or
+null on failure. This is the equivalent of the Python expression:
+o1 ^= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2);
- /*
- Returns the result of bitwise or of o1 and o2, possibly in-place,
- or null on failure. This is the equivalent of the Python
- expression: o1 |= o2.
- */
+ /*
+Returns the result of bitwise or of o1 and o2, possibly in-place,
+or null on failure. This is the equivalent of the Python
+expression: o1 |= o2.
+ */
- PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base);
+PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base);
- /*
- Returns the integer n converted to a string with a base, with a base
- marker of 0b, 0o or 0x prefixed if applicable.
- If n is not an int object, it is converted with PyNumber_Index first.
- */
+ /*
+Returns the integer n converted to a string with a base, with a base
+marker of 0b, 0o or 0x prefixed if applicable.
+If n is not an int object, it is converted with PyNumber_Index first.
+ */
-/* Sequence protocol:*/
+/* === Sequence protocol ================================================ */
- PyAPI_FUNC(int) PySequence_Check(PyObject *o);
+PyAPI_FUNC(int) PySequence_Check(PyObject *o);
- /*
- Return 1 if the object provides sequence protocol, and zero
- otherwise.
+ /*
+Return 1 if the object provides sequence protocol, and zero
+otherwise.
- This function always succeeds.
- */
+This function always succeeds.
+ */
- PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o);
- /*
- Return the size of sequence object o, or -1 on failure.
- */
+ /*
+Return the size of sequence object o, or -1 on failure.
+ */
- /* For DLL compatibility */
+/* For DLL compatibility */
#undef PySequence_Length
PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o);
#define PySequence_Length PySequence_Size
- PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2);
- /*
- Return the concatenation of o1 and o2 on success, and NULL on
- failure. This is the equivalent of the Python
- expression: o1+o2.
- */
+ /*
+Return the concatenation of o1 and o2 on success, and NULL on
+failure. This is the equivalent of the Python
+expression: o1+o2.
+ */
- PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count);
+PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count);
- /*
- Return the result of repeating sequence object o count times,
- or NULL on failure. This is the equivalent of the Python
- expression: o1*count.
- */
+ /*
+Return the result of repeating sequence object o count times,
+or NULL on failure. This is the equivalent of the Python
+expression: o1*count.
+ */
- PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i);
+PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i);
- /*
- Return the ith element of o, or NULL on failure. This is the
- equivalent of the Python expression: o[i].
- */
+ /*
+Return the ith element of o, or NULL on failure. This is the
+equivalent of the Python expression: o[i].
+ */
- PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
+PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
- /*
- Return the slice of sequence object o between i1 and i2, or
- NULL on failure. This is the equivalent of the Python
- expression: o[i1:i2].
- */
+ /*
+Return the slice of sequence object o between i1 and i2, or
+NULL on failure. This is the equivalent of the Python
+expression: o[i1:i2].
+ */
- PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v);
+PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v);
- /*
- Assign object v to the ith element of o. Raise an exception and return
- -1 on failure; return 0 on success. This is the equivalent of the
- Python statement o[i]=v.
- */
+ /*
+Assign object v to the ith element of o. Raise an exception and return
+-1 on failure; return 0 on success. This is the equivalent of the
+Python statement o[i]=v.
+ */
- PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i);
+PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i);
- /*
- Delete the ith element of object v. Returns
- -1 on failure. This is the equivalent of the Python
- statement: del o[i].
- */
+ /*
+Delete the ith element of object v. Returns
+-1 on failure. This is the equivalent of the Python
+statement: del o[i].
+ */
- PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2,
- PyObject *v);
+PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2,
+ PyObject *v);
- /*
- Assign the sequence object, v, to the slice in sequence
- object, o, from i1 to i2. Returns -1 on failure. This is the
- equivalent of the Python statement: o[i1:i2]=v.
- */
+ /*
+Assign the sequence object, v, to the slice in sequence
+object, o, from i1 to i2. Returns -1 on failure. This is the
+equivalent of the Python statement: o[i1:i2]=v.
+ */
- PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
+PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
- /*
- Delete the slice in sequence object, o, from i1 to i2.
- Returns -1 on failure. This is the equivalent of the Python
- statement: del o[i1:i2].
- */
+ /*
+Delete the slice in sequence object, o, from i1 to i2.
+Returns -1 on failure. This is the equivalent of the Python
+statement: del o[i1:i2].
+ */
- PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o);
+PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o);
- /*
- Returns the sequence, o, as a tuple on success, and NULL on failure.
- This is equivalent to the Python expression: tuple(o)
- */
+ /*
+Returns the sequence, o, as a tuple on success, and NULL on failure.
+This is equivalent to the Python expression: tuple(o)
+ */
- PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o);
- /*
- Returns the sequence, o, as a list on success, and NULL on failure.
- This is equivalent to the Python expression: list(o)
- */
+PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o);
+ /*
+Returns the sequence, o, as a list on success, and NULL on failure.
+This is equivalent to the Python expression: list(o)
+ */
- PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m);
- /*
- Return the sequence, o, as a list, unless it's already a
- tuple or list. Use PySequence_Fast_GET_ITEM to access the
- members of this list, and PySequence_Fast_GET_SIZE to get its length.
+PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m);
+ /*
+Return the sequence, o, as a list, unless it's already a
+tuple or list. Use PySequence_Fast_GET_ITEM to access the
+members of this list, and PySequence_Fast_GET_SIZE to get its length.
- Returns NULL on failure. If the object does not support iteration,
- raises a TypeError exception with m as the message text.
- */
+Returns NULL on failure. If the object does not support iteration,
+raises a TypeError exception with m as the message text.
+ */
#define PySequence_Fast_GET_SIZE(o) \
(PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o))
@@ -1159,189 +1170,190 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/
#define PySequence_Fast_ITEMS(sf) \
(PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \
: ((PyTupleObject *)(sf))->ob_item)
- /* Return a pointer to the underlying item array for
- an object retured by PySequence_Fast */
+/* Return a pointer to the underlying item array for
+ an object retured by PySequence_Fast */
- PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value);
+PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value);
- /*
- Return the number of occurrences on value on o, that is,
- return the number of keys for which o[key]==value. On
- failure, return -1. This is equivalent to the Python
- expression: o.count(value).
- */
+ /*
+Return the number of occurrences on value on o, that is,
+return the number of keys for which o[key]==value. On
+failure, return -1. This is equivalent to the Python
+expression: o.count(value).
+ */
- PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob);
- /*
- Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
- Use __contains__ if possible, else _PySequence_IterSearch().
- */
+PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob);
+ /*
+Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
+Use __contains__ if possible, else _PySequence_IterSearch().
+ */
#ifndef Py_LIMITED_API
#define PY_ITERSEARCH_COUNT 1
#define PY_ITERSEARCH_INDEX 2
#define PY_ITERSEARCH_CONTAINS 3
- PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq,
- PyObject *obj, int operation);
+PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq,
+ PyObject *obj, int operation);
#endif
- /*
- Iterate over seq. Result depends on the operation:
- PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if
- error.
- PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of
- obj in seq; set ValueError and return -1 if none found;
- also return -1 on error.
- PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on
- error.
- */
+/*
+ Iterate over seq. Result depends on the operation:
+ PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if
+ error.
+ PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of
+ obj in seq; set ValueError and return -1 if none found;
+ also return -1 on error.
+ PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on
+ error.
+*/
/* For DLL-level backwards compatibility */
#undef PySequence_In
- PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value);
+PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value);
/* For source-level backwards compatibility */
#define PySequence_In PySequence_Contains
- /*
- Determine if o contains value. If an item in o is equal to
- X, return 1, otherwise return 0. On error, return -1. This
- is equivalent to the Python expression: value in o.
- */
+ /*
+Determine if o contains value. If an item in o is equal to
+X, return 1, otherwise return 0. On error, return -1. This
+is equivalent to the Python expression: value in o.
+ */
- PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value);
+PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value);
+
+ /*
+Return the first index for which o[i]=value. On error,
+return -1. This is equivalent to the Python
+expression: o.index(value).
+ */
- /*
- Return the first index for which o[i]=value. On error,
- return -1. This is equivalent to the Python
- expression: o.index(value).
- */
/* In-place versions of some of the above Sequence functions. */
- PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2);
+PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2);
- /*
- Append o2 to o1, in-place when possible. Return the resulting
- object, which could be o1, or NULL on failure. This is the
- equivalent of the Python expression: o1 += o2.
+ /*
+Append o2 to o1, in-place when possible. Return the resulting
+object, which could be o1, or NULL on failure. This is the
+equivalent of the Python expression: o1 += o2.
- */
+ */
- PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count);
+PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count);
- /*
- Repeat o1 by count, in-place when possible. Return the resulting
- object, which could be o1, or NULL on failure. This is the
- equivalent of the Python expression: o1 *= count.
+ /*
+Repeat o1 by count, in-place when possible. Return the resulting
+object, which could be o1, or NULL on failure. This is the
+equivalent of the Python expression: o1 *= count.
- */
+ */
/* Mapping protocol:*/
- PyAPI_FUNC(int) PyMapping_Check(PyObject *o);
+PyAPI_FUNC(int) PyMapping_Check(PyObject *o);
- /*
- Return 1 if the object provides mapping protocol, and zero
- otherwise.
+ /*
+Return 1 if the object provides mapping protocol, and zero
+otherwise.
- This function always succeeds.
- */
+This function always succeeds.
+ */
- PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o);
- /*
- Returns the number of keys in object o on success, and -1 on
- failure. For objects that do not provide sequence protocol,
- this is equivalent to the Python expression: len(o).
- */
+ /*
+Returns the number of keys in object o on success, and -1 on
+failure. For objects that do not provide sequence protocol,
+this is equivalent to the Python expression: len(o).
+ */
- /* For DLL compatibility */
+/* For DLL compatibility */
#undef PyMapping_Length
- PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o);
+PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o);
#define PyMapping_Length PyMapping_Size
- /* implemented as a macro:
+/* implemented as a macro:
- int PyMapping_DelItemString(PyObject *o, const char *key);
+int PyMapping_DelItemString(PyObject *o, const char *key);
- Remove the mapping for object, key, from the object *o.
- Returns -1 on failure. This is equivalent to
- the Python statement: del o[key].
- */
+Remove the mapping for object, key, from the object *o.
+Returns -1 on failure. This is equivalent to
+the Python statement: del o[key].
+ */
#define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K))
- /* implemented as a macro:
+/* implemented as a macro:
- int PyMapping_DelItem(PyObject *o, PyObject *key);
+int PyMapping_DelItem(PyObject *o, PyObject *key);
- Remove the mapping for object, key, from the object *o.
- Returns -1 on failure. This is equivalent to
- the Python statement: del o[key].
- */
+Remove the mapping for object, key, from the object *o.
+Returns -1 on failure. This is equivalent to
+the Python statement: del o[key].
+ */
#define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K))
- PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *key);
+PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *key);
- /*
- On success, return 1 if the mapping object has the key, key,
- and 0 otherwise. This is equivalent to the Python expression:
- key in o.
+ /*
+On success, return 1 if the mapping object has the key, key,
+and 0 otherwise. This is equivalent to the Python expression:
+key in o.
- This function always succeeds.
- */
+This function always succeeds.
+ */
- PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key);
+PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key);
- /*
- Return 1 if the mapping object has the key, key,
- and 0 otherwise. This is equivalent to the Python expression:
- key in o.
+ /*
+Return 1 if the mapping object has the key, key,
+and 0 otherwise. This is equivalent to the Python expression:
+key in o.
- This function always succeeds.
+This function always succeeds.
- */
+ */
- PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o);
+PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o);
- /*
- On success, return a list or tuple of the keys in object o.
- On failure, return NULL.
- */
+ /*
+On success, return a list or tuple of the keys in object o.
+On failure, return NULL.
+ */
- PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o);
+PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o);
- /*
- On success, return a list or tuple of the values in object o.
- On failure, return NULL.
- */
+ /*
+On success, return a list or tuple of the values in object o.
+On failure, return NULL.
+ */
- PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o);
+PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o);
- /*
- On success, return a list or tuple of the items in object o,
- where each item is a tuple containing a key-value pair.
- On failure, return NULL.
+ /*
+On success, return a list or tuple of the items in object o,
+where each item is a tuple containing a key-value pair.
+On failure, return NULL.
- */
+ */
- PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o,
- const char *key);
+PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o,
+ const char *key);
- /*
- Return element of o corresponding to the object, key, or NULL
- on failure. This is the equivalent of the Python expression:
- o[key].
- */
+ /*
+Return element of o corresponding to the object, key, or NULL
+on failure. This is the equivalent of the Python expression:
+o[key].
+ */
- PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, const char *key,
- PyObject *value);
+PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, const char *key,
+ PyObject *value);
- /*
- Map the object, key, to the value, v. Returns
- -1 on failure. This is the equivalent of the Python
- statement: o[key]=v.
- */
+ /*
+Map the object, key, to the value, v. Returns
+-1 on failure. This is the equivalent of the Python
+statement: o[key]=v.
+ */
PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass);