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