快捷導(dǎo)航

Redis的Python客戶端redis-py安裝使用說明文檔

更新時間：2015年06月23日 09:28:00 投稿：junjie

這篇文章主要介紹了Redis的Python客戶端redis-py安裝使用說明文檔,本文講解了安裝方法、入門使用實(shí)例、API參考和詳細(xì)說明,需要的朋友可以參考下

1.安裝

redis-py是Redis key-value 數(shù)據(jù)庫的 Python 接口，安裝如下，后面我們會講hiredis這個庫

$ sudo pip install redis

$ sudo pip install hiredis

2.入門

復(fù)制代碼代碼如下:

>>> import redis

>>> pool = redis.ConnectionPool(host='localhost', port=6379, db=0)

>>> r = redis.StrictRedis(connection_pool = pool)

>>> r.set('foo', 'bar')

True

>>> r.get('foo')

'bar'

3.API參考

Redis 官方文檔詳細(xì)解釋了每個命令（http://redis.io/commands）。redis-py 提供了兩個實(shí)現(xiàn)這些命令的客戶端類。StrictRedis 類試圖遵守官方的命令語法，但也有幾點(diǎn)例外：

·SELECT：沒有實(shí)現(xiàn)。參見下面“線程安全”部分的解釋。

·DEL：'del' 是 Python 語法的保留關(guān)鍵字。因此redis-py 使用 “delete” 代替。

·CONFIG GET|SET：分別用 config_get 和 config_set 實(shí)現(xiàn)。

·MULTI/EXEC：作為 Pipeline 類的一部分來實(shí)現(xiàn)。若在調(diào)用pipeline 方法時指定use_transaction=True，在執(zhí)行 pipeline 時會用 MULTI 和 EXEC 封裝 pipeline 的操作。參見下面 Pipeline 部分。

·SUBSCRIBE/LISTEN: 和 pipeline 類似，由于需要下層的連接保持狀態(tài)， PubSub 也實(shí)現(xiàn)成單獨(dú)的類。調(diào)用 Redis 客戶端的 pubsub 方法返回一個 PubSub 的實(shí)例，通過這個實(shí)例可以訂閱頻道或偵聽消息。兩個類（StrictRedis 和 PubSub 類）都可以發(fā)布(PUBLISH)消息。

除了上面的改變，StrictRedis 的子類 Redis，提供了對舊版本 redis-py 的兼容：

·LREM：參數(shù) ‘num' 和 ‘value' 的順序交換了一下，這樣‘num' 可以提供缺省值 0.

·ZADD：實(shí)現(xiàn)時 score 和 value 的順序不小心弄反了，后來有人用了，就這樣了

·SETEX: time 和 value 的順序反了

注：最好不要用 Redis，這個類只是做兼容用的

4.詳細(xì)說明

4.1 連接池

在后臺，redis-py 采用了連接池（ConnectionPool）來管理對 Redis 服務(wù)器的連接。缺省情況下，每個Redis 實(shí)例都創(chuàng)建自己的連接池。也可以采用向 Redis 類的 connection_pool 參數(shù)傳遞已創(chuàng)建的連接池的方式。通過這種方式，可以實(shí)現(xiàn)客戶端分片或精確控制連接的管理:

復(fù)制代碼代碼如下:

>>> pool = redis.ConnectionPool(host='localhost', port=6379, db=0)

>>> r = redis.StrictRedis(connection_pool=pool)

4.2 連接

ConnectionPool 管理一組 Connection 實(shí)例。redis-py 提供兩種類型的 Connection。缺省情況下，Connection 是一個普通的 TCP 連接。 UnixDomainSocketConnection 允許和服務(wù)器運(yùn)行在同一個設(shè)備上的客戶端通過 unix 套接字進(jìn)行連接。要使用 UnixDomainSocketConnection 連接, 只需要通過unix_socket_path 參數(shù)傳遞一個 unix 套接字文件的字符串。另外，確保redis.conf 文件配置了unixsocket 參數(shù)（缺省情況下是注釋掉的）:

復(fù)制代碼代碼如下:

>>> r = redis.StrictRedis(unix_socket_path='/tmp/redis.sock')

也可以自己創(chuàng)建 Connection 子類。這個特性可以在使用異步框架時用于控制 socket 的行為。要使用自己的Connection 初始化客戶端類，需要創(chuàng)建一個連接池，通 connection_class 參數(shù)把自己的類傳遞進(jìn)去。傳遞的其它關(guān)鍵字參數(shù)會在初始化時傳遞給自定義的類:

復(fù)制代碼代碼如下:

>>> pool = redis.ConnectionPool(connection_class=YourConnectionClass, your_arg='...', ...)

