文档章节

python redis 模块 官方文档(上)

xiaoanyunfei
 xiaoanyunfei
发布于 2015/04/29 14:17
字数 2123
阅读 215
收藏 0

redis-py提供两个类Redis和StrictRedis用于实现Redis的命令,StrictRedis用于实现大部分官方的命令,并使用官方的语法和命令(比如,SET命令对应与StrictRedis.set方法)。Redis是StrictRedis的子类,用于向后兼容旧版本的redis-py。

StrictRedis:

select#没有实现,参见下面线程安全小节

del#与python的del冲突,用delete代替

CONFIG GET|SET#config_get config_set

MULTI/EXEC#被当做Pipeline的一部分,执行时默认被 MULTI 和EXEC状态包裹,可以用transaction=False 关闭SUBSCRIBE/LISTEN#和Pipeline类似,PubSub作为单独的类实现,它生成潜在的连接状态,此时无法执行非pubsub命令,在redis-client端执行PubSub会返回一个pubsub实例,可以用它来订阅频道,监听信息,注意只能在client端执行

SCAN/SSCAN/HSCAN/ZSCAN#*scan命令在redis文件中实现,每个方法都有一个迭代器方法,这样纯粹时为了方便用户,不用记录迭代器的游标,用scan_iter/sscan_iter/hscan_iter/zscan_iter实现

StrictRedis的子类Redis重写了一些方法实现了后向兼容

LREM#num和value顺序颠倒了,以便num可以提供缺省值0

ZADD#在value前指明score,实现时意外交换了顺序,人们已经使用时才发现,Redis期望*args格式是name1, score1, name2, score2, …
SETEX#time和value的顺序颠倒

redis使用连接池管理与redis-server的连接,默认每个redis实例会创建自己的连接池,可以用已经存在的连接池覆盖实例redis的connection_pool参数来覆盖这一行为,你可以通过这种方式实现客户端的切分或连接池的管理

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

ConnectionPools管理着连接实例的集合,redis实线两种类型的连接,默认使用基于tcp socket的连接,

UnixDomainSocketConnection 允许和服务器运行在同一个设备上的客户端通过 unix 套接字进行连接。要使用 UnixDomainSocketConnection 连接, 只需要通过unix_socket_path 参数传递一个 unix 套接字文件的字符串。另外,确保redis.conf 文件配置了unixsocket 参数(缺省情况下是注释掉的):

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

也可以自己创建 Connection 子类。这个特性可以在使用异步框架时用于控制 socket 的行为。要使用自己的Connection 初始化客户端类,需要创建一个连接池,通 connection_class 参数把自己的类传递进去。传递的其它关键字参数会在初始化时传递给自定义的类:

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

解析器

解析类提供了控制如何对 Redis 服务器的响应进行解析的途径。redis-py 提供了两个解析类, PythonParser和 HiredisParser。缺省情况下,如果安装了 hiredis 模块, redis-py 会尝试使用 HiredisParser,否则使用 PythonParser

Hiredis 是由 Redis 核心团队维护的 C 库。 Pieter Noordhuis 创建了 Python 的实现。分析 Redis 服务器的响应时,Hiredis 可以提供 10 倍的速度提升。性能提升在获取大量数据时优为明显,比如 LRANGE 和SMEMBERS 操作。

和 redis-py 一样,Hiredis 在 Pypi 中就有,可以通过 pip 或 easy_install 安装:

$ pip install hiredis

:

$ easy_install hiredis

响应回调函数

客户端类使用一系列回调函数来把 Redis 响应转换成合适的 Python 类型。很多回调函数在 Redis 客户端类的字典 RESPONSE_CALLBACKS 中定义。

通过 set_response_callback 方法可以把自定义的回调函数添加到单个实例。这个方法接受两个参数:一个命令名和一个回调函数。通过这种方法添加的回调函数只对添加到的对象有效。要想全局定义或重载一个回调函数,应该创建 Redis 客户端的子类并把回调函数添加到类的 RESPONSE_CALLBACKS

响应回调函数至少有一个参数:Redis 服务器的响应。要进一步控制如何解释响应,也可以使用关键字参数。这些关键字参数在对 execute_command 的命令调用时指定。通过 “withscores” 参数,ZRANGE 演示了回调函数如何使用关键字参数。

