Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1 | #ifndef Py_ABSTRACTOBJECT_H |
| 2 | #define Py_ABSTRACTOBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 7 | /* Abstract Object Interface (many thanks to Jim Fulton) */ |
| 8 | |
| 9 | /* |
| 10 | PROPOSAL: A Generic Python Object Interface for Python C Modules |
| 11 | |
| 12 | Problem |
| 13 | |
| 14 | Python modules written in C that must access Python objects must do |
| 15 | so through routines whose interfaces are described by a set of |
| 16 | include files. Unfortunately, these routines vary according to the |
| 17 | object accessed. To use these routines, the C programmer must check |
| 18 | the type of the object being used and must call a routine based on |
| 19 | the object type. For example, to access an element of a sequence, |
| 20 | the programmer must determine whether the sequence is a list or a |
| 21 | tuple: |
| 22 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 23 | if (is_tupleobject(o)) |
| 24 | e = gettupleitem(o, i) |
| 25 | else if (is_listitem(o)) |
| 26 | e = getlistitem(o, i) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 27 | |
| 28 | If the programmer wants to get an item from another type of object |
| 29 | that provides sequence behavior, there is no clear way to do it |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 30 | correctly. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 31 | |
| 32 | The persistent programmer may peruse object.h and find that the |
| 33 | _typeobject structure provides a means of invoking up to (currently |
| 34 | about) 41 special operators. So, for example, a routine can get an |
| 35 | item from any object that provides sequence behavior. However, to |
| 36 | use this mechanism, the programmer must make their code dependent on |
| 37 | the current Python implementation. |
| 38 | |
| 39 | Also, certain semantics, especially memory management semantics, may |
| 40 | differ by the type of object being used. Unfortunately, these |
| 41 | semantics are not clearly described in the current include files. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 42 | An abstract interface providing more consistent semantics is needed. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 43 | |
| 44 | Proposal |
| 45 | |
| 46 | I propose the creation of a standard interface (with an associated |
| 47 | library of routines and/or macros) for generically obtaining the |
| 48 | services of Python objects. This proposal can be viewed as one |
| 49 | components of a Python C interface consisting of several components. |
| 50 | |
Raymond Hettinger | a72e2f9 | 2003-02-28 05:11:03 +0000 | [diff] [blame] | 51 | From the viewpoint of C access to Python services, we have (as |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 52 | suggested by Guido in off-line discussions): |
| 53 | |
| 54 | - "Very high level layer": two or three functions that let you exec or |
| 55 | eval arbitrary Python code given as a string in a module whose name is |
| 56 | given, passing C values in and getting C values out using |
| 57 | mkvalue/getargs style format strings. This does not require the user |
| 58 | to declare any variables of type "PyObject *". This should be enough |
| 59 | to write a simple application that gets Python code from the user, |
| 60 | execs it, and returns the output or errors. (Error handling must also |
| 61 | be part of this API.) |
| 62 | |
| 63 | - "Abstract objects layer": which is the subject of this proposal. |
| 64 | It has many functions operating on objects, and lest you do many |
| 65 | things from C that you can also write in Python, without going |
| 66 | through the Python parser. |
| 67 | |
| 68 | - "Concrete objects layer": This is the public type-dependent |
| 69 | interface provided by the standard built-in types, such as floats, |
| 70 | strings, and lists. This interface exists and is currently |
Raymond Hettinger | a72e2f9 | 2003-02-28 05:11:03 +0000 | [diff] [blame] | 71 | documented by the collection of include files provided with the |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 72 | Python distributions. |
| 73 | |
| 74 | From the point of view of Python accessing services provided by C |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 75 | modules: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 76 | |
| 77 | - "Python module interface": this interface consist of the basic |
| 78 | routines used to define modules and their members. Most of the |
| 79 | current extensions-writing guide deals with this interface. |
| 80 | |
| 81 | - "Built-in object interface": this is the interface that a new |
| 82 | built-in type must provide and the mechanisms and rules that a |
| 83 | developer of a new built-in type must use and follow. |
| 84 | |
| 85 | This proposal is a "first-cut" that is intended to spur |
| 86 | discussion. See especially the lists of notes. |
| 87 | |
| 88 | The Python C object interface will provide four protocols: object, |
| 89 | numeric, sequence, and mapping. Each protocol consists of a |
| 90 | collection of related operations. If an operation that is not |
| 91 | provided by a particular type is invoked, then a standard exception, |
Martin Panter | 7462b649 | 2015-11-02 03:37:02 +0000 | [diff] [blame] | 92 | NotImplementedError is raised with an operation name as an argument. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 93 | In addition, for convenience this interface defines a set of |
| 94 | constructors for building objects of built-in types. This is needed |
| 95 | so new objects can be returned from C functions that otherwise treat |
| 96 | objects generically. |
| 97 | |
| 98 | Memory Management |
| 99 | |
| 100 | For all of the functions described in this proposal, if a function |
| 101 | retains a reference to a Python object passed as an argument, then the |
| 102 | function will increase the reference count of the object. It is |
| 103 | unnecessary for the caller to increase the reference count of an |
| 104 | argument in anticipation of the object's retention. |
| 105 | |
| 106 | All Python objects returned from functions should be treated as new |
| 107 | objects. Functions that return objects assume that the caller will |
| 108 | retain a reference and the reference count of the object has already |
| 109 | been incremented to account for this fact. A caller that does not |
| 110 | retain a reference to an object that is returned from a function |
| 111 | must decrement the reference count of the object (using |
| 112 | DECREF(object)) to prevent memory leaks. |
| 113 | |
| 114 | Note that the behavior mentioned here is different from the current |
| 115 | behavior for some objects (e.g. lists and tuples) when certain |
| 116 | type-specific routines are called directly (e.g. setlistitem). The |
| 117 | proposed abstraction layer will provide a consistent memory |
| 118 | management interface, correcting for inconsistent behavior for some |
| 119 | built-in types. |
| 120 | |
| 121 | Protocols |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 122 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 123 | |
| 124 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 125 | /* === Object Protocol ================================================== */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 126 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 127 | /* Implemented elsewhere: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 128 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 129 | int PyObject_Print(PyObject *o, FILE *fp, int flags); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 130 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 131 | Print an object 'o' on file 'fp'. Returns -1 on error. The flags argument |
| 132 | is used to enable certain printing options. The only option currently |
| 133 | supported is Py_Print_RAW. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 134 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 135 | (What should be said about Py_Print_RAW?). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 136 | |
| 137 | |
| 138 | /* Implemented elsewhere: |
| 139 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 140 | int PyObject_HasAttrString(PyObject *o, const char *attr_name); |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 141 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 142 | Returns 1 if object 'o' has the attribute attr_name, and 0 otherwise. |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 143 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 144 | This is equivalent to the Python expression: hasattr(o,attr_name). |
| 145 | |
| 146 | This function always succeeds. */ |
| 147 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 148 | |
| 149 | /* Implemented elsewhere: |
| 150 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 151 | PyObject* PyObject_GetAttrString(PyObject *o, const char *attr_name); |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 152 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 153 | Retrieve an attributed named attr_name form object o. |
| 154 | Returns the attribute value on success, or NULL on failure. |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 155 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 156 | This is the equivalent of the Python expression: o.attr_name. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 157 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 158 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 159 | /* Implemented elsewhere: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 160 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 161 | int PyObject_HasAttr(PyObject *o, PyObject *attr_name); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 162 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 163 | Returns 1 if o has the attribute attr_name, and 0 otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 164 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 165 | This is equivalent to the Python expression: hasattr(o,attr_name). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 166 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 167 | This function always succeeds. */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 168 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 169 | /* Implemented elsewhere: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 170 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 171 | PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 172 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 173 | Retrieve an attributed named 'attr_name' form object 'o'. |
| 174 | Returns the attribute value on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 175 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 176 | This is the equivalent of the Python expression: o.attr_name. */ |
Marc-André Lemburg | ad7c98e | 2001-01-17 17:09:53 +0000 | [diff] [blame] | 177 | |
Marc-André Lemburg | ad7c98e | 2001-01-17 17:09:53 +0000 | [diff] [blame] | 178 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 179 | /* Implemented elsewhere: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 180 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 181 | int PyObject_SetAttrString(PyObject *o, const char *attr_name, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 182 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 183 | Set the value of the attribute named attr_name, for object 'o', |
| 184 | to the value 'v'. Raise an exception and return -1 on failure; return 0 on |
| 185 | success. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 186 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 187 | This is the equivalent of the Python statement o.attr_name=v. */ |
| 188 | |
| 189 | |
| 190 | /* Implemented elsewhere: |
| 191 | |
| 192 | int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v); |
| 193 | |
| 194 | Set the value of the attribute named attr_name, for object 'o', to the value |
| 195 | 'v'. an exception and return -1 on failure; return 0 on success. |
| 196 | |
| 197 | This is the equivalent of the Python statement o.attr_name=v. */ |
| 198 | |
| 199 | /* Implemented as a macro: |
| 200 | |
| 201 | int PyObject_DelAttrString(PyObject *o, const char *attr_name); |
| 202 | |
| 203 | Delete attribute named attr_name, for object o. Returns |
| 204 | -1 on failure. |
| 205 | |
| 206 | This is the equivalent of the Python statement: del o.attr_name. */ |
| 207 | #define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A), NULL) |
| 208 | |
| 209 | |
| 210 | /* Implemented as a macro: |
| 211 | |
| 212 | int PyObject_DelAttr(PyObject *o, PyObject *attr_name); |
| 213 | |
| 214 | Delete attribute named attr_name, for object o. Returns -1 |
| 215 | on failure. This is the equivalent of the Python |
| 216 | statement: del o.attr_name. */ |
| 217 | #define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A), NULL) |
| 218 | |
| 219 | |
| 220 | /* Implemented elsewhere: |
| 221 | |
| 222 | PyObject *PyObject_Repr(PyObject *o); |
| 223 | |
| 224 | Compute the string representation of object 'o'. Returns the |
| 225 | string representation on success, NULL on failure. |
| 226 | |
| 227 | This is the equivalent of the Python expression: repr(o). |
| 228 | |
| 229 | Called by the repr() built-in function. */ |
| 230 | |
| 231 | |
| 232 | /* Implemented elsewhere: |
| 233 | |
| 234 | PyObject *PyObject_Str(PyObject *o); |
| 235 | |
| 236 | Compute the string representation of object, o. Returns the |
| 237 | string representation on success, NULL on failure. |
| 238 | |
| 239 | This is the equivalent of the Python expression: str(o). |
| 240 | |
| 241 | Called by the str() and print() built-in functions. */ |
| 242 | |
| 243 | |
| 244 | /* Declared elsewhere |
| 245 | |
| 246 | PyAPI_FUNC(int) PyCallable_Check(PyObject *o); |
| 247 | |
| 248 | Determine if the object, o, is callable. Return 1 if the object is callable |
| 249 | and 0 otherwise. |
| 250 | |
| 251 | This function always succeeds. */ |
| 252 | |
| 253 | |
| 254 | #ifdef PY_SSIZE_T_CLEAN |
| 255 | # define PyObject_CallFunction _PyObject_CallFunction_SizeT |
| 256 | # define PyObject_CallMethod _PyObject_CallMethod_SizeT |
| 257 | # ifndef Py_LIMITED_API |
| 258 | # define _PyObject_CallMethodId _PyObject_CallMethodId_SizeT |
| 259 | # endif /* !Py_LIMITED_API */ |
| 260 | #endif |
| 261 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 262 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 263 | /* Call a callable Python object 'callable' with arguments given by the |
| 264 | tuple 'args' and keywords arguments given by the dictionary 'kwargs'. |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 265 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 266 | 'args' must not be *NULL*, use an empty tuple if no arguments are |
| 267 | needed. If no named arguments are needed, 'kwargs' can be NULL. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 268 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 269 | This is the equivalent of the Python expression: |
| 270 | callable(*args, **kwargs). */ |
| 271 | PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable, |
| 272 | PyObject *args, PyObject *kwargs); |
| 273 | |
Victor Stinner | 4a7cc88 | 2015-03-06 23:35:27 +0100 | [diff] [blame] | 274 | #ifndef Py_LIMITED_API |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 275 | PyAPI_FUNC(PyObject*) _PyStack_AsTuple( |
| 276 | PyObject **stack, |
| 277 | Py_ssize_t nargs); |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 278 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 279 | /* Convert keyword arguments from the (stack, kwnames) format to a Python |
| 280 | dictionary. |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 281 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 282 | kwnames must only contains str strings, no subclass, and all keys must be |
| 283 | unique. kwnames is not checked, usually these checks are done before or |
| 284 | later calling _PyStack_AsDict(). For example, _PyArg_ParseStack() raises an |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 285 | error if a key is not a string. */ |
| 286 | PyAPI_FUNC(PyObject *) _PyStack_AsDict( |
| 287 | PyObject **values, |
| 288 | PyObject *kwnames); |
Victor Stinner | ae8b69c | 2016-09-09 14:07:44 -0700 | [diff] [blame] | 289 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 290 | /* Convert (args, nargs, kwargs) into a (stack, nargs, kwnames). |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 291 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 292 | Return a new stack which should be released by PyMem_Free(), or return |
| 293 | args unchanged if kwargs is NULL or an empty dictionary. |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 294 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 295 | The stack uses borrowed references. |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 296 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 297 | The type of keyword keys is not checked, these checks should be done |
| 298 | later (ex: _PyArg_ParseStack). */ |
| 299 | PyAPI_FUNC(PyObject **) _PyStack_UnpackDict( |
| 300 | PyObject **args, |
| 301 | Py_ssize_t nargs, |
| 302 | PyObject *kwargs, |
| 303 | PyObject **kwnames, |
| 304 | PyObject *func); |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 305 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 306 | /* Call the callable object 'callable' with the "fast call" calling convention: |
| 307 | args is a C array for positional arguments (nargs is the number of |
| 308 | positional arguments), kwargs is a dictionary for keyword arguments. |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 309 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 310 | If nargs is equal to zero, args can be NULL. kwargs can be NULL. |
| 311 | nargs must be greater or equal to zero. |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 312 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 313 | Return the result on success. Raise an exception on return NULL on |
| 314 | error. */ |
| 315 | PyAPI_FUNC(PyObject *) _PyObject_FastCallDict( |
| 316 | PyObject *callable, |
| 317 | PyObject **args, |
| 318 | Py_ssize_t nargs, |
| 319 | PyObject *kwargs); |
Victor Stinner | 559bb6a | 2016-08-22 22:48:54 +0200 | [diff] [blame] | 320 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 321 | /* Call the callable object 'callable' with the "fast call" calling convention: |
| 322 | args is a C array for positional arguments followed by values of |
| 323 | keyword arguments. Keys of keyword arguments are stored as a tuple |
| 324 | of strings in kwnames. nargs is the number of positional parameters at |
| 325 | the beginning of stack. The size of kwnames gives the number of keyword |
| 326 | values in the stack after positional arguments. |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 327 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 328 | kwnames must only contains str strings, no subclass, and all keys must |
| 329 | be unique. |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 330 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 331 | If nargs is equal to zero and there is no keyword argument (kwnames is |
| 332 | NULL or its size is zero), args can be NULL. |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 333 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 334 | Return the result on success. Raise an exception and return NULL on |
| 335 | error. */ |
| 336 | PyAPI_FUNC(PyObject *) _PyObject_FastCallKeywords( |
| 337 | PyObject *callable, |
| 338 | PyObject **args, |
| 339 | Py_ssize_t nargs, |
| 340 | PyObject *kwnames); |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 341 | |
Victor Stinner | 559bb6a | 2016-08-22 22:48:54 +0200 | [diff] [blame] | 342 | #define _PyObject_FastCall(func, args, nargs) \ |
| 343 | _PyObject_FastCallDict((func), (args), (nargs), NULL) |
| 344 | |
| 345 | #define _PyObject_CallNoArg(func) \ |
Victor Stinner | 7bfb42d | 2016-12-05 17:04:32 +0100 | [diff] [blame] | 346 | _PyObject_FastCallDict((func), NULL, 0, NULL) |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 347 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 348 | PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend( |
| 349 | PyObject *callable, |
| 350 | PyObject *obj, |
| 351 | PyObject *args, |
| 352 | PyObject *kwargs); |
Victor Stinner | 3f1057a | 2016-08-25 01:04:14 +0200 | [diff] [blame] | 353 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 354 | PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *callable, |
| 355 | PyObject *result, |
| 356 | const char *where); |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 357 | #endif /* Py_LIMITED_API */ |
Victor Stinner | 4a7cc88 | 2015-03-06 23:35:27 +0100 | [diff] [blame] | 358 | |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 359 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 360 | /* Call a callable Python object 'callable', with arguments given by the |
| 361 | tuple 'args'. If no arguments are needed, then 'args' can be *NULL*. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 362 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 363 | Returns the result of the call on success, or *NULL* on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 364 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 365 | This is the equivalent of the Python expression: |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 366 | callable(*args). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 367 | PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable, |
| 368 | PyObject *args); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 369 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 370 | /* Call a callable Python object, callable, with a variable number of C |
| 371 | arguments. The C arguments are described using a mkvalue-style format |
| 372 | string. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 373 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 374 | The format may be NULL, indicating that no arguments are provided. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 375 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 376 | Returns the result of the call on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 377 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 378 | This is the equivalent of the Python expression: |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 379 | callable(arg1, arg2, ...). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 380 | PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable, |
| 381 | const char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 382 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 383 | /* Call the method named 'name' of object 'obj' with a variable number of |
| 384 | C arguments. The C arguments are described by a mkvalue format string. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 385 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 386 | The format can be NULL, indicating that no arguments are provided. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 387 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 388 | Returns the result of the call on success, or NULL on failure. |
| 389 | |
| 390 | This is the equivalent of the Python expression: |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 391 | obj.name(arg1, arg2, ...). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 392 | PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *obj, |
| 393 | const char *name, |
| 394 | const char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 395 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 396 | #ifndef Py_LIMITED_API |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 397 | /* Like PyObject_CallMethod(), but expect a _Py_Identifier* |
| 398 | as the method name. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 399 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *obj, |
| 400 | _Py_Identifier *name, |
| 401 | const char *format, ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 402 | #endif /* !Py_LIMITED_API */ |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 403 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 404 | PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, |
| 405 | const char *format, |
| 406 | ...); |
| 407 | |
| 408 | PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *obj, |
| 409 | const char *name, |
| 410 | const char *format, |
| 411 | ...); |
| 412 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 413 | #ifndef Py_LIMITED_API |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 414 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *obj, |
| 415 | _Py_Identifier *name, |
| 416 | const char *format, |
| 417 | ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 418 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 419 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 420 | /* Call a callable Python object 'callable' with a variable number of C |
| 421 | arguments. The C arguments are provided as PyObject* values, terminated |
| 422 | by a NULL. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 423 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 424 | Returns the result of the call on success, or NULL on failure. |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 425 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 426 | This is the equivalent of the Python expression: |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 427 | callable(arg1, arg2, ...). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 428 | PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, |
| 429 | ...); |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 430 | |
Victor Stinner | 7f39c0c | 2016-12-09 00:40:33 +0100 | [diff] [blame] | 431 | #ifndef Py_LIMITED_API |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 432 | /* Similar PyObject_CallFunctionObjArgs(), but pass positional arguments |
| 433 | as a va_list: list of PyObject* object. */ |
Victor Stinner | 7f39c0c | 2016-12-09 00:40:33 +0100 | [diff] [blame] | 434 | PyAPI_FUNC(PyObject *) _PyObject_VaCallFunctionObjArgs( |
| 435 | PyObject *callable, |
| 436 | va_list vargs); |
| 437 | #endif |
| 438 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 439 | /* Call the method named 'name' of object 'obj' with a variable number of |
| 440 | C arguments. The C arguments are provided as PyObject* values, terminated |
| 441 | by NULL. |
| 442 | |
| 443 | Returns the result of the call on success, or NULL on failure. |
| 444 | |
| 445 | This is the equivalent of the Python expression: obj.name(*args). */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 446 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 447 | PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs( |
| 448 | PyObject *obj, |
| 449 | PyObject *name, |
| 450 | ...); |
| 451 | |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 452 | #ifndef Py_LIMITED_API |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 453 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs( |
| 454 | PyObject *obj, |
| 455 | struct _Py_Identifier *name, |
| 456 | ...); |
Victor Stinner | 2d0eb65 | 2016-12-06 16:27:24 +0100 | [diff] [blame] | 457 | #endif /* !Py_LIMITED_API */ |
| 458 | |
| 459 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 460 | /* Implemented elsewhere: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 461 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 462 | long PyObject_Hash(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 463 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 464 | Compute and return the hash, hash_value, of an object, o. On |
| 465 | failure, return -1. |
| 466 | |
| 467 | This is the equivalent of the Python expression: hash(o). */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 468 | |
| 469 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 470 | /* Implemented elsewhere: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 471 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 472 | int PyObject_IsTrue(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 473 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 474 | Returns 1 if the object, o, is considered to be true, 0 if o is |
| 475 | considered to be false and -1 on failure. |
| 476 | |
| 477 | This is equivalent to the Python expression: not not o. */ |
| 478 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 479 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 480 | /* Implemented elsewhere: |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 481 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 482 | int PyObject_Not(PyObject *o); |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 483 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 484 | Returns 0 if the object, o, is considered to be true, 1 if o is |
| 485 | considered to be false and -1 on failure. |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 486 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 487 | This is equivalent to the Python expression: not o. */ |
| 488 | |
| 489 | |
| 490 | /* Get the type of an object. |
| 491 | |
| 492 | On success, returns a type object corresponding to the object type of object |
| 493 | 'o'. On failure, returns NULL. |
| 494 | |
| 495 | This is equivalent to the Python expression: type(o) */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 496 | PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 497 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 498 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 499 | /* Return the size of object 'o'. If the object 'o' provides both sequence and |
| 500 | mapping protocols, the sequence size is returned. |
| 501 | |
| 502 | On error, -1 is returned. |
| 503 | |
| 504 | This is the equivalent to the Python expression: len(o) */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 505 | PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 506 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 507 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 508 | /* For DLL compatibility */ |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 509 | #undef PyObject_Length |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 510 | PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 511 | #define PyObject_Length PyObject_Size |
| 512 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 513 | |
Armin Ronacher | 74b38b1 | 2012-10-07 10:29:32 +0200 | [diff] [blame] | 514 | #ifndef Py_LIMITED_API |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 515 | PyAPI_FUNC(int) _PyObject_HasLen(PyObject *o); |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 516 | |
| 517 | /* Guess the size of object 'o' using len(o) or o.__length_hint__(). |
| 518 | If neither of those return a non-negative value, then return the default |
| 519 | value. If one of the calls fails, this function returns -1. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 520 | PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t); |
Armin Ronacher | 74b38b1 | 2012-10-07 10:29:32 +0200 | [diff] [blame] | 521 | #endif |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 522 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 523 | /* Return element of 'o' corresponding to the object 'key'. Return NULL |
| 524 | on failure. |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 525 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 526 | This is the equivalent of the Python expression: o[key] */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 527 | PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 528 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 529 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 530 | /* Map the object 'key' to the value 'v' into 'o'. |
| 531 | |
| 532 | Raise an exception and return -1 on failure; return 0 on success. |
| 533 | |
| 534 | This is the equivalent of the Python statement: o[key]=v. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 535 | PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 536 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 537 | /* Remove the mapping for object, key, from the object 'o'. |
| 538 | Returns -1 on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 539 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 540 | This is equivalent to the Python statement: del o[key]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 541 | PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, const char *key); |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 542 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 543 | /* Delete the mapping for key from object 'o'. Returns -1 on failure. |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 544 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 545 | This is the equivalent of the Python statement: del o[key]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 546 | PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 547 | |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 548 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 549 | /* === Old Buffer API ============================================ */ |
| 550 | |
| 551 | /* FIXME: usage of these should all be replaced in Python itself |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 552 | but for backwards compatibility we will implement them. |
| 553 | Their usage without a corresponding "unlock" mechanism |
| 554 | may create issues (but they would already be there). */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 555 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 556 | /* Takes an arbitrary object which must support the (character, single segment) |
| 557 | buffer interface and returns a pointer to a read-only memory location |
| 558 | useable as character based input for subsequent processing. |
| 559 | |
| 560 | Return 0 on success. buffer and buffer_len are only set in case no error |
| 561 | occurs. Otherwise, -1 is returned and an exception set. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 562 | PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj, |
| 563 | const char **buffer, |
| 564 | Py_ssize_t *buffer_len) |
| 565 | Py_DEPRECATED(3.0); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 566 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 567 | /* Checks whether an arbitrary object supports the (character, single segment) |
| 568 | buffer interface. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 569 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 570 | Returns 1 on success, 0 on failure. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 571 | PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj) |
| 572 | Py_DEPRECATED(3.0); |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 573 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 574 | /* Same as PyObject_AsCharBuffer() except that this API expects (readable, |
| 575 | single segment) buffer interface and returns a pointer to a read-only memory |
| 576 | location which can contain arbitrary data. |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 577 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 578 | 0 is returned on success. buffer and buffer_len are only set in case no |
| 579 | error occurs. Otherwise, -1 is returned and an exception set. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 580 | PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj, |
| 581 | const void **buffer, |
| 582 | Py_ssize_t *buffer_len) |
| 583 | Py_DEPRECATED(3.0); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 584 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 585 | /* Takes an arbitrary object which must support the (writable, single segment) |
| 586 | buffer interface and returns a pointer to a writable memory location in |
| 587 | buffer of size 'buffer_len'. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 588 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 589 | Return 0 on success. buffer and buffer_len are only set in case no error |
| 590 | occurs. Otherwise, -1 is returned and an exception set. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 591 | PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj, |
| 592 | void **buffer, |
| 593 | Py_ssize_t *buffer_len) |
| 594 | Py_DEPRECATED(3.0); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 595 | |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 596 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 597 | /* === New Buffer API ============================================ */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 598 | |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 599 | #ifndef Py_LIMITED_API |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 600 | |
| 601 | /* Return 1 if the getbuffer function is available, otherwise return 0. */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 602 | #define PyObject_CheckBuffer(obj) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 603 | (((obj)->ob_type->tp_as_buffer != NULL) && \ |
| 604 | ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL)) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 605 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 606 | /* This is a C-API version of the getbuffer function call. It checks |
| 607 | to make sure object has the required function pointer and issues the |
| 608 | call. |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 609 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 610 | Returns -1 and raises an error on failure and returns 0 on success. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 611 | PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view, |
| 612 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 613 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 614 | /* Get the memory area pointed to by the indices for the buffer given. |
| 615 | Note that view->ndim is the assumed size of indices. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 616 | PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 617 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 618 | /* Return the implied itemsize of the data-format area from a |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 619 | struct-style description. */ |
| 620 | PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 621 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 622 | /* Implementation in memoryobject.c */ |
| 623 | PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view, |
| 624 | Py_ssize_t len, char order); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 625 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 626 | PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf, |
| 627 | Py_ssize_t len, char order); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 628 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 629 | /* Copy len bytes of data from the contiguous chunk of memory |
| 630 | pointed to by buf into the buffer exported by obj. Return |
| 631 | 0 on success and return -1 and raise a PyBuffer_Error on |
| 632 | error (i.e. the object does not have a buffer interface or |
| 633 | it is not working). |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 634 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 635 | If fort is 'F', then if the object is multi-dimensional, |
| 636 | then the data will be copied into the array in |
| 637 | Fortran-style (first dimension varies the fastest). If |
| 638 | fort is 'C', then the data will be copied into the array |
| 639 | in C-style (last dimension varies the fastest). If fort |
| 640 | is 'A', then it does not matter and the copy will be made |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 641 | in whatever way is more efficient. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 642 | PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 643 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 644 | /* Copy the data from the src buffer to the buffer of destination. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 645 | PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 646 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 647 | /*Fill the strides array with byte-strides of a contiguous |
| 648 | (Fortran-style if fort is 'F' or C-style otherwise) |
| 649 | array of the given shape with the given number of bytes |
| 650 | per element. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 651 | PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims, |
| 652 | Py_ssize_t *shape, |
| 653 | Py_ssize_t *strides, |
| 654 | int itemsize, |
| 655 | char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 656 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 657 | /* Fills in a buffer-info structure correctly for an exporter |
| 658 | that can only share a contiguous chunk of memory of |
| 659 | "unsigned bytes" of the given length. |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 660 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 661 | Returns 0 on success and -1 (with raising an error) on error. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 662 | PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf, |
| 663 | Py_ssize_t len, int readonly, |
| 664 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 665 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 666 | /* Releases a Py_buffer obtained from getbuffer ParseTuple's "s*". */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 667 | PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view); |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 668 | |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 669 | #endif /* Py_LIMITED_API */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 670 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 671 | /* Takes an arbitrary object and returns the result of calling |
| 672 | obj.__format__(format_spec). */ |
| 673 | PyAPI_FUNC(PyObject *) PyObject_Format(PyObject *obj, |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 674 | PyObject *format_spec); |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 675 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 676 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 677 | /* ==== Iterators ================================================ */ |
| 678 | |
| 679 | /* Takes an object and returns an iterator for it. |
| 680 | This is typically a new iterator but if the argument is an iterator, this |
| 681 | returns itself. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 682 | PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *); |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 683 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 684 | #define PyIter_Check(obj) \ |
Amaury Forgeot d'Arc | f343e01 | 2009-01-12 23:58:21 +0000 | [diff] [blame] | 685 | ((obj)->ob_type->tp_iternext != NULL && \ |
| 686 | (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented) |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 687 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 688 | /* Takes an iterator object and calls its tp_iternext slot, |
| 689 | returning the next value. |
| 690 | |
| 691 | If the iterator is exhausted, this returns NULL without setting an |
| 692 | exception. |
| 693 | |
| 694 | NULL with an exception means an error occurred. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 695 | PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *); |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 696 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 697 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 698 | /* === Number Protocol ================================================== */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 699 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 700 | /* Returns 1 if the object 'o' provides numeric protocols, and 0 otherwise. |
| 701 | |
| 702 | This function always succeeds. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 703 | PyAPI_FUNC(int) PyNumber_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 704 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 705 | /* Returns the result of adding o1 and o2, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 706 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 707 | This is the equivalent of the Python expression: o1 + o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 708 | PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 709 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 710 | /* Returns the result of subtracting o2 from o1, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 711 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 712 | This is the equivalent of the Python expression: o1 - o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 713 | PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 714 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 715 | /* Returns the result of multiplying o1 and o2, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 716 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 717 | This is the equivalent of the Python expression: o1 * o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 718 | PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 719 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 720 | /* This is the equivalent of the Python expression: o1 @ o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 721 | PyAPI_FUNC(PyObject *) PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2); |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 722 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 723 | /* Returns the result of dividing o1 by o2 giving an integral result, |
| 724 | or NULL on failure. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 725 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 726 | This is the equivalent of the Python expression: o1 // o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 727 | PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 728 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 729 | /* Returns the result of dividing o1 by o2 giving a float result, or NULL on |
| 730 | failure. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 731 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 732 | This is the equivalent of the Python expression: o1 / o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 733 | PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 734 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 735 | /* Returns the remainder of dividing o1 by o2, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 736 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 737 | This is the equivalent of the Python expression: o1 % o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 738 | PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 739 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 740 | /* See the built-in function divmod. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 741 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 742 | Returns NULL on failure. |
| 743 | |
| 744 | This is the equivalent of the Python expression: divmod(o1, o2). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 745 | PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 746 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 747 | /* See the built-in function pow. Returns NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 748 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 749 | This is the equivalent of the Python expression: pow(o1, o2, o3), |
| 750 | where o3 is optional. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 751 | PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2, |
| 752 | PyObject *o3); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 753 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 754 | /* Returns the negation of o on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 755 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 756 | This is the equivalent of the Python expression: -o. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 757 | PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 758 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 759 | /* Returns the positive of o on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 760 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 761 | This is the equivalent of the Python expression: +o. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 762 | PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 763 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 764 | /* Returns the absolute value of 'o', or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 765 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 766 | This is the equivalent of the Python expression: abs(o). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 767 | PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 768 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 769 | /* Returns the bitwise negation of 'o' on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 770 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 771 | This is the equivalent of the Python expression: ~o. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 772 | PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 773 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 774 | /* Returns the result of left shifting o1 by o2 on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 775 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 776 | This is the equivalent of the Python expression: o1 << o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 777 | PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 778 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 779 | /* Returns the result of right shifting o1 by o2 on success, or NULL on |
| 780 | failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 781 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 782 | This is the equivalent of the Python expression: o1 >> o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 783 | PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 784 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 785 | /* Returns the result of bitwise and of o1 and o2 on success, or NULL on |
| 786 | failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 787 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 788 | This is the equivalent of the Python expression: o1 & o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 789 | PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 790 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 791 | /* Returns the bitwise exclusive or of o1 by o2 on success, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 792 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 793 | This is the equivalent of the Python expression: o1 ^ o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 794 | PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 795 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 796 | /* Returns the result of bitwise or on o1 and o2 on success, or NULL on |
| 797 | failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 798 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 799 | This is the equivalent of the Python expression: o1 | o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 800 | PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2); |
| 801 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 802 | #define PyIndex_Check(obj) \ |
| 803 | ((obj)->ob_type->tp_as_number != NULL && \ |
| 804 | (obj)->ob_type->tp_as_number->nb_index != NULL) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 805 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 806 | /* Returns the object 'o' converted to a Python int, or NULL with an exception |
| 807 | raised on failure. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 808 | PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o); |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 809 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 810 | /* Returns the object 'o' converted to Py_ssize_t by going through |
| 811 | PyNumber_Index() first. |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 812 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 813 | If an overflow error occurs while converting the int to Py_ssize_t, then the |
| 814 | second argument 'exc' is the error-type to return. If it is NULL, then the |
| 815 | overflow error is cleared and the value is clipped. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 816 | PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc); |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 817 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 818 | /* Returns the object 'o' converted to an integer object on success, or NULL |
| 819 | on failure. |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 820 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 821 | This is the equivalent of the Python expression: int(o). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 822 | PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o); |
Mark Dickinson | d746768 | 2009-01-10 22:14:33 +0000 | [diff] [blame] | 823 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 824 | /* Returns the object 'o' converted to a float object on success, or NULL |
| 825 | on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 826 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 827 | This is the equivalent of the Python expression: float(o). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 828 | PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 829 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 830 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 831 | /* --- In-place variants of (some of) the above number protocol functions -- */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 832 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 833 | /* Returns the result of adding o2 to o1, possibly in-place, or NULL |
| 834 | on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 835 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 836 | This is the equivalent of the Python expression: o1 += o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 837 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 838 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 839 | /* Returns the result of subtracting o2 from o1, possibly in-place or |
| 840 | NULL on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 841 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 842 | This is the equivalent of the Python expression: o1 -= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 843 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 844 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 845 | /* Returns the result of multiplying o1 by o2, possibly in-place, or NULL on |
| 846 | failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 847 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 848 | This is the equivalent of the Python expression: o1 *= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 849 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 850 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 851 | /* This is the equivalent of the Python expression: o1 @= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 852 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2); |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 853 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 854 | /* Returns the result of dividing o1 by o2 giving an integral result, possibly |
| 855 | in-place, or NULL on failure. |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 856 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 857 | This is the equivalent of the Python expression: o1 /= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 858 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1, |
| 859 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 860 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 861 | /* Returns the result of dividing o1 by o2 giving a float result, possibly |
| 862 | in-place, or null on failure. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 863 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 864 | This is the equivalent of the Python expression: o1 /= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 865 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1, |
| 866 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 867 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 868 | /* Returns the remainder of dividing o1 by o2, possibly in-place, or NULL on |
| 869 | failure. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 870 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 871 | This is the equivalent of the Python expression: o1 %= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 872 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 873 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 874 | /* Returns the result of raising o1 to the power of o2, possibly in-place, |
| 875 | or NULL on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 876 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 877 | This is the equivalent of the Python expression: o1 **= o2, |
| 878 | or o1 = pow(o1, o2, o3) if o3 is present. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 879 | PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2, |
| 880 | PyObject *o3); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 881 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 882 | /* Returns the result of left shifting o1 by o2, possibly in-place, or NULL |
| 883 | on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 884 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 885 | This is the equivalent of the Python expression: o1 <<= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 886 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 887 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 888 | /* Returns the result of right shifting o1 by o2, possibly in-place or NULL |
| 889 | on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 890 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 891 | This is the equivalent of the Python expression: o1 >>= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 892 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 893 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 894 | /* Returns the result of bitwise and of o1 and o2, possibly in-place, or NULL |
| 895 | on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 896 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 897 | This is the equivalent of the Python expression: o1 &= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 898 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 899 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 900 | /* Returns the bitwise exclusive or of o1 by o2, possibly in-place, or NULL |
| 901 | on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 902 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 903 | This is the equivalent of the Python expression: o1 ^= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 904 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 905 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 906 | /* Returns the result of bitwise or of o1 and o2, possibly in-place, |
| 907 | or NULL on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 908 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 909 | This is the equivalent of the Python expression: o1 |= o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 910 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 911 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 912 | /* Returns the integer n converted to a string with a base, with a base |
| 913 | marker of 0b, 0o or 0x prefixed if applicable. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 914 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 915 | If n is not an int object, it is converted with PyNumber_Index first. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 916 | PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base); |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 917 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 918 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 919 | /* === Sequence protocol ================================================ */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 920 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 921 | /* Return 1 if the object provides sequence protocol, and zero |
| 922 | otherwise. |
| 923 | |
| 924 | This function always succeeds. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 925 | PyAPI_FUNC(int) PySequence_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 926 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 927 | /* Return the size of sequence object o, or -1 on failure. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 928 | PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 929 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 930 | /* For DLL compatibility */ |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 931 | #undef PySequence_Length |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 932 | PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 933 | #define PySequence_Length PySequence_Size |
| 934 | |
| 935 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 936 | /* Return the concatenation of o1 and o2 on success, and NULL on failure. |
| 937 | |
| 938 | This is the equivalent of the Python expression: o1 + o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 939 | PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 940 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 941 | /* Return the result of repeating sequence object 'o' 'count' times, |
| 942 | or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 943 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 944 | This is the equivalent of the Python expression: o * count. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 945 | PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 946 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 947 | /* Return the ith element of o, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 948 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 949 | This is the equivalent of the Python expression: o[i]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 950 | PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 951 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 952 | /* Return the slice of sequence object o between i1 and i2, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 953 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 954 | This is the equivalent of the Python expression: o[i1:i2]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 955 | PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 956 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 957 | /* Assign object 'v' to the ith element of the sequence 'o'. Raise an exception |
| 958 | and return -1 on failure; return 0 on success. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 959 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 960 | This is the equivalent of the Python statement o[i] = v. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 961 | PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 962 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 963 | /* Delete the 'i'-th element of the sequence 'v'. Returns -1 on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 964 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 965 | This is the equivalent of the Python statement: del o[i]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 966 | PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 967 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 968 | /* Assign the sequence object 'v' to the slice in sequence object 'o', |
| 969 | from 'i1' to 'i2'. Returns -1 on failure. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 970 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 971 | This is the equivalent of the Python statement: o[i1:i2] = v. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 972 | PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, |
| 973 | PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 974 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 975 | /* Delete the slice in sequence object 'o' from 'i1' to 'i2'. |
| 976 | Returns -1 on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 977 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 978 | This is the equivalent of the Python statement: del o[i1:i2]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 979 | PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 980 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 981 | /* Returns the sequence 'o' as a tuple on success, and NULL on failure. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 982 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 983 | This is equivalent to the Python expression: tuple(o). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 984 | PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 985 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 986 | /* Returns the sequence 'o' as a list on success, and NULL on failure. |
| 987 | This is equivalent to the Python expression: list(o) */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 988 | PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o); |
Guido van Rossum | f39fc43 | 1997-03-04 18:31:47 +0000 | [diff] [blame] | 989 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 990 | /* Return the sequence 'o' as a list, unless it's already a tuple or list. |
| 991 | |
| 992 | Use PySequence_Fast_GET_ITEM to access the members of this list, and |
| 993 | PySequence_Fast_GET_SIZE to get its length. |
| 994 | |
| 995 | Returns NULL on failure. If the object does not support iteration, raises a |
| 996 | TypeError exception with 'm' as the message text. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 997 | PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m); |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 998 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 999 | /* Return the size of the sequence 'o', assuming that 'o' was returned by |
| 1000 | PySequence_Fast and is not NULL. */ |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1001 | #define PySequence_Fast_GET_SIZE(o) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1002 | (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o)) |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1003 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1004 | /* Return the 'i'-th element of the sequence 'o', assuming that o was returned |
| 1005 | by PySequence_Fast, and that i is within bounds. */ |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1006 | #define PySequence_Fast_GET_ITEM(o, i)\ |
| 1007 | (PyList_Check(o) ? PyList_GET_ITEM(o, i) : PyTuple_GET_ITEM(o, i)) |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1008 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1009 | /* Assume tp_as_sequence and sq_item exist and that 'i' does not |
| 1010 | need to be corrected for a negative index. */ |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1011 | #define PySequence_ITEM(o, i)\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1012 | ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) ) |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1013 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1014 | /* Return a pointer to the underlying item array for |
| 1015 | an object retured by PySequence_Fast */ |
Raymond Hettinger | 42bec93 | 2004-03-12 16:38:17 +0000 | [diff] [blame] | 1016 | #define PySequence_Fast_ITEMS(sf) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1017 | (PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \ |
| 1018 | : ((PyTupleObject *)(sf))->ob_item) |
Raymond Hettinger | c1e4f9d | 2004-03-12 08:04:00 +0000 | [diff] [blame] | 1019 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1020 | /* Return the number of occurrences on value on 'o', that is, return |
| 1021 | the number of keys for which o[key] == value. |
| 1022 | |
| 1023 | On failure, return -1. This is equivalent to the Python expression: |
| 1024 | o.count(value). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1025 | PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1026 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1027 | /* Return 1 if 'ob' is in the sequence 'seq'; 0 if 'ob' is not in the sequence |
| 1028 | 'seq'; -1 on error. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1029 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1030 | Use __contains__ if possible, else _PySequence_IterSearch(). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1031 | PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob); |
Tim Peters | cb8d368 | 2001-05-05 21:05:01 +0000 | [diff] [blame] | 1032 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1033 | #ifndef Py_LIMITED_API |
Tim Peters | 16a77ad | 2001-09-08 04:00:12 +0000 | [diff] [blame] | 1034 | #define PY_ITERSEARCH_COUNT 1 |
| 1035 | #define PY_ITERSEARCH_INDEX 2 |
| 1036 | #define PY_ITERSEARCH_CONTAINS 3 |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1037 | |
| 1038 | /* Iterate over seq. |
| 1039 | |
| 1040 | Result depends on the operation: |
| 1041 | |
| 1042 | PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if |
| 1043 | error. |
| 1044 | PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of |
| 1045 | obj in seq; set ValueError and return -1 if none found; |
| 1046 | also return -1 on error. |
| 1047 | PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on |
| 1048 | error. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1049 | PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq, |
| 1050 | PyObject *obj, int operation); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1051 | #endif |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1052 | |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1053 | |
| 1054 | /* For DLL-level backwards compatibility */ |
| 1055 | #undef PySequence_In |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1056 | /* Determine if the sequence 'o' contains 'value'. If an item in 'o' is equal |
| 1057 | to 'value', return 1, otherwise return 0. On error, return -1. |
| 1058 | |
| 1059 | This is equivalent to the Python expression: value in o. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1060 | PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value); |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1061 | |
| 1062 | /* For source-level backwards compatibility */ |
Guido van Rossum | f1536db | 1998-08-23 22:06:59 +0000 | [diff] [blame] | 1063 | #define PySequence_In PySequence_Contains |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1064 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1065 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1066 | /* Return the first index for which o[i] == value. |
| 1067 | On error, return -1. |
| 1068 | |
| 1069 | This is equivalent to the Python expression: o.index(value). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1070 | PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1071 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1072 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1073 | /* --- In-place versions of some of the above Sequence functions --- */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1074 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1075 | /* Append sequence 'o2' to sequence 'o1', in-place when possible. Return the |
| 1076 | resulting object, which could be 'o1', or NULL on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1077 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1078 | This is the equivalent of the Python expression: o1 += o2. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1079 | PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1080 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1081 | /* Repeat sequence 'o' by 'count', in-place when possible. Return the resulting |
| 1082 | object, which could be 'o', or NULL on failure. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1083 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1084 | This is the equivalent of the Python expression: o1 *= count. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1085 | PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1086 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1087 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1088 | /* === Mapping protocol ================================================= */ |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1089 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1090 | /* Return 1 if the object provides mapping protocol, and 0 otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1091 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1092 | This function always succeeds. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1093 | PyAPI_FUNC(int) PyMapping_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1094 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1095 | /* Returns the number of keys in mapping object 'o' on success, and -1 on |
| 1096 | failure. For objects that do not provide sequence protocol, this is |
| 1097 | equivalent to the Python expression: len(o). */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1098 | PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 1099 | |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1100 | /* For DLL compatibility */ |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1101 | #undef PyMapping_Length |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1102 | PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1103 | #define PyMapping_Length PyMapping_Size |
| 1104 | |
| 1105 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1106 | /* Implemented as a macro: |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1107 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1108 | int PyMapping_DelItemString(PyObject *o, const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1109 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1110 | Remove the mapping for object 'key' from the mapping 'o'. Returns -1 on |
| 1111 | failure. |
| 1112 | |
| 1113 | This is equivalent to the Python statement: del o[key]. */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1114 | #define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K)) |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1115 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1116 | /* Implemented as a macro: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1117 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1118 | int PyMapping_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1119 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1120 | Remove the mapping for object 'key' from the mapping object 'o'. |
| 1121 | Returns -1 on failure. |
| 1122 | |
| 1123 | This is equivalent to the Python statement: del o[key]. */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1124 | #define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K)) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1125 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1126 | /* On success, return 1 if the mapping object 'o' has the key 'key', |
| 1127 | and 0 otherwise. |
| 1128 | |
| 1129 | This is equivalent to the Python expression: key in o. |
| 1130 | |
| 1131 | This function always succeeds. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1132 | PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1133 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1134 | /* Return 1 if the mapping object has the key 'key', and 0 otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1135 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1136 | This is equivalent to the Python expression: key in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1137 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1138 | This function always succeeds. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1139 | PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1140 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1141 | /* On success, return a list or tuple of the keys in mapping object 'o'. |
| 1142 | On failure, return NULL. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1143 | PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1144 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1145 | /* On success, return a list or tuple of the values in mapping object 'o'. |
| 1146 | On failure, return NULL. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1147 | PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1148 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1149 | /* On success, return a list or tuple of the items in mapping object 'o', |
| 1150 | where each item is a tuple containing a key-value pair. On failure, return |
| 1151 | NULL. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1152 | PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1153 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1154 | /* Return element of o corresponding to the object, key, or NULL on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1155 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1156 | This is the equivalent of the Python expression: o[key]. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1157 | PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o, |
| 1158 | const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1159 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1160 | /* Map the object 'key' to the value 'v' in the mapping 'o'. |
| 1161 | Returns -1 on failure. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1162 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1163 | This is the equivalent of the Python statement: o[key]=v. */ |
Victor Stinner | 2a358f8 | 2016-12-06 16:55:39 +0100 | [diff] [blame] | 1164 | PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, const char *key, |
| 1165 | PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1166 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1167 | /* isinstance(object, typeorclass) */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1168 | PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1169 | |
Victor Stinner | 5bef7cd | 2016-12-15 09:14:25 +0100 | [diff] [blame^] | 1170 | /* issubclass(object, typeorclass) */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1171 | PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1172 | |
| 1173 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1174 | #ifndef Py_LIMITED_API |
Antoine Pitrou | ec569b7 | 2008-08-26 22:40:48 +0000 | [diff] [blame] | 1175 | PyAPI_FUNC(int) _PyObject_RealIsInstance(PyObject *inst, PyObject *cls); |
| 1176 | |
| 1177 | PyAPI_FUNC(int) _PyObject_RealIsSubclass(PyObject *derived, PyObject *cls); |
| 1178 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1179 | PyAPI_FUNC(char *const *) _PySequence_BytesToCharpArray(PyObject* self); |
| 1180 | |
| 1181 | PyAPI_FUNC(void) _Py_FreeCharPArray(char *const array[]); |
Antoine Pitrou | ec569b7 | 2008-08-26 22:40:48 +0000 | [diff] [blame] | 1182 | |
Antoine Pitrou | f68c2a7 | 2010-09-01 12:58:21 +0000 | [diff] [blame] | 1183 | /* For internal use by buffer API functions */ |
| 1184 | PyAPI_FUNC(void) _Py_add_one_to_index_F(int nd, Py_ssize_t *index, |
| 1185 | const Py_ssize_t *shape); |
| 1186 | PyAPI_FUNC(void) _Py_add_one_to_index_C(int nd, Py_ssize_t *index, |
| 1187 | const Py_ssize_t *shape); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 1188 | #endif /* !Py_LIMITED_API */ |
Antoine Pitrou | f68c2a7 | 2010-09-01 12:58:21 +0000 | [diff] [blame] | 1189 | |
| 1190 | |
Guido van Rossum | 8ca687a | 1995-09-18 21:20:02 +0000 | [diff] [blame] | 1191 | #ifdef __cplusplus |
| 1192 | } |
| 1193 | #endif |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1194 | #endif /* Py_ABSTRACTOBJECT_H */ |