def __init__(self, host, port, pipeline_mode=False):
'''NOTE: pipeline_mode mode will queue up all requests that have noreply
set *until* flush_pipeline is called. If you're interleaving those with
get() etc they will not be sent in the order you expect!'''
self.stream = BufferedSocketStream(host, port)
self.pipeline_mode = pipeline_mode
def __init__(self, host, port, pipeline_mode=False):
'''NOTE: pipeline_mode mode will queue up all requests that have noreply
set *until* flush_pipeline is called. If you're interleaving those with
get() etc they will not be sent in the order you expect!'''
self.stream = BufferedSocketStream(host, port)
self.pipeline_mode = pipeline_mode
class MemcacheClient(object):
rx_get_value = re.compile(
'VALUE (?P<key>[^ ]*) (?P<flags>\d+) (?P<len>\d+)')
rx_gets_value = re.compile(
'VALUE (?P<key>[^ ]*) (?P<flags>\d+) (?P<len>\d+) (?P<cas>\d+)')
rx_inc_value = re.compile('(?P<value>\d+)')
def __init__(self, host, port, pipeline_mode=False):
'''NOTE: pipeline_mode mode will queue up all requests that have noreply
set *until* flush_pipeline is called. If you're interleaving those with
get() etc they will not be sent in the order you expect!'''
self.stream = BufferedSocketStream(host, port)
self.pipeline_mode = pipeline_mode
def add(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'add',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def append(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'append',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def cas(self,
key,
value,
flags=0,
exptime=0,
cas_unique=None,
noreply=False):
return self._set_family(
'cas',
key=key,
value=value,
flags=flags,
exptime=exptime,
cas_unique=cas_unique,
noreply=noreply,
)
def decr(self, key, delta=1, noreply=False):
return self._inc_family('decr', key, delta, noreply)
def delete(self, key, noreply=False):
# prepare command
command = 'delete %(key)s %(noreply)s\r\n' % {
'key': key,
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# parse the response
if not noreply:
resp = self.stream.read_line()
if not resp == 'DELETED\r\n':
raise create_exc(resp, 'Could not delete key %r' % key)
def flush_all(self, exptime=None, noreply=False):
# prepare command
# TODO no support for parameters yet
command = 'flush_all\r\n'
# execute command
self.maybe_write_now(command, noreply=noreply)
# parse the response
if not noreply:
resp = self.stream.read_line()
if not resp == 'OK\r\n':
raise create_exc(resp, 'Could not perform flush_all')
def get_multi(self, keys):
return self._get_multi_family('get', keys)
def gets_multi(self, keys):
return self._get_multi_family('gets', keys)
def _get_multi_family(self, instr, keys):
# prepare command
keys = ' '.join(keys)
command = '%(instr)s %(keys)s\r\n' % {
'instr': instr,
'keys': keys,
}
# execute command
self.stream.write(command)
# parse the response
dct = OrderedDict()
stream_terminator = 'END\r\n'
while True:
line = self.stream.read_line()
try:
cas_unique = None
if instr == 'get':
key, flags, bytelen = self.rx_get_value.findall(line)[0]
elif instr == 'gets':
key, flags, bytelen, cas_unique = self.rx_gets_value.findall(
line)[0]
flags = int(flags)
bytelen = int(bytelen)
except IndexError:
# no items were returned at all
if line == stream_terminator:
break
# read value + line terminator
data = self.stream.read_exact(bytelen + 2)
data = data[:-2]
item = Item(key, flags, data, cas_unique=cas_unique)
dct[key] = item
if self.stream.peek_contains(stream_terminator, consume=True):
break
return dct
def get(self, key):
keys = (key, )
dct = self.get_multi(keys)
try:
return dct[key]
except KeyError:
raise NotFoundError('The item with key %r was not found' % key)
def gets(self, key):
keys = (key, )
dct = self.gets_multi(keys)
try:
return dct[key]
except KeyError:
raise NotFoundError('The item with key %r was not found' % key)
def get_stats(self):
dct = OrderedDict()
# prepare command
command = 'stats\r\n'
# execute command
self.stream.write(command)
# read response line by line
stream_terminator = 'END\r\n'
line = self.stream.read_line()
while line != stream_terminator:
kw, key, value = line.split(' ', 2)
dct[key] = value.strip()
line = self.stream.read_line()
return dct
def incr(self, key, delta=1, noreply=False):
return self._inc_family('incr', key, delta, noreply)
def _inc_family(self, instr, key, delta=1, noreply=False):
# prepare command
command = '%(instr)s %(key)s %(delta)d %(noreply)s\r\n' % {
'instr': instr,
'key': key,
'delta': int(delta),
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# read the response
if not noreply:
resp = self.stream.read_line()
try:
num = self.rx_inc_value.findall(resp)[0]
return num
except IndexError:
raise create_exc(resp, 'Could not %s key %r' % (instr, key))
def quit(self):
'''Tells the server to drop the connection.'''
# prepare command
command = 'quit\r\n'
# execute command
self.stream.write(command)
def prepend(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'prepend',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def replace(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'replace',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def set(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'set',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def _set_family(self,
instr,
key,
value,
flags=0,
exptime=0,
cas_unique=None,
noreply=False):
# prepare command
header = '%(instr)s %(key)s %(flags)d %(exptime)d %(bytelen)d %(cas)s%(noreply)s\r\n' % {
'instr': instr,
'key': key,
'flags': flags,
'exptime': exptime,
'bytelen': len(value),
'cas': '%s ' % cas_unique if cas_unique else '',
'noreply': 'noreply' if noreply else '',
}
command = header + value + '\r\n'
# execute command
self.maybe_write_now(command, noreply=noreply)
# check for success
if not noreply:
resp = self.stream.read_line()
if not resp == 'STORED\r\n':
raise create_exc(
resp,
'Could not %s key %r to %r...' % (instr, key, value[:10]))
def send_malformed_cmd(self):
'''Sends an invalid command - causes the server to drop the
connection'''
self.stream.write('set 0 1\r\n')
buf = self.stream.read(4096)
return buf.strip()
def touch(self, key, exptime=0, noreply=False):
# prepare command
command = 'touch %(key)s %(exptime)d %(noreply)s\r\n' % {
'key': key,
'exptime': exptime,
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# check for success
if not noreply:
resp = self.stream.read_line()
if not resp == 'TOUCHED\r\n':
raise create_exc(resp, 'Could not touch key %r' % key)
def version(self):
# prepare command
command = 'version\r\n'
# execute command
self.stream.write(command)
# check for success
resp = self.stream.read_line()
kw, version = resp.split(' ', 1)
return version.strip()
def maybe_write_now(self, command, noreply=False):
if noreply and self.pipeline_mode:
self.stream.write_pipelined(command)
else:
self.stream.write(command)
def flush_pipeline(self):
self.stream.flush_pipeline()
class MemcacheClient(object):
rx_get_value = re.compile('VALUE (?P<key>[^ ]*) (?P<flags>\d+) (?P<len>\d+)')
rx_gets_value = re.compile('VALUE (?P<key>[^ ]*) (?P<flags>\d+) (?P<len>\d+) (?P<cas>\d+)')
rx_inc_value = re.compile('(?P<value>\d+)')
def __init__(self, host, port, pipeline_mode=False):
'''NOTE: pipeline_mode mode will queue up all requests that have noreply
set *until* flush_pipeline is called. If you're interleaving those with
get() etc they will not be sent in the order you expect!'''
self.stream = BufferedSocketStream(host, port)
self.pipeline_mode = pipeline_mode
def add(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'add',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def append(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'append',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def cas(self, key, value, flags=0, exptime=0, cas_unique=None, noreply=False):
return self._set_family(
'cas',
key=key,
value=value,
flags=flags,
exptime=exptime,
cas_unique=cas_unique,
noreply=noreply,
)
def decr(self, key, delta=1, noreply=False):
return self._inc_family('decr', key, delta, noreply)
def delete(self, key, noreply=False):
# prepare command
command = 'delete %(key)s %(noreply)s\r\n' % {
'key': key,
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# parse the response
if not noreply:
resp = self.stream.read_line()
if not resp == 'DELETED\r\n':
raise create_exc(resp, 'Could not delete key %r' % key)
def flush_all(self, exptime=None, noreply=False):
# prepare command
# TODO no support for parameters yet
command = 'flush_all\r\n'
# execute command
self.maybe_write_now(command, noreply=noreply)
# parse the response
if not noreply:
resp = self.stream.read_line()
if not resp == 'OK\r\n':
raise create_exc(resp, 'Could not perform flush_all')
def get_multi(self, keys):
return self._get_multi_family('get', keys)
def gets_multi(self, keys):
return self._get_multi_family('gets', keys)
def _get_multi_family(self, instr, keys):
# prepare command
keys = ' '.join(keys)
command = '%(instr)s %(keys)s\r\n' % {
'instr': instr,
'keys': keys,
}
# execute command
self.stream.write(command)
# parse the response
dct = OrderedDict()
stream_terminator = 'END\r\n'
while True:
line = self.stream.read_line()
try:
cas_unique = None
if instr == 'get':
key, flags, bytelen = self.rx_get_value.findall(line)[0]
elif instr == 'gets':
key, flags, bytelen, cas_unique = self.rx_gets_value.findall(line)[0]
flags = int(flags)
bytelen = int(bytelen)
except IndexError:
# no items were returned at all
if line == stream_terminator:
break
# read value + line terminator
data = self.stream.read_exact(bytelen + 2)
data = data[:-2]
item = Item(key, flags, data, cas_unique=cas_unique)
dct[key] = item
if self.stream.peek_contains(stream_terminator, consume=True):
break
return dct
def get(self, key):
keys = (key,)
dct = self.get_multi(keys)
try:
return dct[key]
except KeyError:
raise NotFoundError('The item with key %r was not found' % key)
def gets(self, key):
keys = (key,)
dct = self.gets_multi(keys)
try:
return dct[key]
except KeyError:
raise NotFoundError('The item with key %r was not found' % key)
def get_stats(self):
dct = OrderedDict()
# prepare command
command = 'stats\r\n'
# execute command
self.stream.write(command)
# read response line by line
stream_terminator = 'END\r\n'
line = self.stream.read_line()
while line != stream_terminator:
kw, key, value = line.split(' ', 2)
dct[key] = value.strip()
line = self.stream.read_line()
return dct
def incr(self, key, delta=1, noreply=False):
return self._inc_family('incr', key, delta, noreply)
def _inc_family(self, instr, key, delta=1, noreply=False):
# prepare command
command = '%(instr)s %(key)s %(delta)d %(noreply)s\r\n' % {
'instr': instr,
'key': key,
'delta': int(delta),
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# read the response
if not noreply:
resp = self.stream.read_line()
try:
num = self.rx_inc_value.findall(resp)[0]
return num
except IndexError:
raise create_exc(resp, 'Could not %s key %r' % (instr, key))
def quit(self):
'''Tells the server to drop the connection.'''
# prepare command
command = 'quit\r\n'
# execute command
self.stream.write(command)
def prepend(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'prepend',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def replace(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'replace',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def set(self, key, value, flags=0, exptime=0, noreply=False):
return self._set_family(
'set',
key=key,
value=value,
flags=flags,
exptime=exptime,
noreply=noreply,
)
def _set_family(self, instr, key, value, flags=0, exptime=0, cas_unique=None, noreply=False):
# prepare command
header = '%(instr)s %(key)s %(flags)d %(exptime)d %(bytelen)d %(cas)s%(noreply)s\r\n' % {
'instr': instr,
'key': key,
'flags': flags,
'exptime': exptime,
'bytelen': len(value),
'cas': '%s ' % cas_unique if cas_unique else '',
'noreply': 'noreply' if noreply else '',
}
command = header + value + '\r\n'
# execute command
self.maybe_write_now(command, noreply=noreply)
# check for success
if not noreply:
resp = self.stream.read_line()
if not resp == 'STORED\r\n':
raise create_exc(resp, 'Could not %s key %r to %r...' %
(instr, key, value[:10]))
def send_malformed_cmd(self):
'''Sends an invalid command - causes the server to drop the
connection'''
self.stream.write('set 0 1\r\n')
buf = self.stream.read(4096)
return buf.strip()
def touch(self, key, exptime=0, noreply=False):
# prepare command
command = 'touch %(key)s %(exptime)d %(noreply)s\r\n' % {
'key': key,
'exptime': exptime,
'noreply': 'noreply' if noreply else '',
}
# execute command
self.maybe_write_now(command, noreply=noreply)
# check for success
if not noreply:
resp = self.stream.read_line()
if not resp == 'TOUCHED\r\n':
raise create_exc(resp, 'Could not touch key %r' % key)
def version(self):
# prepare command
command = 'version\r\n'
# execute command
self.stream.write(command)
# check for success
resp = self.stream.read_line()
kw, version = resp.split(' ', 1)
return version.strip()
def maybe_write_now(self, command, noreply=False):
if noreply and self.pipeline_mode:
self.stream.write_pipelined(command)
else:
self.stream.write(command)
def flush_pipeline(self):
self.stream.flush_pipeline()