Python: Added SPOP command

CHANGELOG.md

@@ -3,7 +3,7 @@
 * Python: Added STRLEN command ([#1230](https:/aws/glide-for-redis/pull/1230))
 * Python: Added HKEYS command ([#1228](https:/aws/glide-for-redis/pull/1228))
 * Python: Added ZREMRANGEBYSCORE command ([#1151](https:/aws/glide-for-redis/pull/1151))
-* Node: Added SPOP, SPOPCOUNT commands. ([#1117](https:/aws/glide-for-redis/pull/1117))
+* Node, Python: Added SPOP, SPOPCOUNT commands. ([#1117](https:/aws/glide-for-redis/pull/1117), [#1261](https:/aws/glide-for-redis/pull/1261))
 * Node: Added ZRANGE command ([#1115](https:/aws/glide-for-redis/pull/1115))
 * Python: Added RENAME command ([#1252](https:/aws/glide-for-redis/pull/1252))
 

glide-core/src/client/value_conversion.rs

@@ -233,6 +233,13 @@ pub(crate) fn expected_type_for_cmd(cmd: &Cmd) -> Option<ExpectedReturnType> {
  b"ZRANK" | b"ZREVRANK" => cmd
  .position(b"WITHSCORE")
  .map(|_| ExpectedReturnType::ZrankReturnType),
+ b"SPOP" => {
+ if cmd.arg_idx(2).is_some() {
+ Some(ExpectedReturnType::Set)
+ } else {
+ None
+ }
+ }
  _ => None,
  }
 }
@@ -479,4 +486,13 @@ mod tests {
  )
  .is_err());
  }
+
+ #[test]
+ fn test_convert_spop_to_set_for_spop_count() {
+ assert!(matches!(
+ expected_type_for_cmd(redis::cmd("SPOP").arg("key1").arg("3")),
+ Some(ExpectedReturnType::Set)
+ ));
+ assert!(expected_type_for_cmd(redis::cmd("SPOP").arg("key1")).is_none());
+ }
 }

python/python/glide/async_commands/core.py

@@ -1047,6 +1047,53 @@ async def scard(self, key: str) -> int:
  """
  return cast(int, await self._execute_command(RequestType.SCard, [key]))
 
+ async def spop(self, key: str) -> str:
+ """
+ Removes and returns one random member from the set stored at `key`.
+
+ See https://valkey-io.github.io/commands/spop/ for more details.
+ To pop multiple members, see `spop_count`.
+
+ Args:
+ key (str): The key of the set.
+
+ Returns:
+ str: The value of the popped member.
+
+ Examples:
+ >>> await client.spop("my_set")
+ "value1" # Removes and returns a random member from the set "my_set".
+ >>> await client.spop("non_exiting_key")
+ None
+ """
+ return cast(str, await self._execute_command(RequestType.Spop, [key]))
+
+ async def spop_count(self, key: str, count: int) -> Set[str]:
+ """
+ Removes and returns up to `count` random members from the set stored at `key`, depending on the set's length.
+
+ See https://valkey-io.github.io/commands/spop/ for details.
+ To pop a single member, see `spop`
+
+ Args:
+ key (str): The key of the set.
+ count (int): The count of the elements to pop from the set.
+
+ Returns:
+ Set[str]: A set of popped elements will be returned depending on the set's length.
+ If `key` does not exist, empty set will be returned.
+
+ Examples:
+ >>> await client.spop_count("my_set", 2)
+ {"value1", "value2"} # Removes and returns 2 random members from the set "my_set".
+ >>> await client.spop_count("non_exiting_key", 2)
+ Set()
+
+ """
+ return cast(
+ Set[str], await self._execute_command(RequestType.Spop, [key, str(count)])
+ )
+
  async def sismember(
  self,
  key: str,

python/python/glide/async_commands/transaction.py

@@ -784,6 +784,38 @@ def scard(self: TTransaction, key: str) -> TTransaction:
  """
  return self.append_command(RequestType.SCard, [key])
 
+ def spop(self: TTransaction, key: str) -> TTransaction:
+ """
+ Removes and returns one random member from the set value store at `key`.
+ See https://valkey-io.github.io/commands/spop/ for details.
+ To pop multiple members, see `spop_count`
+
+ Args:
+ key (str): The key of the set.
+
+ Commands response:
+ str: The value of the popped member.
+
+ """
+ return self.append_command(RequestType.Spop, [key])
+
+ def spop_count(self: TTransaction, key: str, count: int) -> TTransaction:
+ """
+ Removes and returns up to `count` random members from the set stored at `key`, depending on the set's length.
+ See https://valkey-io.github.io/commands/spop/ for details.
+ To pop a single member, see `spop`
+
+ Args:
+ key (str): The key of the set.
+ count (int): The count of the elements to pop from the set.
+
+ Commands response:
+ Set[str]: A set of popped elements will be returned depending on the set's length.
+ If `key` does not exist, empty set will be returned.
+
+ """
+ return self.append_command(RequestType.Spop, [key, str(count)])
+
  def sismember(
  self: TTransaction,
  key: str,

python/python/tests/test_async_client.py

@@ -923,6 +923,24 @@ async def test_sismember(self, redis_client: TRedisClient):
  assert not await redis_client.sismember(key, get_random_string(5))
  assert not await redis_client.sismember("non_existing_key", member)
 
+ @pytest.mark.parametrize("cluster_mode", [True, False])
+ @pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])
+ async def test_spop(self, redis_client: TRedisClient):
+ key = get_random_string(10)
+ member = get_random_string(5)
+ assert await redis_client.sadd(key, [member]) == 1
+ assert await redis_client.spop(key) == member
+
+ member2 = get_random_string(5)
+ member3 = get_random_string(5)
+ assert await redis_client.sadd(key, [member, member2, member3]) == 3
+ assert await redis_client.spop_count(key, 4) == {member, member2, member3}
+
+ assert await redis_client.scard(key) == 0
+
+ assert await redis_client.spop("non_existing_key") == None
+ assert await redis_client.spop_count("non_existing_key", 3) == set()
+
  @pytest.mark.parametrize("cluster_mode", [True, False])
  @pytest.mark.parametrize("protocol", [ProtocolVersion.RESP2, ProtocolVersion.RESP3])
  async def test_ltrim(self, redis_client: TRedisClient):

python/python/tests/test_transaction.py

@@ -156,6 +156,12 @@ async def transaction_test(
  args.append(1)
  transaction.sismember(key7, "bar")
  args.append(True)
+ transaction.spop(key7)
+ args.append("bar")
+ transaction.sadd(key7, ["foo", "bar"])
+ args.append(2)
+ transaction.spop_count(key7, 4)
+ args.append({"foo", "bar"})
 
  transaction.zadd(key8, {"one": 1, "two": 2, "three": 3, "four": 4})
  args.append(4)