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 | f0ff849 | 2017-06-09 13:24:53 +0200 | [diff] [blame] | 293 | /* Convert (args, nargs, kwargs: dict) into (stack, nargs, kwnames: tuple). |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 294 | |
Victor Stinner | f0ff849 | 2017-06-09 13:24:53 +0200 | [diff] [blame] | 295 | Return 0 on success, raise an exception and return -1 on error. |
| 296 | |
| 297 | Write the new stack into *p_stack. If *p_stack is differen than args, it |
| 298 | must be released by PyMem_Free(). |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 299 | |
| 300 | The stack uses borrowed references. |
| 301 | |
| 302 | The type of keyword keys is not checked, these checks should be done |
Victor Stinner | f0ff849 | 2017-06-09 13:24:53 +0200 | [diff] [blame] | 303 | later (ex: _PyArg_ParseStackAndKeywords). */ |
| 304 | PyAPI_FUNC(int) _PyStack_UnpackDict( |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 305 | PyObject **args, |
| 306 | Py_ssize_t nargs, |
| 307 | PyObject *kwargs, |
Victor Stinner | f0ff849 | 2017-06-09 13:24:53 +0200 | [diff] [blame] | 308 | PyObject ***p_stack, |
| 309 | PyObject **p_kwnames); |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 310 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 311 | /* Call the callable object func with the "fast call" calling convention: |
| 312 | args is a C array for positional arguments (nargs is the number of |
| 313 | positional arguments), kwargs is a dictionary for keyword arguments. |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 314 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 315 | If nargs is equal to zero, args can be NULL. kwargs can be NULL. |
| 316 | nargs must be greater or equal to zero. |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 317 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 318 | Return the result on success. Raise an exception on return NULL on |
| 319 | error. */ |
| 320 | PyAPI_FUNC(PyObject *) _PyObject_FastCallDict(PyObject *func, |
| 321 | PyObject **args, Py_ssize_t nargs, |
| 322 | PyObject *kwargs); |
Victor Stinner | 559bb6a | 2016-08-22 22:48:54 +0200 | [diff] [blame] | 323 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 324 | /* Call the callable object func with the "fast call" calling convention: |
| 325 | args is a C array for positional arguments followed by values of |
| 326 | keyword arguments. Keys of keyword arguments are stored as a tuple |
| 327 | of strings in kwnames. nargs is the number of positional parameters at |
| 328 | the beginning of stack. The size of kwnames gives the number of keyword |
| 329 | values in the stack after positional arguments. |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 330 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 331 | kwnames must only contains str strings, no subclass, and all keys must |
| 332 | be unique. |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 333 | |
Victor Stinner | 57f91ac | 2016-09-12 13:37:07 +0200 | [diff] [blame] | 334 | If nargs is equal to zero and there is no keyword argument (kwnames is |
| 335 | NULL or its size is zero), args can be NULL. |
| 336 | |
| 337 | Return the result on success. Raise an exception and return NULL on |
| 338 | error. */ |
| 339 | PyAPI_FUNC(PyObject *) _PyObject_FastCallKeywords |
| 340 | (PyObject *func, |
| 341 | PyObject **args, |
| 342 | Py_ssize_t nargs, |
| 343 | PyObject *kwnames); |
Victor Stinner | d873572 | 2016-09-09 12:36:44 -0700 | [diff] [blame] | 344 | |
Victor Stinner | 559bb6a | 2016-08-22 22:48:54 +0200 | [diff] [blame] | 345 | #define _PyObject_FastCall(func, args, nargs) \ |
| 346 | _PyObject_FastCallDict((func), (args), (nargs), NULL) |
| 347 | |
| 348 | #define _PyObject_CallNoArg(func) \ |
| 349 | _PyObject_FastCall((func), NULL, 0) |
| 350 | |
| 351 | #define _PyObject_CallArg1(func, arg) \ |
| 352 | _PyObject_FastCall((func), &(arg), 1) |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 353 | |
Victor Stinner | 3f1057a | 2016-08-25 01:04:14 +0200 | [diff] [blame] | 354 | PyAPI_FUNC(PyObject *) _PyObject_Call_Prepend(PyObject *func, |
| 355 | PyObject *obj, PyObject *args, |
| 356 | PyObject *kwargs); |
| 357 | |
Victor Stinner | efde146 | 2015-03-21 15:04:43 +0100 | [diff] [blame] | 358 | PyAPI_FUNC(PyObject *) _Py_CheckFunctionResult(PyObject *func, |
| 359 | PyObject *result, |
| 360 | const char *where); |
Victor Stinner | 9be7e7b | 2016-08-19 16:11:43 +0200 | [diff] [blame] | 361 | #endif /* Py_LIMITED_API */ |
Victor Stinner | 4a7cc88 | 2015-03-06 23:35:27 +0100 | [diff] [blame] | 362 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 363 | PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 364 | PyObject *args); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 365 | |
| 366 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 367 | Call a callable Python object, callable_object, with |
| 368 | arguments given by the tuple, args. If no arguments are |
| 369 | needed, then args may be NULL. Returns the result of the |
| 370 | call on success, or NULL on failure. This is the equivalent |
| 371 | of the Python expression: o(*args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 372 | */ |
| 373 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 374 | PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object, |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 375 | const char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 376 | |
| 377 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 378 | Call a callable Python object, callable_object, with a |
| 379 | variable number of C arguments. The C arguments are described |
| 380 | using a mkvalue-style format string. The format may be NULL, |
| 381 | indicating that no arguments are provided. Returns the |
| 382 | result of the call on success, or NULL on failure. This is |
| 383 | the equivalent of the Python expression: o(*args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 384 | */ |
| 385 | |
| 386 | |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 387 | PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, |
| 388 | const char *method, |
| 389 | const char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 390 | |
| 391 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 392 | Call the method named m of object o with a variable number of |
| 393 | C arguments. The C arguments are described by a mkvalue |
| 394 | format string. The format may be NULL, indicating that no |
| 395 | arguments are provided. Returns the result of the call on |
| 396 | success, or NULL on failure. This is the equivalent of the |
| 397 | Python expression: o.method(args). |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 398 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 399 | |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 400 | #ifndef Py_LIMITED_API |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 401 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodId(PyObject *o, |
| 402 | _Py_Identifier *method, |
| 403 | const char *format, ...); |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 404 | |
| 405 | /* |
| 406 | Like PyObject_CallMethod, but expect a _Py_Identifier* as the |
| 407 | method name. |
| 408 | */ |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 409 | #endif /* !Py_LIMITED_API */ |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 410 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 411 | PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 412 | const char *format, |
| 413 | ...); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 414 | PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o, |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 415 | const char *name, |
| 416 | const char *format, |
| 417 | ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 418 | #ifndef Py_LIMITED_API |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 419 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodId_SizeT(PyObject *o, |
| 420 | _Py_Identifier *name, |
Serhiy Storchaka | 1cfebc7 | 2013-05-29 18:50:54 +0300 | [diff] [blame] | 421 | const char *format, |
| 422 | ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 423 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 424 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 425 | PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 426 | ...); |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 427 | |
| 428 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 429 | Call a callable Python object, callable_object, with a |
| 430 | variable number of C arguments. The C arguments are provided |
| 431 | as PyObject * values, terminated by a NULL. Returns the |
| 432 | result of the call on success, or NULL on failure. This is |
| 433 | the equivalent of the Python expression: o(*args). |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 434 | */ |
| 435 | |
| 436 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 437 | PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 438 | PyObject *method, ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 439 | #ifndef Py_LIMITED_API |
Alexandre Vassalotti | 865eaa1 | 2013-05-02 10:44:04 -0700 | [diff] [blame] | 440 | PyAPI_FUNC(PyObject *) _PyObject_CallMethodIdObjArgs(PyObject *o, |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 441 | struct _Py_Identifier *method, |
| 442 | ...); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 443 | #endif /* !Py_LIMITED_API */ |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 444 | |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 445 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 446 | Call the method named m of object o with a variable number of |
| 447 | C arguments. The C arguments are provided as PyObject * |
| 448 | values, terminated by NULL. Returns the result of the call |
| 449 | on success, or NULL on failure. This is the equivalent of |
| 450 | the Python expression: o.method(args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 451 | */ |
| 452 | |
| 453 | |
| 454 | /* Implemented elsewhere: |
| 455 | |
| 456 | long PyObject_Hash(PyObject *o); |
| 457 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 458 | Compute and return the hash, hash_value, of an object, o. On |
| 459 | failure, return -1. This is the equivalent of the Python |
| 460 | expression: hash(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 461 | */ |
| 462 | |
| 463 | |
| 464 | /* Implemented elsewhere: |
| 465 | |
| 466 | int PyObject_IsTrue(PyObject *o); |
| 467 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 468 | Returns 1 if the object, o, is considered to be true, 0 if o is |
| 469 | considered to be false and -1 on failure. This is equivalent to the |
| 470 | Python expression: not not o |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 471 | */ |
| 472 | |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 473 | /* Implemented elsewhere: |
| 474 | |
| 475 | int PyObject_Not(PyObject *o); |
| 476 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 477 | Returns 0 if the object, o, is considered to be true, 1 if o is |
| 478 | considered to be false and -1 on failure. This is equivalent to the |
| 479 | Python expression: not o |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 480 | */ |
| 481 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 482 | PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 483 | |
| 484 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 485 | On success, returns a type object corresponding to the object |
| 486 | type of object o. On failure, returns NULL. This is |
| 487 | equivalent to the Python expression: type(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 488 | */ |
| 489 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 490 | PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 491 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 492 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 493 | Return the size of object o. If the object, o, provides |
| 494 | both sequence and mapping protocols, the sequence size is |
| 495 | returned. On error, -1 is returned. This is the equivalent |
| 496 | to the Python expression: len(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 497 | */ |
| 498 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 499 | /* For DLL compatibility */ |
| 500 | #undef PyObject_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 501 | PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 502 | #define PyObject_Length PyObject_Size |
| 503 | |
Armin Ronacher | 74b38b1 | 2012-10-07 10:29:32 +0200 | [diff] [blame] | 504 | #ifndef Py_LIMITED_API |
| 505 | PyAPI_FUNC(int) _PyObject_HasLen(PyObject *o); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 506 | PyAPI_FUNC(Py_ssize_t) PyObject_LengthHint(PyObject *o, Py_ssize_t); |
Armin Ronacher | 74b38b1 | 2012-10-07 10:29:32 +0200 | [diff] [blame] | 507 | #endif |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 508 | |
| 509 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 510 | Guess the size of object o using len(o) or o.__length_hint__(). |
| 511 | If neither of those return a non-negative value, then return the |
| 512 | default value. If one of the calls fails, this function returns -1. |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 513 | */ |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 514 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 515 | PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 516 | |
| 517 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 518 | Return element of o corresponding to the object, key, or NULL |
| 519 | on failure. This is the equivalent of the Python expression: |
| 520 | o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 521 | */ |
| 522 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 523 | PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 524 | |
| 525 | /* |
Martin Panter | 45be8d6 | 2015-12-08 00:03:20 +0000 | [diff] [blame] | 526 | Map the object key to the value v. Raise an exception and return -1 |
| 527 | on failure; return 0 on success. This is the equivalent of the Python |
| 528 | statement o[key]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 529 | */ |
| 530 | |
Serhiy Storchaka | c679227 | 2013-10-19 21:03:34 +0300 | [diff] [blame] | 531 | PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, const char *key); |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 532 | |
| 533 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 534 | Remove the mapping for object, key, from the object *o. |
| 535 | Returns -1 on failure. This is equivalent to |
| 536 | the Python statement: del o[key]. |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 537 | */ |
| 538 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 539 | PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 540 | |
| 541 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 542 | Delete the mapping for key from *o. Returns -1 on failure. |
| 543 | This is the equivalent of the Python statement: del o[key]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 544 | */ |
| 545 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 546 | /* old buffer API |
| 547 | FIXME: usage of these should all be replaced in Python itself |
| 548 | but for backwards compatibility we will implement them. |
Raymond Hettinger | 15f44ab | 2016-08-30 10:47:49 -0700 | [diff] [blame] | 549 | Their usage without a corresponding "unlock" mechanism |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 550 | may create issues (but they would already be there). */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 551 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 552 | PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 553 | const char **buffer, |
| 554 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 555 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 556 | /* |
| 557 | Takes an arbitrary object which must support the (character, |
| 558 | single segment) buffer interface and returns a pointer to a |
| 559 | read-only memory location useable as character based input |
| 560 | for subsequent processing. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 561 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 562 | 0 is returned on success. buffer and buffer_len are only |
| 563 | set in case no error occurs. Otherwise, -1 is returned and |
| 564 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 565 | */ |
| 566 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 567 | PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj); |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 568 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 569 | /* |
| 570 | Checks whether an arbitrary object supports the (character, |
| 571 | single segment) buffer interface. Returns 1 on success, 0 |
| 572 | on failure. |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 573 | */ |
| 574 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 575 | PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 576 | const void **buffer, |
| 577 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 578 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 579 | /* |
| 580 | Same as PyObject_AsCharBuffer() except that this API expects |
| 581 | (readable, single segment) buffer interface and returns a |
| 582 | pointer to a read-only memory location which can contain |
| 583 | arbitrary data. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 584 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 585 | 0 is returned on success. buffer and buffer_len are only |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 586 | set in case no error occurs. Otherwise, -1 is returned and |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 587 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 588 | */ |
| 589 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 590 | PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 591 | void **buffer, |
| 592 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 593 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 594 | /* |
| 595 | Takes an arbitrary object which must support the (writable, |
| 596 | single segment) buffer interface and returns a pointer to a |
| 597 | writable memory location in buffer of size buffer_len. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 598 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 599 | 0 is returned on success. buffer and buffer_len are only |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 600 | set in case no error occurs. Otherwise, -1 is returned and |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 601 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 602 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 603 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 604 | /* new buffer API */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 605 | |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 606 | #ifndef Py_LIMITED_API |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 607 | #define PyObject_CheckBuffer(obj) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 608 | (((obj)->ob_type->tp_as_buffer != NULL) && \ |
| 609 | ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL)) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 610 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 611 | /* Return 1 if the getbuffer function is available, otherwise |
| 612 | return 0 */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 613 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 614 | PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view, |
| 615 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 616 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 617 | /* This is a C-API version of the getbuffer function call. It checks |
| 618 | to make sure object has the required function pointer and issues the |
| 619 | call. Returns -1 and raises an error on failure and returns 0 on |
| 620 | success |
| 621 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 622 | |
| 623 | |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 624 | PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 625 | |
| 626 | /* Get the memory area pointed to by the indices for the buffer given. |
| 627 | Note that view->ndim is the assumed size of indices |
| 628 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 629 | |
| 630 | PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 631 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 632 | /* Return the implied itemsize of the data-format area from a |
| 633 | struct-style description */ |
| 634 | |
| 635 | |
| 636 | |
Stefan Krah | 7d12d9d | 2012-07-28 12:25:55 +0200 | [diff] [blame] | 637 | /* Implementation in memoryobject.c */ |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 638 | PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view, |
Stefan Krah | 7d12d9d | 2012-07-28 12:25:55 +0200 | [diff] [blame] | 639 | Py_ssize_t len, char order); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 640 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 641 | PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf, |
Stefan Krah | 7d12d9d | 2012-07-28 12:25:55 +0200 | [diff] [blame] | 642 | Py_ssize_t len, char order); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 643 | |
| 644 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 645 | /* Copy len bytes of data from the contiguous chunk of memory |
| 646 | pointed to by buf into the buffer exported by obj. Return |
| 647 | 0 on success and return -1 and raise a PyBuffer_Error on |
| 648 | error (i.e. the object does not have a buffer interface or |
| 649 | it is not working). |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 650 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 651 | If fort is 'F', then if the object is multi-dimensional, |
| 652 | then the data will be copied into the array in |
| 653 | Fortran-style (first dimension varies the fastest). If |
| 654 | fort is 'C', then the data will be copied into the array |
| 655 | in C-style (last dimension varies the fastest). If fort |
| 656 | is 'A', then it does not matter and the copy will be made |
| 657 | in whatever way is more efficient. |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 658 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 659 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 660 | |
| 661 | PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 662 | |
| 663 | /* Copy the data from the src buffer to the buffer of destination |
| 664 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 665 | |
Stefan Krah | 9a2d99e | 2012-02-25 12:24:21 +0100 | [diff] [blame] | 666 | PyAPI_FUNC(int) PyBuffer_IsContiguous(const Py_buffer *view, char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 667 | |
| 668 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 669 | PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims, |
| 670 | Py_ssize_t *shape, |
| 671 | Py_ssize_t *strides, |
| 672 | int itemsize, |
| 673 | char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 674 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 675 | /* Fill the strides array with byte-strides of a contiguous |
| 676 | (Fortran-style if fort is 'F' or C-style otherwise) |
| 677 | array of the given shape with the given number of bytes |
| 678 | per element. |
| 679 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 680 | |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 681 | PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 682 | Py_ssize_t len, int readonly, |
| 683 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 684 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 685 | /* Fills in a buffer-info structure correctly for an exporter |
| 686 | that can only share a contiguous chunk of memory of |
| 687 | "unsigned bytes" of the given length. Returns 0 on success |
| 688 | and -1 (with raising an error) on error. |
| 689 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 690 | |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 691 | PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view); |
| 692 | |
| 693 | /* Releases a Py_buffer obtained from getbuffer ParseTuple's s*. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 694 | */ |
Martin v. Löwis | c83bc3c | 2011-01-06 19:15:47 +0000 | [diff] [blame] | 695 | #endif /* Py_LIMITED_API */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 696 | |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 697 | PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 698 | PyObject *format_spec); |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 699 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 700 | Takes an arbitrary object and returns the result of |
| 701 | calling obj.__format__(format_spec). |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 702 | */ |
| 703 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 704 | /* Iterators */ |
| 705 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 706 | PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *); |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 707 | /* Takes an object and returns an iterator for it. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 708 | This is typically a new iterator but if the argument |
| 709 | is an iterator, this returns itself. */ |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 710 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 711 | #define PyIter_Check(obj) \ |
Amaury Forgeot d'Arc | f343e01 | 2009-01-12 23:58:21 +0000 | [diff] [blame] | 712 | ((obj)->ob_type->tp_iternext != NULL && \ |
| 713 | (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented) |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 714 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 715 | PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *); |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 716 | /* Takes an iterator object and calls its tp_iternext slot, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 717 | returning the next value. If the iterator is exhausted, |
| 718 | this returns NULL without setting an exception. |
| 719 | NULL with an exception means an error occurred. */ |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 720 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 721 | /* Number Protocol:*/ |
| 722 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 723 | PyAPI_FUNC(int) PyNumber_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 724 | |
| 725 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 726 | Returns 1 if the object, o, provides numeric protocols, and |
| 727 | false otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 728 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 729 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 730 | */ |
| 731 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 732 | PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 733 | |
| 734 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 735 | Returns the result of adding o1 and o2, or null on failure. |
| 736 | This is the equivalent of the Python expression: o1+o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 737 | */ |
| 738 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 739 | PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 740 | |
| 741 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 742 | Returns the result of subtracting o2 from o1, or null on |
| 743 | failure. This is the equivalent of the Python expression: |
| 744 | o1-o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 745 | */ |
| 746 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 747 | PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 748 | |
| 749 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 750 | Returns the result of multiplying o1 and o2, or null on |
| 751 | failure. This is the equivalent of the Python expression: |
| 752 | o1*o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 753 | */ |
| 754 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 755 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 756 | PyAPI_FUNC(PyObject *) PyNumber_MatrixMultiply(PyObject *o1, PyObject *o2); |
| 757 | |
| 758 | /* |
| 759 | This is the equivalent of the Python expression: o1 @ o2. |
| 760 | */ |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 761 | #endif |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 762 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 763 | PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 764 | |
| 765 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 766 | Returns the result of dividing o1 by o2 giving an integral result, |
| 767 | or null on failure. |
| 768 | This is the equivalent of the Python expression: o1//o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 769 | */ |
| 770 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 771 | PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 772 | |
| 773 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 774 | Returns the result of dividing o1 by o2 giving a float result, |
| 775 | or null on failure. |
| 776 | This is the equivalent of the Python expression: o1/o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 777 | */ |
| 778 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 779 | PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 780 | |
| 781 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 782 | Returns the remainder of dividing o1 by o2, or null on |
| 783 | failure. This is the equivalent of the Python expression: |
| 784 | o1%o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 785 | */ |
| 786 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 787 | PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 788 | |
| 789 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 790 | See the built-in function divmod. Returns NULL on failure. |
| 791 | This is the equivalent of the Python expression: |
| 792 | divmod(o1,o2). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 793 | */ |
| 794 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 795 | PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 796 | PyObject *o3); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 797 | |
| 798 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 799 | See the built-in function pow. Returns NULL on failure. |
| 800 | This is the equivalent of the Python expression: |
| 801 | pow(o1,o2,o3), where o3 is optional. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 802 | */ |
| 803 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 804 | PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 805 | |
| 806 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 807 | Returns the negation of o on success, or null on failure. |
| 808 | This is the equivalent of the Python expression: -o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 809 | */ |
| 810 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 811 | PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 812 | |
| 813 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 814 | Returns the (what?) of o on success, or NULL on failure. |
| 815 | This is the equivalent of the Python expression: +o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 816 | */ |
| 817 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 818 | PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 819 | |
| 820 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 821 | Returns the absolute value of o, or null on failure. This is |
| 822 | the equivalent of the Python expression: abs(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 823 | */ |
| 824 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 825 | PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 826 | |
| 827 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 828 | Returns the bitwise negation of o on success, or NULL on |
| 829 | failure. This is the equivalent of the Python expression: |
| 830 | ~o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 831 | */ |
| 832 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 833 | PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 834 | |
| 835 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 836 | Returns the result of left shifting o1 by o2 on success, or |
| 837 | NULL on failure. This is the equivalent of the Python |
| 838 | expression: o1 << o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 839 | */ |
| 840 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 841 | PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 842 | |
| 843 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 844 | Returns the result of right shifting o1 by o2 on success, or |
| 845 | NULL on failure. This is the equivalent of the Python |
| 846 | expression: o1 >> o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 847 | */ |
| 848 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 849 | PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 850 | |
| 851 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 852 | Returns the result of bitwise and of o1 and o2 on success, or |
| 853 | NULL on failure. This is the equivalent of the Python |
| 854 | expression: o1&o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 855 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 856 | */ |
| 857 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 858 | PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 859 | |
| 860 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 861 | Returns the bitwise exclusive or of o1 by o2 on success, or |
| 862 | NULL on failure. This is the equivalent of the Python |
| 863 | expression: o1^o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 864 | */ |
| 865 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 866 | PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 867 | |
| 868 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 869 | Returns the result of bitwise or on o1 and o2 on success, or |
| 870 | NULL on failure. This is the equivalent of the Python |
| 871 | expression: o1|o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 872 | */ |
| 873 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 874 | #define PyIndex_Check(obj) \ |
| 875 | ((obj)->ob_type->tp_as_number != NULL && \ |
| 876 | (obj)->ob_type->tp_as_number->nb_index != NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 877 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 878 | PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o); |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 879 | |
| 880 | /* |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 881 | Returns the object converted to a Python int |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 882 | or NULL with an error raised on failure. |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 883 | */ |
| 884 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 885 | PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc); |
| 886 | |
| 887 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 888 | Returns the object converted to Py_ssize_t by going through |
| 889 | PyNumber_Index first. If an overflow error occurs while |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 890 | converting the int to Py_ssize_t, then the second argument |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 891 | is the error-type to return. If it is NULL, then the overflow error |
| 892 | is cleared and the value is clipped. |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 893 | */ |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 894 | |
Mark Dickinson | d746768 | 2009-01-10 22:14:33 +0000 | [diff] [blame] | 895 | PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o); |
| 896 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 897 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 898 | Returns the o converted to an integer object on success, or |
| 899 | NULL on failure. This is the equivalent of the Python |
| 900 | expression: int(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 901 | */ |
| 902 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 903 | PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 904 | |
| 905 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 906 | Returns the o converted to a float object on success, or NULL |
| 907 | on failure. This is the equivalent of the Python expression: |
| 908 | float(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 909 | */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 910 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 911 | /* In-place variants of (some of) the above number protocol functions */ |
| 912 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 913 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 914 | |
| 915 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 916 | Returns the result of adding o2 to o1, possibly in-place, or null |
| 917 | on failure. This is the equivalent of the Python expression: |
| 918 | o1 += o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 919 | */ |
| 920 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 921 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 922 | |
| 923 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 924 | Returns the result of subtracting o2 from o1, possibly in-place or |
| 925 | null on failure. This is the equivalent of the Python expression: |
| 926 | o1 -= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 927 | */ |
| 928 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 929 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 930 | |
| 931 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 932 | Returns the result of multiplying o1 by o2, possibly in-place, or |
| 933 | null on failure. This is the equivalent of the Python expression: |
| 934 | o1 *= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 935 | */ |
| 936 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 937 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 938 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceMatrixMultiply(PyObject *o1, PyObject *o2); |
| 939 | |
| 940 | /* |
| 941 | This is the equivalent of the Python expression: o1 @= o2. |
| 942 | */ |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 943 | #endif |
Benjamin Peterson | d51374e | 2014-04-09 23:55:56 -0400 | [diff] [blame] | 944 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 945 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 946 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 947 | |
| 948 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 949 | Returns the result of dividing o1 by o2 giving an integral result, |
| 950 | possibly in-place, or null on failure. |
| 951 | This is the equivalent of the Python expression: |
| 952 | o1 /= o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 953 | */ |
| 954 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 955 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 956 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 957 | |
| 958 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 959 | Returns the result of dividing o1 by o2 giving a float result, |
| 960 | possibly in-place, or null on failure. |
| 961 | This is the equivalent of the Python expression: |
| 962 | o1 /= o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 963 | */ |
| 964 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 965 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 966 | |
| 967 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 968 | Returns the remainder of dividing o1 by o2, possibly in-place, or |
| 969 | null on failure. This is the equivalent of the Python expression: |
| 970 | o1 %= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 971 | */ |
| 972 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 973 | PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 974 | PyObject *o3); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 975 | |
| 976 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 977 | Returns the result of raising o1 to the power of o2, possibly |
| 978 | in-place, or null on failure. This is the equivalent of the Python |
| 979 | expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 980 | */ |
| 981 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 982 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 983 | |
| 984 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 985 | Returns the result of left shifting o1 by o2, possibly in-place, or |
| 986 | null on failure. This is the equivalent of the Python expression: |
| 987 | o1 <<= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 988 | */ |
| 989 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 990 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 991 | |
| 992 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 993 | Returns the result of right shifting o1 by o2, possibly in-place or |
| 994 | null on failure. This is the equivalent of the Python expression: |
| 995 | o1 >>= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 996 | */ |
| 997 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 998 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 999 | |
| 1000 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1001 | Returns the result of bitwise and of o1 and o2, possibly in-place, |
| 1002 | or null on failure. This is the equivalent of the Python |
| 1003 | expression: o1 &= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1004 | */ |
| 1005 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1006 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1007 | |
| 1008 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1009 | Returns the bitwise exclusive or of o1 by o2, possibly in-place, or |
| 1010 | null on failure. This is the equivalent of the Python expression: |
| 1011 | o1 ^= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1012 | */ |
| 1013 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1014 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1015 | |
| 1016 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1017 | Returns the result of bitwise or of o1 and o2, possibly in-place, |
| 1018 | or null on failure. This is the equivalent of the Python |
| 1019 | expression: o1 |= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1020 | */ |
| 1021 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 1022 | PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base); |
| 1023 | |
| 1024 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1025 | Returns the integer n converted to a string with a base, with a base |
| 1026 | marker of 0b, 0o or 0x prefixed if applicable. |
| 1027 | 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] | 1028 | */ |
| 1029 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1030 | |
| 1031 | /* Sequence protocol:*/ |
| 1032 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1033 | PyAPI_FUNC(int) PySequence_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1034 | |
| 1035 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1036 | Return 1 if the object provides sequence protocol, and zero |
| 1037 | otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1038 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1039 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1040 | */ |
| 1041 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1042 | PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 1043 | |
Guido van Rossum | 4f4ce68 | 1996-07-21 02:22:56 +0000 | [diff] [blame] | 1044 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1045 | Return the size of sequence object o, or -1 on failure. |
Guido van Rossum | 4f4ce68 | 1996-07-21 02:22:56 +0000 | [diff] [blame] | 1046 | */ |
| 1047 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1048 | /* For DLL compatibility */ |
| 1049 | #undef PySequence_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1050 | PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1051 | #define PySequence_Length PySequence_Size |
| 1052 | |
| 1053 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1054 | PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1055 | |
| 1056 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1057 | Return the concatenation of o1 and o2 on success, and NULL on |
| 1058 | failure. This is the equivalent of the Python |
| 1059 | expression: o1+o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1060 | */ |
| 1061 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1062 | PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1063 | |
| 1064 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1065 | Return the result of repeating sequence object o count times, |
| 1066 | or NULL on failure. This is the equivalent of the Python |
| 1067 | expression: o1*count. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1068 | */ |
| 1069 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1070 | PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1071 | |
| 1072 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1073 | Return the ith element of o, or NULL on failure. This is the |
| 1074 | equivalent of the Python expression: o[i]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1075 | */ |
| 1076 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1077 | 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] | 1078 | |
| 1079 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1080 | Return the slice of sequence object o between i1 and i2, or |
| 1081 | NULL on failure. This is the equivalent of the Python |
| 1082 | expression: o[i1:i2]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1083 | */ |
| 1084 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1085 | 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] | 1086 | |
| 1087 | /* |
Martin Panter | 45be8d6 | 2015-12-08 00:03:20 +0000 | [diff] [blame] | 1088 | Assign object v to the ith element of o. Raise an exception and return |
| 1089 | -1 on failure; return 0 on success. This is the equivalent of the |
| 1090 | Python statement o[i]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1091 | */ |
| 1092 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1093 | PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 1094 | |
| 1095 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1096 | Delete the ith element of object v. Returns |
| 1097 | -1 on failure. This is the equivalent of the Python |
| 1098 | statement: del o[i]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 1099 | */ |
| 1100 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1101 | 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] | 1102 | PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1103 | |
| 1104 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1105 | Assign the sequence object, v, to the slice in sequence |
| 1106 | object, o, from i1 to i2. Returns -1 on failure. This is the |
| 1107 | equivalent of the Python statement: o[i1:i2]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1108 | */ |
| 1109 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1110 | 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] | 1111 | |
| 1112 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1113 | Delete the slice in sequence object, o, from i1 to i2. |
| 1114 | Returns -1 on failure. This is the equivalent of the Python |
| 1115 | statement: del o[i1:i2]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 1116 | */ |
| 1117 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1118 | PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1119 | |
| 1120 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1121 | Returns the sequence, o, as a tuple on success, and NULL on failure. |
| 1122 | This is equivalent to the Python expression: tuple(o) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1123 | */ |
| 1124 | |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1125 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1126 | PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o); |
Guido van Rossum | 2adf06b | 1996-12-05 21:48:50 +0000 | [diff] [blame] | 1127 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1128 | Returns the sequence, o, as a list on success, and NULL on failure. |
| 1129 | This is equivalent to the Python expression: list(o) |
Guido van Rossum | 2adf06b | 1996-12-05 21:48:50 +0000 | [diff] [blame] | 1130 | */ |
Guido van Rossum | f39fc43 | 1997-03-04 18:31:47 +0000 | [diff] [blame] | 1131 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1132 | PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m); |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1133 | /* |
Benjamin Peterson | 7ddf3eb | 2014-04-08 10:51:20 -0400 | [diff] [blame] | 1134 | Return the sequence, o, as a list, unless it's already a |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1135 | tuple or list. Use PySequence_Fast_GET_ITEM to access the |
| 1136 | 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] | 1137 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1138 | Returns NULL on failure. If the object does not support iteration, |
| 1139 | raises a TypeError exception with m as the message text. |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1140 | */ |
| 1141 | |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1142 | #define PySequence_Fast_GET_SIZE(o) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1143 | (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o)) |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1144 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1145 | Return the size of o, assuming that o was returned by |
| 1146 | PySequence_Fast and is not NULL. |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1147 | */ |
| 1148 | |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1149 | #define PySequence_Fast_GET_ITEM(o, i)\ |
| 1150 | (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] | 1151 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1152 | Return the ith element of o, assuming that o was returned by |
| 1153 | PySequence_Fast, and that i is within bounds. |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1154 | */ |
| 1155 | |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1156 | #define PySequence_ITEM(o, i)\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1157 | ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) ) |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1158 | /* 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] | 1159 | need to be corrected for a negative index |
| 1160 | */ |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1161 | |
Raymond Hettinger | 42bec93 | 2004-03-12 16:38:17 +0000 | [diff] [blame] | 1162 | #define PySequence_Fast_ITEMS(sf) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1163 | (PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \ |
| 1164 | : ((PyTupleObject *)(sf))->ob_item) |
| 1165 | /* Return a pointer to the underlying item array for |
| 1166 | an object retured by PySequence_Fast */ |
Raymond Hettinger | c1e4f9d | 2004-03-12 08:04:00 +0000 | [diff] [blame] | 1167 | |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1168 | PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1169 | |
| 1170 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1171 | Return the number of occurrences on value on o, that is, |
| 1172 | return the number of keys for which o[key]==value. On |
| 1173 | failure, return -1. This is equivalent to the Python |
| 1174 | expression: o.count(value). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1175 | */ |
| 1176 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1177 | PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob); |
Tim Peters | cb8d368 | 2001-05-05 21:05:01 +0000 | [diff] [blame] | 1178 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1179 | Return -1 if error; 1 if ob in seq; 0 if ob not in seq. |
| 1180 | Use __contains__ if possible, else _PySequence_IterSearch(). |
Tim Peters | cb8d368 | 2001-05-05 21:05:01 +0000 | [diff] [blame] | 1181 | */ |
| 1182 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1183 | #ifndef Py_LIMITED_API |
Tim Peters | 16a77ad | 2001-09-08 04:00:12 +0000 | [diff] [blame] | 1184 | #define PY_ITERSEARCH_COUNT 1 |
| 1185 | #define PY_ITERSEARCH_INDEX 2 |
| 1186 | #define PY_ITERSEARCH_CONTAINS 3 |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1187 | PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1188 | PyObject *obj, int operation); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1189 | #endif |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1190 | /* |
| 1191 | Iterate over seq. Result depends on the operation: |
| 1192 | PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if |
| 1193 | error. |
| 1194 | PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of |
| 1195 | obj in seq; set ValueError and return -1 if none found; |
| 1196 | also return -1 on error. |
| 1197 | PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on |
| 1198 | error. |
| 1199 | */ |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1200 | |
| 1201 | /* For DLL-level backwards compatibility */ |
| 1202 | #undef PySequence_In |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1203 | PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value); |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1204 | |
| 1205 | /* For source-level backwards compatibility */ |
Guido van Rossum | f1536db | 1998-08-23 22:06:59 +0000 | [diff] [blame] | 1206 | #define PySequence_In PySequence_Contains |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1207 | |
| 1208 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1209 | Determine if o contains value. If an item in o is equal to |
| 1210 | X, return 1, otherwise return 0. On error, return -1. This |
| 1211 | is equivalent to the Python expression: value in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1212 | */ |
| 1213 | |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1214 | PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1215 | |
| 1216 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1217 | Return the first index for which o[i]=value. On error, |
| 1218 | return -1. This is equivalent to the Python |
| 1219 | expression: o.index(value). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1220 | */ |
| 1221 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1222 | /* In-place versions of some of the above Sequence functions. */ |
| 1223 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1224 | PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1225 | |
| 1226 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1227 | Append o2 to o1, in-place when possible. Return the resulting |
| 1228 | object, which could be o1, or NULL on failure. This is the |
| 1229 | equivalent of the Python expression: o1 += o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1230 | |
| 1231 | */ |
| 1232 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1233 | PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1234 | |
| 1235 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1236 | Repeat o1 by count, in-place when possible. Return the resulting |
| 1237 | object, which could be o1, or NULL on failure. This is the |
| 1238 | equivalent of the Python expression: o1 *= count. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1239 | |
| 1240 | */ |
| 1241 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1242 | /* Mapping protocol:*/ |
| 1243 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1244 | PyAPI_FUNC(int) PyMapping_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1245 | |
| 1246 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1247 | Return 1 if the object provides mapping protocol, and zero |
| 1248 | otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1249 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1250 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1251 | */ |
| 1252 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1253 | PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 1254 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1255 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1256 | Returns the number of keys in object o on success, and -1 on |
| 1257 | failure. For objects that do not provide sequence protocol, |
| 1258 | this is equivalent to the Python expression: len(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1259 | */ |
| 1260 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1261 | /* For DLL compatibility */ |
| 1262 | #undef PyMapping_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1263 | PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1264 | #define PyMapping_Length PyMapping_Size |
| 1265 | |
| 1266 | |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1267 | /* implemented as a macro: |
| 1268 | |
Serhiy Storchaka | c679227 | 2013-10-19 21:03:34 +0300 | [diff] [blame] | 1269 | int PyMapping_DelItemString(PyObject *o, const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1270 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1271 | Remove the mapping for object, key, from the object *o. |
| 1272 | Returns -1 on failure. This is equivalent to |
| 1273 | the Python statement: del o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1274 | */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1275 | #define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K)) |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1276 | |
| 1277 | /* implemented as a macro: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1278 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 1279 | int PyMapping_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1280 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1281 | Remove the mapping for object, key, from the object *o. |
| 1282 | Returns -1 on failure. This is equivalent to |
| 1283 | the Python statement: del o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1284 | */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1285 | #define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K)) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1286 | |
Serhiy Storchaka | c679227 | 2013-10-19 21:03:34 +0300 | [diff] [blame] | 1287 | PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1288 | |
| 1289 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1290 | On success, return 1 if the mapping object has the key, key, |
| 1291 | and 0 otherwise. This is equivalent to the Python expression: |
| 1292 | key in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1293 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1294 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1295 | */ |
| 1296 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1297 | PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1298 | |
| 1299 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1300 | Return 1 if the mapping object has the key, key, |
| 1301 | and 0 otherwise. This is equivalent to the Python expression: |
| 1302 | key in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1303 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1304 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1305 | |
| 1306 | */ |
| 1307 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1308 | PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1309 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1310 | /* |
Serhiy Storchaka | 1d480be | 2016-09-26 20:52:41 +0300 | [diff] [blame] | 1311 | On success, return a list or tuple of the keys in object o. |
| 1312 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1313 | */ |
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 | PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1316 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1317 | /* |
Serhiy Storchaka | 1d480be | 2016-09-26 20:52:41 +0300 | [diff] [blame] | 1318 | On success, return a list or tuple of the values in object o. |
| 1319 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1320 | */ |
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 | PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1323 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1324 | /* |
Serhiy Storchaka | 1d480be | 2016-09-26 20:52:41 +0300 | [diff] [blame] | 1325 | On success, return a list or tuple of the items in object o, |
| 1326 | where each item is a tuple containing a key-value pair. |
| 1327 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1328 | |
| 1329 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1330 | |
Serhiy Storchaka | c679227 | 2013-10-19 21:03:34 +0300 | [diff] [blame] | 1331 | PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o, |
| 1332 | const char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1333 | |
| 1334 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1335 | Return element of o corresponding to the object, key, or NULL |
| 1336 | on failure. This is the equivalent of the Python expression: |
| 1337 | o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1338 | */ |
| 1339 | |
Serhiy Storchaka | c679227 | 2013-10-19 21:03:34 +0300 | [diff] [blame] | 1340 | PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, const char *key, |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 1341 | PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1342 | |
| 1343 | /* |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1344 | Map the object, key, to the value, v. Returns |
| 1345 | -1 on failure. This is the equivalent of the Python |
| 1346 | statement: o[key]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1347 | */ |
| 1348 | |
| 1349 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1350 | PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1351 | /* isinstance(object, typeorclass) */ |
| 1352 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1353 | PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1354 | /* issubclass(object, typeorclass) */ |
| 1355 | |
| 1356 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 1357 | #ifndef Py_LIMITED_API |
Antoine Pitrou | ec569b7 | 2008-08-26 22:40:48 +0000 | [diff] [blame] | 1358 | PyAPI_FUNC(int) _PyObject_RealIsInstance(PyObject *inst, PyObject *cls); |
| 1359 | |
| 1360 | PyAPI_FUNC(int) _PyObject_RealIsSubclass(PyObject *derived, PyObject *cls); |
| 1361 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1362 | PyAPI_FUNC(char *const *) _PySequence_BytesToCharpArray(PyObject* self); |
| 1363 | |
| 1364 | PyAPI_FUNC(void) _Py_FreeCharPArray(char *const array[]); |
Antoine Pitrou | ec569b7 | 2008-08-26 22:40:48 +0000 | [diff] [blame] | 1365 | |
Antoine Pitrou | f68c2a7 | 2010-09-01 12:58:21 +0000 | [diff] [blame] | 1366 | /* For internal use by buffer API functions */ |
| 1367 | PyAPI_FUNC(void) _Py_add_one_to_index_F(int nd, Py_ssize_t *index, |
| 1368 | const Py_ssize_t *shape); |
| 1369 | PyAPI_FUNC(void) _Py_add_one_to_index_C(int nd, Py_ssize_t *index, |
| 1370 | const Py_ssize_t *shape); |
Serhiy Storchaka | 9fab79b | 2016-09-11 11:03:14 +0300 | [diff] [blame] | 1371 | #endif /* !Py_LIMITED_API */ |
Antoine Pitrou | f68c2a7 | 2010-09-01 12:58:21 +0000 | [diff] [blame] | 1372 | |
| 1373 | |
Guido van Rossum | 8ca687a | 1995-09-18 21:20:02 +0000 | [diff] [blame] | 1374 | #ifdef __cplusplus |
| 1375 | } |
| 1376 | #endif |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1377 | #endif /* Py_ABSTRACTOBJECT_H */ |