Close #19282: Native context management in dbm · pythoncapi/cpython@c610aba · GitHub
Skip to content

Commit c610aba

Browse files
committed
Close python#19282: Native context management in dbm
1 parent eb8ea26 commit c610aba

8 files changed

Lines changed: 101 additions & 16 deletions

File tree

Doc/library/dbm.rst

Lines changed: 22 additions & 16 deletions

Lib/dbm/dumb.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,12 @@ def _chmod(self, file):
236236
if hasattr(self._os, 'chmod'):
237237
self._os.chmod(file, self._mode)
238238

239+
def __enter__(self):
240+
return self
241+
242+
def __exit__(self, *args):
243+
self.close()
244+
239245

240246
def open(file, flag=None, mode=0o666):
241247
"""Open the database file, filename, and return corresponding object.

Lib/test/test_dbm_dumb.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,19 @@ def test_random(self):
184184
self.assertEqual(expected, got)
185185
f.close()
186186

187+
def test_context_manager(self):
188+
with dumbdbm.open(_fname, 'c') as db:
189+
db["dumbdbm context manager"] = "context manager"
190+
191+
with dumbdbm.open(_fname, 'r') as db:
192+
self.assertEqual(list(db.keys()), [b"dumbdbm context manager"])
193+
194+
# This currently just raises AttributeError rather than a specific
195+
# exception like the GNU or NDBM based implementations. See
196+
# http://bugs.python.org/issue19385 for details.
197+
with self.assertRaises(Exception):
198+
db.keys()
199+
187200
def tearDown(self):
188201
_delete_files()
189202

Lib/test/test_dbm_gnu.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,17 @@ def test_reorganize(self):
8181
size2 = os.path.getsize(filename)
8282
self.assertTrue(size1 > size2 >= size0)
8383

84+
def test_context_manager(self):
85+
with gdbm.open(filename, 'c') as db:
86+
db["gdbm context manager"] = "context manager"
87+
88+
with gdbm.open(filename, 'r') as db:
89+
self.assertEqual(list(db.keys()), [b"gdbm context manager"])
90+
91+
with self.assertRaises(gdbm.error) as cm:
92+
db.keys()
93+
self.assertEqual(str(cm.exception),
94+
"GDBM object has already been closed")
8495

8596
if __name__ == '__main__':
8697
unittest.main()

Lib/test/test_dbm_ndbm.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,18 @@ def test_modes(self):
3737
except error:
3838
self.fail()
3939

40+
def test_context_manager(self):
41+
with dbm.ndbm.open(self.filename, 'c') as db:
42+
db["ndbm context manager"] = "context manager"
43+
44+
with dbm.ndbm.open(self.filename, 'r') as db:
45+
self.assertEqual(list(db.keys()), [b"ndbm context manager"])
46+
47+
with self.assertRaises(dbm.ndbm.error) as cm:
48+
db.keys()
49+
self.assertEqual(str(cm.exception),
50+
"DBM object has already been closed")
51+
52+
4053
if __name__ == '__main__':
4154
unittest.main()

Misc/NEWS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ Core and Builtins
5050
Library
5151
-------
5252

53+
- Issue #19282: dbm.open now supports the context manager protocol. (Inital
54+
patch by Claudiu Popa)
55+
5356
- Issue #8311: Added support for writing any bytes-like objects in the aifc,
5457
sunau, and wave modules.
5558

Modules/_dbmmodule.c

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,21 @@ dbm_setdefault(dbmobject *dp, PyObject *args)
313313
return defvalue;
314314
}
315315

316+
static PyObject *
317+
dbm__enter__(PyObject *self, PyObject *args)
318+
{
319+
Py_INCREF(self);
320+
return self;
321+
}
322+
323+
static PyObject *
324+
dbm__exit__(PyObject *self, PyObject *args)
325+
{
326+
_Py_IDENTIFIER(close);
327+
return _PyObject_CallMethodId(self, &PyId_close, NULL);
328+
}
329+
330+
316331
static PyMethodDef dbm_methods[] = {
317332
{"close", (PyCFunction)dbm__close, METH_NOARGS,
318333
"close()\nClose the database."},
@@ -325,6 +340,8 @@ static PyMethodDef dbm_methods[] = {
325340
"setdefault(key[, default]) -> value\n"
326341
"Return the value for key if present, otherwise default. If key\n"
327342
"is not in the database, it is inserted with default as the value."},
343+
{"__enter__", dbm__enter__, METH_NOARGS, NULL},
344+
{"__exit__", dbm__exit__, METH_VARARGS, NULL},
328345
{NULL, NULL} /* sentinel */
329346
};
330347

Modules/_gdbmmodule.c

Lines changed: 16 additions & 0 deletions

0 commit comments

Comments
 (0)