From ba86008aac6890c5c4a2c6d30ea8110f228d483e Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sun, 20 Nov 2016 12:16:46 +0200 Subject: Issue #19569: Compiler warnings are now emitted if use most of deprecated functions. --- Include/abstract.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 44107a8a81..727d1a8f7b 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -549,7 +549,8 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj, const char **buffer, - Py_ssize_t *buffer_len); + Py_ssize_t *buffer_len) + Py_DEPRECATED(3.0); /* Takes an arbitrary object which must support the (character, @@ -562,7 +563,8 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ an exception set. */ - PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj); + PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj) + Py_DEPRECATED(3.0); /* Checks whether an arbitrary object supports the (character, @@ -572,7 +574,8 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj, const void **buffer, - Py_ssize_t *buffer_len); + Py_ssize_t *buffer_len) + Py_DEPRECATED(3.0); /* Same as PyObject_AsCharBuffer() except that this API expects @@ -587,7 +590,8 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj, void **buffer, - Py_ssize_t *buffer_len); + Py_ssize_t *buffer_len) + Py_DEPRECATED(3.0); /* Takes an arbitrary object which must support the (writable, -- cgit v1.2.1 From 7a82fd02f2c897880626cfcd23cf1e1e966138db Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 29 Nov 2016 18:47:56 +0100 Subject: Uniformize argument names of "call" functions * Callable object: callable, o, callable_object => func * Object for method calls: o => obj * Method name: name or nameid => method Cleanup also the C code: * Don't initialize variables to NULL if they are not used before their first assignement * Add braces for readability --- Include/abstract.h | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 727d1a8f7b..408fbe9ad0 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -257,15 +257,15 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ /* Declared elsewhere - PyAPI_FUNC(int) PyCallable_Check(PyObject *o); + PyAPI_FUNC(int) PyCallable_Check(PyObject *obj); - Determine if the object, o, is callable. Return 1 if the + Determine if the object, obj, is callable. Return 1 if the object is callable and 0 otherwise. This function always succeeds. */ - PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object, + PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *func, PyObject *args, PyObject *kwargs); #ifndef Py_LIMITED_API @@ -344,7 +344,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ _PyObject_FastCall((func), &(arg), 1) PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, - PyObject *obj, PyObject *args, + PyObject *arg0, PyObject *args, PyObject *kwargs); PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *func, @@ -353,27 +353,27 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ #endif /* Py_LIMITED_API */ /* - Call a callable Python object, callable_object, with + Call a callable Python object, func, with arguments and keywords arguments. The 'args' argument can not be NULL. */ - PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object, + PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *func, PyObject *args); /* - Call a callable Python object, callable_object, with + Call a callable Python object, func, with arguments given by the tuple, args. If no arguments are needed, then args may be NULL. Returns the result of the call on success, or NULL on failure. This is the equivalent of the Python expression: o(*args). */ - PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object, + PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *func, const char *format, ...); /* - Call a callable Python object, callable_object, with a + Call a callable Python object, func, with a variable number of C arguments. The C arguments are described using a mkvalue-style format string. The format may be NULL, indicating that no arguments are provided. Returns the @@ -382,7 +382,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ - PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, + PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj, const char *method, const char *format, ...); @@ -396,7 +396,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *o, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj, _Py_Identifier *method, const char *format, ...); @@ -406,25 +406,25 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ #endif /* !Py_LIMITED_API */ - PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, + PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *func, const char *format, ...); - PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o, - const char *name, + PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *obj, + const char *method, const char *format, ...); #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *o, - _Py_Identifier *name, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, + _Py_Identifier *method, const char *format, ...); #endif /* !Py_LIMITED_API */ - PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, + PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *func, ...); /* - Call a callable Python object, callable_object, with a + Call a callable Python object, func, 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. This is @@ -432,10 +432,10 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ - PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o, + PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *obj, PyObject *method, ...); #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *o, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *obj, struct _Py_Identifier *method, ...); #endif /* !Py_LIMITED_API */ -- cgit v1.2.1 From cbd0371d81fc46a7a9353ce362ec85ee45ce354b Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Wed, 30 Nov 2016 12:10:54 +0100 Subject: Backed out changeset 7efddbf1aa70 --- Include/abstract.h | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 408fbe9ad0..727d1a8f7b 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -257,15 +257,15 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ /* Declared elsewhere - PyAPI_FUNC(int) PyCallable_Check(PyObject *obj); + PyAPI_FUNC(int) PyCallable_Check(PyObject *o); - Determine if the object, obj, is callable. Return 1 if the + Determine if the object, o, is callable. Return 1 if the object is callable and 0 otherwise. This function always succeeds. */ - PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *func, + PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object, PyObject *args, PyObject *kwargs); #ifndef Py_LIMITED_API @@ -344,7 +344,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ _PyObject_FastCall((func), &(arg), 1) PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, - PyObject *arg0, PyObject *args, + PyObject *obj, PyObject *args, PyObject *kwargs); PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *func, @@ -353,27 +353,27 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ #endif /* Py_LIMITED_API */ /* - Call a callable Python object, func, with + Call a callable Python object, callable_object, with arguments and keywords arguments. The 'args' argument can not be NULL. */ - PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *func, + PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object, PyObject *args); /* - Call a callable Python object, func, with + Call a callable Python object, callable_object, with arguments given by the tuple, args. If no arguments are needed, then args may be NULL. Returns the result of the call on success, or NULL on failure. This is the equivalent of the Python expression: o(*args). */ - PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *func, + PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object, const char *format, ...); /* - Call a callable Python object, func, with a + Call a callable Python object, callable_object, with a variable number of C arguments. The C arguments are described using a mkvalue-style format string. The format may be NULL, indicating that no arguments are provided. Returns the @@ -382,7 +382,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ - PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj, + PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, const char *method, const char *format, ...); @@ -396,7 +396,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *o, _Py_Identifier *method, const char *format, ...); @@ -406,25 +406,25 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ #endif /* !Py_LIMITED_API */ - PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *func, + PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...); - PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *obj, - const char *method, + PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o, + const char *name, const char *format, ...); #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, - _Py_Identifier *method, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *o, + _Py_Identifier *name, const char *format, ...); #endif /* !Py_LIMITED_API */ - PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *func, + PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, ...); /* - Call a callable Python object, func, with a + Call a callable Python object, callable_object, 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. This is @@ -432,10 +432,10 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ */ - PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *obj, + PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o, PyObject *method, ...); #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *obj, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *o, struct _Py_Identifier *method, ...); #endif /* !Py_LIMITED_API */ -- cgit v1.2.1 From bfd49e943b6ca6172715524e1676b66208b59167 Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Thu, 1 Dec 2016 22:01:32 -0800 Subject: fix _PyObject_CallArg1 compiler warnings (closes #28855) --- Include/abstract.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 727d1a8f7b..900ef23932 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -341,7 +341,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ _PyObject_FastCall((func), NULL, 0) #define _PyObject_CallArg1(func, arg) \ - _PyObject_FastCall((func), &(arg), 1) + _PyObject_FastCall((func), (PyObject **)&(arg), 1) PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, PyObject *obj, PyObject *args, -- cgit v1.2.1 From 40273ec4f37c65c13a09d0ac23b08c99ebe2f1a3 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Mon, 5 Dec 2016 17:04:32 +0100 Subject: Issue #28858: Remove _PyObject_CallArg1() macro Replace _PyObject_CallArg1(func, arg) with PyObject_CallFunctionObjArgs(func, arg, NULL) Using the _PyObject_CallArg1() macro increases the usage of the C stack, which was unexpected and unwanted. PyObject_CallFunctionObjArgs() doesn't have this issue. --- Include/abstract.h | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 900ef23932..3dfac6577a 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -338,10 +338,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ _PyObject_FastCallDict((func), (args), (nargs), NULL) #define _PyObject_CallNoArg(func) \ - _PyObject_FastCall((func), NULL, 0) - -#define _PyObject_CallArg1(func, arg) \ - _PyObject_FastCall((func), (PyObject **)&(arg), 1) + _PyObject_FastCallDict((func), NULL, 0, NULL) PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, PyObject *obj, PyObject *args, -- cgit v1.2.1 From 647e75b25047cd0bf6a780e929db7a67de4cca75 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 6 Dec 2016 16:27:24 +0100 Subject: Uniformize argument names of "call" functions Issue #28838: Rename parameters of the "calls" functions of the Python C API. * Rename 'callable_object' and 'func' to 'callable': any Python callable object is accepted, not only Python functions * Rename 'method' and 'nameid' to 'name' (method name) * Rename 'o' to 'obj' * Move, fix and update documentation of PyObject_CallXXX() functions in abstract.h * Update also the documentaton of the C API (update parameter names) --- Include/abstract.h | 132 +++++++++++++++++++++++++++-------------------------- 1 file changed, 67 insertions(+), 65 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index f135afae97..95f6569f9b 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -265,14 +265,16 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ This function always succeeds. */ - PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object, - PyObject *args, PyObject *kwargs); + /* 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_object, with - arguments and keywords arguments. The 'args' argument can not 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); #ifndef Py_LIMITED_API PyAPI_FUNC(PyObject*) _PyStack_AsTuple( @@ -306,7 +308,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ PyObject **kwnames, PyObject *func); - /* Call the callable object func with the "fast call" calling convention: + /* 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. @@ -315,11 +317,11 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ Return the result on success. Raise an exception on return NULL on error. */ - PyAPI_FUNC(PyObject *) _PyObject_FastCallDict(PyObject *func, + PyAPI_FUNC(PyObject *) _PyObject_FastCallDict(PyObject *callable, PyObject **args, Py_ssize_t nargs, PyObject *kwargs); - /* Call the callable object func with the "fast call" calling convention: + /* 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 @@ -335,7 +337,7 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ Return the result on success. Raise an exception and return NULL on error. */ PyAPI_FUNC(PyObject *) _PyObject_FastCallKeywords - (PyObject *func, + (PyObject *callable, PyObject **args, Py_ssize_t nargs, PyObject *kwnames); @@ -346,55 +348,54 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ #define _PyObject_CallNoArg(func) \ _PyObject_FastCallDict((func), NULL, 0, NULL) - PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, + PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *callable, PyObject *obj, PyObject *args, PyObject *kwargs); - PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *func, + PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *callable, PyObject *result, const char *where); #endif /* Py_LIMITED_API */ - PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object, + /* 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. + + This is the equivalent of the Python expression: + callable(*args) */ + PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable, PyObject *args); - /* - Call a callable Python object, callable_object, with - arguments given by the tuple, args. If no arguments are - needed, then args may be NULL. Returns the result of the - call on success, or NULL on failure. This is the equivalent - of the Python expression: o(*args). - */ + /* Call a callable Python object, callable, with a variable number of C + arguments. The C arguments are described using a mkvalue-style format + string. - PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object, + The format may be NULL, indicating that no arguments are provided. + + 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_CallFunction(PyObject *callable, const char *format, ...); - /* - Call a callable Python object, callable_object, with a - variable number of C arguments. The C arguments are described - using a mkvalue-style format string. The format may be NULL, - indicating that no arguments are provided. Returns the - result of the call on success, or NULL on failure. This is - the equivalent of the Python expression: o(*args). - */ + /* 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. + The format can be NULL, indicating that no arguments are provided. - PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, - const char *method, - const char *format, ...); + Returns the result of the call on success, or NULL on failure. - /* - Call the method named m of object o with a variable number of - C arguments. The C arguments are described by a mkvalue - format string. The format may be NULL, indicating that no - arguments are provided. Returns the result of the call on - success, or NULL on failure. This is the equivalent of the - Python expression: o.method(args). - */ + 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 *o, - _Py_Identifier *method, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj, + _Py_Identifier *name, const char *format, ...); /* @@ -406,44 +407,45 @@ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...); - PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o, + 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 *o, - _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. + + 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, ...); /* - Call a callable Python object, callable_object, 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. This is - the equivalent of the Python expression: o(*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 *o, - PyObject *method, ...); + PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *obj, + PyObject *name, + ...); #ifndef Py_LIMITED_API - PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *o, - struct _Py_Identifier *method, + PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *obj, + struct _Py_Identifier *name, ...); #endif /* !Py_LIMITED_API */ - /* - Call the method named m of object o 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: o.method(args). - */ /* Implemented elsewhere: -- cgit v1.2.1 From b603d0b7fcfcd7d960402b35c48b92f2b50c03b3 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 6 Dec 2016 16:55:39 +0100 Subject: Issue #28838: Fix weird indentation of abstract.h Remove most indentation to move code at the left. --- Include/abstract.h | 1706 ++++++++++++++++++++++++++-------------------------- 1 file changed, 859 insertions(+), 847 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 95f6569f9b..09efd119bf 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); -- cgit v1.2.1 From cb8c62febe743a22d57f0d431340c0dd8e504fb2 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Fri, 9 Dec 2016 00:40:33 +0100 Subject: Add _PyObject_VaCallFunctionObjArgs() private function Issue #28915: Similar to _PyObject_CallFunctionObjArgs() but use va_list to pass arguments. --- Include/abstract.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 09efd119bf..5981d69e83 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -437,6 +437,12 @@ PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, ...); +#ifndef Py_LIMITED_API +PyAPI_FUNC(PyObject *) _PyObject_VaCallFunctionObjArgs( + PyObject *callable, + va_list vargs); +#endif + /* Call the method named 'name' of object 'obj' with a variable number of C arguments. The C arguments are provided as PyObject * -- cgit v1.2.1 From 0a99a4996ef685f99cecf2ad1a2ea106cc527fac Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Thu, 15 Dec 2016 09:14:25 +0100 Subject: Issue #28838: Cleanup abstract.h Rewrite all comments to use the same style than other Python header files: comment functions *before* their declaration, no newline between the comment and the declaration. Reformat some comments, add newlines, to make them easier to read. Quote argument like 'arg' to mention an argument in a comment. --- Include/abstract.h | 1044 +++++++++++++++++++++------------------------------- 1 file changed, 423 insertions(+), 621 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 5981d69e83..8c1e45bb26 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -4,14 +4,6 @@ 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 */ -#endif - /* Abstract Object Interface (many thanks to Jim Fulton) */ /* @@ -134,136 +126,139 @@ Protocols /* 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: -int PyObject_HasAttrString(PyObject *o, const char *attr_name); + int PyObject_HasAttrString(PyObject *o, const char *attr_name); + + Returns 1 if object 'o' has the attribute attr_name, and 0 otherwise. -Returns 1 if o has the attribute attr_name, and 0 otherwise. -This is equivalent to the Python expression: -hasattr(o,attr_name). + This is equivalent to the Python expression: hasattr(o,attr_name). -This function always succeeds. + This function always succeeds. */ - */ /* 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: -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 function always succeeds. + 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); + 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: -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. -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. + This is the equivalent of the Python statement o.attr_name=v. */ - */ /* 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'. 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. - */ -#define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A),NULL) + 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); +/* Implemented as a macro: -Delete attribute named attr_name, for object o. Returns -1 -on failure. This is the equivalent of the Python -statement: del o.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. */ +#define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A), NULL) - */ -#define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A),NULL) /* 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. -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). + 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: -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. -Called by the str() and print() built-in functions. + 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); +/* Declared elsewhere -Determine if the object, o, is callable. Return 1 if the -object is callable and 0 otherwise. + 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 +# ifndef Py_LIMITED_API +# define _PyObject_CallMethodId _PyObject_CallMethodId_SizeT +# endif /* !Py_LIMITED_API */ +#endif -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'. @@ -276,7 +271,6 @@ This function always succeeds. PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs); - #ifndef Py_LIMITED_API PyAPI_FUNC(PyObject*) _PyStack_AsTuple( PyObject **stack, @@ -285,9 +279,9 @@ PyAPI_FUNC(PyObject*) _PyStack_AsTuple( /* 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 + 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, @@ -369,7 +363,7 @@ PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *callable, Returns the result of the call on success, or *NULL* on failure. This is the equivalent of the Python expression: - callable(*args) */ + callable(*args). */ PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable, PyObject *args); @@ -382,7 +376,7 @@ PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable, Returns the result of the call on success, or NULL on failure. This is the equivalent of the Python expression: - callable(arg1, arg2, ...) */ + callable(arg1, arg2, ...). */ PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable, const char *format, ...); @@ -394,20 +388,17 @@ PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable, Returns the result of the call on success, or NULL on failure. This is the equivalent of the Python expression: - obj.name(arg1, arg2, ...) */ + obj.name(arg1, arg2, ...). */ PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...); #ifndef Py_LIMITED_API +/* Like PyObject_CallMethod(), but expect a _Py_Identifier* + as the method name. */ 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. -*/ #endif /* !Py_LIMITED_API */ PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, @@ -433,23 +424,25 @@ PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, Returns the result of the call on success, or NULL on failure. This is the equivalent of the Python expression: - callable(arg1, arg2, ...) */ + callable(arg1, arg2, ...). */ PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, ...); #ifndef Py_LIMITED_API +/* Similar PyObject_CallFunctionObjArgs(), but pass positional arguments + as a va_list: list of PyObject* object. */ PyAPI_FUNC(PyObject *) _PyObject_VaCallFunctionObjArgs( PyObject *callable, va_list vargs); #endif - /* -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, @@ -466,189 +459,165 @@ PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs( /* 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: -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: -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. -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 - */ + This is equivalent to the Python expression: not o. */ + +/* Get the type of an object. + + 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(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). - */ +/* 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) */ 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). - */ /* For DLL compatibility */ #undef PyObject_Length 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); + +/* 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(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. - */ +/* Return element of 'o' corresponding to the object 'key'. Return NULL + on failure. + This is the equivalent of the Python expression: o[key] */ 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]. - */ +/* Map the object 'key' to the value 'v' into 'o'. + + 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_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. - */ +/* 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_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]. - */ +/* Delete the mapping for key from object 'o'. Returns -1 on failure. + This is the equivalent of the Python statement: del o[key]. */ PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key); - /* -Delete the mapping for key from *o. Returns -1 on failure. -This is the equivalent of the Python statement: del o[key]. - */ -/* old buffer API - FIXME: usage of these should all be replaced in Python itself +/* === 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). */ +/* 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. + + Return 0 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); - /* -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. - */ +/* Checks whether an arbitrary object supports the (character, single segment) + buffer interface. + Returns 1 on success, 0 on failure. */ PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj) Py_DEPRECATED(3.0); -/* -Checks whether an arbitrary object supports the (character, -single segment) buffer interface. Returns 1 on success, 0 -on failure. -*/ +/* 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_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. - */ +/* 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'. + Return 0 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 */ +/* === New Buffer API ============================================ */ #ifndef Py_LIMITED_API + +/* Return 1 if the getbuffer function is available, otherwise return 0. */ #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 */ - -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 -*/ + call. -PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices); + Returns -1 and raises an error on failure and returns 0 on success. */ +PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view, + int flags); /* 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 *); + Note that view->ndim is the assumed size of indices. */ +PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices); /* Return the implied itemsize of the data-format area from a - struct-style description */ - - + struct-style description. */ +PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *); /* Implementation in memoryobject.c */ PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view, @@ -657,7 +626,6 @@ PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view, 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 @@ -670,703 +638,537 @@ PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf, 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. - -*/ - + in whatever way is more efficient. */ 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); - +/*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(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. -*/ +/* 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(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. - */ - +/* Releases a Py_buffer obtained from getbuffer ParseTuple's "s*". */ PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view); -/* Releases a Py_buffer obtained from getbuffer ParseTuple's s*. - */ #endif /* Py_LIMITED_API */ -PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj, +/* 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 */ +/* ==== Iterators ================================================ */ + +/* 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) +/* 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); +/* Returns 1 if the object 'o' provides numeric protocols, and 0 otherwise. - /* -Returns 1 if the object, o, provides numeric protocols, and -false otherwise. + This function always succeeds. */ +PyAPI_FUNC(int) PyNumber_Check(PyObject *o); -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -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); - /* -Returns the negation of o on success, or null on failure. -This is the equivalent of the Python expression: -o. - */ +/* Returns the positive of o on success, or NULL on failure. + This is the equivalent of the Python expression: +o. */ PyAPI_FUNC(PyObject *) PyNumber_Positive(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); - /* -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); - /* -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); - /* -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); - /* -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. - - */ +/* 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); - /* -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) +#define PyIndex_Check(obj) \ + ((obj)->ob_type->tp_as_number != NULL && \ + (obj)->ob_type->tp_as_number->nb_index != NULL) +/* Returns the object 'o' converted to a Python int, or NULL with an exception + raised on failure. */ 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 'o' 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 'exc' is the error-type to return. If it is NULL, then the + overflow error is cleared and the value is clipped. */ 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 '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_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 object 'o' converted to a float object on success, or NULL + on failure. + This is the equivalent of the Python expression: float(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). - */ +/* --- In-place variants of (some of) the above number protocol functions -- */ -/* In-place variants of (some of) the above number protocol functions */ +/* 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_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 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_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 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_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. - */ - +/* This is the equivalent of the Python expression: o1 @= o2. */ PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(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, possibly + in-place, or NULL on failure. + This is the equivalent of the Python expression: o1 /= 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 a float 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); - /* -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 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_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 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 o1 = pow(o1, o2, o3) if o3 is present. */ 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 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_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 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_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 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_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 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_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 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_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 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. */ 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. - */ - /* === Sequence protocol ================================================ */ -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(int) PySequence_Check(PyObject *o); +/* Return the size of sequence object o, or -1 on failure. */ PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o); - /* -Return the size of sequence object o, or -1 on failure. - */ - /* For DLL compatibility */ #undef PySequence_Length - PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o); +PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o); #define PySequence_Length PySequence_Size +/* 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_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 result of repeating sequence object 'o' 'count' times, + or NULL on failure. + This is the equivalent of the Python expression: o * 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 ith element of o, or NULL on failure. + This is the equivalent of the Python expression: o[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 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(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]. - */ +/* Assign object 'v' to the ith element of the sequence '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_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. - */ +/* Delete the 'i'-th element of the sequence 'v'. Returns -1 on failure. + This is the equivalent of the Python statement: del o[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]. - */ +/* 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_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. - */ +/* 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(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]. - */ +/* 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_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 list on success, and NULL on failure. + This is equivalent to the Python expression: list(o) */ +PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o); +/* Return the sequence 'o' as a list, unless it's already a tuple or list. -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) - */ + 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. */ 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. - */ +/* Return the size of the sequence 'o', assuming that 'o' was returned by + PySequence_Fast and is not NULL. */ #define PySequence_Fast_GET_SIZE(o) \ (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o)) - /* - Return the size of o, assuming that o was returned by - PySequence_Fast and is not NULL. - */ +/* Return the 'i'-th element of the sequence 'o', assuming that o was returned + by PySequence_Fast, and that i is within bounds. */ #define PySequence_Fast_GET_ITEM(o, i)\ (PyList_Check(o) ? PyList_GET_ITEM(o, i) : PyTuple_GET_ITEM(o, i)) - /* - Return the ith element of o, assuming that o was returned by - PySequence_Fast, and that i is within bounds. - */ +/* Assume tp_as_sequence and sq_item exist and that 'i' does not + need to be corrected for a negative index. */ #define PySequence_ITEM(o, i)\ ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) ) - /* Assume tp_as_sequence and sq_item exist and that i does not - need to be corrected for a negative index - */ +/* Return a pointer to the underlying item array for + an object retured by PySequence_Fast */ #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 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(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 1 if 'ob' is in the sequence 'seq'; 0 if 'ob' is not in the sequence + 'seq'; -1 on error. + 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 + +/* 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. */ 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. -*/ + /* For DLL-level backwards compatibility */ #undef PySequence_In +/* Determine if the sequence 'o' contains 'value'. If an item in 'o' is equal + to 'value', return 1, otherwise return 0. On error, return -1. + + This is equivalent to the Python expression: value in o. */ 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. - */ +/* Return the first index for which o[i] == value. + On error, return -1. + + This is equivalent to the Python expression: o.index(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). - */ +/* --- In-place versions of some of the above Sequence functions --- */ -/* In-place versions of some of the above Sequence functions. */ +/* Append sequence 'o2' to sequence '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_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. - - */ +/* Repeat sequence 'o' by 'count', in-place when possible. Return the resulting + object, which could be 'o', or NULL on failure. + This is the equivalent of the Python expression: o1 *= 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. - */ +/* === Mapping protocol ================================================= */ -/* Mapping protocol:*/ +/* Return 1 if the object provides mapping protocol, and 0 otherwise. + This function always succeeds. */ PyAPI_FUNC(int) PyMapping_Check(PyObject *o); - /* -Return 1 if the object provides mapping protocol, and zero -otherwise. - -This function always succeeds. - */ - +/* Returns the number of keys in mapping 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). */ 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). - */ - /* For DLL compatibility */ #undef PyMapping_Length 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 mapping '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]. - */ -#define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K)) + Remove the mapping for object 'key' from the mapping object 'o'. + Returns -1 on failure. -PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *key); + This is equivalent to the Python statement: del o[key]. */ +#define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K)) - /* -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 'o' has the key 'key', + and 0 otherwise. -This function always succeeds. - */ + This is equivalent to the Python expression: key in o. -PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key); + This function always succeeds. */ +PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *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 function always succeeds. + This is equivalent to the Python expression: key in o. - */ + This function always succeeds. */ +PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key); +/* On success, return a list or tuple of the keys in mapping object 'o'. + On failure, return NULL. */ 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 values in mapping object 'o'. + On failure, return NULL. */ 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 items in mapping object 'o', + where each item is a tuple containing a key-value pair. On failure, return + NULL. */ 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. - - */ +/* 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(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]. - */ +/* Map the object 'key' to the value 'v' in the mapping 'o'. + Returns -1 on failure. + This is the equivalent of the Python statement: o[key]=v. */ 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. - */ - - +/* isinstance(object, typeorclass) */ PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass); - /* isinstance(object, typeorclass) */ +/* issubclass(object, typeorclass) */ PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass); - /* issubclass(object, typeorclass) */ #ifndef Py_LIMITED_API -- cgit v1.2.1 From cff69a956b4ce78ad7c4318ada06f07959dd8023 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Thu, 15 Dec 2016 12:40:53 +0100 Subject: Add _PY_FASTCALL_SMALL_STACK constant Issue #28870: Add a new _PY_FASTCALL_SMALL_STACK constant, size of "small stacks" allocated on the C stack to pass positional arguments to _PyObject_FastCall(). _PyObject_Call_Prepend() now uses a small stack of 5 arguments (40 bytes) instead of 8 (64 bytes), since it is modified to use _PY_FASTCALL_SMALL_STACK. --- Include/abstract.h | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 8c1e45bb26..f6dfc67585 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -303,6 +303,17 @@ PyAPI_FUNC(PyObject **) _PyStack_UnpackDict( PyObject **kwnames, PyObject *func); +/* Suggested size (number of positional arguments) for arrays of PyObject* + allocated on a C stack to avoid allocating memory on the heap memory. Such + array is used to pass positional arguments to call functions of the + _PyObject_FastCall() family. + + The size is chosen to not abuse the C stack and so limit the risk of stack + overflow. The size is also chosen to allow using the small stack for most + function calls of the Python standard library. On 64-bit CPU, it allocates + 40 bytes on the stack. */ +#define _PY_FASTCALL_SMALL_STACK 5 + /* 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. -- cgit v1.2.1 From d8f705f0fd3ad6a85edaf8de71726f172341725d Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Mon, 19 Dec 2016 13:12:08 +0100 Subject: abstract.h: remove long outdated comment Issue #28838: The documentation is of the Python C API is more complete and more up to date than this old comment. Removal suggested by Antoine Pitrou. --- Include/abstract.h | 120 +---------------------------------------------------- 1 file changed, 2 insertions(+), 118 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index f6dfc67585..cfd240c2bf 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -1,127 +1,11 @@ +/* Abstract Object Interface (many thanks to Jim Fulton) */ + #ifndef Py_ABSTRACTOBJECT_H #define Py_ABSTRACTOBJECT_H #ifdef __cplusplus extern "C" { #endif -/* Abstract Object Interface (many thanks to Jim Fulton) */ - -/* - PROPOSAL: A Generic Python Object Interface for Python C Modules - -Problem - - Python modules written in C that must access Python objects must do - so through routines whose interfaces are described by a set of - include files. Unfortunately, these routines vary according to the - object accessed. To use these routines, the C programmer must check - the type of the object being used and must call a routine based on - the object type. For example, to access an element of a sequence, - 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 the programmer wants to get an item from another type of object - that provides sequence behavior, there is no clear way to do it - correctly. - - The persistent programmer may peruse object.h and find that the - _typeobject structure provides a means of invoking up to (currently - about) 41 special operators. So, for example, a routine can get an - item from any object that provides sequence behavior. However, to - use this mechanism, the programmer must make their code dependent on - the current Python implementation. - - Also, certain semantics, especially memory management semantics, may - differ by the type of object being used. Unfortunately, these - semantics are not clearly described in the current include files. - An abstract interface providing more consistent semantics is needed. - -Proposal - - I propose the creation of a standard interface (with an associated - library of routines and/or macros) for generically obtaining the - services of Python objects. This proposal can be viewed as one - components of a Python C interface consisting of several components. - - From the viewpoint of C access to Python services, we have (as - suggested by Guido in off-line discussions): - - - "Very high level layer": two or three functions that let you exec or - eval arbitrary Python code given as a string in a module whose name is - given, passing C values in and getting C values out using - mkvalue/getargs style format strings. This does not require the user - to declare any variables of type "PyObject *". This should be enough - to write a simple application that gets Python code from the user, - execs it, and returns the output or errors. (Error handling must also - be part of this API.) - - - "Abstract objects layer": which is the subject of this proposal. - It has many functions operating on objects, and lest you do many - things from C that you can also write in Python, without going - through the Python parser. - - - "Concrete objects layer": This is the public type-dependent - interface provided by the standard built-in types, such as floats, - strings, and lists. This interface exists and is currently - documented by the collection of include files provided with the - Python distributions. - - From the point of view of Python accessing services provided by C - modules: - - - "Python module interface": this interface consist of the basic - routines used to define modules and their members. Most of the - current extensions-writing guide deals with this interface. - - - "Built-in object interface": this is the interface that a new - built-in type must provide and the mechanisms and rules that a - developer of a new built-in type must use and follow. - - This proposal is a "first-cut" that is intended to spur - discussion. See especially the lists of notes. - - The Python C object interface will provide four protocols: object, - numeric, sequence, and mapping. Each protocol consists of a - collection of related operations. If an operation that is not - provided by a particular type is invoked, then a standard exception, - NotImplementedError is raised with an operation name as an argument. - In addition, for convenience this interface defines a set of - constructors for building objects of built-in types. This is needed - so new objects can be returned from C functions that otherwise treat - objects generically. - -Memory Management - - For all of the functions described in this proposal, if a function - retains a reference to a Python object passed as an argument, then the - function will increase the reference count of the object. It is - unnecessary for the caller to increase the reference count of an - argument in anticipation of the object's retention. - - All Python objects returned from functions should be treated as new - objects. Functions that return objects assume that the caller will - retain a reference and the reference count of the object has already - been incremented to account for this fact. A caller that does not - retain a reference to an object that is returned from a function - must decrement the reference count of the object (using - DECREF(object)) to prevent memory leaks. - - Note that the behavior mentioned here is different from the current - behavior for some objects (e.g. lists and tuples) when certain - type-specific routines are called directly (e.g. setlistitem). The - proposed abstraction layer will provide a consistent memory - management interface, correcting for inconsistent behavior for some - built-in types. - -Protocols -*/ - - /* === Object Protocol ================================================== */ /* Implemented elsewhere: -- cgit v1.2.1 From a8ccebab461e0c74a522f55fc25bef949d34ef29 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Wed, 11 Jan 2017 00:07:40 +0100 Subject: call_method() now uses _PyObject_FastCall() Issue #29233: Replace the inefficient _PyObject_VaCallFunctionObjArgs() with _PyObject_FastCall() in call_method() and call_maybe(). Only a few functions call call_method() and call it with a fixed number of arguments. Avoid the complex and expensive _PyObject_VaCallFunctionObjArgs() function, replace it with an array allocated on the stack with the exact number of argumlents. It reduces the stack consumption, bytes per call, before => after: test_python_call: 1168 => 1152 (-16 B) test_python_getitem: 1344 => 1008 (-336 B) test_python_iterator: 1568 => 1232 (-336 B) Remove the _PyObject_VaCallFunctionObjArgs() function which became useless. Rename it to object_vacall() and make it private. --- Include/abstract.h | 8 -------- 1 file changed, 8 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index f7d7dcc1da..3ca283aa12 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -323,14 +323,6 @@ PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, ...); -#ifndef Py_LIMITED_API -/* Similar PyObject_CallFunctionObjArgs(), but pass positional arguments - as a va_list: list of PyObject* object. */ -PyAPI_FUNC(PyObject *) _PyObject_VaCallFunctionObjArgs( - PyObject *callable, - va_list vargs); -#endif - /* 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. -- cgit v1.2.1 From 7e1c513a9ea54b50e4c3b947208d1306aba5362f Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Mon, 16 Jan 2017 23:50:53 +0100 Subject: Add _PyStack_AsTupleSlice() helper --- Include/abstract.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 3ca283aa12..d96e8a5424 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -160,6 +160,12 @@ PyAPI_FUNC(PyObject*) _PyStack_AsTuple( PyObject **stack, Py_ssize_t nargs); +PyAPI_FUNC(PyObject*) _PyStack_AsTupleSlice( + PyObject **stack, + Py_ssize_t nargs, + Py_ssize_t start, + Py_ssize_t end); + /* Convert keyword arguments from the (stack, kwnames) format to a Python dictionary. -- cgit v1.2.1 From 271403abe36069797ac332e1c6eae3473878db20 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 17 Jan 2017 01:29:01 +0100 Subject: Rename _PyArg_ParseStack to _PyArg_ParseStackAndKeywords Issue #29286. --- Include/abstract.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index d96e8a5424..43bf251222 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -171,7 +171,7 @@ PyAPI_FUNC(PyObject*) _PyStack_AsTupleSlice( 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 + later calling _PyStack_AsDict(). For example, _PyArg_ParseStackAndKeywords() raises an error if a key is not a string. */ PyAPI_FUNC(PyObject *) _PyStack_AsDict( PyObject **values, @@ -185,7 +185,7 @@ PyAPI_FUNC(PyObject *) _PyStack_AsDict( The stack uses borrowed references. The type of keyword keys is not checked, these checks should be done - later (ex: _PyArg_ParseStack). */ + later (ex: _PyArg_ParseStackAndKeywords). */ PyAPI_FUNC(PyObject **) _PyStack_UnpackDict( PyObject **args, Py_ssize_t nargs, -- cgit v1.2.1 From 36b536afbf9f8adfc6511521bb8596ad7762a247 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 17 Jan 2017 01:57:29 +0100 Subject: _PyStack_UnpackDict() now returns -1 on error Issue #29286. Change _PyStack_UnpackDict() prototype to be able to notify of failure when args is NULL. --- Include/abstract.h | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 43bf251222..961279d470 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -177,20 +177,23 @@ PyAPI_FUNC(PyObject *) _PyStack_AsDict( PyObject **values, PyObject *kwnames); -/* Convert (args, nargs, kwargs) into a (stack, nargs, kwnames). +/* Convert (args, nargs, kwargs: dict) into a (stack, nargs, kwnames: tuple). - Return a new stack which should be released by PyMem_Free(), or return - args unchanged if kwargs is NULL or an empty dictionary. + Return 0 on success, raise an exception and return -1 on error. + + Write the new stack into *p_stack. If *p_stack is differen than args, it + must be released by PyMem_Free(). The stack uses borrowed references. The type of keyword keys is not checked, these checks should be done later (ex: _PyArg_ParseStackAndKeywords). */ -PyAPI_FUNC(PyObject **) _PyStack_UnpackDict( +PyAPI_FUNC(int) _PyStack_UnpackDict( PyObject **args, Py_ssize_t nargs, PyObject *kwargs, - PyObject **kwnames, + PyObject ***p_stack, + PyObject **p_kwnames, PyObject *func); /* Suggested size (number of positional arguments) for arrays of PyObject* -- cgit v1.2.1 From e44ae9a7fd3a32fc03338559f82679db3e6f79fd Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Wed, 18 Jan 2017 10:31:46 +0100 Subject: Remove unused func parameter of _PyStack_UnpackDict() Issue #29259. --- Include/abstract.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 961279d470..6647be774a 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -193,8 +193,7 @@ PyAPI_FUNC(int) _PyStack_UnpackDict( Py_ssize_t nargs, PyObject *kwargs, PyObject ***p_stack, - PyObject **p_kwnames, - PyObject *func); + PyObject **p_kwnames); /* Suggested size (number of positional arguments) for arrays of PyObject* allocated on a C stack to avoid allocating memory on the heap memory. Such -- cgit v1.2.1 From df457ae79fffb23d438ddd780dd0fbbb60062299 Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Tue, 24 Jan 2017 15:05:30 +0100 Subject: Issue #29360: _PyStack_AsDict() doesn't check kwnames Remove two assertions which can fail on legit code. Keyword arguments are checked later with better tests and raise a regular (TypeError) exception. --- Include/abstract.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'Include/abstract.h') diff --git a/Include/abstract.h b/Include/abstract.h index 6647be774a..231e209b03 100644 --- a/Include/abstract.h +++ b/Include/abstract.h @@ -166,13 +166,16 @@ PyAPI_FUNC(PyObject*) _PyStack_AsTupleSlice( Py_ssize_t start, Py_ssize_t end); -/* Convert keyword arguments from the (stack, kwnames) format to a Python - dictionary. +/* Convert keyword arguments from the FASTCALL (stack: C array, kwnames: tuple) + format to a Python dictionary ("kwargs" dict). - 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_ParseStackAndKeywords() raises an - error if a key is not a string. */ + The type of kwnames keys is not checked. The final function getting + arguments is reponsible to check if all keys are strings, for example using + PyArg_ParseTupleAndKeywords() or PyArg_ValidateKeywordArguments(). + + Duplicate keys are merged using the last value. If duplicate keys must raise + an exception, the caller is responsible to implement an explicit keys on + kwnames. */ PyAPI_FUNC(PyObject *) _PyStack_AsDict( PyObject **values, PyObject *kwnames); -- cgit v1.2.1