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