redis-py 技术文档

1. 安装指南

使用 Docker 启动 Redis

docker run -p 6379:6379 -it redis/redis-stack:latest

安装 redis-py

pip install redis

为了提高性能，可以安装带有 hiredis 支持的 redis-py，这提供了一个编译的响应解析器，并且在大多数情况下无需修改代码。

pip install "redis[hiredis]"

如果需要处理对象映射的高级库，请查看 redis-om-python！

2. 项目的使用说明

基础示例

import redis

r = redis.Redis(host='localhost', port=6379, db=0)
r.set('foo', 'bar')
r.get('foo')

上面的代码连接到本地主机的 6379 端口，设置一个 Redis 值并检索它。所有响应都返回为字节串，如果需要接收解码的字符串，请设置 decode_responses=True。

RESP3 支持

要启用 RESP3 支持，确保你的客户端版本至少为 5.0，并在连接对象中包含 protocol=3。

import redis

r = redis.Redis(host='localhost', port=6379, db=0, protocol=3)

连接池

默认情况下，redis-py 使用连接池来管理连接。每个 Redis 类实例接收自己的连接池。然而，你可以自定义 redis.ConnectionPool。

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

另外，你还可以查看 异步连接，集群连接，甚至 异步集群连接。

Redis 命令

redis-py 内置了对所有 Redis 命令的支持。它们使用原始 Redis 命令名称（HSET、HGETALL 等），但在语言中保留的关键字（如 del）除外。完整的命令集可以在 这里 或 文档 中找到。

3. 项目API使用文档

redis-py 的 API 文档详细介绍了如何使用该库的所有功能，包括连接管理、数据类型、命令等。具体的 API 使用方法请参考官方文档。

4. 项目安装方式

请参考本文档的“安装指南”部分，了解如何通过 pip 和 Docker 安装 redis-py。