线程安全

Redis 客户端实例可以安全地在线程间共享。从内部实现来说,只有在命令执行时才获取连接实例,完成后直接返回连接池,命令永不修改客户端实例的状态。

但是,有一点需要注意:SELECT 命令。SELECT 命令允许切换当前连接使用的数据库。新的数据库保持被选中状态,直到选中另一个数据库或连接关闭。这会导致在返回连接池时,连接可能指定了别的数据库。

因此,redis-py 没有在客户端实例中实现 SELECT 命令。如果要在同一个应用中使用多个 Redis 数据库,应该给第一个数据库创建独立的客户端实例(可能也需要独立的连接池)。

在线程间传递 PubSub 和 Pipeline 对象是不安全的。

Pipeline

Pipeline 是 Redis 基类的一个子类,支持在一个请求里发送缓冲的多个命令。通过减少客户端和服务器之间往来的数据包,可以大大提高命令组的性能。

Pipeline 的使用非常简单:

>>> r = redis.Redis(...)
>>> r.set('bing', 'baz')
>>> # 使用 pipeline()方法创建 pipeline 对象
>>> pip3 = r.pipeline()
>>> # 下面的set方法被缓存
>>> pipe.set('foo', 'bar')
>>> pipe.get('bing')
>>> # 调用execute发送所有缓存命令到服务器端,并返回响应的list,每个命令对应着list的一项
>>> pipe.execute()
[True, 'baz']
为了方便使用,所有缓冲到 pipeline 的命令返回 pipeline 对象本身。因此调用可以链式连接:
>>> pipe.set('foo', 'bar').sadd('faz', 'baz').incr('auto_number').execute()
[True, True, 6]

另外,pipeline 也可以保证缓冲的命令组做为一个原子操作。缺省就是这种模式。要使用命令缓冲,但禁止pipeline 的原子操作属性,可以关掉 transaction:

>>> pipe = r.pipeline(transaction=False)

一个常见的问题是:在进行原子事务操作前需要从 Redis 中获取事务中要用的数据。比如,假设 INCR 命令不存在,但我们需要用 Python 创建一个原子版本的 INCR

一个不成熟做法是先获取值(GET),在 Python 中加1, 设置(SET)新值。但是,这不是原子操作,因为多个客户端可能在同一时间做这件事,每一个都通过 GET 获取同一个值。

WATCH 命令提供了在开始事务前监视一个或多个键的能力。如果这些键中的任何一个在执行事务前发生改变,整个事务就会被取消并抛出 WatchError 异常。要实现我们的客户 INCR 命令,可以按下面的方法操作:

>>> with r.pipeline() as pipe:
...     while 1:
...         try:
...             # 对序列号的键进行 WATCH
...             pipe.watch('OUR-SEQUENCE-KEY')
...             # WATCH 执行后,pipeline 被设置成立即执行模式直到我们通知它
...             # 重新开始缓冲命令。
...             # 这就允许我们获取序列号的值
...             current_value = pipe.get('OUR-SEQUENCE-KEY')
...             next_value = current_value + 1
...             # 现在我们可以用 MULTI 命令把 pipeline 设置成缓冲模式
...             pipe.multi()
...             pipe.set('OUR-SEQUENCE-KEY', next_value)
...             # 最后,执行 pipeline (set 命令)
...             pipe.execute()
...             # 如果执行时没有抛出 WatchError,我们刚才所做的确实“原子地”
...             # 完成了
...             break
...         except WatchError:
...             # 一定是其它客户端在我们开始 WATCH 和执行 pipeline 之间修改了
...             # 'OUR-SEQUENCE-KEY',我们最好的选择是重试
...             continue

注意,因为在整个 WATCH 过程中,Pipeline 必须绑定到一个单连接,必须调用 reset() 方法确保连接返回连接池。如果 Pipeline 用作上下文管理器(如上面的例子所示,with r.pipeline() as pipe:), reset() 会自动调用。当然,也可以用手动的方式明确调用 reset():

