annotate Include/abstract.h @ 78069:a8aa77458e12 3.2

Add c_size_t and c_ssize_t to the ctypes summary table.
author Antoine Pitrou <solipsis@pitrou.net>
date Thu, 12 Jul 2012 20:31:50 +0200
parents dc245d681901
children 5e33219492bc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 #ifndef Py_ABSTRACTOBJECT_H
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 #define Py_ABSTRACTOBJECT_H
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 #ifdef __cplusplus
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 extern "C" {
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 #endif
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
6
37879
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
7 #ifdef PY_SSIZE_T_CLEAN
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
8 #define PyObject_CallFunction _PyObject_CallFunction_SizeT
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
9 #define PyObject_CallMethod _PyObject_CallMethod_SizeT
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
10 #endif
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
11
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 /* Abstract Object Interface (many thanks to Jim Fulton) */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 /*
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 PROPOSAL: A Generic Python Object Interface for Python C Modules
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
16
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 Problem
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
18
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 Python modules written in C that must access Python objects must do
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 so through routines whose interfaces are described by a set of
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 include files. Unfortunately, these routines vary according to the
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 object accessed. To use these routines, the C programmer must check
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 the type of the object being used and must call a routine based on
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 the object type. For example, to access an element of a sequence,
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 the programmer must determine whether the sequence is a list or a
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 tuple:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
27
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 if(is_tupleobject(o))
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 e=gettupleitem(o,i)
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 else if(is_listitem(o))
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 e=getlistitem(o,i)
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 If the programmer wants to get an item from another type of object
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 that provides sequence behavior, there is no clear way to do it
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
35 correctly.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
36
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 The persistent programmer may peruse object.h and find that the
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 _typeobject structure provides a means of invoking up to (currently
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 about) 41 special operators. So, for example, a routine can get an
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 item from any object that provides sequence behavior. However, to
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 use this mechanism, the programmer must make their code dependent on
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
42 the current Python implementation.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
43
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
44 Also, certain semantics, especially memory management semantics, may
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
45 differ by the type of object being used. Unfortunately, these
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 semantics are not clearly described in the current include files.
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
47 An abstract interface providing more consistent semantics is needed.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
48
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 Proposal
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
50
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
51 I propose the creation of a standard interface (with an associated
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 library of routines and/or macros) for generically obtaining the
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
53 services of Python objects. This proposal can be viewed as one
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 components of a Python C interface consisting of several components.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
28102
f4e72a1a9f13 Fix spelling and grammar.
Raymond Hettinger <python@rcn.com>
parents: 26400
diff changeset
56 From the viewpoint of C access to Python services, we have (as
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
57 suggested by Guido in off-line discussions):
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
58
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 - "Very high level layer": two or three functions that let you exec or
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 eval arbitrary Python code given as a string in a module whose name is
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
61 given, passing C values in and getting C values out using
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 mkvalue/getargs style format strings. This does not require the user
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
63 to declare any variables of type "PyObject *". This should be enough
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 to write a simple application that gets Python code from the user,
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 execs it, and returns the output or errors. (Error handling must also
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 be part of this API.)
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
67
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 - "Abstract objects layer": which is the subject of this proposal.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
69 It has many functions operating on objects, and lest you do many
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 things from C that you can also write in Python, without going
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 through the Python parser.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
72
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 - "Concrete objects layer": This is the public type-dependent
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
74 interface provided by the standard built-in types, such as floats,
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 strings, and lists. This interface exists and is currently
28102
f4e72a1a9f13 Fix spelling and grammar.
Raymond Hettinger <python@rcn.com>
parents: 26400
diff changeset
76 documented by the collection of include files provided with the
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
77 Python distributions.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
78
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
79 From the point of view of Python accessing services provided by C
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
80 modules:
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
81
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 - "Python module interface": this interface consist of the basic
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 routines used to define modules and their members. Most of the
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 current extensions-writing guide deals with this interface.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
85
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
86 - "Built-in object interface": this is the interface that a new
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
87 built-in type must provide and the mechanisms and rules that a
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
88 developer of a new built-in type must use and follow.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
89
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 This proposal is a "first-cut" that is intended to spur
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
91 discussion. See especially the lists of notes.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
92
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
93 The Python C object interface will provide four protocols: object,
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 numeric, sequence, and mapping. Each protocol consists of a
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 collection of related operations. If an operation that is not
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 provided by a particular type is invoked, then a standard exception,
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 NotImplementedError is raised with a operation name as an argument.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
98 In addition, for convenience this interface defines a set of
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
99 constructors for building objects of built-in types. This is needed
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
100 so new objects can be returned from C functions that otherwise treat
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 objects generically.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
102
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 Memory Management
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
104
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 For all of the functions described in this proposal, if a function
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
106 retains a reference to a Python object passed as an argument, then the
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 function will increase the reference count of the object. It is
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 unnecessary for the caller to increase the reference count of an
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 argument in anticipation of the object's retention.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
110
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 All Python objects returned from functions should be treated as new
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
112 objects. Functions that return objects assume that the caller will
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 retain a reference and the reference count of the object has already
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 been incremented to account for this fact. A caller that does not
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 retain a reference to an object that is returned from a function
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
116 must decrement the reference count of the object (using
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
117 DECREF(object)) to prevent memory leaks.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
118
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 Note that the behavior mentioned here is different from the current
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 behavior for some objects (e.g. lists and tuples) when certain
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 type-specific routines are called directly (e.g. setlistitem). The
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
122 proposed abstraction layer will provide a consistent memory
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
123 management interface, correcting for inconsistent behavior for some
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 built-in types.
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
125
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 Protocols
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
127
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
128 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
129
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 /* Object Protocol: */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
131
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
133
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
134 int PyObject_Print(PyObject *o, FILE *fp, int flags);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
135
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
136 Print an object, o, on file, fp. Returns -1 on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
137 error. The flags argument is used to enable certain printing
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
138 options. The only option currently supported is Py_Print_RAW.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
139
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
140 (What should be said about Py_Print_RAW?)
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
141
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
142 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
143
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
144 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
145
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
146 int PyObject_HasAttrString(PyObject *o, char *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
147
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
148 Returns 1 if o has the attribute attr_name, and 0 otherwise.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
149 This is equivalent to the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
150 hasattr(o,attr_name).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
151
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
152 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
153
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
154 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
155
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
156 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
157
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
158 PyObject* PyObject_GetAttrString(PyObject *o, char *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
159
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
160 Retrieve an attributed named attr_name form object o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
161 Returns the attribute value on success, or NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
162 This is the equivalent of the Python expression: o.attr_name.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
163
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
164 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
165
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
166 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
167
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
168 int PyObject_HasAttr(PyObject *o, PyObject *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
169
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
170 Returns 1 if o has the attribute attr_name, and 0 otherwise.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
171 This is equivalent to the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
172 hasattr(o,attr_name).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
173
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
174 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
175
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
176 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
177
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
178 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
179
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
180 PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
181
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
182 Retrieve an attributed named attr_name form object o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
183 Returns the attribute value on success, or NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
184 This is the equivalent of the Python expression: o.attr_name.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
185
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
186 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
187
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
188
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
189 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
190
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
191 int PyObject_SetAttrString(PyObject *o, char *attr_name, PyObject *v);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
192
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
193 Set the value of the attribute named attr_name, for object o,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
194 to the value, v. Returns -1 on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
195 the equivalent of the Python statement: o.attr_name=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
196
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
197 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
198
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
199 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
200
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
201 int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
202
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
203 Set the value of the attribute named attr_name, for object o,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
204 to the value, v. Returns -1 on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
205 the equivalent of the Python statement: o.attr_name=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
206
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
207 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
208
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
209 /* implemented as a macro:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
210
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
211 int PyObject_DelAttrString(PyObject *o, char *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
212
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
213 Delete attribute named attr_name, for object o. Returns
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
214 -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
215 statement: del o.attr_name.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
216
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
217 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
218 #define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A),NULL)
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
219
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
220 /* implemented as a macro:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
221
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
222 int PyObject_DelAttr(PyObject *o, PyObject *attr_name);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
223
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
224 Delete attribute named attr_name, for object o. Returns -1
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
225 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
226 statement: del o.attr_name.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
227
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
228 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
229 #define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A),NULL)
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
230
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
231 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
232
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
233 PyObject *PyObject_Repr(PyObject *o);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
234
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
235 Compute the string representation of object, o. Returns the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
236 string representation on success, NULL on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
237 the equivalent of the Python expression: repr(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
238
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
239 Called by the repr() built-in function.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
240
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
241 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
242
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
243 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
244
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
245 PyObject *PyObject_Str(PyObject *o);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
246
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
247 Compute the string representation of object, o. Returns the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
248 string representation on success, NULL on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
249 the equivalent of the Python expression: str(o).)
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
250
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
251 Called by the str() and print() built-in functions.
15952
1f92d63b20f0 This patch adds a new builtin unistr() which behaves like str()
Marc-André Lemburg <mal@egenix.com>
parents: 14162
diff changeset
252
1f92d63b20f0 This patch adds a new builtin unistr() which behaves like str()
Marc-André Lemburg <mal@egenix.com>
parents: 14162
diff changeset
253 */
1f92d63b20f0 This patch adds a new builtin unistr() which behaves like str()
Marc-André Lemburg <mal@egenix.com>
parents: 14162
diff changeset
254
40450
cc992d75d5b3 Four months of trunk changes (including a few releases...)
Thomas Wouters <thomas@python.org>
parents: 39610
diff changeset
255 /* Declared elsewhere
cc992d75d5b3 Four months of trunk changes (including a few releases...)
Thomas Wouters <thomas@python.org>
parents: 39610
diff changeset
256
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
257 PyAPI_FUNC(int) PyCallable_Check(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
258
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
259 Determine if the object, o, is callable. Return 1 if the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
260 object is callable and 0 otherwise.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
261
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
262 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
263 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
264
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
265 PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
266 PyObject *args, PyObject *kw);
18933
09df3254b49d Merge of descr-branch back into trunk.
Tim Peters <tim.peters@gmail.com>
parents: 17692
diff changeset
267
09df3254b49d Merge of descr-branch back into trunk.
Tim Peters <tim.peters@gmail.com>
parents: 17692
diff changeset
268 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
269 Call a callable Python object, callable_object, with
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
270 arguments and keywords arguments. The 'args' argument can not be
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
271 NULL, but the 'kw' argument can be NULL.
18933
09df3254b49d Merge of descr-branch back into trunk.
Tim Peters <tim.peters@gmail.com>
parents: 17692
diff changeset
272 */
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
273
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
274 PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
275 PyObject *args);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
276
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
277 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
278 Call a callable Python object, callable_object, with
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
279 arguments given by the tuple, args. If no arguments are
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
280 needed, then args may be NULL. Returns the result of the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
281 call on success, or NULL on failure. This is the equivalent
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
282 of the Python expression: o(*args).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
284
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
285 PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
286 char *format, ...);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
287
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
288 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
289 Call a callable Python object, callable_object, with a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
290 variable number of C arguments. The C arguments are described
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
291 using a mkvalue-style format string. The format may be NULL,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
292 indicating that no arguments are provided. Returns the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
293 result of the call on success, or NULL on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
294 the equivalent of the Python expression: o(*args).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
295 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
296
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
297
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
298 PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, char *method,
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
299 char *format, ...);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
300
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
301 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
302 Call the method named m of object o with a variable number of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
303 C arguments. The C arguments are described by a mkvalue
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
304 format string. The format may be NULL, indicating that no
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
305 arguments are provided. Returns the result of the call on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
306 success, or NULL on failure. This is the equivalent of the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
307 Python expression: o.method(args).
20694
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
308 */
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
309
37879
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
310 PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
311 char *format, ...);
37879
f731859e9b3b Merge p3yk branch with the trunk up to revision 45595. This breaks a fair
Thomas Wouters <thomas@python.org>
parents: 37046
diff changeset
312 PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
313 char *name,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
314 char *format, ...);
20694
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
315
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
316 PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
317 ...);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
318
20694
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
319 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
320 Call a callable Python object, callable_object, with a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
321 variable number of C arguments. The C arguments are provided
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
322 as PyObject * values, terminated by a NULL. Returns the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
323 result of the call on success, or NULL on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
324 the equivalent of the Python expression: o(*args).
20694
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
325 */
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
326
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
327
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
328 PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
329 PyObject *method, ...);
20694
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
330
d02068d163cf Added two new functions to conveniently call functions/methods from C.
Fred Drake <fdrake@acm.org>
parents: 20683
diff changeset
331 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
332 Call the method named m of object o with a variable number of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
333 C arguments. The C arguments are provided as PyObject *
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
334 values, terminated by NULL. Returns the result of the call
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
335 on success, or NULL on failure. This is the equivalent of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
336 the Python expression: o.method(args).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
337 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
338
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
339
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
340 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
341
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
342 long PyObject_Hash(PyObject *o);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
343
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
344 Compute and return the hash, hash_value, of an object, o. On
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
345 failure, return -1. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
346 expression: hash(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
347 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
348
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
349
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
350 /* Implemented elsewhere:
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
351
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
352 int PyObject_IsTrue(PyObject *o);
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
353
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
354 Returns 1 if the object, o, is considered to be true, 0 if o is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
355 considered to be false and -1 on failure. This is equivalent to the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
356 Python expression: not not o
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
357 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
358
7935
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
359 /* Implemented elsewhere:
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
360
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
361 int PyObject_Not(PyObject *o);
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
362
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
363 Returns 0 if the object, o, is considered to be true, 1 if o is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
364 considered to be false and -1 on failure. This is equivalent to the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
365 Python expression: not o
7935
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
366 */
aa7d69d67c81 Add PyObject_Not().
Guido van Rossum <guido@python.org>
parents: 5167
diff changeset
367
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
368 PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
369
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
370 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
371 On success, returns a type object corresponding to the object
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
372 type of object o. On failure, returns NULL. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
373 equivalent to the Python expression: type(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
374 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
375
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
376 PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o);
13575
7c119f050290 change abstract size functions PySequence_Size &c.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 13444
diff changeset
377
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
378 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
379 Return the size of object o. If the object, o, provides
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
380 both sequence and mapping protocols, the sequence size is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
381 returned. On error, -1 is returned. This is the equivalent
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
382 to the Python expression: len(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
383 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
384
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
385 /* For DLL compatibility */
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
386 #undef PyObject_Length
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
387 PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o);
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
388 #define PyObject_Length PyObject_Size
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
389
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
390 #ifndef Py_LIMITED_API
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 43777
diff changeset
391 PyAPI_FUNC(Py_ssize_t) _PyObject_LengthHint(PyObject *o, Py_ssize_t);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
392 #endif
35636
e22334b1da67 Convert iterator __len__() methods to a private API.
Raymond Hettinger <python@rcn.com>
parents: 31650
diff changeset
393
e22334b1da67 Convert iterator __len__() methods to a private API.
Raymond Hettinger <python@rcn.com>
parents: 31650
diff changeset
394 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
395 Guess the size of object o using len(o) or o.__length_hint__().
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
396 If neither of those return a non-negative value, then return the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
397 default value. If one of the calls fails, this function returns -1.
35636
e22334b1da67 Convert iterator __len__() methods to a private API.
Raymond Hettinger <python@rcn.com>
parents: 31650
diff changeset
398 */
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
399
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
400 PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
401
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
402 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
403 Return element of o corresponding to the object, key, or NULL
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
404 on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
405 o[key].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
406 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
407
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
408 PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
409
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
410 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
411 Map the object, key, to the value, v. Returns
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
412 -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
413 statement: o[key]=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
414 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
415
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
416 PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, char *key);
21644
3c0bd2f37a78 Implement PyObject_DelItemString. Fixes #498915.
Martin v. Löwis <martin@v.loewis.de>
parents: 21069
diff changeset
417
3c0bd2f37a78 Implement PyObject_DelItemString. Fixes #498915.
Martin v. Löwis <martin@v.loewis.de>
parents: 21069
diff changeset
418 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
419 Remove the mapping for object, key, from the object *o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
420 Returns -1 on failure. This is equivalent to
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
421 the Python statement: del o[key].
21644
3c0bd2f37a78 Implement PyObject_DelItemString. Fixes #498915.
Martin v. Löwis <martin@v.loewis.de>
parents: 21069
diff changeset
422 */
3c0bd2f37a78 Implement PyObject_DelItemString. Fixes #498915.
Martin v. Löwis <martin@v.loewis.de>
parents: 21069
diff changeset
423
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
424 PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key);
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
425
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
426 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
427 Delete the mapping for key from *o. Returns -1 on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
428 This is the equivalent of the Python statement: del o[key].
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
429 */
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
430
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
431 /* old buffer API
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
432 FIXME: usage of these should all be replaced in Python itself
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
433 but for backwards compatibility we will implement them.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
434 Their usage without a corresponding "unlock" mechansim
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
435 may create issues (but they would already be there). */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
436
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
437 PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
438 const char **buffer,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
439 Py_ssize_t *buffer_len);
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
440
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
441 /*
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
442 Takes an arbitrary object which must support the (character,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
443 single segment) buffer interface and returns a pointer to a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
444 read-only memory location useable as character based input
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
445 for subsequent processing.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
446
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
447 0 is returned on success. buffer and buffer_len are only
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
448 set in case no error occurs. Otherwise, -1 is returned and
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
449 an exception set.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
450 */
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
451
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
452 PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj);
20946
ef12c9ddefa7 Add PyObject_CheckReadBuffer(), which returns true if its argument
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20729
diff changeset
453
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
454 /*
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
455 Checks whether an arbitrary object supports the (character,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
456 single segment) buffer interface. Returns 1 on success, 0
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
457 on failure.
20946
ef12c9ddefa7 Add PyObject_CheckReadBuffer(), which returns true if its argument
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20729
diff changeset
458 */
ef12c9ddefa7 Add PyObject_CheckReadBuffer(), which returns true if its argument
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20729
diff changeset
459
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
460 PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
461 const void **buffer,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
462 Py_ssize_t *buffer_len);
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
463
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
464 /*
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
465 Same as PyObject_AsCharBuffer() except that this API expects
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
466 (readable, single segment) buffer interface and returns a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
467 pointer to a read-only memory location which can contain
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
468 arbitrary data.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
469
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
470 0 is returned on success. buffer and buffer_len are only
68585
bf94b6a73fc8 #11565: Fix several typos. Patch by Piotr Kasprzyk.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 64344
diff changeset
471 set in case no error occurs. Otherwise, -1 is returned and
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
472 an exception set.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
473 */
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
474
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
475 PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
476 void **buffer,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
477 Py_ssize_t *buffer_len);
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
478
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
479 /*
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
480 Takes an arbitrary object which must support the (writable,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
481 single segment) buffer interface and returns a pointer to a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
482 writable memory location in buffer of size buffer_len.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
483
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
484 0 is returned on success. buffer and buffer_len are only
68585
bf94b6a73fc8 #11565: Fix several typos. Patch by Piotr Kasprzyk.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 64344
diff changeset
485 set in case no error occurs. Otherwise, -1 is returned and
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
486 an exception set.
11965
9f261e94b2b2 Marc-Andre Lemburg: added declarations for PyObject_AsCharBuffer,
Guido van Rossum <guido@python.org>
parents: 10412
diff changeset
487 */
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
488
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
489 /* new buffer API */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
490
67419
8a302a09ee83 Remove buffer API from stable ABI for now, see #10181.
Martin v. Löwis <martin@v.loewis.de>
parents: 66664
diff changeset
491 #ifndef Py_LIMITED_API
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
492 #define PyObject_CheckBuffer(obj) \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
493 (((obj)->ob_type->tp_as_buffer != NULL) && \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
494 ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL))
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
495
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
496 /* Return 1 if the getbuffer function is available, otherwise
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
497 return 0 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
498
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
499 PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
500 int flags);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
501
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
502 /* This is a C-API version of the getbuffer function call. It checks
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
503 to make sure object has the required function pointer and issues the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
504 call. Returns -1 and raises an error on failure and returns 0 on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
505 success
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
506 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
507
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
508
43423
0476a2cc5658 Change PyBuffer to Py_buffer to be consistent with other non-object structures like Py_complex. Add some more functionality to the memoryview object.
Travis E. Oliphant <oliphant@enthought.com>
parents: 43384
diff changeset
509 PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices);
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
510
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
511 /* Get the memory area pointed to by the indices for the buffer given.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
512 Note that view->ndim is the assumed size of indices
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
513 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
514
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
515 PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *);
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
516
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
517 /* Return the implied itemsize of the data-format area from a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
518 struct-style description */
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
519
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
520
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
521
43423
0476a2cc5658 Change PyBuffer to Py_buffer to be consistent with other non-object structures like Py_complex. Add some more functionality to the memoryview object.
Travis E. Oliphant <oliphant@enthought.com>
parents: 43384
diff changeset
522 PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
523 Py_ssize_t len, char fort);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
524
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
525 PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
526 Py_ssize_t len, char fort);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
527
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
528
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
529 /* Copy len bytes of data from the contiguous chunk of memory
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
530 pointed to by buf into the buffer exported by obj. Return
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
531 0 on success and return -1 and raise a PyBuffer_Error on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
532 error (i.e. the object does not have a buffer interface or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
533 it is not working).
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
534
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
535 If fort is 'F', then if the object is multi-dimensional,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
536 then the data will be copied into the array in
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
537 Fortran-style (first dimension varies the fastest). If
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
538 fort is 'C', then the data will be copied into the array
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
539 in C-style (last dimension varies the fastest). If fort
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
540 is 'A', then it does not matter and the copy will be made
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
541 in whatever way is more efficient.
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
542
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
543 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
544
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
545 PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
546
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
547 /* Copy the data from the src buffer to the buffer of destination
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
548 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
549
44469
5d7d2af59afe Some VS 6.0 compatibility fixes from Hirokazu Yamamoto which are also useful for later versions of MSVC. VS6 claims that fortran is a reserved word
Christian Heimes <christian@cheimes.de>
parents: 44351
diff changeset
550 PyAPI_FUNC(int) PyBuffer_IsContiguous(Py_buffer *view, char fort);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
551
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
552
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
553 PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
554 Py_ssize_t *shape,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
555 Py_ssize_t *strides,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
556 int itemsize,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
557 char fort);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
558
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
559 /* Fill the strides array with byte-strides of a contiguous
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
560 (Fortran-style if fort is 'F' or C-style otherwise)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
561 array of the given shape with the given number of bytes
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
562 per element.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
563 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
564
48683
cd3b0b7fd8e1 Merged revisions 65654 via svnmerge from
Martin v. Löwis <martin@v.loewis.de>
parents: 45382
diff changeset
565 PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
566 Py_ssize_t len, int readonly,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
567 int flags);
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
568
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
569 /* Fills in a buffer-info structure correctly for an exporter
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
570 that can only share a contiguous chunk of memory of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
571 "unsigned bytes" of the given length. Returns 0 on success
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
572 and -1 (with raising an error) on error.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
573 */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
574
48683
cd3b0b7fd8e1 Merged revisions 65654 via svnmerge from
Martin v. Löwis <martin@v.loewis.de>
parents: 45382
diff changeset
575 PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);
cd3b0b7fd8e1 Merged revisions 65654 via svnmerge from
Martin v. Löwis <martin@v.loewis.de>
parents: 45382
diff changeset
576
cd3b0b7fd8e1 Merged revisions 65654 via svnmerge from
Martin v. Löwis <martin@v.loewis.de>
parents: 45382
diff changeset
577 /* Releases a Py_buffer obtained from getbuffer ParseTuple's s*.
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
578 */
67419
8a302a09ee83 Remove buffer API from stable ABI for now, see #10181.
Martin v. Löwis <martin@v.loewis.de>
parents: 66664
diff changeset
579 #endif /* Py_LIMITED_API */
42665
85c22b4d4455 Merged in py3k-buffer branch to main line. All objects now use the buffer protocol in PEP 3118.
Travis E. Oliphant <oliphant@enthought.com>
parents: 42334
diff changeset
580
45382
7af955843929 Fixes for shared 2.6 code that implements PEP 3101, advanced string
Eric Smith <eric@trueblade.com>
parents: 45145
diff changeset
581 PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
582 PyObject *format_spec);
45382
7af955843929 Fixes for shared 2.6 code that implements PEP 3101, advanced string
Eric Smith <eric@trueblade.com>
parents: 45145
diff changeset
583 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
584 Takes an arbitrary object and returns the result of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
585 calling obj.__format__(format_spec).
45382
7af955843929 Fixes for shared 2.6 code that implements PEP 3101, advanced string
Eric Smith <eric@trueblade.com>
parents: 45145
diff changeset
586 */
7af955843929 Fixes for shared 2.6 code that implements PEP 3101, advanced string
Eric Smith <eric@trueblade.com>
parents: 45145
diff changeset
587
17617
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
588 /* Iterators */
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
589
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
590 PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);
17597
32e7d0898eab Iterators phase 1. This comprises:
Guido van Rossum <guido@python.org>
parents: 17111
diff changeset
591 /* Takes an object and returns an iterator for it.
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
592 This is typically a new iterator but if the argument
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
593 is an iterator, this returns itself. */
17597
32e7d0898eab Iterators phase 1. This comprises:
Guido van Rossum <guido@python.org>
parents: 17111
diff changeset
594
17617
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
595 #define PyIter_Check(obj) \
50755
c99ce0164699 Merged revisions 68560 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 50717
diff changeset
596 ((obj)->ob_type->tp_iternext != NULL && \
c99ce0164699 Merged revisions 68560 via svnmerge from
Amaury Forgeot d'Arc <amauryfa@gmail.com>
parents: 50717
diff changeset
597 (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented)
17617
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
598
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
599 PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *);
17617
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
600 /* Takes an iterator object and calls its tp_iternext slot,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
601 returning the next value. If the iterator is exhausted,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
602 this returns NULL without setting an exception.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
603 NULL with an exception means an error occurred. */
17617
aac65f50df6f Mondo changes to the iterator stuff, without changing how Python code
Guido van Rossum <guido@python.org>
parents: 17597
diff changeset
604
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
605 /* Number Protocol:*/
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
606
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
607 PyAPI_FUNC(int) PyNumber_Check(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
608
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
609 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
610 Returns 1 if the object, o, provides numeric protocols, and
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
611 false otherwise.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
612
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
613 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
614 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
615
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
616 PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
617
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
618 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
619 Returns the result of adding o1 and o2, or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
620 This is the equivalent of the Python expression: o1+o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
621 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
622
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
623 PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
624
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
625 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
626 Returns the result of subtracting o2 from o1, or null on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
627 failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
628 o1-o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
629 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
630
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
631 PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
632
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
633 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
634 Returns the result of multiplying o1 and o2, or null on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
635 failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
636 o1*o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
637 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
638
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
639 PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2);
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
640
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
641 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
642 Returns the result of dividing o1 by o2 giving an integral result,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
643 or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
644 This is the equivalent of the Python expression: o1//o2.
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
645 */
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
646
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
647 PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2);
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
648
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
649 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
650 Returns the result of dividing o1 by o2 giving a float result,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
651 or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
652 This is the equivalent of the Python expression: o1/o2.
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
653 */
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
654
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
655 PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
656
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
657 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
658 Returns the remainder of dividing o1 by o2, or null on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
659 failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
660 o1%o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
661 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
662
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
663 PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
664
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
665 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
666 See the built-in function divmod. Returns NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
667 This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
668 divmod(o1,o2).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
669 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
670
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
671 PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
672 PyObject *o3);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
673
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
674 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
675 See the built-in function pow. Returns NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
676 This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
677 pow(o1,o2,o3), where o3 is optional.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
678 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
679
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
680 PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
681
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
682 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
683 Returns the negation of o on success, or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
684 This is the equivalent of the Python expression: -o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
685 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
686
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
687 PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
688
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
689 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
690 Returns the (what?) of o on success, or NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
691 This is the equivalent of the Python expression: +o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
692 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
693
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
694 PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
695
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
696 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
697 Returns the absolute value of o, or null on failure. This is
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
698 the equivalent of the Python expression: abs(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
699 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
700
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
701 PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
702
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
703 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
704 Returns the bitwise negation of o on success, or NULL on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
705 failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
706 ~o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
707 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
708
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
709 PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
710
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
711 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
712 Returns the result of left shifting o1 by o2 on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
713 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
714 expression: o1 << o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
715 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
716
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
717 PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
718
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
719 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
720 Returns the result of right shifting o1 by o2 on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
721 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
722 expression: o1 >> o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
723 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
724
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
725 PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
726
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
727 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
728 Returns the result of bitwise and of o1 and o2 on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
729 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
730 expression: o1&o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
731
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
732 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
733
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
734 PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
735
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
736 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
737 Returns the bitwise exclusive or of o1 by o2 on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
738 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
739 expression: o1^o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
740 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
741
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
742 PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
743
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
744 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
745 Returns the result of bitwise or on o1 and o2 on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
746 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
747 expression: o1|o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
748 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
749
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
750 #define PyIndex_Check(obj) \
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
751 ((obj)->ob_type->tp_as_number != NULL && \
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
752 (obj)->ob_type->tp_as_number->nb_index != NULL)
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
753
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
754 PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o);
36882
6a9c7165b17b Checking in the code for PEP 357.
Guido van Rossum <guido@python.org>
parents: 36834
diff changeset
755
6a9c7165b17b Checking in the code for PEP 357.
Guido van Rossum <guido@python.org>
parents: 36834
diff changeset
756 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
757 Returns the object converted to a Python long or int
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
758 or NULL with an error raised on failure.
36882
6a9c7165b17b Checking in the code for PEP 357.
Guido van Rossum <guido@python.org>
parents: 36834
diff changeset
759 */
6a9c7165b17b Checking in the code for PEP 357.
Guido van Rossum <guido@python.org>
parents: 36834
diff changeset
760
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
761 PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc);
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
762
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
763 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
764 Returns the Integral instance converted to an int. The
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
765 instance is expected to be int or long or have an __int__
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
766 method. Steals integral's reference. error_format will be
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
767 used to create the TypeError if integral isn't actually an
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
768 Integral instance. error_format should be a format string
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
769 that can accept a char* naming integral's type.
45145
3d7b84daa34a Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552-60567 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44469
diff changeset
770 */
3d7b84daa34a Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552-60567 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44469
diff changeset
771
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
772 #ifndef Py_LIMITED_API
45145
3d7b84daa34a Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552-60567 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44469
diff changeset
773 PyAPI_FUNC(PyObject *) _PyNumber_ConvertIntegralToInt(
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
774 PyObject *integral,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
775 const char* error_format);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
776 #endif
45145
3d7b84daa34a Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552-60567 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44469
diff changeset
777
3d7b84daa34a Merged revisions 60481,60485,60489-60492,60494-60496,60498-60499,60501-60503,60505-60506,60508-60509,60523-60524,60532,60543,60545,60547-60548,60552-60567 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44469
diff changeset
778 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
779 Returns the object converted to Py_ssize_t by going through
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
780 PyNumber_Index first. If an overflow error occurs while
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
781 converting the int-or-long to Py_ssize_t, then the second argument
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
782 is the error-type to return. If it is NULL, then the overflow error
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
783 is cleared and the value is clipped.
39610
3674f20ac781 Merge current trunk into p3yk. This includes the PyNumber_Index API change,
Thomas Wouters <thomas@python.org>
parents: 39603
diff changeset
784 */
36882
6a9c7165b17b Checking in the code for PEP 357.
Guido van Rossum <guido@python.org>
parents: 36834
diff changeset
785
50717
0496963fcfe9 Merged revisions 68508 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 48875
diff changeset
786 PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o);
0496963fcfe9 Merged revisions 68508 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 48875
diff changeset
787
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
788 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
789 Returns the o converted to an integer object on success, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
790 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
791 expression: int(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
792 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
793
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
794 PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
795
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
796 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
797 Returns the o converted to a float object on success, or NULL
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
798 on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
799 float(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
800 */
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
801
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
802 /* In-place variants of (some of) the above number protocol functions */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
803
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
804 PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
805
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
806 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
807 Returns the result of adding o2 to o1, possibly in-place, or null
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
808 on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
809 o1 += o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
810 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
811
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
812 PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
813
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
814 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
815 Returns the result of subtracting o2 from o1, possibly in-place or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
816 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
817 o1 -= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
818 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
819
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
820 PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
821
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
822 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
823 Returns the result of multiplying o1 by o2, possibly in-place, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
824 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
825 o1 *= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
826 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
827
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
828 PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
829 PyObject *o2);
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
830
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
831 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
832 Returns the result of dividing o1 by o2 giving an integral result,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
833 possibly in-place, or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
834 This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
835 o1 /= o2.
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
836 */
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
837
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
838 PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
839 PyObject *o2);
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
840
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
841 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
842 Returns the result of dividing o1 by o2 giving a float result,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
843 possibly in-place, or null on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
844 This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
845 o1 /= o2.
19051
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
846 */
f20727cc3d0f Implement PEP 238 in its (almost) full glory.
Guido van Rossum <guido@python.org>
parents: 18933
diff changeset
847
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
848 PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
849
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
850 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
851 Returns the remainder of dividing o1 by o2, possibly in-place, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
852 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
853 o1 %= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
854 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
855
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
856 PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
857 PyObject *o3);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
858
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
859 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
860 Returns the result of raising o1 to the power of o2, possibly
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
861 in-place, or null on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
862 expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
863 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
864
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
865 PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
866
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
867 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
868 Returns the result of left shifting o1 by o2, possibly in-place, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
869 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
870 o1 <<= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
871 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
872
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
873 PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
874
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
875 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
876 Returns the result of right shifting o1 by o2, possibly in-place or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
877 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
878 o1 >>= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
879 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
880
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
881 PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
882
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
883 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
884 Returns the result of bitwise and of o1 and o2, possibly in-place,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
885 or null on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
886 expression: o1 &= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
887 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
888
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
889 PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
890
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
891 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
892 Returns the bitwise exclusive or of o1 by o2, possibly in-place, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
893 null on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
894 o1 ^= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
895 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
896
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
897 PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
898
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
899 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
900 Returns the result of bitwise or of o1 and o2, possibly in-place,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
901 or null on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
902 expression: o1 |= o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
903 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
904
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40809
diff changeset
905 PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base);
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40809
diff changeset
906
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40809
diff changeset
907 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
908 Returns the integer n converted to a string with a base, with a base
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
909 marker of 0b, 0o or 0x prefixed if applicable.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
910 If n is not an int object, it is converted with PyNumber_Index first.
42084
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40809
diff changeset
911 */
229c28cb9afb Merged revisions 55817-55961 via svnmerge from
Guido van Rossum <guido@python.org>
parents: 40809
diff changeset
912
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
913
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
914 /* Sequence protocol:*/
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
915
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
916 PyAPI_FUNC(int) PySequence_Check(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
917
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
918 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
919 Return 1 if the object provides sequence protocol, and zero
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
920 otherwise.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
921
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
922 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
923 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
924
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
925 PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o);
13575
7c119f050290 change abstract size functions PySequence_Size &c.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 13444
diff changeset
926
3762
c57b38e40b2d Added prototype + doc for PySequence_Length()
Guido van Rossum <guido@python.org>
parents: 3098
diff changeset
927 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
928 Return the size of sequence object o, or -1 on failure.
3762
c57b38e40b2d Added prototype + doc for PySequence_Length()
Guido van Rossum <guido@python.org>
parents: 3098
diff changeset
929 */
c57b38e40b2d Added prototype + doc for PySequence_Length()
Guido van Rossum <guido@python.org>
parents: 3098
diff changeset
930
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
931 /* For DLL compatibility */
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
932 #undef PySequence_Length
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
933 PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o);
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
934 #define PySequence_Length PySequence_Size
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
935
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
936
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
937 PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
938
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
939 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
940 Return the concatenation of o1 and o2 on success, and NULL on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
941 failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
942 expression: o1+o2.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
943 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
944
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
945 PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
946
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
947 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
948 Return the result of repeating sequence object o count times,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
949 or NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
950 expression: o1*count.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
951 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
952
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
953 PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
954
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
955 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
956 Return the ith element of o, or NULL on failure. This is the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
957 equivalent of the Python expression: o[i].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
958 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
959
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
960 PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
961
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
962 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
963 Return the slice of sequence object o between i1 and i2, or
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
964 NULL on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
965 expression: o[i1:i2].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
966 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
967
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
968 PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
969
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
970 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
971 Assign object v to the ith element of o. Returns
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
972 -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
973 statement: o[i]=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
974 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
975
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
976 PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i);
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
977
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
978 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
979 Delete the ith element of object v. Returns
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
980 -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
981 statement: del o[i].
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
982 */
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
983
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
984 PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2,
37046
3342b3b58630 Whitespace changes. Also remove apply from a few comments
Neal Norwitz <nnorwitz@gmail.com>
parents: 36882
diff changeset
985 PyObject *v);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
986
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
987 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
988 Assign the sequence object, v, to the slice in sequence
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
989 object, o, from i1 to i2. Returns -1 on failure. This is the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
990 equivalent of the Python statement: o[i1:i2]=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
991 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
992
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
993 PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
994
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
995 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
996 Delete the slice in sequence object, o, from i1 to i2.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
997 Returns -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
998 statement: del o[i1:i2].
4090
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
999 */
0b40c8d5b21d Added PyObject_DelItem and PySequence_Del{Item,Slice}.
Guido van Rossum <guido@python.org>
parents: 3959
diff changeset
1000
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1001 PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1002
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1003 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1004 Returns the sequence, o, as a tuple on success, and NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1005 This is equivalent to the Python expression: tuple(o)
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1006 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1007
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1008
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1009 PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o);
4581
c837f25c7e47 Added missing for PySequence_List.
Guido van Rossum <guido@python.org>
parents: 4503
diff changeset
1010 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1011 Returns the sequence, o, as a list on success, and NULL on failure.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1012 This is equivalent to the Python expression: list(o)
4581
c837f25c7e47 Added missing for PySequence_List.
Guido van Rossum <guido@python.org>
parents: 4503
diff changeset
1013 */
5167
61f89beba1aa A few comment alignment and clarifications.
Guido van Rossum <guido@python.org>
parents: 5116
diff changeset
1014
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1015 PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m);
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1016 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1017 Returns the sequence, o, as a tuple, unless it's already a
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1018 tuple or list. Use PySequence_Fast_GET_ITEM to access the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1019 members of this list, and PySequence_Fast_GET_SIZE to get its length.
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1020
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1021 Returns NULL on failure. If the object does not support iteration,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1022 raises a TypeError exception with m as the message text.
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1023 */
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1024
20683
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the
Tim Peters <tim.peters@gmail.com>
parents: 19808
diff changeset
1025 #define PySequence_Fast_GET_SIZE(o) \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1026 (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o))
20683
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the
Tim Peters <tim.peters@gmail.com>
parents: 19808
diff changeset
1027 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1028 Return the size of o, assuming that o was returned by
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1029 PySequence_Fast and is not NULL.
20683
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the
Tim Peters <tim.peters@gmail.com>
parents: 19808
diff changeset
1030 */
505dd34e0eeb Generalize dictionary() to accept a sequence of 2-sequences. At the
Tim Peters <tim.peters@gmail.com>
parents: 19808
diff changeset
1031
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1032 #define PySequence_Fast_GET_ITEM(o, i)\
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1033 (PyList_Check(o) ? PyList_GET_ITEM(o, i) : PyTuple_GET_ITEM(o, i))
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1034 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1035 Return the ith element of o, assuming that o was returned by
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1036 PySequence_Fast, and that i is within bounds.
12952
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1037 */
51949de76365 Patch from /F:
Andrew M. Kuchling <amk@amk.ca>
parents: 11965
diff changeset
1038
23397
0d8740094bec Patch #552433: Special-case tuples. Avoid sub-type checking for lists.
Martin v. Löwis <martin@v.loewis.de>
parents: 21644
diff changeset
1039 #define PySequence_ITEM(o, i)\
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1040 ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) )
23397
0d8740094bec Patch #552433: Special-case tuples. Avoid sub-type checking for lists.
Martin v. Löwis <martin@v.loewis.de>
parents: 21644
diff changeset
1041 /* Assume tp_as_sequence and sq_item exist and that i does not
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1042 need to be corrected for a negative index
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1043 */
23397
0d8740094bec Patch #552433: Special-case tuples. Avoid sub-type checking for lists.
Martin v. Löwis <martin@v.loewis.de>
parents: 21644
diff changeset
1044
31650
be782d07c518 Make PySequence_Fast_ITEMS public. (Thanks Skip.)
Raymond Hettinger <python@rcn.com>
parents: 31645
diff changeset
1045 #define PySequence_Fast_ITEMS(sf) \
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1046 (PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1047 : ((PyTupleObject *)(sf))->ob_item)
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1048 /* Return a pointer to the underlying item array for
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1049 an object retured by PySequence_Fast */
31645
5760b4dd3a22 Use a new macro, PySequence_Fast_ITEMS to factor out code common to
Raymond Hettinger <python@rcn.com>
parents: 30723
diff changeset
1050
36834
0b7809660456 Change some sequnce APIs to use Py_ssize_t.
Neal Norwitz <nnorwitz@gmail.com>
parents: 36501
diff changeset
1051 PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1052
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1053 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1054 Return the number of occurrences on value on o, that is,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1055 return the number of keys for which o[key]==value. On
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1056 failure, return -1. This is equivalent to the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1057 expression: o.count(value).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1058 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1059
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1060 PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob);
17692
1812476b7fe4 Reimplement PySequence_Contains() and instance_contains(), so they work
Tim Peters <tim.peters@gmail.com>
parents: 17684
diff changeset
1061 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1062 Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1063 Use __contains__ if possible, else _PySequence_IterSearch().
17692
1812476b7fe4 Reimplement PySequence_Contains() and instance_contains(), so they work
Tim Peters <tim.peters@gmail.com>
parents: 17684
diff changeset
1064 */
1812476b7fe4 Reimplement PySequence_Contains() and instance_contains(), so they work
Tim Peters <tim.peters@gmail.com>
parents: 17684
diff changeset
1065
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
1066 #ifndef Py_LIMITED_API
19808
0584c9132525 Generalize operator.indexOf (PySequence_Index) to work with any
Tim Peters <tim.peters@gmail.com>
parents: 19051
diff changeset
1067 #define PY_ITERSEARCH_COUNT 1
0584c9132525 Generalize operator.indexOf (PySequence_Index) to work with any
Tim Peters <tim.peters@gmail.com>
parents: 19051
diff changeset
1068 #define PY_ITERSEARCH_INDEX 2
0584c9132525 Generalize operator.indexOf (PySequence_Index) to work with any
Tim Peters <tim.peters@gmail.com>
parents: 19051
diff changeset
1069 #define PY_ITERSEARCH_CONTAINS 3
36834
0b7809660456 Change some sequnce APIs to use Py_ssize_t.
Neal Norwitz <nnorwitz@gmail.com>
parents: 36501
diff changeset
1070 PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq,
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1071 PyObject *obj, int operation);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
1072 #endif
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1073 /*
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1074 Iterate over seq. Result depends on the operation:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1075 PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1076 error.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1077 PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1078 obj in seq; set ValueError and return -1 if none found;
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1079 also return -1 on error.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1080 PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1081 error.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1082 */
10412
e9e69b02d0f0 Add DLL level b/w compat for PySequence_In and PyEval_CallObject
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
1083
e9e69b02d0f0 Add DLL level b/w compat for PySequence_In and PyEval_CallObject
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
1084 /* For DLL-level backwards compatibility */
e9e69b02d0f0 Add DLL level b/w compat for PySequence_In and PyEval_CallObject
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
1085 #undef PySequence_In
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1086 PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value);
10412
e9e69b02d0f0 Add DLL level b/w compat for PySequence_In and PyEval_CallObject
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
1087
e9e69b02d0f0 Add DLL level b/w compat for PySequence_In and PyEval_CallObject
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
1088 /* For source-level backwards compatibility */
9031
d2722a4cbd9c Move an indented #define to column 1.
Guido van Rossum <guido@python.org>
parents: 8401
diff changeset
1089 #define PySequence_In PySequence_Contains
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1090
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1091 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1092 Determine if o contains value. If an item in o is equal to
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1093 X, return 1, otherwise return 0. On error, return -1. This
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1094 is equivalent to the Python expression: value in o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1095 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1096
36834
0b7809660456 Change some sequnce APIs to use Py_ssize_t.
Neal Norwitz <nnorwitz@gmail.com>
parents: 36501
diff changeset
1097 PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1098
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1099 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1100 Return the first index for which o[i]=value. On error,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1101 return -1. This is equivalent to the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1102 expression: o.index(value).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1103 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1104
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1105 /* In-place versions of some of the above Sequence functions. */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1106
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1107 PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1108
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1109 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1110 Append o2 to o1, in-place when possible. Return the resulting
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1111 object, which could be o1, or NULL on failure. This is the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1112 equivalent of the Python expression: o1 += o2.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1113
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1114 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1115
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
1116 PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count);
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1117
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1118 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1119 Repeat o1 by count, in-place when possible. Return the resulting
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1120 object, which could be o1, or NULL on failure. This is the
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1121 equivalent of the Python expression: o1 *= count.
14162
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1122
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1123 */
27d7d89c774b The real suport for augmented assignment: new opcodes, new PyNumber and
Thomas Wouters <thomas@python.org>
parents: 13830
diff changeset
1124
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1125 /* Mapping protocol:*/
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1126
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1127 PyAPI_FUNC(int) PyMapping_Check(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1128
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1129 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1130 Return 1 if the object provides mapping protocol, and zero
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1131 otherwise.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1132
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1133 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1134 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1135
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
1136 PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o);
13575
7c119f050290 change abstract size functions PySequence_Size &c.
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 13444
diff changeset
1137
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1138 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1139 Returns the number of keys in object o on success, and -1 on
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1140 failure. For objects that do not provide sequence protocol,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1141 this is equivalent to the Python expression: len(o).
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1142 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1143
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
1144 /* For DLL compatibility */
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
1145 #undef PyMapping_Length
36501
7fdc639bc5b4 Merge ssize_t branch.
Martin v. Löwis <martin@v.loewis.de>
parents: 36484
diff changeset
1146 PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o);
13634
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
1147 #define PyMapping_Length PyMapping_Size
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
1148
6f0d96e6b5a5 Restore PyXXX_Length() APIs for binary compatibility.
Marc-André Lemburg <mal@egenix.com>
parents: 13620
diff changeset
1149
4218
9e0e8417a98a PyMapping_DelItem[String] are actually macros.
Guido van Rossum <guido@python.org>
parents: 4217
diff changeset
1150 /* implemented as a macro:
9e0e8417a98a PyMapping_DelItem[String] are actually macros.
Guido van Rossum <guido@python.org>
parents: 4217
diff changeset
1151
13444
5709ddba423c ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents: 13256
diff changeset
1152 int PyMapping_DelItemString(PyObject *o, char *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1153
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1154 Remove the mapping for object, key, from the object *o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1155 Returns -1 on failure. This is equivalent to
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1156 the Python statement: del o[key].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1157 */
21069
7d3a211ef233 Fix SF bug [ #476852 ] Some bad macros in abstract.h
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20946
diff changeset
1158 #define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K))
4218
9e0e8417a98a PyMapping_DelItem[String] are actually macros.
Guido van Rossum <guido@python.org>
parents: 4217
diff changeset
1159
9e0e8417a98a PyMapping_DelItem[String] are actually macros.
Guido van Rossum <guido@python.org>
parents: 4217
diff changeset
1160 /* implemented as a macro:
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1161
13444
5709ddba423c ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents: 13256
diff changeset
1162 int PyMapping_DelItem(PyObject *o, PyObject *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1163
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1164 Remove the mapping for object, key, from the object *o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1165 Returns -1 on failure. This is equivalent to
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1166 the Python statement: del o[key].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1167 */
21069
7d3a211ef233 Fix SF bug [ #476852 ] Some bad macros in abstract.h
Jeremy Hylton <jeremy@alum.mit.edu>
parents: 20946
diff changeset
1168 #define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K))
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1169
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1170 PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, char *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1171
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1172 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1173 On success, return 1 if the mapping object has the key, key,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1174 and 0 otherwise. This is equivalent to the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1175 key in o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1176
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1177 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1178 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1179
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1180 PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1181
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1182 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1183 Return 1 if the mapping object has the key, key,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1184 and 0 otherwise. This is equivalent to the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1185 key in o.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1186
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1187 This function always succeeds.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1188
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1189 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1190
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1191 PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1192
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1193 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1194 On success, return a list or tuple of the keys in object o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1195 On failure, return NULL.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1196 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1197
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1198 PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1199
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1200 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1201 On success, return a list or tuple of the values in object o.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1202 On failure, return NULL.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1203 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1204
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1205 PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1206
40809
f340cb045bf9 - PEP 3106: dict.iterkeys(), .iteritems(), .itervalues() are now gone;
Guido van Rossum <guido@python.org>
parents: 40626
diff changeset
1207 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1208 On success, return a list or tuple of the items in object o,
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1209 where each item is a tuple containing a key-value pair.
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1210 On failure, return NULL.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1211
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1212 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1213
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1214 PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o, char *key);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1215
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1216 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1217 Return element of o corresponding to the object, key, or NULL
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1218 on failure. This is the equivalent of the Python expression:
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1219 o[key].
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1220 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1221
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1222 PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, char *key,
13444
5709ddba423c ANSI-fication and Py_PROTO extermination.
Fred Drake <fdrake@acm.org>
parents: 13256
diff changeset
1223 PyObject *value);
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1224
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1225 /*
61467
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1226 Map the object, key, to the value, v. Returns
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1227 -1 on failure. This is the equivalent of the Python
f197407bdba2 Recorded merge of revisions 81032 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 55596
diff changeset
1228 statement: o[key]=v.
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1229 */
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1230
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1231
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1232 PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass);
17111
bf678a11c21a Move the code implementing isinstance() and issubclass() to new C
Guido van Rossum <guido@python.org>
parents: 15952
diff changeset
1233 /* isinstance(object, typeorclass) */
bf678a11c21a Move the code implementing isinstance() and issubclass() to new C
Guido van Rossum <guido@python.org>
parents: 15952
diff changeset
1234
24752
c1eb668525e1 Excise DL_EXPORT from Include.
Mark Hammond <mhammond@skippinet.com.au>
parents: 23397
diff changeset
1235 PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass);
17111
bf678a11c21a Move the code implementing isinstance() and issubclass() to new C
Guido van Rossum <guido@python.org>
parents: 15952
diff changeset
1236 /* issubclass(object, typeorclass) */
bf678a11c21a Move the code implementing isinstance() and issubclass() to new C
Guido van Rossum <guido@python.org>
parents: 15952
diff changeset
1237
bf678a11c21a Move the code implementing isinstance() and issubclass() to new C
Guido van Rossum <guido@python.org>
parents: 15952
diff changeset
1238
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
1239 #ifndef Py_LIMITED_API
48875
d6e86a96f9b3 Issue #2534: speed up isinstance() and issubclass() by 50-70%, so as to
Antoine Pitrou <solipsis@pitrou.net>
parents: 48683
diff changeset
1240 PyAPI_FUNC(int) _PyObject_RealIsInstance(PyObject *inst, PyObject *cls);
d6e86a96f9b3 Issue #2534: speed up isinstance() and issubclass() by 50-70%, so as to
Antoine Pitrou <solipsis@pitrou.net>
parents: 48683
diff changeset
1241
d6e86a96f9b3 Issue #2534: speed up isinstance() and issubclass() by 50-70%, so as to
Antoine Pitrou <solipsis@pitrou.net>
parents: 48683
diff changeset
1242 PyAPI_FUNC(int) _PyObject_RealIsSubclass(PyObject *derived, PyObject *cls);
d6e86a96f9b3 Issue #2534: speed up isinstance() and issubclass() by 50-70%, so as to
Antoine Pitrou <solipsis@pitrou.net>
parents: 48683
diff changeset
1243
59605
768722b2ae0a * Replaces the internals of the subprocess module from fork through exec on
Gregory P. Smith <greg@mad-scientist.com>
parents: 55596
diff changeset
1244 PyAPI_FUNC(char *const *) _PySequence_BytesToCharpArray(PyObject* self);
768722b2ae0a * Replaces the internals of the subprocess module from fork through exec on
Gregory P. Smith <greg@mad-scientist.com>
parents: 55596
diff changeset
1245
768722b2ae0a * Replaces the internals of the subprocess module from fork through exec on
Gregory P. Smith <greg@mad-scientist.com>
parents: 55596
diff changeset
1246 PyAPI_FUNC(void) _Py_FreeCharPArray(char *const array[]);
66664
62b61abd02b8 Merge branches/pep-0384.
Martin v. Löwis <martin@v.loewis.de>
parents: 64343
diff changeset
1247 #endif
48875
d6e86a96f9b3 Issue #2534: speed up isinstance() and issubclass() by 50-70%, so as to
Antoine Pitrou <solipsis@pitrou.net>
parents: 48683
diff changeset
1248
64344
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1249 /* For internal use by buffer API functions */
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1250 PyAPI_FUNC(void) _Py_add_one_to_index_F(int nd, Py_ssize_t *index,
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1251 const Py_ssize_t *shape);
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1252 PyAPI_FUNC(void) _Py_add_one_to_index_C(int nd, Py_ssize_t *index,
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1253 const Py_ssize_t *shape);
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1254
b3b8d08f9d06 Merged revisions 84391 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 61467
diff changeset
1255
3098
4c83f569b434 use Py_PROTO macro
Guido van Rossum <guido@python.org>
parents: 2838
diff changeset
1256 #ifdef __cplusplus
4c83f569b434 use Py_PROTO macro
Guido van Rossum <guido@python.org>
parents: 2838
diff changeset
1257 }
4c83f569b434 use Py_PROTO macro
Guido van Rossum <guido@python.org>
parents: 2838
diff changeset
1258 #endif
2838
9b1a326727df Generic Abstract Object Interface
Guido van Rossum <guido@python.org>
parents:
diff changeset
1259 #endif /* Py_ABSTRACTOBJECT_H */