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