peewee Documentation Release 2.10.2

• 语言: 英语
• 格式: .pdf
• 来源: docs.peewee-orm.com

摘要

Peewee 是一个简单且小型的ORM（对象关系映射）框架，支持Python 2.6+ 和 3.2+，内置支持SQLite、MySQL和PostgreSQL，并提供多种扩展模块。文档详细介绍了Peewee的核心功能，包括数据库管理、框架集成、错误处理、连接池、事务管理、查询日志以及数据迁移等。此外，还提供了安装指南和使用说明，帮助用户快速上手和深入集成Peewee到项目中。

AI总结

### 总结：Peewee Documentation Release 2.10.2

**Peewee** 是一个简单且小巧的 Python ORM（对象关系映射），以其简洁的设计和强大的功能著称。以下是文档的核心内容和关键信息：

---

#### **1. Peewee 的核心特点**
- **简单易用**：Peewee 的设计注重简洁性，学习和使用门槛低。
- **支持的 Python 版本**：兼容 Python 2.6+ 和 Python 3.2+。
- **内置数据库支持**：
- SQLite
- MySQL
- PostgreSQL
- **扩展性强**：提供丰富的扩展模块，如 PostgreSQL 的 HStore、JSON、数组支持，SQLite 的全文搜索、模式迁移等。

---

#### **2. 主要功能模块**
- **快捷功能**：
- Hybrid Attributes（混合属性）
- Signal 支持
- DataSet
- Key/Value Store
- Generic 外键
- **数据库管理与框架集成**：
- `pwiz`：模型生成器
- Schema Migrations：支持数据库模式迁移
- Connection Pool：连接池支持
- Reflection：数据库反射
- Database URL：支持通过 URL 配置数据库
- Read Slaves：读从库支持
- Test Utils：测试工具
- Flask Utils 和 Django Integration：支持常见 Web 框架

---

#### **3. SQLite 扩展**
Peewee 提供了针对 SQLite 的高级扩展功能：
- 支持自定义聚合、排序规则和函数。
- 支持 FTS3/4 全文搜索，包括 BM25 排序。
- 支持 FTS5 扩展。
- 支持事务隔离级别配置。
- 提供虚拟表和 SQLite C 扩展支持。
- 支持 Closure Table 扩展，用于高效查询层次结构数据。

---

#### **4. 错误处理**
- Peewee 提供了自己的异常类，简化了数据库操作的异常处理：
- `DatabaseError`
- `DataError`
- `IntegrityError`
- `InterfaceError`
- `InternalError`
- `NotSupportedError`
- `OperationalError`
- `ProgrammingError`
- 所有异常均继承自 `PeeweeException`。

---

#### **5. 自动重连功能**
- 通过 `RetryOperationalError` 混合类实现自动重连：

  from peewee import *
  from playhouse.shortcuts import RetryOperationalError

  class MyRetryDB(RetryOperationalError, MySQLDatabase):
      pass

  db = MyRetryDB('my_app')

- 重试失败的查询一次，若再次失败则抛出异常。

---

#### **6. 查询日志**
- 所有查询默认通过 `logging` 模块记录到 `peewee` 命名空间，日志级别为 `DEBUG`。
- 示例：

  import logging
  logger = logging.getLogger('peewee')
  logger.setLevel(logging.DEBUG)
  logger.addHandler(logging.StreamHandler())

---

#### **7. 安装与配置**
- **安装**：
- 使用 PyPI：

    pip install peewee

- 通过 Git 克隆仓库：

    git clone https://github.com/coleifer/peewee.git
    cd peewee
    python setup.py install

- **C 扩展支持**：
- `speedups`：使用 Cython 提供的性能优化函数。
- `sqlite_ext`：需要手动运行 `python setup.py build_sqlite_ext` 编译。

---

#### **8. 其他**
- 提供详细的文档和工具，帮助开发者快速上手和深入使用。
- 若遇到问题或有新功能建议，可通过 GitHub 提交 Issues。

---

### 总结
Peewee 是一个功能强大且易于使用的 ORM，适合快速开发数据库驱动的应用程序。其内置的数据库支持和丰富的扩展模块使其在不同场景下都能表现出色。文档详细介绍了核心功能、高级扩展和使用方法，便于开发者快速掌握和应用。