Index: Doc/library/dbm.rst =================================================================== --- Doc/library/dbm.rst (revision 87144) +++ Doc/library/dbm.rst (working copy) @@ -62,12 +62,15 @@ The object returned by :func:`.open` supports the same basic functionality as -dictionaries; keys and their corresponding values can be stored, retrieved, and -deleted, and the :keyword:`in` operator and the :meth:`keys` method are -available, as well as :meth:`get` and :meth:`setdefault`. +:mod:`collection`.MutableMapping; keys and their corresponding values can be +stored, retrieved, and deleted, and the :keyword:`in` operator and the +:meth:`keys`, :meth:`values`, :meth:`items` methods are available, as well as +:meth:`get`, :meth:`setdefault`, :meth:`pop`, :meth:`popitem` :meth:`clear` +and :meth:`update`. .. versionchanged:: 3.2 - :meth:`get` and :meth:`setdefault` are now available in all database modules. + The MutableMapping interfaces and :meth:`setdefault` are now available in all + database modules. Key and values are always stored as bytes. This means that when strings are used they are implicitly converted to the default encoding before Index: Lib/dbm/dumb.py =================================================================== --- Lib/dbm/dumb.py (revision 87144) +++ Lib/dbm/dumb.py (working copy) @@ -209,10 +209,10 @@ self._commit() def keys(self): - return list(self._index.keys()) + return self._index.keys() def items(self): - return [(key, self[key]) for key in self._index.keys()] + return set([(key, self[key]) for key in self._index.keys()]) def __contains__(self, key): if isinstance(key, str): Index: Lib/test/test_dbm_dumb.py =================================================================== --- Lib/test/test_dbm_dumb.py (revision 87144) +++ Lib/test/test_dbm_dumb.py (working copy) @@ -34,7 +34,7 @@ def test_dumbdbm_creation(self): f = dumbdbm.open(_fname, 'c') - self.assertEqual(list(f.keys()), []) + self.assertEqual(f.keys(), set()) for key in self._dict: f[key] = self._dict[key] self.read_helper(f) Index: Lib/test/test_dbm.py =================================================================== --- Lib/test/test_dbm.py (revision 87144) +++ Lib/test/test_dbm.py (working copy) @@ -64,7 +64,7 @@ def test_anydbm_creation(self): f = dbm.open(_fname, 'c') - self.assertEqual(list(f.keys()), []) + self.assertEqual(f.keys(), set()) for key in self._dict: f[key.encode("ascii")] = self._dict[key] self.read_helper(f) @@ -148,7 +148,7 @@ def test_keys(self): self.d = dbm.open(self.filename, 'c') - self.assertEqual(self.d.keys(), []) + self.assertEqual(self.d.keys(), set()) a = [(b'a', b'b'), (b'12345678910', b'019237410982340912840198242')] for k, v in a: self.d[k] = v Index: Lib/test/test_dbm_gnu.py =================================================================== --- Lib/test/test_dbm_gnu.py (revision 87144) +++ Lib/test/test_dbm_gnu.py (working copy) @@ -16,13 +16,90 @@ self.g.close() unlink(filename) + def test_get(self): + self.g = gdbm.open(filename, 'c') + self.g['a'] = 'b' + self.assertEqual(b'b', self.g.get('a')) + self.assertEqual(b'b', self.g.get(b'a')) + self.assertEqual(b'b', self.g.get('a', None)) + self.assertEqual(None, self.g.get('b')) + self.assertEqual(None, self.g.get(b'b')) + self.assertEqual('c', self.g.get('b', 'c')) + + def test_contains(self): + self.g = gdbm.open(filename, 'c') + self.g['a'] = 'b' + self.assertEqual(True, 'a' in self.g) + self.assertEqual(True, b'a' in self.g) + self.assertEqual(False, 'b' in self.g) + + def test_values(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(set(), set(self.g.values())) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(set((b'b', b'd')), set(self.g.values())) + + def test_items(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(set(), self.g.items()) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(set(((b'a', b'b'), (b'c', b'd'))), self.g.items()) + + def test_pop(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(None, self.g.pop('a')) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(None, self.g.pop('e')) + self.assertEqual(set((b'a', b'c')), self.g.keys()) + self.assertEqual(None, self.g.pop('e', None)) + self.assertEqual(set((b'a', b'c')), self.g.keys()) + self.assertEqual(b'b', self.g.pop('a')) + self.assertEqual(set((b'c', )), self.g.keys()) + self.assertEqual(b'd', self.g.pop('c', None)) + self.assertEqual(set(), self.g.keys()) + + def test_popitem(self): + self.g = gdbm.open(filename, 'c') + self.assertRaises(KeyError, self.g.popitem) + self.g['a'] = 'b' + self.assertEqual((b'a', b'b'), self.g.popitem()) + self.assertRaises(KeyError, self.g.popitem) + + def test_clear(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(set(), self.g.keys()) + self.g['a'] = 'b' + self.g['c'] = 'c' + self.g.clear() + self.assertEqual(set(), self.g.keys()) + + def test_iteration(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(set(), self.g.keys()) + self.assertRaises(StopIteration, next, iter(self.g)) + self.g['a'] = 'b' + self.g['c'] = 'd' + gi = iter(self.g) + self.assertEqual(set((b'a', b'c')), set((next(gi), next(gi)))) + self.assertRaises(StopIteration, next, gi) + + def test_abc(self): + self.g = gdbm.open(filename, 'c') + from collections import Iterable, Mapping, MutableMapping + self.assertEqual(True, isinstance(self.g, Iterable)) + self.assertEqual(True, isinstance(self.g, Mapping)) + self.assertEqual(True, isinstance(self.g, MutableMapping)) + def test_key_methods(self): self.g = gdbm.open(filename, 'c') - self.assertEqual(self.g.keys(), []) + self.assertEqual(self.g.keys(), set()) self.g['a'] = 'b' self.g['12345678910'] = '019237410982340912840198242' self.g[b'bytes'] = b'data' - key_set = set(self.g.keys()) + key_set = self.g.keys() self.assertEqual(key_set, set([b'a', b'bytes', b'12345678910'])) self.assertIn(b'a', self.g) self.assertEqual(self.g[b'bytes'], b'data') @@ -37,6 +114,38 @@ self.assertEqual(self.g.setdefault(b'xxx', b'foo'), b'foo') self.assertEqual(self.g[b'xxx'], b'foo') + def test_update1(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + self.g.update({'b':'b', 'c':'c'}) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + + def test_update2(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + class Other(object): + def __init__(self, dic): + self._dict = dic + def keys(self): + return self._dict.keys() + def __getitem__(self, key): + return self._dict[key] + + self.g.update(Other({'b':'b', 'c':'c'})) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + + def test_update3(self): + self.g = gdbm.open(filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + self.g.update({b'b':b'b', b'c':b'c'}.items()) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + def test_error_conditions(self): # Try to open a non-existent database. unlink(filename) Index: Lib/test/test_dbm_ndbm.py =================================================================== --- Lib/test/test_dbm_ndbm.py (revision 87144) +++ Lib/test/test_dbm_ndbm.py (working copy) @@ -17,9 +17,86 @@ for suffix in ['', '.pag', '.dir', '.db']: support.unlink(self.filename + suffix) + def test_get(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.g['a'] = 'b' + self.assertEqual(b'b', self.g.get('a')) + self.assertEqual(b'b', self.g.get(b'a')) + self.assertEqual(b'b', self.g.get('a', None)) + self.assertEqual(None, self.g.get('b')) + self.assertEqual(None, self.g.get(b'b')) + self.assertEqual('c', self.g.get('b', 'c')) + + def test_contains(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.g['a'] = 'b' + self.assertEqual(True, 'a' in self.g) + self.assertEqual(True, b'a' in self.g) + self.assertEqual(False, 'b' in self.g) + + def test_values(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(set(), set(self.g.values())) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(set((b'b', b'd')), set(self.g.values())) + + def test_items(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(set(), self.g.items()) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(set(((b'a', b'b'), (b'c', b'd'))), self.g.items()) + + def test_pop(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(None, self.g.pop('a')) + self.g['a'] = 'b' + self.g['c'] = 'd' + self.assertEqual(None, self.g.pop('e')) + self.assertEqual(set((b'a', b'c')), self.g.keys()) + self.assertEqual(None, self.g.pop('e', None)) + self.assertEqual(set((b'a', b'c')), self.g.keys()) + self.assertEqual(b'b', self.g.pop('a')) + self.assertEqual(set((b'c', )), self.g.keys()) + self.assertEqual(b'd', self.g.pop('c', None)) + self.assertEqual(set(), self.g.keys()) + + def test_popitem(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertRaises(KeyError, self.g.popitem) + self.g['a'] = 'b' + self.assertEqual((b'a', b'b'), self.g.popitem()) + self.assertRaises(KeyError, self.g.popitem) + + def test_clear(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(set(), self.g.keys()) + self.g['a'] = 'b' + self.g['c'] = 'c' + self.g.clear() + self.assertEqual(set(), self.g.keys()) + + def test_iteration(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(set(), self.g.keys()) + self.assertRaises(StopIteration, next, iter(self.g)) + self.g['a'] = 'b' + self.g['c'] = 'd' + gi = iter(self.g) + self.assertEqual(set((b'a', b'c')), set((next(gi), next(gi)))) + self.assertRaises(StopIteration, next, gi) + + def test_abc(self): + self.g = dbm.ndbm.open(self.filename, 'c') + from collections import Iterable, Mapping, MutableMapping + self.assertEqual(True, isinstance(self.g, Iterable)) + self.assertEqual(True, isinstance(self.g, Mapping)) + self.assertEqual(True, isinstance(self.g, MutableMapping)) + def test_keys(self): self.d = dbm.ndbm.open(self.filename, 'c') - self.assertTrue(self.d.keys() == []) + self.assertTrue(self.d.keys() == set()) self.d['a'] = 'b' self.d[b'bytes'] = b'data' self.d['12345678910'] = '019237410982340912840198242' @@ -28,6 +105,38 @@ self.assertEqual(self.d[b'bytes'], b'data') self.d.close() + def test_update1(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + self.g.update({'b':'b', 'c':'c'}) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + + def test_update2(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + class Other(object): + def __init__(self, dic): + self._dict = dic + def keys(self): + return self._dict.keys() + def __getitem__(self, key): + return self._dict[key] + + self.g.update(Other({'b':'b', 'c':'c'})) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + + def test_update3(self): + self.g = dbm.ndbm.open(self.filename, 'c') + self.assertEqual(self.g.keys(), set()) + self.g['a'] = 'a' + self.g.update({b'b':b'b', b'c':b'c'}.items()) + self.assertEqual(set(((b'a', b'a'), (b'b', b'b'), (b'c', b'c'))), + self.g.items()) + def test_modes(self): for mode in ['r', 'rw', 'w', 'n']: try: Index: Modules/_gdbmmodule.c =================================================================== --- Modules/_gdbmmodule.c (revision 87144) +++ Modules/_gdbmmodule.c (working copy) @@ -243,8 +243,8 @@ /* XXX Should return a set or a set view */ PyDoc_STRVAR(dbm_keys__doc__, -"keys() -> list_of_keys\n\ -Get a list of all keys in the database."); +"keys() -> set of keys\n\ +Get a set of all keys in the database."); static PyObject * dbm_keys(register dbmobject *dp, PyObject *unused) @@ -259,7 +259,7 @@ } check_dbmobject_open(dp); - v = PyList_New(0); + v = PySet_New(NULL); if (v == NULL) return NULL; @@ -271,7 +271,7 @@ Py_DECREF(v); return NULL; } - err = PyList_Append(v, item); + err = PySet_Add(v, item); Py_DECREF(item); if (err != 0) { free(key.dptr); @@ -291,19 +291,14 @@ dbmobject *dp = (dbmobject *)self; datum key; + if (!PyArg_Parse(arg, "s#", &key.dptr, &key.dsize)) + return -1; + if ((dp)->di_dbm == NULL) { PyErr_SetString(DbmError, "GDBM object has already been closed"); return -1; } - if (!PyBytes_Check(arg)) { - PyErr_Format(PyExc_TypeError, - "gdbm key must be bytes, not %.100s", - arg->ob_type->tp_name); - return -1; - } - key.dptr = PyBytes_AS_STRING(arg); - key.dsize = PyBytes_GET_SIZE(arg); return gdbm_exists(dp->di_dbm, key); } @@ -416,6 +411,530 @@ return Py_None; } +PyDoc_STRVAR(dbm_values__doc__, +"values() -> list_of_values\n\ +Get a list of all values in the database."); + +static PyObject * +dbm_values(register dbmobject *dp, PyObject *unused) +{ + register PyObject *v, *item; + datum key, val, nextkey; + int err; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + v = PyList_New(0); + if (v == NULL) + return NULL; + + key = gdbm_firstkey(dp->di_dbm); + while (key.dptr) { + val = gdbm_fetch(dp->di_dbm, key); + assert(val.dptr != NULL); + item = PyBytes_FromStringAndSize(val.dptr, val.dsize); + free(val.dptr); + if (item == NULL) { + Py_DECREF(v); + return NULL; + } + err = PyList_Append(v, item); + Py_DECREF(item); + if (err != 0) { + Py_DECREF(v); + return NULL; + } + nextkey = gdbm_nextkey(dp->di_dbm, key); + free(key.dptr); + key = nextkey; + } + return v; +} + +PyDoc_STRVAR(dbm_items__doc__, +"items() -> set of (key, value) tuples\n\ +Get a set of all (key, value) tuple in the database."); + +static PyObject * +dbm_items(register dbmobject *dp, PyObject *unused) +{ + register PyObject *result, *item, *k, *v; + datum key, val, nextkey; + int err; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + result = PySet_New(NULL); + if (result == NULL) + return NULL; + + key = gdbm_firstkey(dp->di_dbm); + while (key.dptr) { + val = gdbm_fetch(dp->di_dbm, key); + assert(val.dptr != NULL); + k = PyBytes_FromStringAndSize(key.dptr, key.dsize); + if (k == NULL) + goto fail1; + v = PyBytes_FromStringAndSize(val.dptr, val.dsize); + free(val.dptr); + if (v == NULL) { + Py_DECREF(k); + goto fail1; + } + item = PyTuple_New(2); + if (item == NULL) + goto fail1; + if (PyTuple_SetItem(item, 0, k)) { + Py_DECREF(v); + Py_DECREF(item); + goto fail2; + } + if (PyTuple_SetItem(item, 1, v)) { + Py_DECREF(item); + goto fail2; + } + err = PySet_Add(result, item); + Py_DECREF(item); + if (err != 0) + goto fail2; + nextkey = gdbm_nextkey(dp->di_dbm, key); + free(key.dptr); + key = nextkey; + } + return result; + +fail1: + Py_XDECREF(k); + Py_XDECREF(v); +fail2: + free(key.dptr); + Py_DECREF(result); + return NULL; +} + +PyDoc_STRVAR(dbm_pop__doc__, +"pop([key[, default]) -> value\n\ +Return the value for key and delete the key-value pair if present, \n\ +otherwise return default if specified, raise KeyError if not specified."); + +static PyObject * +dbm_pop(dbmobject *dp, PyObject *args) +{ + datum key, val; + PyObject *defvalue = Py_None, *result; + char *tmp_ptr; + Py_ssize_t tmp_size; + + if (!PyArg_ParseTuple(args, "s#|O:get", &tmp_ptr, &tmp_size, &defvalue)) + return NULL; + + key.dptr = tmp_ptr; + key.dsize = tmp_size; + check_dbmobject_open(dp); + val = gdbm_fetch(dp->di_dbm, key); + if (val.dptr != NULL) { + result = PyBytes_FromStringAndSize(val.dptr, val.dsize); + free(val.dptr); + if (result == NULL) + return NULL; + if (gdbm_delete(dp->di_dbm, key) < 0) { + PyErr_SetString(PyExc_ValueError, "Delete key error"); + Py_DECREF(result); + return NULL; + } + return result; + } + else { + Py_INCREF(defvalue); + return defvalue; + } +} + +PyDoc_STRVAR(dbm_popitem__doc__, +"popitem() -> (key, value)\n\ +Return the next (key, value) tuple if there is items in db, \n\ +otherwise raise KeyError."); + +static PyObject * +dbm_popitem(dbmobject *dp, PyObject *unused) +{ + datum k, v; + PyObject *result, *iter, *key, *val; + iter = PyObject_GetIter((PyObject *)dp); + if (iter == NULL) + return NULL; + key = PyIter_Next(iter); + Py_DECREF(iter); + if (key == NULL) { + if (!PyErr_Occurred()) + PyErr_SetString(PyExc_KeyError, "GDBM object has no more items"); + return NULL; + } + assert(PyBytes_Check(key)); + if (PyBytes_AsStringAndSize(key, &k.dptr, &k.dsize)) + goto fail1; + v = gdbm_fetch(dp->di_dbm, k); + assert(v.dptr != NULL); + val = PyBytes_FromStringAndSize(v.dptr, v.dsize); + free(v.dptr); + if (val == NULL) + goto fail1; + result = PyTuple_New(2); + if (result == NULL) + goto fail2; + if (PyTuple_SetItem(result, 0, key)) { + Py_DECREF(val); + Py_DECREF(result); + return NULL; + } + if (PyTuple_SetItem(result, 1, val)) { + Py_DECREF(result); + return NULL; + } + if (gdbm_delete(dp->di_dbm, k) < 0) { + PyErr_SetString(PyExc_ValueError, "Delete key error"); + Py_DECREF(result); + return NULL; + } + return result; +fail1: + Py_DECREF(val); +fail2: + Py_DECREF(key); + return NULL; +} + +PyDoc_STRVAR(dbm_clear__doc__, +"clear() -> None\n\ +Delete all the items in db."); + +static PyObject * +dbm_clear(dbmobject *dp, PyObject *unused) +{ + datum key; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + key = gdbm_firstkey(dp->di_dbm); + while (key.dptr) { + if (gdbm_delete(dp->di_dbm, key) < 0) { + PyErr_SetString(PyExc_ValueError, "Delete key error"); + free(key.dptr); + return NULL; + } + free(key.dptr); + key = gdbm_firstkey(dp->di_dbm); + } + Py_RETURN_NONE; +} + +static PyObject * +dbm_update(dbmobject *dp, PyObject *args, PyObject *kwds) +{ + datum krec, drec; + PyObject *arg = NULL; + PyObject *coll_mod, *mapping_abc; + PyObject *arg_iter, *arg_keys, *iter_item, *item_value; + PyObject *key, *value; + Py_ssize_t pos = 0; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + if ((coll_mod = PyImport_ImportModule("collections")) == NULL) + return NULL; + if ((mapping_abc = PyObject_GetAttrString(coll_mod, "Mapping")) == + NULL) { + Py_DECREF(coll_mod); + return NULL; + } + Py_DECREF(coll_mod); + + if (!PyArg_UnpackTuple(args, "update", 0, 1, &arg)) + Py_DECREF(mapping_abc); + else if (arg != NULL) { + if (PyObject_IsInstance(arg, mapping_abc)) { + Py_DECREF(mapping_abc); + if ((arg_iter = PyObject_GetIter(arg)) == NULL) + return NULL; + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PyArg_Parse(iter_item, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(iter_item); + return NULL; + } + Py_DECREF(iter_item); + if ((item_value = PyObject_GetItem(arg, iter_item)) == NULL) { + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(item_value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(item_value); + return NULL; + } + Py_DECREF(item_value); + if (gdbm_store(dp->di_dbm, krec, drec, GDBM_REPLACE) < 0 ) { + if (errno != 0) + PyErr_SetFromErrno(DbmError); + else + PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + else if (PyObject_HasAttrString(arg, "keys")) { + Py_DECREF(mapping_abc); + if ((arg_keys = PyObject_CallMethod(arg, "keys", NULL)) == NULL) + return NULL; + if ((arg_iter = PyObject_GetIter(arg_keys)) == NULL) { + Py_DECREF(arg_keys); + return NULL; + } + Py_DECREF(arg_keys); + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PyArg_Parse(iter_item, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(iter_item); + return NULL; + } + Py_DECREF(iter_item); + if ((item_value = PyObject_GetItem(arg, iter_item)) == NULL) { + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(item_value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(item_value); + return NULL; + } + Py_DECREF(item_value); + if (gdbm_store(dp->di_dbm, krec, drec, GDBM_REPLACE) < 0 ) { + if (errno != 0) + PyErr_SetFromErrno(DbmError); + else + PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + else { + Py_DECREF(mapping_abc); + if ((arg_iter = PyObject_GetIter(arg)) == NULL) + return NULL; + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PySequence_Check(iter_item) || + PySequence_Size(iter_item) != 2) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if ((key = PySequence_GetItem(iter_item, 0)) == NULL) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(key, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + Py_DECREF(key); + return NULL; + } + Py_DECREF(key); + + if ((value = PySequence_GetItem(iter_item, 1)) == NULL) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + return NULL; + } + Py_DECREF(value); + Py_DECREF(iter_item); + + if (gdbm_store(dp->di_dbm, krec, drec, GDBM_REPLACE) < 0 ) { + if (errno != 0) + PyErr_SetFromErrno(DbmError); + else + PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + } + if (kwds == NULL) + Py_RETURN_NONE; + while (PyDict_Next(kwds, &pos, &key, &value)) { + if (!PyArg_Parse(key, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + return NULL; + } + if (!PyArg_Parse(value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + return NULL; + } + if (gdbm_store(dp->di_dbm, krec, drec, GDBM_REPLACE) < 0 ) { + if (errno != 0) + PyErr_SetFromErrno(DbmError); + else + PyErr_SetString(DbmError, gdbm_strerror(gdbm_errno)); + PyErr_SetString(DbmError, "Cannot add item to database"); + return NULL; + } + } + Py_RETURN_NONE; +} + +PyDoc_STRVAR(dbm_update__doc__, +"update([other][, **keywords]) -> None\n\ +Add all the items in other if other is a mapping object, raise TypeError " +"else, as well as those in keywords."); + +typedef struct { + PyObject_HEAD + dbmobject *dbm; /* Set to NULL when iterator is exhausted */ + datum curr_key; +} dbmiterobject; + +static void +dbmiter_dealloc(dbmiterobject *di) +{ + Py_XDECREF(di->dbm); + if (di->curr_key.dptr) + free(di->curr_key.dptr); + PyObject_GC_Del(di); +} + +static int +dbmiter_traverse(dbmiterobject *di, visitproc visit, void *arg) +{ + Py_VISIT(di->dbm); + return 0; +} + +static PyObject *dbmiter_iternextkey(dbmiterobject *di) +{ + PyObject *result; + datum next; + if (di->dbm != NULL) { + if (di->curr_key.dptr == NULL) + di->curr_key = gdbm_firstkey(di->dbm->di_dbm); + else { + next = gdbm_nextkey(di->dbm->di_dbm, di->curr_key); + free(di->curr_key.dptr); + di->curr_key = next; + } + if (di->curr_key.dptr == NULL) { + PyErr_SetNone(PyExc_StopIteration); + di->dbm = NULL; + return NULL; + } + result = PyBytes_FromStringAndSize(di->curr_key.dptr, + di->curr_key.dsize); + return result; + } + else { + //the iteration has already exhaust. + PyErr_SetNone(PyExc_StopIteration); + return NULL; + } +} + +PyTypeObject DbmIterKey_Type= { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "DbmIterKey_Type", /* tp_name */ + sizeof(dbmiterobject), /* tp_basicsize */ + 0, /* tp_itemsize */ + /* methods */ + (destructor)dbmiter_dealloc, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + PyObject_GenericGetAttr, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + (traverseproc)dbmiter_traverse, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + PyObject_SelfIter, /* tp_iter */ + (iternextfunc)dbmiter_iternextkey, /* tp_iternext */ + 0, /* tp_methods */ + 0, +}; + +static PyObject * +dbmiter_new(dbmobject *dbm) +{ + dbmiterobject *di = PyObject_GC_New(dbmiterobject, &DbmIterKey_Type); + if (di == NULL) + return NULL; + Py_INCREF(dbm); + di->dbm = dbm; + di->curr_key.dptr = NULL; + _PyObject_GC_TRACK(di); + return (PyObject *)di; +} + +static PyObject * +dbm_iter(dbmobject *dbm) +{ + return dbmiter_new(dbm); +} + static PyMethodDef dbm_methods[] = { {"close", (PyCFunction)dbm_close, METH_NOARGS, dbm_close__doc__}, {"keys", (PyCFunction)dbm_keys, METH_NOARGS, dbm_keys__doc__}, @@ -425,6 +944,13 @@ {"sync", (PyCFunction)dbm_sync, METH_NOARGS, dbm_sync__doc__}, {"get", (PyCFunction)dbm_get, METH_VARARGS, dbm_get__doc__}, {"setdefault",(PyCFunction)dbm_setdefault,METH_VARARGS, dbm_setdefault__doc__}, + {"values", (PyCFunction)dbm_values, METH_NOARGS, dbm_values__doc__}, + {"items", (PyCFunction)dbm_items, METH_NOARGS, dbm_items__doc__}, + {"pop", (PyCFunction)dbm_pop, METH_VARARGS, dbm_pop__doc__}, + {"popitem", (PyCFunction)dbm_popitem, METH_VARARGS, dbm_popitem__doc__}, + {"clear", (PyCFunction)dbm_clear, METH_VARARGS, dbm_clear__doc__}, + {"update", (PyCFunction)dbm_update, METH_VARARGS|METH_KEYWORDS, + dbm_update__doc__}, {NULL, NULL} /* sentinel */ }; @@ -454,7 +980,7 @@ 0, /*tp_clear*/ 0, /*tp_richcompare*/ 0, /*tp_weaklistoffset*/ - 0, /*tp_iter*/ + (getiterfunc)dbm_iter, /*tp_iter*/ 0, /*tp_iternext*/ dbm_methods, /*tp_methods*/ }; @@ -575,9 +1101,23 @@ PyMODINIT_FUNC PyInit__gdbm(void) { PyObject *m, *d, *s; + PyObject *coll_mod, *mapping_abc; if (PyType_Ready(&Dbmtype) < 0) return NULL; + + if ((coll_mod = PyImport_ImportModule("collections")) == NULL) + return NULL; + mapping_abc = PyObject_GetAttrString(coll_mod, "MutableMapping"); + Py_DECREF(coll_mod); + if (mapping_abc == NULL) + return NULL; + if (PyObject_CallMethod(mapping_abc, "register", "O", &Dbmtype) == NULL) { + Py_DECREF(mapping_abc); + return NULL; + } + Py_DECREF(mapping_abc); + m = PyModule_Create(&_gdbmmodule); if (m == NULL) return NULL; Index: Modules/_dbmmodule.c =================================================================== --- Modules/_dbmmodule.c (revision 87144) +++ Modules/_dbmmodule.c (working copy) @@ -187,7 +187,7 @@ int err; check_dbmobject_open(dp); - v = PyList_New(0); + v = PySet_New(NULL); if (v == NULL) return NULL; for (key = dbm_firstkey(dp->di_dbm); key.dptr; @@ -197,7 +197,7 @@ Py_DECREF(v); return NULL; } - err = PyList_Append(v, item); + err = PySet_Add(v, item); Py_DECREF(item); if (err != 0) { Py_DECREF(v); @@ -252,7 +252,7 @@ dbm_get(register dbmobject *dp, PyObject *args) { datum key, val; - PyObject *defvalue = Py_None; + PyObject *defvalue = Py_None, *result; char *tmp_ptr; Py_ssize_t tmp_size; @@ -263,8 +263,10 @@ key.dsize = tmp_size; check_dbmobject_open(dp); val = dbm_fetch(dp->di_dbm, key); - if (val.dptr != NULL) - return PyBytes_FromStringAndSize(val.dptr, val.dsize); + if (val.dptr != NULL) { + result = PyBytes_FromStringAndSize(val.dptr, val.dsize); + return result; + } else { Py_INCREF(defvalue); return defvalue; @@ -313,11 +315,367 @@ return defvalue; } +static PyObject * +dbm_values(register dbmobject *dp, PyObject *unused) +{ + register PyObject *v, *item; + datum key, val; + int err; + + check_dbmobject_open(dp); + v = PyList_New(0); + if (v == NULL) + return NULL; + for (key = dbm_firstkey(dp->di_dbm); key.dptr; + key = dbm_nextkey(dp->di_dbm)) { + val = dbm_fetch(dp->di_dbm, key); + assert(val.dptr != NULL); + item = PyBytes_FromStringAndSize(val.dptr, val.dsize); + if (item == NULL) { + Py_DECREF(v); + return NULL; + } + err = PyList_Append(v, item); + Py_DECREF(item); + if (err != 0) { + Py_DECREF(v); + return NULL; + } + } + return v; +} + +static PyObject * +dbm_items(register dbmobject *dp, PyObject *unused) +{ + register PyObject *result, *k, *v, *item; + datum key, val; + int err; + + check_dbmobject_open(dp); + result = PySet_New(NULL); + if (result == NULL) + return NULL; + for (key = dbm_firstkey(dp->di_dbm); key.dptr; + key = dbm_nextkey(dp->di_dbm)) { + assert(val.dptr != NULL); + k = PyBytes_FromStringAndSize(key.dptr, key.dsize); + if (k == NULL) + goto fail; + val = dbm_fetch(dp->di_dbm, key); + v = PyBytes_FromStringAndSize(val.dptr, val.dsize); + if (v == NULL) { + Py_DECREF(k); + goto fail; + } + item = PyTuple_New(2); + if (item == NULL) { + Py_DECREF(k); + Py_DECREF(v); + goto fail; + } + if (PyTuple_SetItem(item, 0, k)) { + Py_DECREF(v); + Py_DECREF(item); + goto fail; + } + if (PyTuple_SetItem(item, 1, v)) { + Py_DECREF(item); + goto fail; + } + err = PySet_Add(result, item); + Py_DECREF(item); + if (err != 0) + goto fail; + } + return result; +fail: + Py_DECREF(result); + return NULL; +} + +static PyObject * +dbm_pop(register dbmobject *dp, PyObject *args) +{ + datum key, val; + PyObject *defvalue = Py_None, *result; + char *tmp_ptr; + Py_ssize_t tmp_size; + + if (!PyArg_ParseTuple(args, "s#|O:get", + &tmp_ptr, &tmp_size, &defvalue)) + return NULL; + key.dptr = tmp_ptr; + key.dsize = tmp_size; + check_dbmobject_open(dp); + val = dbm_fetch(dp->di_dbm, key); + if (val.dptr != NULL) { + result = PyBytes_FromStringAndSize(val.dptr, val.dsize); + if (result == NULL) + return NULL; + dbm_delete(dp->di_dbm, key); + return result; + } + else { + Py_INCREF(defvalue); + return defvalue; + } +} + +static PyObject * +dbm_popitem(register dbmobject *dp, PyObject *unused) +{ + datum k, v; + PyObject *result, *iter, *key, *val; + iter = PyObject_GetIter((PyObject *)dp); + if (iter == NULL) + return NULL; + key = PyIter_Next(iter); + Py_DECREF(iter); + if (key == NULL) { + if (!PyErr_Occurred()) + PyErr_SetString(PyExc_KeyError, "DBM object has no more items"); + return NULL; + } + assert(PyBytes_Check(key)); + if (PyBytes_AsStringAndSize(key, &k.dptr, &k.dsize)) + goto fail1; + v = dbm_fetch(dp->di_dbm, k); + assert(v.dptr != NULL); + val = PyBytes_FromStringAndSize(v.dptr, v.dsize); + if (val == NULL) + goto fail1; + result = PyTuple_New(2); + if (result == NULL) + goto fail2; + if (PyTuple_SetItem(result, 0, key)) { + Py_DECREF(val); + Py_DECREF(result); + return NULL; + } + if (PyTuple_SetItem(result, 1, val)) { + Py_DECREF(result); + return NULL; + } + if (dbm_delete(dp->di_dbm, k) < 0) { + PyErr_SetString(PyExc_ValueError, "Delete key error"); + Py_DECREF(result); + return NULL; + } + return result; +fail1: + Py_DECREF(val); +fail2: + Py_DECREF(key); + return NULL; +} + +static PyObject * +dbm_clear(dbmobject *dp, PyObject *unused) +{ + datum key; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + key = dbm_firstkey(dp->di_dbm); + while (key.dptr) { + if (dbm_delete(dp->di_dbm, key) < 0) { + PyErr_SetString(PyExc_ValueError, "Delete key error"); + return NULL; + } + key = dbm_firstkey(dp->di_dbm); + } + Py_RETURN_NONE; +} + +static PyObject * +dbm_update(dbmobject *dp, PyObject *args, PyObject *kwds) +{ + datum krec, drec; + PyObject *arg = NULL; + PyObject *coll_mod, *mapping_abc; + PyObject *arg_iter, *arg_keys, *iter_item, *item_value; + PyObject *key, *value; + Py_ssize_t pos = 0; + + if (dp == NULL || !is_dbmobject(dp)) { + PyErr_BadInternalCall(); + return NULL; + } + check_dbmobject_open(dp); + + if ((coll_mod = PyImport_ImportModule("collections")) == NULL) + return NULL; + if ((mapping_abc = PyObject_GetAttrString(coll_mod, "Mapping")) == + NULL) { + Py_DECREF(coll_mod); + return NULL; + } + Py_DECREF(coll_mod); + + if (!PyArg_UnpackTuple(args, "update", 0, 1, &arg)) + Py_DECREF(mapping_abc); + else if (arg != NULL) { + if (PyObject_IsInstance(arg, mapping_abc)) { + Py_DECREF(mapping_abc); + if ((arg_iter = PyObject_GetIter(arg)) == NULL) + return NULL; + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PyArg_Parse(iter_item, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(iter_item); + return NULL; + } + Py_DECREF(iter_item); + if ((item_value = PyObject_GetItem(arg, iter_item)) == NULL) { + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(item_value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(item_value); + return NULL; + } + Py_DECREF(item_value); + if (dbm_store(dp->di_dbm, krec, drec, DBM_REPLACE) < 0 ) { + dbm_clearerr(dp->di_dbm); + PyErr_SetString(DbmError, "Cannot add item to database"); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + else if (PyObject_HasAttrString(arg, "keys")) { + Py_DECREF(mapping_abc); + if ((arg_keys = PyObject_CallMethod(arg, "keys", NULL)) == NULL) + return NULL; + if ((arg_iter = PyObject_GetIter(arg_keys)) == NULL) { + Py_DECREF(arg_keys); + return NULL; + } + Py_DECREF(arg_keys); + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PyArg_Parse(iter_item, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(iter_item); + return NULL; + } + Py_DECREF(iter_item); + if ((item_value = PyObject_GetItem(arg, iter_item)) == NULL) { + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(item_value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + Py_DECREF(item_value); + return NULL; + } + Py_DECREF(item_value); + if (dbm_store(dp->di_dbm, krec, drec, DBM_REPLACE) < 0 ) { + dbm_clearerr(dp->di_dbm); + PyErr_SetString(DbmError, "Cannot add item to database"); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + else { + Py_DECREF(mapping_abc); + if ((arg_iter = PyObject_GetIter(arg)) == NULL) + return NULL; + while ((iter_item = PyIter_Next(arg_iter)) != NULL) { + if (!PySequence_Check(iter_item) || + PySequence_Size(iter_item) != 2) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if ((key = PySequence_GetItem(iter_item, 0)) == NULL) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(key, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + Py_DECREF(key); + return NULL; + } + Py_DECREF(key); + + if ((value = PySequence_GetItem(iter_item, 1)) == NULL) { + Py_DECREF(iter_item); + Py_DECREF(arg_iter); + return NULL; + } + if (!PyArg_Parse(value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + Py_DECREF(arg_iter); + return NULL; + } + Py_DECREF(value); + Py_DECREF(iter_item); + + if (dbm_store(dp->di_dbm, krec, drec, DBM_REPLACE) < 0 ) { + dbm_clearerr(dp->di_dbm); + PyErr_SetString(DbmError, "Cannot add item to database"); + Py_DECREF(arg_iter); + return NULL; + } + } + Py_DECREF(arg_iter); + if (PyErr_Occurred()) + return NULL; + } + } + if (kwds == NULL) + Py_RETURN_NONE; + while (PyDict_Next(kwds, &pos, &key, &value)) { + if (!PyArg_Parse(key, "s#", &krec.dptr, &krec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm key can only be buffers."); + return NULL; + } + if (!PyArg_Parse(value, "s#", &drec.dptr, &drec.dsize)) { + PyErr_SetString(PyExc_TypeError, + "dbm value can only be buffers."); + return NULL; + } + if (dbm_store(dp->di_dbm, krec, drec, DBM_REPLACE) < 0 ) { + dbm_clearerr(dp->di_dbm); + PyErr_SetString(DbmError, "Cannot add item to database"); + return NULL; + } + } + Py_RETURN_NONE; +} + static PyMethodDef dbm_methods[] = { {"close", (PyCFunction)dbm__close, METH_NOARGS, "close()\nClose the database."}, {"keys", (PyCFunction)dbm_keys, METH_NOARGS, - "keys() -> list\nReturn a list of all keys in the database."}, + "keys() -> set of keys.\nReturn a set of all keys in the database."}, {"get", (PyCFunction)dbm_get, METH_VARARGS, "get(key[, default]) -> value\n" "Return the value for key if present, otherwise default."}, @@ -325,9 +683,37 @@ "setdefault(key[, default]) -> value\n" "Return the value for key if present, otherwise default. If key\n" "is not in the database, it is inserted with default as the value."}, + {"values", (PyCFunction)dbm_values, METH_NOARGS, + "values() -> list of values\n" + "Return a list of values of all keys."}, + {"items", (PyCFunction)dbm_items, METH_NOARGS, + "items() -> set of (key1, value1) tuples\n" + "Return a set of (key, values) tuples of all keys."}, + {"pop", (PyCFunction)dbm_pop, METH_VARARGS, + "pop(key[, default]) -> value\n" + "Return the value for key and delete the key-value pair if present,\n" + "otherwise return default if specified, raise KeyError if not " + "specified."}, + {"popitem", (PyCFunction)dbm_popitem, METH_NOARGS, + "popitem() -> (key, value)\n" + "Return the next (key, value) tuple if there is items in db, otherwise\n" + " raise KeyError."}, + {"clear", (PyCFunction)dbm_clear, METH_NOARGS, + "clear() -> None\n" + "Delete all the items in db."}, + {"update", (PyCFunction)dbm_update, METH_VARARGS | METH_KEYWORDS, + "update([other][, **keywords]) -> None\n" + "Add all the items in other if other is a mapping object, raise TypeError" + " else, as well as those in keywords."}, {NULL, NULL} /* sentinel */ }; +static PyObject * +dbm_iter(dbmobject *dbm) +{ + return PyObject_GetIter(dbm_keys(dbm, NULL)); +} + static PyTypeObject Dbmtype = { PyVarObject_HEAD_INIT(NULL, 0) "_dbm.dbm", @@ -354,7 +740,7 @@ 0, /*tp_clear*/ 0, /*tp_richcompare*/ 0, /*tp_weaklistoffset*/ - 0, /*tp_iter*/ + (getiterfunc)dbm_iter, /*tp_iter*/ 0, /*tp_iternext*/ dbm_methods, /*tp_methods*/ }; @@ -412,9 +798,23 @@ PyMODINIT_FUNC PyInit__dbm(void) { PyObject *m, *d, *s; + PyObject *coll_mod, *mapping_abc; if (PyType_Ready(&Dbmtype) < 0) return NULL; + + if ((coll_mod = PyImport_ImportModule("collections")) == NULL) + return NULL; + mapping_abc = PyObject_GetAttrString(coll_mod, "MutableMapping"); + Py_DECREF(coll_mod); + if (mapping_abc == NULL) + return NULL; + if (PyObject_CallMethod(mapping_abc, "register", "O", &Dbmtype) == NULL) { + Py_DECREF(mapping_abc); + return NULL; + } + Py_DECREF(mapping_abc); + m = PyModule_Create(&_dbmmodule); if (m == NULL) return NULL;