ledisdb/client/ledis-py/ledis/client.py

935 lines
33 KiB
Python
Raw Normal View History

2014-06-30 06:56:32 +04:00
from __future__ import with_statement
import datetime
import time as mod_time
2014-08-26 06:56:29 +04:00
from itertools import chain, starmap
from ledis._compat import (b, izip, imap, iteritems,
basestring, long, nativestr, bytes)
2014-07-01 06:40:56 +04:00
from ledis.connection import ConnectionPool, UnixDomainSocketConnection
from ledis.exceptions import (
2014-06-30 06:56:32 +04:00
ConnectionError,
DataError,
2014-07-01 06:40:56 +04:00
LedisError,
2014-08-26 06:56:29 +04:00
ResponseError,
TxNotBeginError
2014-06-30 06:56:32 +04:00
)
SYM_EMPTY = b('')
def list_or_args(keys, args):
# returns a single list combining keys and args
try:
iter(keys)
# a string or bytes instance can be iterated, but indicates
# keys wasn't passed as a list
if isinstance(keys, (basestring, bytes)):
keys = [keys]
except TypeError:
keys = [keys]
if args:
keys.extend(args)
return keys
def string_keys_to_dict(key_string, callback):
return dict.fromkeys(key_string.split(), callback)
def dict_merge(*dicts):
merged = {}
[merged.update(d) for d in dicts]
return merged
def pairs_to_dict(response):
"Create a dict given a list of key/value pairs"
it = iter(response)
return dict(izip(it, it))
def zset_score_pairs(response, **options):
"""
If ``withscores`` is specified in the options, return the response as
a list of (value, score) pairs
"""
if not response or not options['withscores']:
return response
it = iter(response)
return list(izip(it, imap(int, it)))
2014-06-30 06:56:32 +04:00
def int_or_none(response):
if response is None:
return None
return int(response)
2014-07-01 06:40:56 +04:00
class Ledis(object):
2014-06-30 06:56:32 +04:00
"""
Implementation of the Redis protocol.
2014-07-01 06:40:56 +04:00
This abstract class provides a Python interface to all LedisDB commands
2014-06-30 06:56:32 +04:00
and an implementation of the Redis protocol.
Connection and Pipeline derive from this, implementing how
2014-07-01 06:40:56 +04:00
the commands are sent and received to the Ledis server
2014-06-30 06:56:32 +04:00
"""
RESPONSE_CALLBACKS = dict_merge(
string_keys_to_dict(
'EXISTS HEXISTS SISMEMBER HMSET SETNX'
'PERSIST HPERSIST LPERSIST ZPERSIST SPERSIST BPERSIST'
'EXPIRE LEXPIRE HEXPIRE SEXPIRE ZEXPIRE BEXPIRE'
'EXPIREAT LBEXPIREAT HEXPIREAT SEXPIREAT ZEXPIREAT BEXPIREAT',
2014-06-30 06:56:32 +04:00
bool
),
string_keys_to_dict(
'DECRBY DEL HDEL HLEN INCRBY LLEN ZADD ZCARD ZREM'
'ZREMRANGEBYRANK ZREMRANGEBYSCORE LMCLEAR HMCLEAR'
'ZMCLEAR BCOUNT BGETBIT BSETBIT BOPT BMSETBIT'
'SADD SCARD SDIFFSTORE SINTERSTORE SUNIONSTORE SREM'
'SCLEAR SMLEAR BDELETE',
2014-06-30 06:56:32 +04:00
int
),
string_keys_to_dict(
'LPUSH RPUSH',
lambda r: isinstance(r, long) and r or nativestr(r) == 'OK'
),
string_keys_to_dict(
2014-07-02 05:15:56 +04:00
'MSET SELECT ',
2014-06-30 06:56:32 +04:00
lambda r: nativestr(r) == 'OK'
),
string_keys_to_dict(
'SDIFF SINTER SMEMBERS SUNION',
lambda r: r and set(r) or set()
),
2014-06-30 06:56:32 +04:00
string_keys_to_dict(
'ZRANGE ZRANGEBYSCORE ZREVRANGE ZREVRANGEBYSCORE',
zset_score_pairs
),
string_keys_to_dict('ZRANK ZREVRANK ZSCORE ZINCRBY', int_or_none),
2014-06-30 06:56:32 +04:00
{
'HGETALL': lambda r: r and pairs_to_dict(r) or {},
'PING': lambda r: nativestr(r) == 'PONG',
'SET': lambda r: r and nativestr(r) == 'OK',
},
2014-06-30 06:56:32 +04:00
)
@classmethod
def from_url(cls, url, db=None, **kwargs):
"""
Return a Ledis client object configured from the given URL.
2014-06-30 06:56:32 +04:00
For example::
2014-07-10 11:17:51 +04:00
ledis://localhost:6380/0
unix:///path/to/socket.sock?db=0
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
There are several ways to specify a database number. The parse function
will return the first specified option:
2014-07-10 11:17:51 +04:00
1. A ``db`` querystring option, e.g. ledis://localhost?db=0
2. If using the ledis:// scheme, the path argument of the url, e.g.
ledis://localhost/0
2014-07-01 06:40:56 +04:00
3. The ``db`` argument to this function.
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
If none of these options are specified, db=0 is used.
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
Any additional querystring arguments and keyword arguments will be
passed along to the ConnectionPool class's initializer. In the case
of conflicting arguments, querystring arguments always win.
"""
connection_pool = ConnectionPool.from_url(url, db=db, **kwargs)
return cls(connection_pool=connection_pool)
2014-06-30 06:56:32 +04:00
def __init__(self, host='localhost', port=6380,
db=0, socket_timeout=None,
2014-06-30 06:56:32 +04:00
connection_pool=None, charset='utf-8',
errors='strict', decode_responses=False,
unix_socket_path=None):
if not connection_pool:
kwargs = {
'db': db,
'socket_timeout': socket_timeout,
'encoding': charset,
'encoding_errors': errors,
'decode_responses': decode_responses,
}
# based on input, setup appropriate connection args
if unix_socket_path:
kwargs.update({
'path': unix_socket_path,
'connection_class': UnixDomainSocketConnection
})
else:
kwargs.update({
'host': host,
'port': port
})
connection_pool = ConnectionPool(**kwargs)
self.connection_pool = connection_pool
self.response_callbacks = self.__class__.RESPONSE_CALLBACKS.copy()
def set_response_callback(self, command, callback):
"Set a custom Response Callback"
self.response_callbacks[command] = callback
2014-08-26 06:56:29 +04:00
# def pipeline(self, transaction=True, shard_hint=None):
# """
# Return a new pipeline object that can queue multiple commands for
# later execution. ``transaction`` indicates whether all commands
# should be executed atomically. Apart from making a group of operations
# atomic, pipelines are useful for reducing the back-and-forth overhead
# between the client and server.
# """
# return StrictPipeline(
# self.connection_pool,
# self.response_callbacks,
# transaction,
# shard_hint)
def tx(self):
return Transaction(
self.connection_pool,
self.response_callbacks)
2014-06-30 06:56:32 +04:00
#### COMMAND EXECUTION AND PROTOCOL PARSING ####
2014-07-01 06:40:56 +04:00
2014-06-30 06:56:32 +04:00
def execute_command(self, *args, **options):
"Execute a command and return a parsed response"
pool = self.connection_pool
command_name = args[0]
connection = pool.get_connection(command_name, **options)
try:
connection.send_command(*args)
return self.parse_response(connection, command_name, **options)
except ConnectionError:
connection.disconnect()
connection.send_command(*args)
return self.parse_response(connection, command_name, **options)
finally:
pool.release(connection)
def parse_response(self, connection, command_name, **options):
2014-07-01 06:40:56 +04:00
"Parses a response from the Ledis server"
2014-06-30 06:56:32 +04:00
response = connection.read_response()
if command_name in self.response_callbacks:
return self.response_callbacks[command_name](response, **options)
return response
2014-07-01 06:40:56 +04:00
#### SERVER INFORMATION ####
2014-06-30 06:56:32 +04:00
def echo(self, value):
"Echo the string back from the server"
return self.execute_command('ECHO', value)
def ping(self):
2014-07-01 06:40:56 +04:00
"Ping the Ledis server"
2014-06-30 06:56:32 +04:00
return self.execute_command('PING')
2014-07-01 06:40:56 +04:00
def select(self, db):
"""Select a Ledis db, ``db`` is integer type"""
2014-06-30 06:56:32 +04:00
try:
2014-07-01 06:40:56 +04:00
db = int(db)
except ValueError:
db = 0
return self.execute_command('SELECT', db)
2014-06-30 06:56:32 +04:00
#### BASIC KEY COMMANDS ####
2014-07-01 06:40:56 +04:00
def decr(self, name, amount=1):
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
Decrements the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as 0 - ``amount``
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
return self.execute_command('DECRBY', name, amount)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def decrby(self, name, amount=1):
2014-06-30 06:56:32 +04:00
"""
Decrements the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as 0 - ``amount``
"""
2014-07-01 06:40:56 +04:00
return self.decr(name, amount)
2014-06-30 06:56:32 +04:00
def delete(self, *names):
"Delete one or more keys specified by ``names``"
return self.execute_command('DEL', *names)
def exists(self, name):
"Returns a boolean indicating whether key ``name`` exists"
return self.execute_command('EXISTS', name)
def expire(self, name, time):
"""
Set an expire flag on key ``name`` for ``time`` seconds. ``time``
can be represented by an integer or a Python timedelta object.
"""
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
return self.execute_command('EXPIRE', name, time)
def expireat(self, name, when):
"""
Set an expire flag on key ``name``. ``when`` can be represented
as an integer indicating unix time or a Python datetime object.
"""
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('EXPIREAT', name, when)
def get(self, name):
"""
Return the value at key ``name``, or None if the key doesn't exist
"""
return self.execute_command('GET', name)
def __getitem__(self, name):
"""
Return the value at key ``name``, raises a KeyError if the key
doesn't exist.
"""
value = self.get(name)
if value:
return value
raise KeyError(name)
def getset(self, name, value):
"""
Set the value at key ``name`` to ``value`` if key doesn't exist
Return the value at key ``name`` atomically
"""
return self.execute_command('GETSET', name, value)
def incr(self, name, amount=1):
"""
Increments the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as ``amount``
"""
return self.execute_command('INCRBY', name, amount)
def incrby(self, name, amount=1):
"""
Increments the value of ``key`` by ``amount``. If no key exists,
the value will be initialized as ``amount``
"""
# An alias for ``incr()``, because it is already implemented
2014-07-01 06:40:56 +04:00
# as INCRBY ledis command.
2014-06-30 06:56:32 +04:00
return self.incr(name, amount)
def mget(self, keys, *args):
"""
Returns a list of values ordered identically to ``keys``
"""
args = list_or_args(keys, args)
return self.execute_command('MGET', *args)
def mset(self, *args, **kwargs):
"""
Sets key/values based on a mapping. Mapping can be supplied as a single
dictionary argument or as kwargs.
"""
if args:
if len(args) != 1 or not isinstance(args[0], dict):
2014-07-01 06:40:56 +04:00
raise LedisError('MSET requires **kwargs or a single dict arg')
2014-06-30 06:56:32 +04:00
kwargs.update(args[0])
items = []
for pair in iteritems(kwargs):
items.extend(pair)
return self.execute_command('MSET', *items)
def set(self, name, value):
2014-06-30 06:56:32 +04:00
"""
2014-07-08 16:44:09 +04:00
Set the value of key ``name`` to ``value``.
2014-06-30 06:56:32 +04:00
"""
pieces = [name, value]
return self.execute_command('SET', *pieces)
def setnx(self, name, value):
"Set the value of key ``name`` to ``value`` if key doesn't exist"
return self.execute_command('SETNX', name, value)
def ttl(self, name):
"Returns the number of seconds until the key ``name`` will expire"
return self.execute_command('TTL', name)
2014-07-01 06:40:56 +04:00
def persist(self, name):
2014-07-08 16:44:09 +04:00
"Removes an expiration on name"
2014-07-01 06:40:56 +04:00
return self.execute_command('PERSIST', name)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
#### LIST COMMANDS ####
2014-06-30 06:56:32 +04:00
def lindex(self, name, index):
"""
Return the item from list ``name`` at position ``index``
Negative indexes are supported and will return an item at the
end of the list
"""
return self.execute_command('LINDEX', name, index)
def llen(self, name):
"Return the length of the list ``name``"
return self.execute_command('LLEN', name)
def lpop(self, name):
"Remove and return the first item of the list ``name``"
return self.execute_command('LPOP', name)
def lpush(self, name, *values):
"Push ``values`` onto the head of the list ``name``"
return self.execute_command('LPUSH', name, *values)
def lrange(self, name, start, end):
"""
Return a slice of the list ``name`` between
position ``start`` and ``end``
``start`` and ``end`` can be negative numbers just like
Python slicing notation
"""
return self.execute_command('LRANGE', name, start, end)
def rpop(self, name):
"Remove and return the last item of the list ``name``"
return self.execute_command('RPOP', name)
def rpush(self, name, *values):
"Push ``values`` onto the tail of the list ``name``"
return self.execute_command('RPUSH', name, *values)
2014-07-01 06:40:56 +04:00
# SPECIAL COMMANDS SUPPORTED BY LEDISDB
def lclear(self, name):
2014-07-08 16:44:09 +04:00
"Delete the key of ``name``"
2014-07-01 06:40:56 +04:00
return self.execute_command("LCLEAR", name)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def lmclear(self, *names):
2014-07-08 16:44:09 +04:00
"Delete multiple keys of ``name``"
2014-07-01 06:40:56 +04:00
return self.execute_command('LMCLEAR', *names)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def lexpire(self, name, time):
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
Set an expire flag on key ``name`` for ``time`` seconds. ``time``
can be represented by an integer or a Python timedelta object.
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
return self.execute_command("LEXPIRE", name, time)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def lexpireat(self, name, when):
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
Set an expire flag on key ``name``. ``when`` can be represented as an integer
indicating unix time or a Python datetime object.
2014-06-30 06:56:32 +04:00
"""
2014-07-01 06:40:56 +04:00
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('LEXPIREAT', name, when)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def lttl(self, name):
2014-07-08 16:44:09 +04:00
"Returns the number of seconds until the key ``name`` will expire"
2014-07-01 06:40:56 +04:00
return self.execute_command('LTTL', name)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def lpersist(self, name):
2014-07-08 16:44:09 +04:00
"Removes an expiration on ``name``"
2014-07-01 06:40:56 +04:00
return self.execute_command('LPERSIST', name)
2014-06-30 06:56:32 +04:00
#### SET COMMANDS ####
def sadd(self, name, *values):
"Add ``value(s)`` to set ``name``"
return self.execute_command('SADD', name, *values)
def scard(self, name):
"Return the number of elements in set ``name``"
return self.execute_command('SCARD', name)
def sdiff(self, keys, *args):
"Return the difference of sets specified by ``keys``"
args = list_or_args(keys, args)
return self.execute_command('SDIFF', *args)
def sdiffstore(self, dest, keys, *args):
"""
Store the difference of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
"""
args = list_or_args(keys, args)
return self.execute_command('SDIFFSTORE', dest, *args)
def sinter(self, keys, *args):
"Return the intersection of sets specified by ``keys``"
args = list_or_args(keys, args)
return self.execute_command('SINTER', *args)
def sinterstore(self, dest, keys, *args):
"""
Store the intersection of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
"""
args = list_or_args(keys, args)
return self.execute_command('SINTERSTORE', dest, *args)
def sismember(self, name, value):
"Return a boolean indicating if ``value`` is a member of set ``name``"
return self.execute_command('SISMEMBER', name, value)
def smembers(self, name):
"Return all members of the set ``name``"
return self.execute_command('SMEMBERS', name)
def srem(self, name, *values):
"Remove ``values`` from set ``name``"
return self.execute_command('SREM', name, *values)
def sunion(self, keys, *args):
"Return the union of sets specified by ``keys``"
args = list_or_args(keys, args)
return self.execute_command('SUNION', *args)
def sunionstore(self, dest, keys, *args):
"""
Store the union of sets specified by ``keys`` into a new
set named ``dest``. Returns the number of keys in the new set.
"""
args = list_or_args(keys, args)
return self.execute_command('SUNIONSTORE', dest, *args)
# SPECIAL COMMANDS SUPPORTED BY LEDISDB
def sclear(self, name):
"Delete key ``name`` from set"
return self.execute_command('SCLEAR', name)
def smclear(self, *names):
"Delete multiple keys ``names`` from set"
return self.execute_command('SMCLEAR', *names)
def sexpire(self, name, time):
"""
Set an expire flag on key name for time milliseconds.
time can be represented by an integer or a Python timedelta object.
"""
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
return self.execute_command('SEXPIRE', name, time)
def sexpireat(self, name, when):
"""
Set an expire flag on key name. when can be represented as an integer
representing unix time in milliseconds (unix time * 1000) or a
Python datetime object.
"""
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('SEXPIREAT', name, when)
def sttl(self, name):
"Returns the number of seconds until the key name will expire"
return self.execute_command('STTL', name)
def spersist(self, name):
"Removes an expiration on name"
return self.execute_command('SPERSIST', name)
2014-06-30 06:56:32 +04:00
#### SORTED SET COMMANDS ####
def zadd(self, name, *args, **kwargs):
"""
Set any number of score, element-name pairs to the key ``name``. Pairs
can be specified in two ways:
As *args, in the form of: score1, name1, score2, name2, ...
or as **kwargs, in the form of: name1=score1, name2=score2, ...
The following example would add four values to the 'my-key' key:
2014-07-01 06:40:56 +04:00
ledis.zadd('my-key', 1.1, 'name1', 2.2, 'name2', name3=3.3, name4=4.4)
2014-06-30 06:56:32 +04:00
"""
pieces = []
if args:
if len(args) % 2 != 0:
2014-07-01 06:40:56 +04:00
raise LedisError("ZADD requires an equal number of "
2014-06-30 06:56:32 +04:00
"values and scores")
pieces.extend(args)
for pair in iteritems(kwargs):
pieces.append(pair[1])
pieces.append(pair[0])
return self.execute_command('ZADD', name, *pieces)
def zcard(self, name):
"Return the number of elements in the sorted set ``name``"
return self.execute_command('ZCARD', name)
def zcount(self, name, min, max):
2014-07-08 16:44:09 +04:00
"""
Return the number of elements in the sorted set at key ``name`` with a score
between ``min`` and ``max``.
2014-07-08 16:44:09 +04:00
The min and max arguments have the same semantic as described for ZRANGEBYSCORE.
"""
2014-06-30 06:56:32 +04:00
return self.execute_command('ZCOUNT', name, min, max)
def zincrby(self, name, value, amount=1):
"Increment the score of ``value`` in sorted set ``name`` by ``amount``"
return self.execute_command('ZINCRBY', name, amount, value)
def zrange(self, name, start, end, desc=False, withscores=False):
2014-06-30 06:56:32 +04:00
"""
Return a range of values from sorted set ``name`` between
``start`` and ``end`` sorted in ascending order.
``start`` and ``end`` can be negative, indicating the end of the range.
``desc`` a boolean indicating whether to sort the results descendingly
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs
"""
if desc:
return self.zrevrange(name, start, end, withscores)
2014-06-30 06:56:32 +04:00
pieces = ['ZRANGE', name, start, end]
if withscores:
pieces.append('withscores')
options = {
'withscores': withscores}
2014-06-30 06:56:32 +04:00
return self.execute_command(*pieces, **options)
def zrangebyscore(self, name, min, max, start=None, num=None,
2014-07-01 12:32:06 +04:00
withscores=False):
2014-06-30 06:56:32 +04:00
"""
Return a range of values from the sorted set ``name`` with scores
between ``min`` and ``max``.
If ``start`` and ``num`` are specified, then return a slice
of the range.
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs
"""
if (start is not None and num is None) or \
(num is not None and start is None):
2014-07-01 06:40:56 +04:00
raise LedisError("``start`` and ``num`` must both be specified")
2014-06-30 06:56:32 +04:00
pieces = ['ZRANGEBYSCORE', name, min, max]
if start is not None and num is not None:
pieces.extend(['LIMIT', start, num])
if withscores:
pieces.append('withscores')
options = {
'withscores': withscores}
2014-06-30 06:56:32 +04:00
return self.execute_command(*pieces, **options)
def zrank(self, name, value):
"""
Returns a 0-based value indicating the rank of ``value`` in sorted set
``name``
"""
return self.execute_command('ZRANK', name, value)
def zrem(self, name, *values):
"Remove member ``values`` from sorted set ``name``"
return self.execute_command('ZREM', name, *values)
def zremrangebyrank(self, name, min, max):
"""
Remove all elements in the sorted set ``name`` with ranks between
``min`` and ``max``. Values are 0-based, ordered from smallest score
to largest. Values can be negative indicating the highest scores.
Returns the number of elements removed
"""
return self.execute_command('ZREMRANGEBYRANK', name, min, max)
def zremrangebyscore(self, name, min, max):
"""
Remove all elements in the sorted set ``name`` with scores
between ``min`` and ``max``. Returns the number of elements removed.
"""
return self.execute_command('ZREMRANGEBYSCORE', name, min, max)
def zrevrange(self, name, start, num, withscores=False):
2014-06-30 06:56:32 +04:00
"""
Return a range of values from sorted set ``name`` between
``start`` and ``num`` sorted in descending order.
``start`` and ``num`` can be negative, indicating the end of the range.
``withscores`` indicates to return the scores along with the values
The return type is a list of (value, score) pairs
"""
pieces = ['ZREVRANGE', name, start, num]
if withscores:
pieces.append('withscores')
options = {'withscores': withscores}
2014-06-30 06:56:32 +04:00
return self.execute_command(*pieces, **options)
2014-07-01 06:40:56 +04:00
def zrevrangebyscore(self, name, min, max, start=None, num=None,
withscores=False):
2014-06-30 06:56:32 +04:00
"""
Return a range of values from the sorted set ``name`` with scores
between ``min`` and ``max`` in descending order.
If ``start`` and ``num`` are specified, then return a slice
of the range.
``withscores`` indicates to return the scores along with the values.
The return type is a list of (value, score) pairs
"""
if (start is not None and num is None) or \
(num is not None and start is None):
2014-07-01 06:40:56 +04:00
raise LedisError("``start`` and ``num`` must both be specified")
pieces = ['ZREVRANGEBYSCORE', name, min, max]
2014-06-30 06:56:32 +04:00
if start is not None and num is not None:
pieces.extend(['LIMIT', start, num])
if withscores:
pieces.append('withscores')
options = {'withscores': withscores}
2014-06-30 06:56:32 +04:00
return self.execute_command(*pieces, **options)
def zrevrank(self, name, value):
"""
Returns a 0-based value indicating the descending rank of
``value`` in sorted set ``name``
"""
return self.execute_command('ZREVRANK', name, value)
def zscore(self, name, value):
"Return the score of element ``value`` in sorted set ``name``"
return self.execute_command('ZSCORE', name, value)
2014-07-01 06:40:56 +04:00
# SPECIAL COMMANDS SUPPORTED BY LEDISDB
def zclear(self, name):
2014-07-08 16:44:09 +04:00
"Delete key of ``name`` from sorted set"
2014-07-01 06:40:56 +04:00
return self.execute_command('ZCLEAR', name)
def zmclear(self, *names):
2014-07-08 16:44:09 +04:00
"Delete multiple keys of ``names`` from sorted set"
2014-07-01 06:40:56 +04:00
return self.execute_command('ZMCLEAR', *names)
def zexpire(self, name, time):
2014-07-08 16:44:09 +04:00
"Set timeout on key ``name`` with ``time``"
2014-07-01 06:40:56 +04:00
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
return self.execute_command('ZEXPIRE', name, time)
def zexpireat(self, name, when):
2014-07-08 16:44:09 +04:00
"""
Set an expire flag on key name for time seconds. time can be represented by
an integer or a Python timedelta object.
"""
2014-07-01 06:40:56 +04:00
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('ZEXPIREAT', name, when)
def zttl(self, name):
2014-07-08 16:44:09 +04:00
"Returns the number of seconds until the key name will expire"
2014-07-01 06:40:56 +04:00
return self.execute_command('ZTTL', name)
def zpersist(self, name):
2014-07-08 16:44:09 +04:00
"Removes an expiration on name"
2014-07-01 06:40:56 +04:00
return self.execute_command('ZPERSIST', name)
2014-06-30 06:56:32 +04:00
#### HASH COMMANDS ####
def hdel(self, name, *keys):
"Delete ``keys`` from hash ``name``"
return self.execute_command('HDEL', name, *keys)
def hexists(self, name, key):
"Returns a boolean indicating if ``key`` exists within hash ``name``"
return self.execute_command('HEXISTS', name, key)
def hget(self, name, key):
"Return the value of ``key`` within the hash ``name``"
return self.execute_command('HGET', name, key)
def hgetall(self, name):
"Return a Python dict of the hash's name/value pairs"
return self.execute_command('HGETALL', name)
def hincrby(self, name, key, amount=1):
"Increment the value of ``key`` in hash ``name`` by ``amount``"
return self.execute_command('HINCRBY', name, key, amount)
def hkeys(self, name):
"Return the list of keys within hash ``name``"
return self.execute_command('HKEYS', name)
def hlen(self, name):
"Return the number of elements in hash ``name``"
return self.execute_command('HLEN', name)
2014-07-01 06:40:56 +04:00
def hmget(self, name, keys, *args):
"Returns a list of values ordered identically to ``keys``"
args = list_or_args(keys, args)
return self.execute_command('HMGET', name, *args)
2014-06-30 06:56:32 +04:00
def hmset(self, name, mapping):
"""
Sets each key in the ``mapping`` dict to its corresponding value
in the hash ``name``
"""
if not mapping:
raise DataError("'hmset' with 'mapping' of length 0")
items = []
for pair in iteritems(mapping):
items.extend(pair)
return self.execute_command('HMSET', name, *items)
2014-07-01 06:40:56 +04:00
def hset(self, name, key, value):
"""
Set ``key`` to ``value`` within hash ``name``
Returns 1 if HSET created a new field, otherwise 0
"""
return self.execute_command('HSET', name, key, value)
2014-06-30 06:56:32 +04:00
def hvals(self, name):
"Return the list of values within hash ``name``"
return self.execute_command('HVALS', name)
2014-07-01 06:40:56 +04:00
# SPECIAL COMMANDS SUPPORTED BY LEDISDB
def hclear(self, name):
2014-07-08 16:44:09 +04:00
"Delete key ``name`` from hash"
2014-07-01 06:40:56 +04:00
return self.execute_command('HCLEAR', name)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def hmclear(self, *names):
2014-07-08 16:44:09 +04:00
"Delete multiple keys ``names`` from hash"
2014-07-01 06:40:56 +04:00
return self.execute_command('HMCLEAR', *names)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def hexpire(self, name, time):
2014-07-08 16:44:09 +04:00
"""
Set an expire flag on key name for time milliseconds.
time can be represented by an integer or a Python timedelta object.
"""
2014-06-30 06:56:32 +04:00
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
2014-07-01 06:40:56 +04:00
return self.execute_command('HEXPIRE', name, time)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def hexpireat(self, name, when):
2014-07-08 16:44:09 +04:00
"""
Set an expire flag on key name. when can be represented as an integer representing
unix time in milliseconds (unix time * 1000) or a Python datetime object.
"""
2014-07-01 06:40:56 +04:00
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('HEXPIREAT', name, when)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def httl(self, name):
2014-07-08 16:44:09 +04:00
"Returns the number of seconds until the key name will expire"
2014-07-01 06:40:56 +04:00
return self.execute_command('HTTL', name)
2014-06-30 06:56:32 +04:00
2014-07-01 06:40:56 +04:00
def hpersist(self, name):
2014-07-08 16:44:09 +04:00
"Removes an expiration on name"
2014-07-01 06:40:56 +04:00
return self.execute_command('HPERSIST', name)
2014-06-30 06:56:32 +04:00
### BIT COMMANDS
def bget(self, name):
""
return self.execute_command("BGET", name)
def bdelete(self, name):
""
return self.execute_command("BDELETE", name)
def bsetbit(self, name, offset, value):
""
value = value and 1 or 0
return self.execute_command("BSETBIT", name, offset, value)
def bgetbit(self, name, offset):
""
return self.execute_command("BGETBIT", name, offset)
def bmsetbit(self, name, *args):
"""
Set any number of offset, value pairs to the key ``name``. Pairs can be
specified in the following way:
offset1, value1, offset2, value2, ...
"""
pieces = []
if args:
if len(args) % 2 != 0:
raise LedisError("BMSETBIT requires an equal number of "
"offset and value")
pieces.extend(args)
return self.execute_command("BMSETBIT", name, *pieces)
def bcount(self, key, start=None, end=None):
""
params = [key]
if start is not None and end is not None:
params.append(start)
params.append(end)
elif (start is not None and end is None) or \
(start is None and end is not None):
raise LedisError("Both start and end must be specified")
return self.execute_command("BCOUNT", *params)
def bopt(self, operation, dest, *keys):
"""
Perform a bitwise operation using ``operation`` between ``keys`` and
store the result in ``dest``.
``operation`` is one of `and`, `or`, `xor`, `not`.
"""
return self.execute_command('BOPT', operation, dest, *keys)
def bexpire(self, name, time):
"Set timeout on key ``name`` with ``time``"
if isinstance(time, datetime.timedelta):
time = time.seconds + time.days * 24 * 3600
return self.execute_command('BEXPIRE', name, time)
def bexpireat(self, name, when):
"""
Set an expire flag on key name for time seconds. time can be represented by
an integer or a Python timedelta object.
"""
if isinstance(when, datetime.datetime):
when = int(mod_time.mktime(when.timetuple()))
return self.execute_command('BEXPIREAT', name, when)
def bttl(self, name):
"Returns the number of seconds until the key name will expire"
return self.execute_command('BTTL', name)
def bpersist(self, name):
"Removes an expiration on name"
2014-08-26 06:56:29 +04:00
return self.execute_command('BPERSIST', name)
class Transaction(Ledis):
def __init__(self, connection_pool, response_callbacks):
self.connection_pool = connection_pool
self.response_callbacks = response_callbacks
self.connection = None
def execute_command(self, *args, **options):
"Execute a command and return a parsed response"
command_name = args[0]
connection = self.connection
if self.connection is None:
raise TxNotBeginError
try:
connection.send_command(*args)
return self.parse_response(connection, command_name, **options)
except ConnectionError:
connection.disconnect()
connection.send_command(*args)
return self.parse_response(connection, command_name, **options)
def begin(self):
self.connection = self.connection_pool.get_connection('begin')
return self.execute_command("BEGIN")
def commit(self):
res = self.execute_command("COMMIT")
self.connection_pool.release(self.connection)
self.connection = None
return res
def rollback(self):
res = self.execute_command("ROLLBACK")
self.connection_pool.release(self.connection)
self.connection = None
return res