1 /* row.c - an enhanced tuple for database rows
2 *
3 * Copyright (C) 2005-2010 Gerhard Häring <gh@ghaering.de>
4 *
5 * This file is part of pysqlite.
6 *
7 * This software is provided 'as-is', without any express or implied
8 * warranty. In no event will the authors be held liable for any damages
9 * arising from the use of this software.
10 *
11 * Permission is granted to anyone to use this software for any purpose,
12 * including commercial applications, and to alter it and redistribute it
13 * freely, subject to the following restrictions:
14 *
15 * 1. The origin of this software must not be misrepresented; you must not
16 * claim that you wrote the original software. If you use this software
17 * in a product, an acknowledgment in the product documentation would be
18 * appreciated but is not required.
19 * 2. Altered source versions must be plainly marked as such, and must not be
20 * misrepresented as being the original software.
21 * 3. This notice may not be removed or altered from any source distribution.
22 */
23
24 #include "row.h"
25 #include "cursor.h"
26
pysqlite_row_dealloc(pysqlite_Row * self)27 void pysqlite_row_dealloc(pysqlite_Row* self)
28 {
29 Py_XDECREF(self->data);
30 Py_XDECREF(self->description);
31
32 Py_TYPE(self)->tp_free((PyObject*)self);
33 }
34
35 static PyObject *
pysqlite_row_new(PyTypeObject * type,PyObject * args,PyObject * kwargs)36 pysqlite_row_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
37 {
38 pysqlite_Row *self;
39 PyObject* data;
40 pysqlite_Cursor* cursor;
41
42 assert(type != NULL && type->tp_alloc != NULL);
43
44 if (!_PyArg_NoKeywords("Row", kwargs))
45 return NULL;
46 if (!PyArg_ParseTuple(args, "OO", &cursor, &data))
47 return NULL;
48
49 if (!PyObject_TypeCheck((PyObject*)cursor, &pysqlite_CursorType)) {
50 PyErr_SetString(PyExc_TypeError, "instance of cursor required for first argument");
51 return NULL;
52 }
53
54 if (!PyTuple_Check(data)) {
55 PyErr_SetString(PyExc_TypeError, "tuple required for second argument");
56 return NULL;
57 }
58
59 self = (pysqlite_Row *) type->tp_alloc(type, 0);
60 if (self == NULL)
61 return NULL;
62
63 Py_INCREF(data);
64 self->data = data;
65
66 Py_INCREF(cursor->description);
67 self->description = cursor->description;
68
69 return (PyObject *) self;
70 }
71
pysqlite_row_item(pysqlite_Row * self,Py_ssize_t idx)72 PyObject* pysqlite_row_item(pysqlite_Row* self, Py_ssize_t idx)
73 {
74 PyObject* item = PyTuple_GetItem(self->data, idx);
75 Py_XINCREF(item);
76 return item;
77 }
78
79 static int
equal_ignore_case(PyObject * left,PyObject * right)80 equal_ignore_case(PyObject *left, PyObject *right)
81 {
82 int eq = PyObject_RichCompareBool(left, right, Py_EQ);
83 if (eq) { /* equal or error */
84 return eq;
85 }
86 if (!PyUnicode_Check(left) || !PyUnicode_Check(right)) {
87 return 0;
88 }
89 if (!PyUnicode_IS_ASCII(left) || !PyUnicode_IS_ASCII(right)) {
90 return 0;
91 }
92
93 Py_ssize_t len = PyUnicode_GET_LENGTH(left);
94 if (PyUnicode_GET_LENGTH(right) != len) {
95 return 0;
96 }
97 const Py_UCS1 *p1 = PyUnicode_1BYTE_DATA(left);
98 const Py_UCS1 *p2 = PyUnicode_1BYTE_DATA(right);
99 for (; len; len--, p1++, p2++) {
100 if (Py_TOLOWER(*p1) != Py_TOLOWER(*p2)) {
101 return 0;
102 }
103 }
104 return 1;
105 }
106
pysqlite_row_subscript(pysqlite_Row * self,PyObject * idx)107 PyObject* pysqlite_row_subscript(pysqlite_Row* self, PyObject* idx)
108 {
109 Py_ssize_t _idx;
110 Py_ssize_t nitems, i;
111 PyObject* item;
112
113 if (PyLong_Check(idx)) {
114 _idx = PyNumber_AsSsize_t(idx, PyExc_IndexError);
115 if (_idx == -1 && PyErr_Occurred())
116 return NULL;
117 if (_idx < 0)
118 _idx += PyTuple_GET_SIZE(self->data);
119 item = PyTuple_GetItem(self->data, _idx);
120 Py_XINCREF(item);
121 return item;
122 } else if (PyUnicode_Check(idx)) {
123 nitems = PyTuple_Size(self->description);
124
125 for (i = 0; i < nitems; i++) {
126 PyObject *obj;
127 obj = PyTuple_GET_ITEM(self->description, i);
128 obj = PyTuple_GET_ITEM(obj, 0);
129 int eq = equal_ignore_case(idx, obj);
130 if (eq < 0) {
131 return NULL;
132 }
133 if (eq) {
134 /* found item */
135 item = PyTuple_GetItem(self->data, i);
136 Py_INCREF(item);
137 return item;
138 }
139 }
140
141 PyErr_SetString(PyExc_IndexError, "No item with that key");
142 return NULL;
143 }
144 else if (PySlice_Check(idx)) {
145 return PyObject_GetItem(self->data, idx);
146 }
147 else {
148 PyErr_SetString(PyExc_IndexError, "Index must be int or string");
149 return NULL;
150 }
151 }
152
153 static Py_ssize_t
pysqlite_row_length(pysqlite_Row * self)154 pysqlite_row_length(pysqlite_Row* self)
155 {
156 return PyTuple_GET_SIZE(self->data);
157 }
158
pysqlite_row_keys(pysqlite_Row * self,PyObject * Py_UNUSED (ignored))159 PyObject* pysqlite_row_keys(pysqlite_Row* self, PyObject *Py_UNUSED(ignored))
160 {
161 PyObject* list;
162 Py_ssize_t nitems, i;
163
164 list = PyList_New(0);
165 if (!list) {
166 return NULL;
167 }
168 nitems = PyTuple_Size(self->description);
169
170 for (i = 0; i < nitems; i++) {
171 if (PyList_Append(list, PyTuple_GET_ITEM(PyTuple_GET_ITEM(self->description, i), 0)) != 0) {
172 Py_DECREF(list);
173 return NULL;
174 }
175 }
176
177 return list;
178 }
179
pysqlite_iter(pysqlite_Row * self)180 static PyObject* pysqlite_iter(pysqlite_Row* self)
181 {
182 return PyObject_GetIter(self->data);
183 }
184
pysqlite_row_hash(pysqlite_Row * self)185 static Py_hash_t pysqlite_row_hash(pysqlite_Row *self)
186 {
187 return PyObject_Hash(self->description) ^ PyObject_Hash(self->data);
188 }
189
pysqlite_row_richcompare(pysqlite_Row * self,PyObject * _other,int opid)190 static PyObject* pysqlite_row_richcompare(pysqlite_Row *self, PyObject *_other, int opid)
191 {
192 if (opid != Py_EQ && opid != Py_NE)
193 Py_RETURN_NOTIMPLEMENTED;
194
195 if (PyObject_TypeCheck(_other, &pysqlite_RowType)) {
196 pysqlite_Row *other = (pysqlite_Row *)_other;
197 int eq = PyObject_RichCompareBool(self->description, other->description, Py_EQ);
198 if (eq < 0) {
199 return NULL;
200 }
201 if (eq) {
202 return PyObject_RichCompare(self->data, other->data, opid);
203 }
204 return PyBool_FromLong(opid != Py_EQ);
205 }
206 Py_RETURN_NOTIMPLEMENTED;
207 }
208
209 PyMappingMethods pysqlite_row_as_mapping = {
210 /* mp_length */ (lenfunc)pysqlite_row_length,
211 /* mp_subscript */ (binaryfunc)pysqlite_row_subscript,
212 /* mp_ass_subscript */ (objobjargproc)0,
213 };
214
215 static PySequenceMethods pysqlite_row_as_sequence = {
216 /* sq_length */ (lenfunc)pysqlite_row_length,
217 /* sq_concat */ 0,
218 /* sq_repeat */ 0,
219 /* sq_item */ (ssizeargfunc)pysqlite_row_item,
220 };
221
222
223 static PyMethodDef pysqlite_row_methods[] = {
224 {"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,
225 PyDoc_STR("Returns the keys of the row.")},
226 {NULL, NULL}
227 };
228
229
230 PyTypeObject pysqlite_RowType = {
231 PyVarObject_HEAD_INIT(NULL, 0)
232 MODULE_NAME ".Row", /* tp_name */
233 sizeof(pysqlite_Row), /* tp_basicsize */
234 0, /* tp_itemsize */
235 (destructor)pysqlite_row_dealloc, /* tp_dealloc */
236 0, /* tp_vectorcall_offset */
237 0, /* tp_getattr */
238 0, /* tp_setattr */
239 0, /* tp_as_async */
240 0, /* tp_repr */
241 0, /* tp_as_number */
242 0, /* tp_as_sequence */
243 0, /* tp_as_mapping */
244 (hashfunc)pysqlite_row_hash, /* tp_hash */
245 0, /* tp_call */
246 0, /* tp_str */
247 0, /* tp_getattro */
248 0, /* tp_setattro */
249 0, /* tp_as_buffer */
250 Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE, /* tp_flags */
251 0, /* tp_doc */
252 (traverseproc)0, /* tp_traverse */
253 0, /* tp_clear */
254 (richcmpfunc)pysqlite_row_richcompare, /* tp_richcompare */
255 0, /* tp_weaklistoffset */
256 (getiterfunc)pysqlite_iter, /* tp_iter */
257 0, /* tp_iternext */
258 pysqlite_row_methods, /* tp_methods */
259 0, /* tp_members */
260 0, /* tp_getset */
261 0, /* tp_base */
262 0, /* tp_dict */
263 0, /* tp_descr_get */
264 0, /* tp_descr_set */
265 0, /* tp_dictoffset */
266 0, /* tp_init */
267 0, /* tp_alloc */
268 0, /* tp_new */
269 0 /* tp_free */
270 };
271
pysqlite_row_setup_types(void)272 extern int pysqlite_row_setup_types(void)
273 {
274 pysqlite_RowType.tp_new = pysqlite_row_new;
275 pysqlite_RowType.tp_as_mapping = &pysqlite_row_as_mapping;
276 pysqlite_RowType.tp_as_sequence = &pysqlite_row_as_sequence;
277 return PyType_Ready(&pysqlite_RowType);
278 }
279