2 /* DBM module using dictionary interface */
11 /* Some Linux systems install gdbm/ndbm.h, but not ndbm.h. This supports
12 * whichever configure was able to locate.
14 #if defined(HAVE_NDBM_H)
16 #if defined(PYOS_OS2) && !defined(PYCC_GCC)
17 static char *which_dbm
= "ndbm";
19 static char *which_dbm
= "GNU gdbm"; /* EMX port of GDBM */
21 #elif defined(HAVE_GDBM_NDBM_H)
22 #include <gdbm/ndbm.h>
23 static char *which_dbm
= "GNU gdbm";
24 #elif defined(HAVE_BERKDB_H)
26 static char *which_dbm
= "Berkeley DB";
28 #error "No ndbm.h available!"
33 int di_size
; /* -1 means recompute */
37 static PyTypeObject Dbmtype
;
39 #define is_dbmobject(v) (Py_TYPE(v) == &Dbmtype)
40 #define check_dbmobject_open(v) if ((v)->di_dbm == NULL) \
41 { PyErr_SetString(DbmError, "DBM object has already been closed"); \
44 static PyObject
*DbmError
;
47 newdbmobject(char *file
, int flags
, int mode
)
51 dp
= PyObject_New(dbmobject
, &Dbmtype
);
55 if ( (dp
->di_dbm
= dbm_open(file
, flags
, mode
)) == 0 ) {
56 PyErr_SetFromErrno(DbmError
);
60 return (PyObject
*)dp
;
66 dbm_dealloc(register dbmobject
*dp
)
69 dbm_close(dp
->di_dbm
);
74 dbm_length(dbmobject
*dp
)
76 if (dp
->di_dbm
== NULL
) {
77 PyErr_SetString(DbmError
, "DBM object has already been closed");
80 if ( dp
->di_size
< 0 ) {
85 for ( key
=dbm_firstkey(dp
->di_dbm
); key
.dptr
;
86 key
= dbm_nextkey(dp
->di_dbm
))
94 dbm_subscript(dbmobject
*dp
, register PyObject
*key
)
99 if (!PyArg_Parse(key
, "s#", &krec
.dptr
, &tmp_size
) )
102 krec
.dsize
= tmp_size
;
103 check_dbmobject_open(dp
);
104 drec
= dbm_fetch(dp
->di_dbm
, krec
);
105 if ( drec
.dptr
== 0 ) {
106 PyErr_SetString(PyExc_KeyError
,
107 PyString_AS_STRING((PyStringObject
*)key
));
110 if ( dbm_error(dp
->di_dbm
) ) {
111 dbm_clearerr(dp
->di_dbm
);
112 PyErr_SetString(DbmError
, "");
115 return PyString_FromStringAndSize(drec
.dptr
, drec
.dsize
);
119 dbm_ass_sub(dbmobject
*dp
, PyObject
*v
, PyObject
*w
)
124 if ( !PyArg_Parse(v
, "s#", &krec
.dptr
, &tmp_size
) ) {
125 PyErr_SetString(PyExc_TypeError
,
126 "dbm mappings have string indices only");
129 krec
.dsize
= tmp_size
;
130 if (dp
->di_dbm
== NULL
) {
131 PyErr_SetString(DbmError
, "DBM object has already been closed");
136 if ( dbm_delete(dp
->di_dbm
, krec
) < 0 ) {
137 dbm_clearerr(dp
->di_dbm
);
138 PyErr_SetString(PyExc_KeyError
,
139 PyString_AS_STRING((PyStringObject
*)v
));
143 if ( !PyArg_Parse(w
, "s#", &drec
.dptr
, &tmp_size
) ) {
144 PyErr_SetString(PyExc_TypeError
,
145 "dbm mappings have string elements only");
148 drec
.dsize
= tmp_size
;
149 if ( dbm_store(dp
->di_dbm
, krec
, drec
, DBM_REPLACE
) < 0 ) {
150 dbm_clearerr(dp
->di_dbm
);
151 PyErr_SetString(DbmError
,
152 "cannot add item to database");
156 if ( dbm_error(dp
->di_dbm
) ) {
157 dbm_clearerr(dp
->di_dbm
);
158 PyErr_SetString(DbmError
, "");
164 static PyMappingMethods dbm_as_mapping
= {
165 (lenfunc
)dbm_length
, /*mp_length*/
166 (binaryfunc
)dbm_subscript
, /*mp_subscript*/
167 (objobjargproc
)dbm_ass_sub
, /*mp_ass_subscript*/
171 dbm__close(register dbmobject
*dp
, PyObject
*unused
)
174 dbm_close(dp
->di_dbm
);
181 dbm_keys(register dbmobject
*dp
, PyObject
*unused
)
183 register PyObject
*v
, *item
;
187 check_dbmobject_open(dp
);
191 for (key
= dbm_firstkey(dp
->di_dbm
); key
.dptr
;
192 key
= dbm_nextkey(dp
->di_dbm
)) {
193 item
= PyString_FromStringAndSize(key
.dptr
, key
.dsize
);
198 err
= PyList_Append(v
, item
);
209 dbm_has_key(register dbmobject
*dp
, PyObject
*args
)
215 if (!PyArg_ParseTuple(args
, "s#:has_key", &tmp_ptr
, &tmp_size
))
218 key
.dsize
= tmp_size
;
219 check_dbmobject_open(dp
);
220 val
= dbm_fetch(dp
->di_dbm
, key
);
221 return PyInt_FromLong(val
.dptr
!= NULL
);
225 dbm_get(register dbmobject
*dp
, PyObject
*args
)
228 PyObject
*defvalue
= Py_None
;
232 if (!PyArg_ParseTuple(args
, "s#|O:get",
233 &tmp_ptr
, &tmp_size
, &defvalue
))
236 key
.dsize
= tmp_size
;
237 check_dbmobject_open(dp
);
238 val
= dbm_fetch(dp
->di_dbm
, key
);
239 if (val
.dptr
!= NULL
)
240 return PyString_FromStringAndSize(val
.dptr
, val
.dsize
);
248 dbm_setdefault(register dbmobject
*dp
, PyObject
*args
)
251 PyObject
*defvalue
= NULL
;
255 if (!PyArg_ParseTuple(args
, "s#|S:setdefault",
256 &tmp_ptr
, &tmp_size
, &defvalue
))
259 key
.dsize
= tmp_size
;
260 check_dbmobject_open(dp
);
261 val
= dbm_fetch(dp
->di_dbm
, key
);
262 if (val
.dptr
!= NULL
)
263 return PyString_FromStringAndSize(val
.dptr
, val
.dsize
);
264 if (defvalue
== NULL
) {
265 defvalue
= PyString_FromStringAndSize(NULL
, 0);
266 if (defvalue
== NULL
)
271 val
.dptr
= PyString_AS_STRING(defvalue
);
272 val
.dsize
= PyString_GET_SIZE(defvalue
);
273 if (dbm_store(dp
->di_dbm
, key
, val
, DBM_INSERT
) < 0) {
274 dbm_clearerr(dp
->di_dbm
);
275 PyErr_SetString(DbmError
, "cannot add item to database");
281 static PyMethodDef dbm_methods
[] = {
282 {"close", (PyCFunction
)dbm__close
, METH_NOARGS
,
283 "close()\nClose the database."},
284 {"keys", (PyCFunction
)dbm_keys
, METH_NOARGS
,
285 "keys() -> list\nReturn a list of all keys in the database."},
286 {"has_key", (PyCFunction
)dbm_has_key
, METH_VARARGS
,
287 "has_key(key} -> boolean\nReturn true iff key is in the database."},
288 {"get", (PyCFunction
)dbm_get
, METH_VARARGS
,
289 "get(key[, default]) -> value\n"
290 "Return the value for key if present, otherwise default."},
291 {"setdefault", (PyCFunction
)dbm_setdefault
, METH_VARARGS
,
292 "setdefault(key[, default]) -> value\n"
293 "Return the value for key if present, otherwise default. If key\n"
294 "is not in the database, it is inserted with default as the value."},
295 {NULL
, NULL
} /* sentinel */
299 dbm_getattr(dbmobject
*dp
, char *name
)
301 return Py_FindMethod(dbm_methods
, (PyObject
*)dp
, name
);
304 static PyTypeObject Dbmtype
= {
305 PyVarObject_HEAD_INIT(NULL
, 0)
309 (destructor
)dbm_dealloc
, /*tp_dealloc*/
311 (getattrfunc
)dbm_getattr
, /*tp_getattr*/
316 0, /*tp_as_sequence*/
317 &dbm_as_mapping
, /*tp_as_mapping*/
320 /* ----------------------------------------------------------------- */
323 dbmopen(PyObject
*self
, PyObject
*args
)
330 if ( !PyArg_ParseTuple(args
, "s|si:open", &name
, &flags
, &mode
) )
332 if ( strcmp(flags
, "r") == 0 )
334 else if ( strcmp(flags
, "w") == 0 )
336 else if ( strcmp(flags
, "rw") == 0 ) /* B/W compat */
337 iflags
= O_RDWR
|O_CREAT
;
338 else if ( strcmp(flags
, "c") == 0 )
339 iflags
= O_RDWR
|O_CREAT
;
340 else if ( strcmp(flags
, "n") == 0 )
341 iflags
= O_RDWR
|O_CREAT
|O_TRUNC
;
343 PyErr_SetString(DbmError
,
344 "arg 2 to open should be 'r', 'w', 'c', or 'n'");
347 return newdbmobject(name
, iflags
, mode
);
350 static PyMethodDef dbmmodule_methods
[] = {
351 { "open", (PyCFunction
)dbmopen
, METH_VARARGS
,
352 "open(path[, flag[, mode]]) -> mapping\n"
353 "Return a database object."},
361 Dbmtype
.ob_type
= &PyType_Type
;
362 m
= Py_InitModule("dbm", dbmmodule_methods
);
365 d
= PyModule_GetDict(m
);
366 if (DbmError
== NULL
)
367 DbmError
= PyErr_NewException("dbm.error", NULL
, NULL
);
368 s
= PyString_FromString(which_dbm
);
370 PyDict_SetItemString(d
, "library", s
);
373 if (DbmError
!= NULL
)
374 PyDict_SetItemString(d
, "error", DbmError
);