List

LPOP

Remove and return the first element(s) of a list

Arguments

keybodystrrequired

The key of the list.

countbodyint

How many elements to pop. If not specified, a single element is popped.

Response

str | List[str] Nonerequired

The popped element(s). If count was specified, an array of elements is returned, otherwise a single element is returned. If the list is empty, None is returned.

Single
redis.rpush("mylist", "one", "two", "three")assert redis.lpop("mylist") == "one"
Multiple
redis.rpush("mylist", "one", "two", "three")assert redis.lpop("mylist", 2) == ["one", "two"]
Loading search…