SPOP Count?

Hey andy/community,

Redis supports a count field when calling SPOP (http://redis.io/commands/spop), but I don’t think this framework has support for that.

Not sure if this was intentional (for some odd reason of which I’m unaware) or not, but it’d be useful to have.

I copy and pasted my patch below if you want to use it. I basically just duplicated the code for srandmember since even Redis docs mention they work the same. Although, it would’ve been nice to have the arg be count and not number.

diff --git a/redis/client.py b/redis/client.py
index 8b5a3fa..0f5ad93 100755
--- a/redis/client.py
+++ b/redis/client.py
@@ -1532,9 +1532,17 @@ class StrictRedis(object):
         "Move ``value`` from set ``src`` to set ``dst`` atomically"
         return self.execute_command('SMOVE', src, dst, value)

-    def spop(self, name):
-        "Remove and return a random member of set ``name``"
-        return self.execute_command('SPOP', name)
+    def spop(self, name, number=None):
+        """
+        Remove and return a random member of set ``name``"
+
+        If ``number`` is None, pops a random member of set ``name``.
+
+        If ``number`` is supplied, pops a list of ``number`` random
+        members of set ``name``.
+        """
+        args = number and [number] or []
+        return self.execute_command('SPOP', name, *args)

     def srandmember(self, name, number=None):
         """
diff --git a/tests/test_commands.py b/tests/test_commands.py
index 286ea04..5c43feb 100644
--- a/tests/test_commands.py
+++ b/tests/test_commands.py
@@ -844,6 +844,13 @@ class TestRedisCommands(object):
         assert value in s
         assert r.smembers('a') == set(s) - set([value])

+    def test_spop_multi_value(self, r):
+        s = [b('1'), b('2'), b('3')]
+        r.sadd('a', *s)
+        values = r.spop('a', 2)
+        assert values in s
+        assert r.smembers('a') == set(values) < set(s)
+
     def test_srandmember(self, r):
         s = [b('1'), b('2'), b('3')]
         r.sadd('a', *s)

[Edited: Added patch to tests in test_commands.py] Ryan

[firla]

+1 Please add the missing count argument. Thank you.

[VaughnGH]

Any update on the release timeline? It’s confusing having dissonance between the documentation on RTD and the latest pypi release…