blob: fd98efdbe7d64044989f89f8919b4e377cd1822d [file] [log] [blame]
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001
2#include "Python.h"
3
4PyDoc_STRVAR(operator_doc,
5"Operator interface.\n\
Guido van Rossum037b9401996-07-30 16:55:54 +00006\n\
7This module exports a set of functions implemented in C corresponding\n\
8to the intrinsic operators of Python. For example, operator.add(x, y)\n\
9is equivalent to the expression x+y. The function names are those\n\
10used for special class methods; variants without leading and trailing\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000011'__' are also provided for convenience.");
Guido van Rossum037b9401996-07-30 16:55:54 +000012
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +000013#define spam1(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a1) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000014 return AOP(a1); }
15
Fred Drake5639ba42000-07-08 04:12:08 +000016#define spam2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000017 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000018 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000019 return AOP(a1,a2); }
20
Fred Drake5639ba42000-07-08 04:12:08 +000021#define spamoi(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000022 PyObject *a1; int a2; \
Fred Drakeea4d3f02000-09-17 16:09:27 +000023 if(! PyArg_ParseTuple(a,"Oi:" #OP,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000024 return AOP(a1,a2); }
25
Fred Drake5639ba42000-07-08 04:12:08 +000026#define spam2n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000027 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000028 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000029 if(-1 == AOP(a1,a2)) return NULL; \
30 Py_INCREF(Py_None); \
31 return Py_None; }
32
Fred Drake5639ba42000-07-08 04:12:08 +000033#define spam3n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000034 PyObject *a1, *a2, *a3; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000035 if(! PyArg_UnpackTuple(a,#OP,3,3,&a1,&a2,&a3)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000036 if(-1 == AOP(a1,a2,a3)) return NULL; \
37 Py_INCREF(Py_None); \
38 return Py_None; }
39
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +000040#define spami(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a1) { \
41 long r; \
Guido van Rossum037b9401996-07-30 16:55:54 +000042 if(-1 == (r=AOP(a1))) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000043 return PyBool_FromLong(r); }
Guido van Rossum037b9401996-07-30 16:55:54 +000044
Fred Drake5639ba42000-07-08 04:12:08 +000045#define spami2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000046 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000047 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000048 if(-1 == (r=AOP(a1,a2))) return NULL; \
49 return PyInt_FromLong(r); }
50
Martin v. Löwis26fd9602006-04-22 11:15:41 +000051#define spamn2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
52 PyObject *a1, *a2; Py_ssize_t r; \
53 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
54 if(-1 == (r=AOP(a1,a2))) return NULL; \
55 return PyInt_FromSsize_t(r); }
56
Guido van Rossum77f6a652002-04-03 22:41:51 +000057#define spami2b(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
58 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000059 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000060 if(-1 == (r=AOP(a1,a2))) return NULL; \
61 return PyBool_FromLong(r); }
62
Fred Drake428e75f2001-08-09 20:14:34 +000063#define spamrc(OP,A) static PyObject *OP(PyObject *s, PyObject *a) { \
64 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000065 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Fred Drake428e75f2001-08-09 20:14:34 +000066 return PyObject_RichCompare(a1,a2,A); }
67
Guido van Rossum037b9401996-07-30 16:55:54 +000068spami(isCallable , PyCallable_Check)
69spami(isNumberType , PyNumber_Check)
70spami(truth , PyObject_IsTrue)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000071spam2(op_add , PyNumber_Add)
72spam2(op_sub , PyNumber_Subtract)
73spam2(op_mul , PyNumber_Multiply)
74spam2(op_div , PyNumber_Divide)
Fred Drake428e75f2001-08-09 20:14:34 +000075spam2(op_floordiv , PyNumber_FloorDivide)
76spam2(op_truediv , PyNumber_TrueDivide)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000077spam2(op_mod , PyNumber_Remainder)
78spam1(op_neg , PyNumber_Negative)
79spam1(op_pos , PyNumber_Positive)
80spam1(op_abs , PyNumber_Absolute)
81spam1(op_inv , PyNumber_Invert)
Fred Drakeea4d3f02000-09-17 16:09:27 +000082spam1(op_invert , PyNumber_Invert)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000083spam2(op_lshift , PyNumber_Lshift)
84spam2(op_rshift , PyNumber_Rshift)
Guido van Rossum99c185e1998-04-09 17:54:26 +000085spami(op_not_ , PyObject_Not)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000086spam2(op_and_ , PyNumber_And)
87spam2(op_xor , PyNumber_Xor)
88spam2(op_or_ , PyNumber_Or)
Armin Rigof5bd3b42005-12-29 16:50:42 +000089spam2(op_iadd , PyNumber_InPlaceAdd)
90spam2(op_isub , PyNumber_InPlaceSubtract)
91spam2(op_imul , PyNumber_InPlaceMultiply)
92spam2(op_idiv , PyNumber_InPlaceDivide)
93spam2(op_ifloordiv , PyNumber_InPlaceFloorDivide)
94spam2(op_itruediv , PyNumber_InPlaceTrueDivide)
95spam2(op_imod , PyNumber_InPlaceRemainder)
96spam2(op_ilshift , PyNumber_InPlaceLshift)
97spam2(op_irshift , PyNumber_InPlaceRshift)
98spam2(op_iand , PyNumber_InPlaceAnd)
99spam2(op_ixor , PyNumber_InPlaceXor)
100spam2(op_ior , PyNumber_InPlaceOr)
Guido van Rossum037b9401996-07-30 16:55:54 +0000101spami(isSequenceType , PySequence_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000102spam2(op_concat , PySequence_Concat)
103spamoi(op_repeat , PySequence_Repeat)
Armin Rigof5bd3b42005-12-29 16:50:42 +0000104spam2(op_iconcat , PySequence_InPlaceConcat)
105spamoi(op_irepeat , PySequence_InPlaceRepeat)
Guido van Rossum77f6a652002-04-03 22:41:51 +0000106spami2b(op_contains , PySequence_Contains)
107spami2b(sequenceIncludes, PySequence_Contains)
Martin v. Löwis26fd9602006-04-22 11:15:41 +0000108spamn2(indexOf , PySequence_Index)
109spamn2(countOf , PySequence_Count)
Guido van Rossum037b9401996-07-30 16:55:54 +0000110spami(isMappingType , PyMapping_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000111spam2(op_getitem , PyObject_GetItem)
112spam2n(op_delitem , PyObject_DelItem)
113spam3n(op_setitem , PyObject_SetItem)
Fred Drake428e75f2001-08-09 20:14:34 +0000114spamrc(op_lt , Py_LT)
115spamrc(op_le , Py_LE)
116spamrc(op_eq , Py_EQ)
117spamrc(op_ne , Py_NE)
118spamrc(op_gt , Py_GT)
119spamrc(op_ge , Py_GE)
Guido van Rossum037b9401996-07-30 16:55:54 +0000120
121static PyObject*
Raymond Hettinger5959c552002-08-19 03:19:09 +0000122op_pow(PyObject *s, PyObject *a)
123{
124 PyObject *a1, *a2;
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000125 if (PyArg_UnpackTuple(a,"pow", 2, 2, &a1, &a2))
Raymond Hettinger5959c552002-08-19 03:19:09 +0000126 return PyNumber_Power(a1, a2, Py_None);
127 return NULL;
128}
129
130static PyObject*
Armin Rigof5bd3b42005-12-29 16:50:42 +0000131op_ipow(PyObject *s, PyObject *a)
132{
133 PyObject *a1, *a2;
134 if (PyArg_UnpackTuple(a,"ipow", 2, 2, &a1, &a2))
135 return PyNumber_InPlacePower(a1, a2, Py_None);
136 return NULL;
137}
138
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000139static PyObject *
140op_index(PyObject *s, PyObject *a)
141{
Neal Norwitz8a87f5d2006-08-12 17:03:09 +0000142 return PyNumber_Index(a);
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000143}
144
Armin Rigof5bd3b42005-12-29 16:50:42 +0000145static PyObject*
Raymond Hettinger9543b342003-01-18 23:22:20 +0000146is_(PyObject *s, PyObject *a)
147{
148 PyObject *a1, *a2, *result = NULL;
149 if (PyArg_UnpackTuple(a,"is_", 2, 2, &a1, &a2)) {
150 result = (a1 == a2) ? Py_True : Py_False;
151 Py_INCREF(result);
152 }
153 return result;
154}
155
156static PyObject*
157is_not(PyObject *s, PyObject *a)
158{
159 PyObject *a1, *a2, *result = NULL;
160 if (PyArg_UnpackTuple(a,"is_not", 2, 2, &a1, &a2)) {
161 result = (a1 != a2) ? Py_True : Py_False;
162 Py_INCREF(result);
163 }
164 return result;
165}
166
167static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000168op_getslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000169{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000170 PyObject *a1;
Georg Brandl40c62612007-03-06 18:59:11 +0000171 Py_ssize_t a2, a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000172
Georg Brandl40c62612007-03-06 18:59:11 +0000173 if (!PyArg_ParseTuple(a, "Onn:getslice", &a1, &a2, &a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000174 return NULL;
Georg Brandl40c62612007-03-06 18:59:11 +0000175 return PySequence_GetSlice(a1, a2, a3);
Guido van Rossum037b9401996-07-30 16:55:54 +0000176}
177
178static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000179op_setslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000180{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000181 PyObject *a1, *a4;
Georg Brandl40c62612007-03-06 18:59:11 +0000182 Py_ssize_t a2, a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000183
Georg Brandl40c62612007-03-06 18:59:11 +0000184 if (!PyArg_ParseTuple(a, "OnnO:setslice", &a1, &a2, &a3, &a4))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000185 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000186
Georg Brandl40c62612007-03-06 18:59:11 +0000187 if (-1 == PySequence_SetSlice(a1, a2, a3, a4))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000188 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000189
Georg Brandl40c62612007-03-06 18:59:11 +0000190 Py_RETURN_NONE;
Guido van Rossum037b9401996-07-30 16:55:54 +0000191}
192
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000193static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000194op_delslice(PyObject *s, PyObject *a)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000195{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000196 PyObject *a1;
Georg Brandl40c62612007-03-06 18:59:11 +0000197 Py_ssize_t a2, a3;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000198
Georg Brandl40c62612007-03-06 18:59:11 +0000199 if (!PyArg_ParseTuple(a, "Onn:delslice", &a1, &a2, &a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000200 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000201
Georg Brandl40c62612007-03-06 18:59:11 +0000202 if (-1 == PySequence_DelSlice(a1, a2, a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000203 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000204
Georg Brandl40c62612007-03-06 18:59:11 +0000205 Py_RETURN_NONE;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000206}
207
Guido van Rossum037b9401996-07-30 16:55:54 +0000208#undef spam1
209#undef spam2
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000210#undef spam1o
211#undef spam1o
Neal Norwitz200788c2002-08-13 22:20:41 +0000212#define spam1(OP,DOC) {#OP, OP, METH_VARARGS, PyDoc_STR(DOC)},
Armin Rigoc4308d52005-12-29 14:39:28 +0000213#define spam2(OP,ALTOP,DOC) {#OP, op_##OP, METH_VARARGS, PyDoc_STR(DOC)}, \
Neal Norwitz200788c2002-08-13 22:20:41 +0000214 {#ALTOP, op_##OP, METH_VARARGS, PyDoc_STR(DOC)},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000215#define spam1o(OP,DOC) {#OP, OP, METH_O, PyDoc_STR(DOC)},
Armin Rigoc4308d52005-12-29 14:39:28 +0000216#define spam2o(OP,ALTOP,DOC) {#OP, op_##OP, METH_O, PyDoc_STR(DOC)}, \
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000217 {#ALTOP, op_##OP, METH_O, PyDoc_STR(DOC)},
Guido van Rossum037b9401996-07-30 16:55:54 +0000218
219static struct PyMethodDef operator_methods[] = {
Guido van Rossum037b9401996-07-30 16:55:54 +0000220
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000221spam1o(isCallable,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000222 "isCallable(a) -- Same as callable(a).")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000223spam1o(isNumberType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000224 "isNumberType(a) -- Return True if a has a numeric type, False otherwise.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000225spam1o(isSequenceType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000226 "isSequenceType(a) -- Return True if a has a sequence type, False otherwise.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000227spam1o(truth,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000228 "truth(a) -- Return True if a is true, False otherwise.")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000229spam2(contains,__contains__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000230 "contains(a, b) -- Same as b in a (note reversed operands).")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000231spam1(sequenceIncludes,
232 "sequenceIncludes(a, b) -- Same as b in a (note reversed operands; deprecated).")
Guido van Rossum17202301996-08-19 22:01:39 +0000233spam1(indexOf,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000234 "indexOf(a, b) -- Return the first index of b in a.")
Guido van Rossum17202301996-08-19 22:01:39 +0000235spam1(countOf,
236 "countOf(a, b) -- Return the number of times b occurs in a.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000237spam1o(isMappingType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000238 "isMappingType(a) -- Return True if a has a mapping type, False otherwise.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000239
Raymond Hettinger9543b342003-01-18 23:22:20 +0000240spam1(is_, "is_(a, b) -- Same as a is b.")
241spam1(is_not, "is_not(a, b) -- Same as a is not b.")
Neal Norwitz8a87f5d2006-08-12 17:03:09 +0000242spam2o(index, __index__, "index(a) -- Same as a.__index__()")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000243spam2(add,__add__, "add(a, b) -- Same as a + b.")
244spam2(sub,__sub__, "sub(a, b) -- Same as a - b.")
245spam2(mul,__mul__, "mul(a, b) -- Same as a * b.")
Fred Drake428e75f2001-08-09 20:14:34 +0000246spam2(div,__div__, "div(a, b) -- Same as a / b when __future__.division is not in effect.")
247spam2(floordiv,__floordiv__, "floordiv(a, b) -- Same as a // b.")
248spam2(truediv,__truediv__, "truediv(a, b) -- Same as a / b when __future__.division is in effect.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000249spam2(mod,__mod__, "mod(a, b) -- Same as a % b.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000250spam2o(neg,__neg__, "neg(a) -- Same as -a.")
251spam2o(pos,__pos__, "pos(a) -- Same as +a.")
252spam2o(abs,__abs__, "abs(a) -- Same as abs(a).")
253spam2o(inv,__inv__, "inv(a) -- Same as ~a.")
254spam2o(invert,__invert__, "invert(a) -- Same as ~a.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000255spam2(lshift,__lshift__, "lshift(a, b) -- Same as a << b.")
256spam2(rshift,__rshift__, "rshift(a, b) -- Same as a >> b.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000257spam2o(not_,__not__, "not_(a) -- Same as not a.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000258spam2(and_,__and__, "and_(a, b) -- Same as a & b.")
259spam2(xor,__xor__, "xor(a, b) -- Same as a ^ b.")
260spam2(or_,__or__, "or_(a, b) -- Same as a | b.")
Armin Rigof5bd3b42005-12-29 16:50:42 +0000261spam2(iadd,__iadd__, "iadd(a, b) -- Same as a += b.")
262spam2(isub,__isub__, "isub(a, b) -- Same as a -= b.")
263spam2(imul,__imul__, "imul(a, b) -- Same as a *= b.")
264spam2(idiv,__idiv__, "idiv(a, b) -- Same as a /= b when __future__.division is not in effect.")
265spam2(ifloordiv,__ifloordiv__, "ifloordiv(a, b) -- Same as a //= b.")
266spam2(itruediv,__itruediv__, "itruediv(a, b) -- Same as a /= b when __future__.division is in effect.")
267spam2(imod,__imod__, "imod(a, b) -- Same as a %= b.")
268spam2(ilshift,__ilshift__, "ilshift(a, b) -- Same as a <<= b.")
269spam2(irshift,__irshift__, "irshift(a, b) -- Same as a >>= b.")
270spam2(iand,__iand__, "iand(a, b) -- Same as a &= b.")
271spam2(ixor,__ixor__, "ixor(a, b) -- Same as a ^= b.")
272spam2(ior,__ior__, "ior(a, b) -- Same as a |= b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000273spam2(concat,__concat__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000274 "concat(a, b) -- Same as a + b, for a and b sequences.")
Guido van Rossum17202301996-08-19 22:01:39 +0000275spam2(repeat,__repeat__,
Guido van Rossum36a484f1996-12-05 19:01:16 +0000276 "repeat(a, b) -- Return a * b, where a is a sequence, and b is an integer.")
Armin Rigof5bd3b42005-12-29 16:50:42 +0000277spam2(iconcat,__iconcat__,
278 "iconcat(a, b) -- Same as a += b, for a and b sequences.")
279spam2(irepeat,__irepeat__,
280 "irepeat(a, b) -- Same as a *= b, where a is a sequence, and b is an integer.")
Guido van Rossum17202301996-08-19 22:01:39 +0000281spam2(getitem,__getitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000282 "getitem(a, b) -- Same as a[b].")
Guido van Rossum17202301996-08-19 22:01:39 +0000283spam2(setitem,__setitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000284 "setitem(a, b, c) -- Same as a[b] = c.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000285spam2(delitem,__delitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000286 "delitem(a, b) -- Same as del a[b].")
Armin Rigof5bd3b42005-12-29 16:50:42 +0000287spam2(pow,__pow__, "pow(a, b) -- Same as a ** b.")
288spam2(ipow,__ipow__, "ipow(a, b) -- Same as a **= b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000289spam2(getslice,__getslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000290 "getslice(a, b, c) -- Same as a[b:c].")
Guido van Rossum17202301996-08-19 22:01:39 +0000291spam2(setslice,__setslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000292"setslice(a, b, c, d) -- Same as a[b:c] = d.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000293spam2(delslice,__delslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000294"delslice(a, b, c) -- Same as del a[b:c].")
Fred Drake428e75f2001-08-09 20:14:34 +0000295spam2(lt,__lt__, "lt(a, b) -- Same as a<b.")
296spam2(le,__le__, "le(a, b) -- Same as a<=b.")
297spam2(eq,__eq__, "eq(a, b) -- Same as a==b.")
298spam2(ne,__ne__, "ne(a, b) -- Same as a!=b.")
299spam2(gt,__gt__, "gt(a, b) -- Same as a>b.")
300spam2(ge,__ge__, "ge(a, b) -- Same as a>=b.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000301
Guido van Rossum037b9401996-07-30 16:55:54 +0000302 {NULL, NULL} /* sentinel */
303
Guido van Rossum037b9401996-07-30 16:55:54 +0000304};
305
Raymond Hettinger166958b2003-12-01 13:18:39 +0000306/* itemgetter object **********************************************************/
Guido van Rossum037b9401996-07-30 16:55:54 +0000307
Raymond Hettinger166958b2003-12-01 13:18:39 +0000308typedef struct {
309 PyObject_HEAD
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000310 Py_ssize_t nitems;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000311 PyObject *item;
312} itemgetterobject;
313
314static PyTypeObject itemgetter_type;
315
316static PyObject *
317itemgetter_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
318{
319 itemgetterobject *ig;
320 PyObject *item;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000321 Py_ssize_t nitems;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000322
Georg Brandl02c42872005-08-26 06:42:30 +0000323 if (!_PyArg_NoKeywords("itemgetter()", kwds))
324 return NULL;
325
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000326 nitems = PyTuple_GET_SIZE(args);
327 if (nitems <= 1) {
328 if (!PyArg_UnpackTuple(args, "itemgetter", 1, 1, &item))
329 return NULL;
330 } else
331 item = args;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000332
333 /* create itemgetterobject structure */
334 ig = PyObject_GC_New(itemgetterobject, &itemgetter_type);
335 if (ig == NULL)
336 return NULL;
337
338 Py_INCREF(item);
339 ig->item = item;
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000340 ig->nitems = nitems;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000341
342 PyObject_GC_Track(ig);
343 return (PyObject *)ig;
344}
345
346static void
347itemgetter_dealloc(itemgetterobject *ig)
348{
349 PyObject_GC_UnTrack(ig);
350 Py_XDECREF(ig->item);
351 PyObject_GC_Del(ig);
352}
353
354static int
355itemgetter_traverse(itemgetterobject *ig, visitproc visit, void *arg)
356{
Thomas Woutersc6e55062006-04-15 21:47:09 +0000357 Py_VISIT(ig->item);
Raymond Hettinger166958b2003-12-01 13:18:39 +0000358 return 0;
359}
360
361static PyObject *
362itemgetter_call(itemgetterobject *ig, PyObject *args, PyObject *kw)
363{
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000364 PyObject *obj, *result;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000365 Py_ssize_t i, nitems=ig->nitems;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000366
367 if (!PyArg_UnpackTuple(args, "itemgetter", 1, 1, &obj))
368 return NULL;
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000369 if (nitems == 1)
370 return PyObject_GetItem(obj, ig->item);
371
372 assert(PyTuple_Check(ig->item));
373 assert(PyTuple_GET_SIZE(ig->item) == nitems);
374
375 result = PyTuple_New(nitems);
376 if (result == NULL)
377 return NULL;
378
379 for (i=0 ; i < nitems ; i++) {
380 PyObject *item, *val;
381 item = PyTuple_GET_ITEM(ig->item, i);
382 val = PyObject_GetItem(obj, item);
383 if (val == NULL) {
384 Py_DECREF(result);
385 return NULL;
386 }
387 PyTuple_SET_ITEM(result, i, val);
388 }
389 return result;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000390}
391
392PyDoc_STRVAR(itemgetter_doc,
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000393"itemgetter(item, ...) --> itemgetter object\n\
Raymond Hettinger166958b2003-12-01 13:18:39 +0000394\n\
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000395Return a callable object that fetches the given item(s) from its operand.\n\
396After, f=itemgetter(2), the call f(r) returns r[2].\n\
397After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])");
Raymond Hettinger166958b2003-12-01 13:18:39 +0000398
399static PyTypeObject itemgetter_type = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000400 PyVarObject_HEAD_INIT(NULL, 0)
Raymond Hettingerbd3a2402003-12-04 22:17:49 +0000401 "operator.itemgetter", /* tp_name */
Raymond Hettinger166958b2003-12-01 13:18:39 +0000402 sizeof(itemgetterobject), /* tp_basicsize */
403 0, /* tp_itemsize */
404 /* methods */
405 (destructor)itemgetter_dealloc, /* tp_dealloc */
406 0, /* tp_print */
407 0, /* tp_getattr */
408 0, /* tp_setattr */
409 0, /* tp_compare */
410 0, /* tp_repr */
411 0, /* tp_as_number */
412 0, /* tp_as_sequence */
413 0, /* tp_as_mapping */
414 0, /* tp_hash */
415 (ternaryfunc)itemgetter_call, /* tp_call */
416 0, /* tp_str */
417 PyObject_GenericGetAttr, /* tp_getattro */
418 0, /* tp_setattro */
419 0, /* tp_as_buffer */
420 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
421 itemgetter_doc, /* tp_doc */
422 (traverseproc)itemgetter_traverse, /* tp_traverse */
423 0, /* tp_clear */
424 0, /* tp_richcompare */
425 0, /* tp_weaklistoffset */
426 0, /* tp_iter */
427 0, /* tp_iternext */
428 0, /* tp_methods */
429 0, /* tp_members */
430 0, /* tp_getset */
431 0, /* tp_base */
432 0, /* tp_dict */
433 0, /* tp_descr_get */
434 0, /* tp_descr_set */
435 0, /* tp_dictoffset */
436 0, /* tp_init */
437 0, /* tp_alloc */
438 itemgetter_new, /* tp_new */
439 0, /* tp_free */
440};
441
442
443/* attrgetter object **********************************************************/
444
445typedef struct {
446 PyObject_HEAD
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000447 Py_ssize_t nattrs;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000448 PyObject *attr;
449} attrgetterobject;
450
451static PyTypeObject attrgetter_type;
452
453static PyObject *
454attrgetter_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
455{
456 attrgetterobject *ag;
457 PyObject *attr;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000458 Py_ssize_t nattrs;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000459
Georg Brandl02c42872005-08-26 06:42:30 +0000460 if (!_PyArg_NoKeywords("attrgetter()", kwds))
461 return NULL;
462
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000463 nattrs = PyTuple_GET_SIZE(args);
464 if (nattrs <= 1) {
465 if (!PyArg_UnpackTuple(args, "attrgetter", 1, 1, &attr))
466 return NULL;
467 } else
468 attr = args;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000469
470 /* create attrgetterobject structure */
471 ag = PyObject_GC_New(attrgetterobject, &attrgetter_type);
472 if (ag == NULL)
473 return NULL;
474
475 Py_INCREF(attr);
476 ag->attr = attr;
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000477 ag->nattrs = nattrs;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000478
479 PyObject_GC_Track(ag);
480 return (PyObject *)ag;
481}
482
483static void
484attrgetter_dealloc(attrgetterobject *ag)
485{
486 PyObject_GC_UnTrack(ag);
487 Py_XDECREF(ag->attr);
488 PyObject_GC_Del(ag);
489}
490
491static int
492attrgetter_traverse(attrgetterobject *ag, visitproc visit, void *arg)
493{
Thomas Woutersc6e55062006-04-15 21:47:09 +0000494 Py_VISIT(ag->attr);
Raymond Hettinger166958b2003-12-01 13:18:39 +0000495 return 0;
496}
497
498static PyObject *
Georg Brandle2065c62008-02-23 23:02:23 +0000499dotted_getattr(PyObject *obj, PyObject *attr)
500{
501 char *s, *p;
502
503#ifdef Py_USING_UNICODE
504 if (PyUnicode_Check(attr)) {
505 attr = _PyUnicode_AsDefaultEncodedString(attr, NULL);
506 if (attr == NULL)
507 return NULL;
508 }
509#endif
510
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000511 if (!PyString_Check(attr)) {
Georg Brandle2065c62008-02-23 23:02:23 +0000512 PyErr_SetString(PyExc_TypeError,
513 "attribute name must be a string");
514 return NULL;
515 }
516
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000517 s = PyString_AS_STRING(attr);
Georg Brandle2065c62008-02-23 23:02:23 +0000518 Py_INCREF(obj);
519 for (;;) {
520 PyObject *newobj, *str;
521 p = strchr(s, '.');
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000522 str = p ? PyString_FromStringAndSize(s, (p-s)) :
523 PyString_FromString(s);
Georg Brandle2065c62008-02-23 23:02:23 +0000524 if (str == NULL) {
525 Py_DECREF(obj);
526 return NULL;
527 }
528 newobj = PyObject_GetAttr(obj, str);
529 Py_DECREF(str);
530 Py_DECREF(obj);
531 if (newobj == NULL)
532 return NULL;
533 obj = newobj;
534 if (p == NULL) break;
535 s = p+1;
536 }
537
538 return obj;
539}
540
541static PyObject *
Raymond Hettinger166958b2003-12-01 13:18:39 +0000542attrgetter_call(attrgetterobject *ag, PyObject *args, PyObject *kw)
543{
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000544 PyObject *obj, *result;
Martin v. Löwisad0a4622006-02-16 14:30:23 +0000545 Py_ssize_t i, nattrs=ag->nattrs;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000546
547 if (!PyArg_UnpackTuple(args, "attrgetter", 1, 1, &obj))
548 return NULL;
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000549 if (ag->nattrs == 1)
Georg Brandle2065c62008-02-23 23:02:23 +0000550 return dotted_getattr(obj, ag->attr);
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000551
552 assert(PyTuple_Check(ag->attr));
553 assert(PyTuple_GET_SIZE(ag->attr) == nattrs);
554
555 result = PyTuple_New(nattrs);
556 if (result == NULL)
557 return NULL;
558
559 for (i=0 ; i < nattrs ; i++) {
560 PyObject *attr, *val;
561 attr = PyTuple_GET_ITEM(ag->attr, i);
Georg Brandle2065c62008-02-23 23:02:23 +0000562 val = dotted_getattr(obj, attr);
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000563 if (val == NULL) {
564 Py_DECREF(result);
565 return NULL;
566 }
567 PyTuple_SET_ITEM(result, i, val);
568 }
569 return result;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000570}
571
572PyDoc_STRVAR(attrgetter_doc,
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000573"attrgetter(attr, ...) --> attrgetter object\n\
Raymond Hettinger166958b2003-12-01 13:18:39 +0000574\n\
Raymond Hettinger984f9bb2005-03-09 16:38:48 +0000575Return a callable object that fetches the given attribute(s) from its operand.\n\
576After, f=attrgetter('name'), the call f(r) returns r.name.\n\
Georg Brandle2065c62008-02-23 23:02:23 +0000577After, g=attrgetter('name', 'date'), the call g(r) returns (r.name, r.date).\n\
578After, h=attrgetter('name.first', 'name.last'), the call h(r) returns\n\
579(r.name.first, r.name.last).");
Raymond Hettinger166958b2003-12-01 13:18:39 +0000580
581static PyTypeObject attrgetter_type = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000582 PyVarObject_HEAD_INIT(NULL, 0)
Raymond Hettingerbd3a2402003-12-04 22:17:49 +0000583 "operator.attrgetter", /* tp_name */
Raymond Hettinger166958b2003-12-01 13:18:39 +0000584 sizeof(attrgetterobject), /* tp_basicsize */
585 0, /* tp_itemsize */
586 /* methods */
587 (destructor)attrgetter_dealloc, /* tp_dealloc */
588 0, /* tp_print */
589 0, /* tp_getattr */
590 0, /* tp_setattr */
591 0, /* tp_compare */
592 0, /* tp_repr */
593 0, /* tp_as_number */
594 0, /* tp_as_sequence */
595 0, /* tp_as_mapping */
596 0, /* tp_hash */
597 (ternaryfunc)attrgetter_call, /* tp_call */
598 0, /* tp_str */
599 PyObject_GenericGetAttr, /* tp_getattro */
600 0, /* tp_setattro */
601 0, /* tp_as_buffer */
602 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */
603 attrgetter_doc, /* tp_doc */
604 (traverseproc)attrgetter_traverse, /* tp_traverse */
605 0, /* tp_clear */
606 0, /* tp_richcompare */
607 0, /* tp_weaklistoffset */
608 0, /* tp_iter */
609 0, /* tp_iternext */
610 0, /* tp_methods */
611 0, /* tp_members */
612 0, /* tp_getset */
613 0, /* tp_base */
614 0, /* tp_dict */
615 0, /* tp_descr_get */
616 0, /* tp_descr_set */
617 0, /* tp_dictoffset */
618 0, /* tp_init */
619 0, /* tp_alloc */
620 attrgetter_new, /* tp_new */
621 0, /* tp_free */
622};
Georg Brandlebcfd112008-02-23 23:04:35 +0000623
624
625/* methodcaller object **********************************************************/
626
627typedef struct {
628 PyObject_HEAD
629 PyObject *name;
630 PyObject *args;
631 PyObject *kwds;
632} methodcallerobject;
633
634static PyTypeObject methodcaller_type;
635
636static PyObject *
637methodcaller_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
638{
639 methodcallerobject *mc;
640 PyObject *name, *newargs;
641
642 if (PyTuple_GET_SIZE(args) < 1) {
643 PyErr_SetString(PyExc_TypeError, "methodcaller needs at least "
644 "one argument, the method name");
645 return NULL;
646 }
647
648 /* create methodcallerobject structure */
649 mc = PyObject_GC_New(methodcallerobject, &methodcaller_type);
650 if (mc == NULL)
651 return NULL;
652
653 newargs = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
654 if (newargs == NULL) {
655 Py_DECREF(mc);
656 return NULL;
657 }
658 mc->args = newargs;
659
660 name = PyTuple_GET_ITEM(args, 0);
661 Py_INCREF(name);
662 mc->name = name;
663
664 Py_XINCREF(kwds);
665 mc->kwds = kwds;
666
667 PyObject_GC_Track(mc);
668 return (PyObject *)mc;
669}
670
671static void
672methodcaller_dealloc(methodcallerobject *mc)
673{
674 PyObject_GC_UnTrack(mc);
675 Py_XDECREF(mc->name);
676 Py_XDECREF(mc->args);
677 Py_XDECREF(mc->kwds);
678 PyObject_GC_Del(mc);
679}
680
681static int
682methodcaller_traverse(methodcallerobject *mc, visitproc visit, void *arg)
683{
684 Py_VISIT(mc->args);
685 Py_VISIT(mc->kwds);
686 return 0;
687}
688
689static PyObject *
690methodcaller_call(methodcallerobject *mc, PyObject *args, PyObject *kw)
691{
692 PyObject *method, *obj, *result;
693
694 if (!PyArg_UnpackTuple(args, "methodcaller", 1, 1, &obj))
695 return NULL;
696 method = PyObject_GetAttr(obj, mc->name);
697 if (method == NULL)
698 return NULL;
699 result = PyObject_Call(method, mc->args, mc->kwds);
700 Py_DECREF(method);
701 return result;
702}
703
704PyDoc_STRVAR(methodcaller_doc,
705"methodcaller(name, ...) --> methodcaller object\n\
706\n\
707Return a callable object that calls the given method on its operand.\n\
708After, f = methodcaller('name'), the call f(r) returns r.name().\n\
709After, g = methodcaller('name', 'date', foo=1), the call g(r) returns\n\
710r.name('date', foo=1).");
711
712static PyTypeObject methodcaller_type = {
713 PyVarObject_HEAD_INIT(NULL, 0)
714 "operator.methodcaller", /* tp_name */
715 sizeof(methodcallerobject), /* tp_basicsize */
716 0, /* tp_itemsize */
717 /* methods */
718 (destructor)methodcaller_dealloc, /* tp_dealloc */
719 0, /* tp_print */
720 0, /* tp_getattr */
721 0, /* tp_setattr */
722 0, /* tp_compare */
723 0, /* tp_repr */
724 0, /* tp_as_number */
725 0, /* tp_as_sequence */
726 0, /* tp_as_mapping */
727 0, /* tp_hash */
728 (ternaryfunc)methodcaller_call, /* tp_call */
729 0, /* tp_str */
730 PyObject_GenericGetAttr, /* tp_getattro */
731 0, /* tp_setattro */
732 0, /* tp_as_buffer */
733 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
734 methodcaller_doc, /* tp_doc */
735 (traverseproc)methodcaller_traverse, /* tp_traverse */
736 0, /* tp_clear */
737 0, /* tp_richcompare */
738 0, /* tp_weaklistoffset */
739 0, /* tp_iter */
740 0, /* tp_iternext */
741 0, /* tp_methods */
742 0, /* tp_members */
743 0, /* tp_getset */
744 0, /* tp_base */
745 0, /* tp_dict */
746 0, /* tp_descr_get */
747 0, /* tp_descr_set */
748 0, /* tp_dictoffset */
749 0, /* tp_init */
750 0, /* tp_alloc */
751 methodcaller_new, /* tp_new */
752 0, /* tp_free */
753};
754
755
Guido van Rossum037b9401996-07-30 16:55:54 +0000756/* Initialization function for the module (*must* be called initoperator) */
757
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000758PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000759initoperator(void)
Guido van Rossum037b9401996-07-30 16:55:54 +0000760{
Raymond Hettinger166958b2003-12-01 13:18:39 +0000761 PyObject *m;
762
763 /* Create the module and add the functions */
764 m = Py_InitModule4("operator", operator_methods, operator_doc,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000765 (PyObject*)NULL, PYTHON_API_VERSION);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000766 if (m == NULL)
767 return;
Raymond Hettinger166958b2003-12-01 13:18:39 +0000768
769 if (PyType_Ready(&itemgetter_type) < 0)
770 return;
771 Py_INCREF(&itemgetter_type);
772 PyModule_AddObject(m, "itemgetter", (PyObject *)&itemgetter_type);
773
774 if (PyType_Ready(&attrgetter_type) < 0)
775 return;
776 Py_INCREF(&attrgetter_type);
777 PyModule_AddObject(m, "attrgetter", (PyObject *)&attrgetter_type);
Georg Brandlebcfd112008-02-23 23:04:35 +0000778
779 if (PyType_Ready(&methodcaller_type) < 0)
780 return;
781 Py_INCREF(&methodcaller_type);
782 PyModule_AddObject(m, "methodcaller", (PyObject *)&methodcaller_type);
Guido van Rossum037b9401996-07-30 16:55:54 +0000783}