diff options
author | Andy McCurdy <andy@andymccurdy.com> | 2018-11-06 16:35:08 -0800 |
---|---|---|
committer | Andy McCurdy <andy@andymccurdy.com> | 2018-11-06 16:35:08 -0800 |
commit | 7b39a14f94f032d9fd71128e9f54d7adf18e5711 (patch) | |
tree | 4df07be39645fa78c600311bc1c7022995ac8cb3 | |
parent | 3e7a1e1f1618b7807d6725ae7537b14e0aff7b7f (diff) | |
download | redis-py-7b39a14f94f032d9fd71128e9f54d7adf18e5711.tar.gz |
support for the bitfield command thanks to Charles Leifer
-rwxr-xr-x | redis/client.py | 84 | ||||
-rw-r--r-- | tests/test_commands.py | 35 |
2 files changed, 119 insertions, 0 deletions
diff --git a/redis/client.py b/redis/client.py index 8173ba8..0692b39 100755 --- a/redis/client.py +++ b/redis/client.py @@ -1005,6 +1005,13 @@ class StrictRedis(object): raise RedisError("Both start and end must be specified") return self.execute_command('BITCOUNT', *params) + def bitfield(self, key): + """ + Return a BitFieldOperation instance to conveniently construct one or + more bitfield operations on ``key``. + """ + return BitFieldOperation(self, key) + def bitop(self, operation, dest, *keys): """ Perform a bitwise operation using ``operation`` between ``keys`` and @@ -3448,3 +3455,80 @@ class Script(object): # Overwrite the sha just in case there was a discrepancy. self.sha = client.script_load(self.script) return client.evalsha(self.sha, len(keys), *args) + + +class BitFieldOperation(object): + """ + Command builder for BITFIELD commands. + """ + def __init__(self, client, key): + self.client = client + self.key = key + self.operations = [] + self._last_overflow = None # Default is "WRAP". + + def incrby(self, fmt, offset, increment, overflow=None): + """ + Increment a bitfield by a given amount. + :param fmt: format-string for the bitfield being updated, e.g. 'u8' + for an unsigned 8-bit integer. + :param int offset: offset (in number of bits). If prefixed with a + '#', this is an offset multiplier, e.g. given the arguments + fmt='i8', offset='#2', the offset will be 16. + :param int increment: value to increment the bitfield by. + :param str overflow: overflow algorithm. Defaults to WRAP, but other + acceptable values are SAT and FAIL. See the Redis docs for + descriptions of these algorithms. + :returns: a :py:class:`BitFieldOperation` instance. + """ + if overflow is not None and overflow != self._last_overflow: + self._last_overflow = overflow + self.operations.append(('OVERFLOW', overflow)) + + self.operations.append(('INCRBY', fmt, offset, increment)) + return self + + def get(self, fmt, offset): + """ + Get the value of a given bitfield. + :param fmt: format-string for the bitfield being read, e.g. 'u8' for + an unsigned 8-bit integer. + :param int offset: offset (in number of bits). If prefixed with a + '#', this is an offset multiplier, e.g. given the arguments + fmt='i8', offset='#2', the offset will be 16. + :returns: a :py:class:`BitFieldOperation` instance. + """ + self.operations.append(('GET', fmt, offset)) + return self + + def set(self, fmt, offset, value): + """ + Set the value of a given bitfield. + :param fmt: format-string for the bitfield being read, e.g. 'u8' for + an unsigned 8-bit integer. + :param int offset: offset (in number of bits). If prefixed with a + '#', this is an offset multiplier, e.g. given the arguments + fmt='i8', offset='#2', the offset will be 16. + :param int value: value to set at the given position. + :returns: a :py:class:`BitFieldOperation` instance. + """ + self.operations.append(('SET', fmt, offset, value)) + return self + + @property + def command(self): + cmd = ['BITFIELD', self.key] + for ops in self.operations: + cmd.extend(ops) + return cmd + + def execute(self): + """ + Execute the operation(s) in a single BITFIELD command. The return value + is a list of values corresponding to each operation. If the client + used to create this instance was a pipeline, the list of values + will be present within the pipeline's execute. + """ + command = self.command + self.operations = [] + return self.client.execute_command(*command) diff --git a/tests/test_commands.py b/tests/test_commands.py index f0394d7..4667708 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -2115,6 +2115,41 @@ class TestRedisCommands(object): # 1 message is trimmed assert r.xtrim(stream, 3, approximate=False) == 1 + def test_bitfield_operations(self, r): + bf = r.bitfield('a') + resp = (bf + .set('u8', 8, 255) + .get('u8', 0) + .get('u4', 8) # 1111 + .get('u4', 12) # 1111 + .get('u4', 13) # 1110 + .execute()) + assert resp == [0, 0, 15, 15, 14] + + resp = (bf + .set('u8', 4, 1) # 00ff -> 001f (returns old val, 0x0f) + .get('u16', 0) # 001f (00011111) + .set('u16', 0, 0) # 001f -> 0000 + .execute()) + assert resp == [15, 31, 31] + + resp = (bf + .incrby('u8', 8, 254) + .get('u16', 0) + .execute()) + assert resp == [254, 254] + + # Verify overflow protection works: + resp = (bf + .incrby('u8', 8, 2, 'FAIL') + .incrby('u8', 8, 1) + .incrby('u8', 8, 1) # Still "FAIL". + .get('u16', 0) + .execute()) + assert resp == [None, 255, None, 255] + + assert r.get('a') == b'\x00\xff' + class TestStrictCommands(object): def test_strict_zadd(self, sr): |