Skip to content

Commit 9b7a5af

Browse files
committed
gh-107122: Add clear method to dbm.ndbm module
1 parent e5252c6 commit 9b7a5af

File tree

5 files changed

+73
-1
lines changed

5 files changed

+73
-1
lines changed

Doc/library/dbm.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,11 @@ to locate the appropriate header file to simplify building this module.
313313

314314
Close the ``ndbm`` database.
315315

316+
.. method:: ndbm.clear()
317+
Remove all items from the ``ndbm`` database.
318+
319+
.. versionadded:: 3.13
320+
316321

317322
:mod:`dbm.dumb` --- Portable DBM implementation
318323
-----------------------------------------------

Lib/test/test_dbm.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,21 @@ def test_keys(self):
155155
self.assertNotIn(b'xxx', d)
156156
self.assertRaises(KeyError, lambda: d[b'xxx'])
157157

158+
def test_clear(self):
159+
with dbm.open(_fname, 'c') as d:
160+
self.assertEqual(d.keys(), [])
161+
a = [(b'a', b'b'), (b'12345678910', b'019237410982340912840198242')]
162+
for k, v in a:
163+
d[k] = v
164+
for k, _ in a:
165+
self.assertIn(k, d)
166+
self.assertEqual(len(d), len(a))
167+
168+
d.clear()
169+
self.assertEqual(len(d), 0)
170+
for k, _ in a:
171+
self.assertNotIn(k, d)
172+
158173
def setUp(self):
159174
self.addCleanup(setattr, dbm, '_defaultmod', dbm._defaultmod)
160175
dbm._defaultmod = self.module
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add :meth:`clear` to :mod:`dbm.ndbm`. Patch By Dong-hee Na.

Modules/_dbmmodule.c

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,34 @@ _dbm_dbm_setdefault_impl(dbmobject *self, PyTypeObject *cls, const char *key,
414414
return default_value;
415415
}
416416

417+
/*[clinic input]
418+
_dbm.dbm.clear
419+
cls: defining_class
420+
/
421+
Remove all items from the database.
422+
423+
[clinic start generated code]*/
424+
425+
static PyObject *
426+
_dbm_dbm_clear_impl(dbmobject *self, PyTypeObject *cls)
427+
/*[clinic end generated code: output=8d126b9e1d01a434 input=43aa6ca1acb7f5f5]*/
428+
{
429+
_dbm_state *state = PyType_GetModuleState(cls);
430+
assert(state != NULL);
431+
check_dbmobject_open(self, state->dbm_error);
432+
for (datum key = dbm_firstkey(self->di_dbm); key.dptr; key = dbm_nextkey(self->di_dbm)) {
433+
if (dbm_delete(self->di_dbm, key) < 0) {
434+
dbm_clearerr(self->di_dbm);
435+
PyErr_SetString(state->dbm_error, "cannot delete item from database");
436+
return NULL;
437+
}
438+
}
439+
if (self->di_size > 0) {
440+
self->di_size = 0;
441+
}
442+
Py_RETURN_NONE;
443+
}
444+
417445
static PyObject *
418446
dbm__enter__(PyObject *self, PyObject *args)
419447
{
@@ -431,6 +459,7 @@ static PyMethodDef dbm_methods[] = {
431459
_DBM_DBM_KEYS_METHODDEF
432460
_DBM_DBM_GET_METHODDEF
433461
_DBM_DBM_SETDEFAULT_METHODDEF
462+
_DBM_DBM_CLEAR_METHODDEF
434463
{"__enter__", dbm__enter__, METH_NOARGS, NULL},
435464
{"__exit__", dbm__exit__, METH_VARARGS, NULL},
436465
{NULL, NULL} /* sentinel */

Modules/clinic/_dbmmodule.c.h

Lines changed: 23 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)