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