>>> pipe = r.pipeline()
>>> while 1:
...     try:
...         pipe.watch('OUR-SEQUENCE-KEY')
...         ...
...         pipe.execute()
...         break
...     except WatchError:
...         continue
...     finally:
...         pipe.reset()

注:·WATCH 执行后,pipeline 被设置成立即执行模式

·用 MULTI 命令把 pipeline 设置成缓冲模式

存在一种方便的方法“transaction”用来处理WatchError的处理和重试的模式。它调用含有一个参数的可执行对象,一个管道对象,和任意数量要 WATCH的键,其中可执行对象接受一个 pipeline 对象做为参数。上面的客户端 INCR 命令可以重写如下(更易可读):

>>> def client_side_incr(pipe):
...     current_value = pipe.get('OUR-SEQUENCE-KEY')
...     next_value = current_value + 1
...     pipe.multi()
...     pipe.set('OUR-SEQUENCE-KEY', next_value)
>>> r.transaction(client_side_incr, 'OUR-SEQUENCE-KEY')

原文https://pypi.python.org/pypi/redis/

© 著作权归作者所有

共有 人打赏支持
xiaoanyunfei
粉丝 0
博文 12
码字总数 11094
作品 0
海淀
私信 提问
Python client for Redis 官翻文档2.10.1(一)

Python client for Redis key-value store redis针对python的客户端, github地址:https://github.com/andymccurdy/redis-py/ 安装: 虽然称redis的python客户端称为redis-py,实际安装时的......

山下狮子
2014/06/19
0
0
python-celery使用教程

Celery Celery是Python开发的分布式任务调度模块。分为任务分发,任务队列,worker3个部分。celery的出现,解决了python运行后台任务的需求。 这篇文章介绍的celery版本是3.1.18 celery架构 ...

go-skyblue
2015/07/23
0
0
《Python3.6官方文档》– 第12章 虚拟环境和包

原文链接   译者:Carvendy 12. 虚拟环境和包 12.1 介绍   Python应用程序总会使用一些包和模块,它们离不开标准库。应用程序需要指定标准库的版本,因为应用程序可能需要避免一个已经修复...

魔术师Carvendy
01/17
0
0
如何使用redis构建异步任务处理程序

原文:http://www.letiantian.me/2015-11-03-redis-async-task/ 如果一些任务没必要马上知道结果,可以将其放入队列中,让后台处理程序去处理,这同时也达到了异步的效果。本文围绕python的r...

樂天
2015/11/04
0
4
初学Python——软件目录结构规范

为什么要设计好目录结构? 可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。 可维护...

学霸初养成
05/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

java.util.concurrent.atomic.AtomicLong 源码

类图: 源码: package java.util.concurrent.atomic;import java.util.function.LongUnaryOperator;import java.util.function.LongBinaryOperator;import sun.misc.Unsafe;......

狼王黄师傅
10分钟前
1
0
Java每天10道面试题,跟我走,offer有!(六)

51.HashMap的实现原理 HashMap的主干是一个Entry数组。Entry是HashMap的基本组成单元,每一个Entry包含一个key-value键值对。HashMap基于hashing原理,我们通过put()和get()方法储...

Java干货分享
16分钟前
1
0
剧调查黑客偏爱用 Python,可能是世界上最好的语言

导读 Python 变得越来越流行,在之前 9 月份的 TIOBE 排行榜中,Python 甚至挤下 C++,拿到第三名。而这有一部分原因应当归于黑客对 Python 的热衷。 据 Threatpost 报导,在 Imperva 最近一...

问题终结者
22分钟前
1
0
apollo生产环境配置-实践笔记(附搭建框架图)

前言 我们这个月上线了apollo1.1.1版本(生产环境),目前一切运行良好,故在此记个笔记。 首先,附上流程图: 简要介绍 一套apollo portal配置管理服务来同时管理pro、dev环境,但pro、dev...

开源小菜鸟2333
24分钟前
3
0
angular6 利用 ngContentOutlet 实现组件位置交换

这篇文章主要介绍了angular6 利用 ngContentOutlet 实现组件位置交换(重排),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧 ngContentOutlet指令介绍 ngCont...

嫣然丫丫丫
31分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部