4.3 分析器

分析類提供了控制如何對 Redis 服務(wù)器的響應(yīng)進(jìn)行分析的途徑。redis-py 提供了兩個分析類， PythonParser和 HiredisParser。缺省情況下，如果安裝了 hiredis 模塊， redis-py 會嘗試使用 HiredisParser，否則使用 PythonParser。

Hiredis 是由 Redis 核心團(tuán)隊維護(hù)的 C 庫。 Pieter Noordhuis 創(chuàng)建了 Python 的實(shí)現(xiàn)。分析 Redis 服務(wù)器的響應(yīng)時，Hiredis 可以提供 10 倍的速度提升。性能提升在獲取大量數(shù)據(jù)時優(yōu)為明顯，比如 LRANGE 和SMEMBERS 操作。

和 redis-py 一樣，Hiredis 在 Pypi 中就有，可以通過 pip 或 easy_install 安裝:

復(fù)制代碼代碼如下:

$ pip install hiredis

或:

復(fù)制代碼代碼如下:

$ easy_install hiredis

4.4 響應(yīng)回調(diào)函數(shù)

客戶端類使用一系列回調(diào)函數(shù)來把 Redis 響應(yīng)轉(zhuǎn)換成合適的 Python 類型。有些回調(diào)函數(shù)在 Redis 客戶端類的字典 RESPONSE_CALLBACKS 中定義。

通過 set_response_callback 方法可以把自定義的回調(diào)函數(shù)添加到單個實(shí)例。這個方法接受兩個參數(shù)：一個命令名和一個回調(diào)函數(shù)。通過這種方法添加的回調(diào)函數(shù)只對添加到的對象有效。要想全局定義或重載一個回調(diào)函數(shù)，應(yīng)該創(chuàng)建 Redis 客戶端的子類并把回調(diào)函數(shù)添加到類的 RESPONSE_CALLBACKS(原文誤為REDIS_CALLBACKS) 中。

響應(yīng)回調(diào)函數(shù)至少有一個參數(shù)：Redis 服務(wù)器的響應(yīng)。要進(jìn)一步控制如何解釋響應(yīng)，也可以使用關(guān)鍵字參數(shù)。這些關(guān)鍵字參數(shù)在對 execute_command 的命令調(diào)用時指定。通過 “withscores” 參數(shù)，ZRANGE 演示了回調(diào)函數(shù)如何使用關(guān)鍵字參數(shù)。

4.5 線程安全

Redis 客戶端實(shí)例可以安全地在線程間共享。從內(nèi)部實(shí)現(xiàn)來說，只有在命令執(zhí)行時才獲取連接實(shí)例，完成后直接返回連接池，命令永不修改客戶端實(shí)例的狀態(tài)。

但是，有一點(diǎn)需要注意：SELECT 命令。SELECT 命令允許切換當(dāng)前連接使用的數(shù)據(jù)庫。新的數(shù)據(jù)庫保持被選中狀態(tài)，直到選中另一個數(shù)據(jù)庫或連接關(guān)閉。這會導(dǎo)致在返回連接池時，連接可能指定了別的數(shù)據(jù)庫。

因此，redis-py 沒有在客戶端實(shí)例中實(shí)現(xiàn) SELECT 命令。如果要在同一個應(yīng)用中使用多個 Redis 數(shù)據(jù)庫，應(yīng)該給第一個數(shù)據(jù)庫創(chuàng)建獨(dú)立的客戶端實(shí)例（可能也需要獨(dú)立的連接池）。

在線程間傳遞 PubSub 和 Pipeline 對象是不安全的。

4.6 Pipeline

Pipeline 是 StrictRedis 類的子類，支持在一個請求里發(fā)送緩沖的多個命令。通過減少客戶端和服務(wù)器之間往來的數(shù)據(jù)包，可以大大提高命令組的性能。

Pipeline 的使用非常簡單:

復(fù)制代碼代碼如下:

>>> r = redis.Redis(...)

>>> r.set('bing', 'baz')

>>> # Use the pipeline() method to create a pipeline instance

>>> pipe = r.pipeline()

>>> # The following SET commands are buffered

>>> pipe.set('foo', 'bar')

>>> pipe.get('bing')

>>> # the EXECUTE call sends all bufferred commands to the server, returning

>>> # a list of responses, one for each command.

>>> pipe.execute()

[True, 'baz']

為了方便使用，所有緩沖到 pipeline 的命令返回 pipeline 對象本身。因此調(diào)用可以鏈起來:

復(fù)制代碼代碼如下:

>>> pipe.set('foo', 'bar').sadd('faz', 'baz').incr('auto_number').execute()

