Skip to content

List Commands

Bases: BaseCommand

Mixin for Redis List commands (e.g. LPUSH, LPOP, LRANGE).

Source code in pyredis/commands/list.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class List(BaseCommand):
    """Mixin for Redis List commands (e.g. LPUSH, LPOP, LRANGE)."""

    def __init__(self):
        super().__init__()

    def blpop(self, *args):
        if self._cluster:
            return self.execute(
                *[b"BLPOP", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"BLPOP", *args]
        )

    def brpop(self, *args):
        if self._cluster:
            return self.execute(
                *[b"BRPOP", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"BRPOP", *args]
        )

    def brpoplpush(self, *args):
        if self._cluster:
            return self.execute(
                *[b"BRPOPPUSH", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"BRPOPPUSH", *args]
        )

    def lindex(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LINDEX", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LINDEX", *args]
        )

    def linsert(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LINSERT", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LINSERT", *args]
        )

    def llen(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LLEN", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LLEN", *args]
        )

    def lpop(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LPOP", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LPOP", *args]
        )

    def lpush(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LPUSH", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LPUSH", *args]
        )

    def lpushx(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LPUSHX", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LPUSHX", *args]
        )

    def lrange(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LRANGE", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LRANGE", *args]
        )

    def lrem(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LREM", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LREM", *args]
        )

    def lset(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LSET", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LSET", *args]
        )

    def ltrim(self, *args):
        if self._cluster:
            return self.execute(
                *[b"LTRIM", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"LTRIM", *args]
        )

    def rpop(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RPOP", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RPOP", *args]
        )

    def rpoplpush(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RPOPLPUSH", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RPOPLPUSH", *args]
        )

    def rpush(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RPUSH", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RPUSH", *args]
        )

    def rpushx(self, *args):
        if self._cluster:
            return self.execute(
                *[b"RPUSHX", *args],
                shard_key=args[0]
            )
        return self.execute(
            *[b"RPUSHX", *args]
        )

__init__()

Source code in pyredis/commands/list.py 
7
8
def __init__(self):
    super().__init__()

blpop(*args)

Source code in pyredis/commands/list.py 
10
11
12
13
14
15
16
17
18
def blpop(self, *args):
    if self._cluster:
        return self.execute(
            *[b"BLPOP", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"BLPOP", *args]
    )

brpop(*args)

Source code in pyredis/commands/list.py 
20
21
22
23
24
25
26
27
28
def brpop(self, *args):
    if self._cluster:
        return self.execute(
            *[b"BRPOP", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"BRPOP", *args]
    )

brpoplpush(*args)

Source code in pyredis/commands/list.py 
30
31
32
33
34
35
36
37
38
def brpoplpush(self, *args):
    if self._cluster:
        return self.execute(
            *[b"BRPOPPUSH", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"BRPOPPUSH", *args]
    )

execute(*args, **kwargs)

Source code in pyredis/commands/base.py 
5
6
def execute(self, *args, **kwargs):
    raise NotImplementedError

lindex(*args)

Source code in pyredis/commands/list.py 
40
41
42
43
44
45
46
47
48
def lindex(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LINDEX", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LINDEX", *args]
    )

linsert(*args)

Source code in pyredis/commands/list.py 
50
51
52
53
54
55
56
57
58
def linsert(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LINSERT", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LINSERT", *args]
    )

llen(*args)

Source code in pyredis/commands/list.py 
60
61
62
63
64
65
66
67
68
def llen(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LLEN", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LLEN", *args]
    )

lpop(*args)

Source code in pyredis/commands/list.py 
70
71
72
73
74
75
76
77
78
def lpop(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LPOP", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LPOP", *args]
    )

lpush(*args)

Source code in pyredis/commands/list.py 
80
81
82
83
84
85
86
87
88
def lpush(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LPUSH", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LPUSH", *args]
    )

lpushx(*args)

Source code in pyredis/commands/list.py 
90
91
92
93
94
95
96
97
98
def lpushx(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LPUSHX", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LPUSHX", *args]
    )

lrange(*args)

Source code in pyredis/commands/list.py 
100
101
102
103
104
105
106
107
108
def lrange(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LRANGE", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LRANGE", *args]
    )

lrem(*args)

Source code in pyredis/commands/list.py 
110
111
112
113
114
115
116
117
118
def lrem(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LREM", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LREM", *args]
    )

lset(*args)

Source code in pyredis/commands/list.py 
120
121
122
123
124
125
126
127
128
def lset(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LSET", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LSET", *args]
    )

ltrim(*args)

Source code in pyredis/commands/list.py 
130
131
132
133
134
135
136
137
138
def ltrim(self, *args):
    if self._cluster:
        return self.execute(
            *[b"LTRIM", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"LTRIM", *args]
    )

rpop(*args)

Source code in pyredis/commands/list.py 
140
141
142
143
144
145
146
147
148
def rpop(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RPOP", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RPOP", *args]
    )

rpoplpush(*args)

Source code in pyredis/commands/list.py 
150
151
152
153
154
155
156
157
158
def rpoplpush(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RPOPLPUSH", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RPOPLPUSH", *args]
    )

rpush(*args)

Source code in pyredis/commands/list.py 
160
161
162
163
164
165
166
167
168
def rpush(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RPUSH", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RPUSH", *args]
    )

rpushx(*args)

Source code in pyredis/commands/list.py 
170
171
172
173
174
175
176
177
178
def rpushx(self, *args):
    if self._cluster:
        return self.execute(
            *[b"RPUSHX", *args],
            shard_key=args[0]
        )
    return self.execute(
        *[b"RPUSHX", *args]
    )