Redis OM Python 项目教程

Redis OM Python 项目教程

redis-om-pythonObject mapping, and more, for Redis and Python项目地址:https://gitcode.com/gh_mirrors/re/redis-om-python

1. 项目的目录结构及介绍

Redis OM Python 项目的目录结构如下：

redis-om-python/
├── docs/
├── examples/
├── redis_om/
│   ├── model/
│   ├── migrations/
│   ├── util/
│   └── ...
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── setup.py

目录结构介绍

• docs/: 包含项目的文档文件。
• examples/: 包含示例代码，展示如何使用 Redis OM Python。
• redis_om/: 核心代码目录，包含模型定义、迁移工具和实用工具。
  • model/: 包含模型定义的相关文件。
  • migrations/: 包含数据库迁移脚本。
  • util/: 包含实用工具函数。
• tests/: 包含测试代码，用于确保项目功能的正确性。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pyproject.toml: 项目配置文件，用于 Poetry 包管理。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

Redis OM Python 项目的启动文件通常是示例代码中的一个脚本，用于展示如何初始化和使用 Redis OM 模型。以下是一个典型的启动文件示例：

from redis_om import HashModel

class Customer(HashModel):
    first_name: str
    last_name: str
    age: int

# 初始化 Redis 连接
Customer.Meta.database = "redis://localhost:6379"

# 创建一个新客户
new_customer = Customer(first_name="John", last_name="Doe", age=30)
new_customer.save()

# 查询客户
customer = Customer.get(new_customer.pk)
print(customer)

启动文件介绍

• 导入模块: 导入 HashModel 类，用于定义模型。
• 定义模型: 定义一个 Customer 模型，继承自 HashModel。
• 初始化 Redis 连接: 设置 Redis 连接字符串。
• 创建和保存实例: 创建一个新的 Customer 实例并保存到 Redis。
• 查询实例: 通过主键查询并打印实例。

3. 项目的配置文件介绍

Redis OM Python 项目的配置文件主要是 pyproject.toml 和 setup.py。

pyproject.toml

pyproject.toml 文件用于 Poetry 包管理，包含项目依赖、构建系统和元数据等信息。

[tool.poetry]
name = "redis-om-python"
version = "0.1.0"
description = "Object mapping and more for Redis and Python"
authors = ["Redis <support@redis.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"
redis = "^4.0.0"
pydantic = "^1.8.2"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

setup.py

setup.py 文件用于传统的包安装，包含项目元数据和依赖信息。

from setuptools import setup, find_packages

setup(
    name="redis-om-python",
    version="0.1.0",
    description="Object mapping and more for Redis and Python",
    author="Redis",
    author_email="support@redis.com",
    license="MIT",
    packages=find_packages(),
    install_requires=[
        "redis>=4.0.0",
        "pydantic>=1.8.2",
    ],
    classifiers=[
        "Development Status :: 3 - Alpha",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.8",

redis-om-pythonObject mapping, and more, for Redis and Python项目地址:https://gitcode.com/gh_mirrors/re/redis-om-python