[True, True, 6]

另外，pipeline 也可以保證緩沖的命令組做為一個原子操作。缺省就是這種模式。要使用命令緩沖，但禁止pipeline 的原子操作屬性，可以關(guān)掉 transaction:

>>> pipe = r.pipeline(transaction=False)
一個常見的問題是：在進(jìn)行原子事務(wù)操作前需要從 Redis 中獲取事務(wù)中要用的數(shù)據(jù)。比如，假設(shè) INCR 命令不存在，但我們需要用 Python 創(chuàng)建一個原子版本的 INCR。

一個不成熟的實(shí)現(xiàn)是獲取值(GET)，在 Python 中增一, 設(shè)置（SET）新值。但是，這不是原子操作，因?yàn)槎鄠€客戶端可能在同一時間做這件事，每一個都通過 GET 獲取同一個值。

WATCH 命令提供了在開始事務(wù)前監(jiān)視一個或多個鍵的能力。如果這些鍵中的任何一個在執(zhí)行事務(wù)前發(fā)生改變，整個事務(wù)就會被取消并拋出 WatchError 異常。要實(shí)現(xiàn)我們的客戶 INCR 命令，可以按下面的方法操作:

復(fù)制代碼代碼如下:

>>> with r.pipeline() as pipe:

... while 1:

... try:

... # 對序列號的鍵進(jìn)行 WATCH

... pipe.watch('OUR-SEQUENCE-KEY')

... # WATCH 執(zhí)行后，pipeline 被設(shè)置成立即執(zhí)行模式直到我們通知它

... # 重新開始緩沖命令。

... # 這就允許我們獲取序列號的值

... current_value = pipe.get('OUR-SEQUENCE-KEY')

... next_value = unicode(int(current_value) + 1)

... # 現(xiàn)在我們可以用 MULTI 命令把 pipeline 設(shè)置成緩沖模式

... pipe.multi()

... pipe.set('OUR-SEQUENCE-KEY', next_value)

... # 最后，執(zhí)行 pipeline (set 命令)

... pipe.execute()

... # 如果執(zhí)行時沒有拋出 WatchError，我們剛才所做的確實(shí)“原子地”

... # 完成了

... break

... except WatchError:

... # 一定是其它客戶端在我們開始 WATCH 和執(zhí)行 pipeline 之間修改了

... # 'OUR-SEQUENCE-KEY'，我們最好的選擇是重試

... continue

注意，因?yàn)樵谡麄€ WATCH 過程中，Pipeline 必須綁定到一個連接，必須調(diào)用 reset() 方法確保連接返回連接池。如果 Pipeline 用作 Context Manager(如上面的例子所示)， reset() 會自動調(diào)用。當(dāng)然，也可以用手動的方式明確調(diào)用 reset():

復(fù)制代碼代碼如下:

>>> pipe = r.pipeline()

>>> while 1:

... try:

... pipe.watch('OUR-SEQUENCE-KEY')

... current_value = pipe.get('OUR-SEQUENCE-KEY')

... next_value = unicode(int(current_value) + 1)

... pipe.multi()

... pipe.set('OUR-SEQUENCE-KEY', next_value)

... pipe.execute()

... break

... except WatchError:

... continue

... finally:

... pipe.reset()

重點(diǎn)(譯者注):

·WATCH 執(zhí)行后，pipeline 被設(shè)置成立即執(zhí)行模式

·用 MULTI 命令把 pipeline 設(shè)置成緩沖模式

·要么使用 with，要么顯式調(diào)用 reset()

有一個簡便的名為“transaction”的方法來處理這種處理和在 WatchError 重試的模式。它的參數(shù)是一個可執(zhí)行對象和要 WATCH 任意個數(shù)的鍵，其中可執(zhí)行對象接受一個 pipeline 對象做為參數(shù)。上面的客戶端 INCR 命令可以重寫如下（更可讀）:

復(fù)制代碼代碼如下:

>>> def client_side_incr(pipe):

... current_value = pipe.get('OUR-SEQUENCE-KEY')

... next_value = unicode(int(current_value) + 1)

... pipe.multi()

... pipe.set('OUR-SEQUENCE-KEY', next_value)

>>>

>>> r.transaction(client_side_incr, 'OUR-SEQUENCE-KEY')

4.7 版本計劃

redis-py 跟隨 Redis 發(fā)布版本。如 redis-py 2.0.0 應(yīng)該支持 Redis 2.0.0 的所有命令。

4.8 作者

redis-py 由 Andy McCurdy (sedrik@gmail.com) 開發(fā)并維護(hù)。項(xiàng)目地址在：http://github.com/andymccurdy/redis-py