Makes shelves viable again in 3.0. Still a work in progress.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | #!/usr/bin/env python3.0
''' Dbm based on sqlite -- Needed to support shelves
Key and values are always stored as bytes. This means that when strings are
used they are implicitly converted to the default encoding before being
stored.
Issues:
# ??? how to coordinate with whichdb
# ??? Size of text fields fixed or varchar (do we need blobs)
# ??? does default encoding affect str-->bytes or PySqlite3 always use UTF-8
# ??? if pure python overhead and pysqlite overhead is too high, rewrite in C
'''
__all__ = ['error', 'open']
import sqlite3
import collections
from operator import itemgetter
error = sqlite3.DatabaseError
class SQLhash(collections.MutableMapping):
def __init__(self, filename=':memory:', flags='r', mode=None):
# XXX add flag/mode handling
# c -- create if it doesn't exist
# n -- new empty
# w -- open existing
# r -- readonly
MAKE_SHELF = 'CREATE TABLE IF NOT EXISTS shelf (key TEXT NOT NULL, value TEXT NOT NULL)'
MAKE_INDEX = 'CREATE UNIQUE INDEX IF NOT EXISTS keyndx ON shelf (key)'
self.conn = sqlite3.connect(filename)
self.conn.text_factory = bytes
self.conn.execute(MAKE_SHELF)
self.conn.execute(MAKE_INDEX)
self.conn.commit()
def __len__(self):
GET_LEN = 'SELECT COUNT(*) FROM shelf'
return self.conn.execute(GET_LEN).fetchone()[0]
def keys(self):
return SQLhashKeysView(self)
def values(self):
return SQLhashValuesView(self)
def items(self):
return SQLhashItemsView(self)
def __iter__(self):
return iter(self.keys())
def __contains__(self, key):
GET_ITEM = 'SELECT value FROM shelf WHERE key = ?'
return self.conn.execute(GET_ITEM, (key,)).fetchone() is not None
def __getitem__(self, key):
GET_ITEM = 'SELECT value FROM shelf WHERE key = ?'
item = self.conn.execute(GET_ITEM, (key,)).fetchone()
if item is None:
raise KeyError(key)
return item[0]
def __setitem__(self, key, value):
ADD_ITEM = 'REPLACE INTO shelf (key, value) VALUES (?,?)'
self.conn.execute(ADD_ITEM, (key, value))
self.conn.commit()
def __delitem__(self, key):
if key not in self:
raise KeyError(key)
DEL_ITEM = 'DELETE FROM shelf WHERE key = ?'
self.conn.execute(DEL_ITEM, (key,))
self.conn.commit()
def update(self, items=(), **kwds):
if isinstance(items, collections.Mapping):
items = items.items()
UPDATE_ITEMS = 'REPLACE INTO shelf (key, value) VALUES (?, ?)'
self.conn.executemany(UPDATE_ITEMS, items)
self.conn.commit()
if kwds:
self.update(kwds)
def clear(self):
CLEAR_ALL = 'DELETE FROM shelf; VACUUM;'
self.conn.executescript(CLEAR_ALL)
self.conn.commit()
def close(self):
if self.conn is not None:
self.conn.commit()
self.conn.close()
self.conn = None
def __del__(self):
self.close()
class ListRepr:
def __repr__(self):
return repr(list(self))
class SQLhashKeysView(collections.KeysView, ListRepr):
def __iter__(self):
GET_KEYS = 'SELECT key FROM shelf ORDER BY ROWID'
return map(itemgetter(0), self._mapping.conn.cursor().execute(GET_KEYS))
class SQLhashValuesView(collections.ValuesView, ListRepr):
def __iter__(self):
GET_VALUES = 'SELECT value FROM shelf ORDER BY ROWID'
return map(itemgetter(0), self._mapping.conn.cursor().execute(GET_VALUES))
class SQLhashItemsView(collections.ValuesView, ListRepr):
def __iter__(self):
GET_ITEMS = 'SELECT key, value FROM shelf ORDER BY ROWID'
return iter(self._mapping.conn.cursor().execute(GET_ITEMS))
def open(file=None, *args):
if file is not None:
return SQLhash(file)
return SQLhash()
if __name__ in '__main___':
for d in SQLhash(), SQLhash('example'):
print(list(d), "start")
d['abc'] = 'lmno'
print(d['abc'])
d['abc'] = 'rsvp'
d['xyz'] = 'pdq'
print(d.items())
print(d.values())
print(d.keys())
print(list(d), 'list')
d.update(p='x', q='y', r='z')
print(d.items())
del d['abc']
try:
print(d['abc'])
except KeyError:
pass
else:
raise Exception('oh noooo!')
try:
del d['abc']
except KeyError:
pass
else:
raise Exception('drat!')
print(list(d))
d.clear()
print(list(d))
d.update(p='x', q='y', r='z')
print(list(d))
d['xyz'] = 'pdq'
print()
d.close()
|
Includes an update based on J P Calderone's comments.
Answer to James Mills' posted question: Ves, the purpose of this is to provide a backend for shelves in Py3.0. We used dbhash for that in 2.x but now that bsddb3 is gone in 3.x, so we need a replacement using another DB.
This is basically a type of persistent storage using an sqlite backend right ? Similar to sheleve if I'm not mistaken.
--JamesMills
Interesting approach! It would also be interesting to turn this into a 'local couchdb', that allows queries on the key:value data by using map/reduce functions.