peewee Documentation Release 3.3.0

### Peewee 3.3.0 文档总结 #### 1. 主要更新内容 - **版本兼容性**： - 从2.x升级到3.x时，部分API和数据库操作方式发生了变化，可能会引发不兼容问题。 - 新增了DeprecationWarning以提示已弃用的功能。 - **数据库连接**： - `get_conn()` 改为 `Database.connection()`。 - `get_cursor()` 改为 `Database.cursor()`。 - `execution_context()` 已移除，建议使用数据库实例作为上下文管理器。 - `create_tables()` 和 `drop_tables()` 默认启用 `safe=True`。 - **模型和字段**： - `BaseModel` 被重命名为 `ModelBase`。 - `db_table` 改为 `table_name`，`db_table_func` 改为 `table_function`。 - `PrimaryKeyField` 重命名为 `AutoField`。 - `ForeignKeyField` 的参数 `rel_model`、`to_field`、`related_name` 分别改为 `model`、`field`、`backref`。 - �移除了 `PasswordField`、`PickledField` 和 `AESEncryptedField` 等扩展字段。 - **新功能**： - **查询构建器**：全新重写的查询构建器更灵活、强大，新增了低级API。 - **SQLite增强**： - 将 `sqlite-vtfunc` 的虚拟表实现集成到主代码库。 - 支持 SQLite 的在线备份 API、BloomFilter、Incremental Blob I/O 和 LSMTable（支持 lsm1 扩展）。 - 提供了更多用户定义的哈希和排名函数。 - **其他扩展**： - 支持 Postgres 的 `hstore`、`json`、`arrays` 等特性。 - 支持 SQLite 的全文检索功能。 #### 2. API 文档 - **数据库错误处理**： - 提供统一的异常类：`DatabaseError`、`DataError`、`IntegrityError` 等，均继承自 `PeeweeException`。 - **日志记录**： - 所有查询默认记录到 `peewee` 日志命名空间，使用 `DEBUG` 级别。 - 可通过标准 `logging` 模块自定义日志处理。 #### 3. 安装与配置 - **安装**： - 使用 `pip` 安装最新版本：`pip install peewee`。 - 支持从 Git 克隆安装：`git clone https://github.com/coleifer/peewee.git`。 - **构建扩展**： - 若需要构建 SQLite 扩展，需使用 `setup.py build_ext -i`。 #### 4. 快速入门 - **核心特性**： - 简单直观的 ORM，支持 Python 2.7+ 和 3.4+。 - 原生支持 SQLite、MySQL 和 PostgreSQL。 - **推荐文档**： - 《Quickstart Guide》：涵盖基础知识，适合快速上手。 - 《Querying》：详细描述查询构建方法。 #### 5. 示例应用 - 提供了一个简单的 Twitter-like 示例应用，使用 Flask 框架。 - 示例代码可在 GitHub 上找到：`examples/twitter`。 #### 6. 其他功能 - **模型生成**： - 使用 `pwiz` 工具自动生成模型：`python -m pwiz -e postgresql charles_blog > blog_models.py`。 - **扩展支持**： - 提供了丰富的扩展模块，如 `postgres_ext`、`sqlite_ext` 等。 #### 7. 注意事项 - 升级时需注意已移除或更改的字段、方法和配置选项。 - 使用前仔细阅读迁移指南，确保代码兼容性。 以上为 Peewee 3.3.0 的核心更新内容和主要功能总结。