peewee软件适配GaussDB开源开发任务

1 背景介绍

开源for Huawei（参考：https://developer.huaweicloud.cn/programs/opensource/contributing/）  通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。

开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。

2 需求分析

2.1 项目影响力

Peewee 是Charles Leifer个人用Python开发并开源，Peewee是一个轻量级的 Python ORM（对象关系映射）库（https://github.com/coleifer/peewee），它允许开发者在 Python 应用程序中轻松地与数据库进行交互。Peewee 的设计目标是简单、轻便且高效，使开发者能够快速构建数据库驱动的应用程序。它支持多种数据库后端，包括 SQLite、MySQL、PostgreSQL 等，因此适用于各种项目。

项目数据：Fork 1.4K, Star 11.1K, Contributor 136

star历史（https://star-history.com/）：

2.2 任务目的和范围

本任务的主要目的是让Peewee库支持GaussDB数据库，帮助拓展GaussDB的影响力。同时，该任务可以为一些项目迁移打下基础，方便用户使用Peewee的时候，可以选择GaussDB作为第三方数据库。

适配任务清单

3 工作量评估和任务分解

3.1 工作量评估

3.2 完成GaussDB数据库适配功能开发

• 可以使用兼容GaussDB的数据库驱动 psycopg2，但可能需要对其进行扩展或定制以支持GaussDB特有的功能。
• 在GitCode完成项目Fork （https://github.com/coleifer/peewee/blob/master/peewee.py#L3163），并完成GaussDB数据库引擎的适配开发，然后保证新的数据库引擎被正确导入和注册。
• 在自定义的数据库引擎模块中，实现所有必要的数据库操作方法，并添加特定的方言支持。如果GaussDB有特定的SQL语法或函数，应该在数据库后端实现这些特性。
• 如果GaussDB存在特定的数据类型，可能需要在Peewee的模型字段中去更新相对应的字段类型 https://github.com/coleifer/peewee/blob/master/peewee.py#L4778。

3.3 完成GaussDB演示DEMO设计

DEMO在resource-server-python（使用了Django，开发者需要在里面集成Peewee实现数据库访问）中完成,https://docs.peewee-orm.com/en/latest/peewee/quickstart.html 的例子开发任务，通过RESTful API暴露数据库访问能力供前端使用。

DEMO的简单部署图如下：

Peewee 本身不直接使用DBAPI（数据库API），但是它是建立在DBAPI之上的，最终都需要依赖于DBAPI兼容的数据库驱动来与数据库进行通信。

3.4 DEMO开发、部署和验证

根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。

3.5 在华为云开发者论坛输出博客

访问华为云开发者论坛（参考：https://bbs.huaweicloud.cn/blogs）发表博客，介绍完成这些任务的过程和心得。

内容包括不限于如下内容：

• 开源for Huawei的背景
• 开源软件的功能介绍
• 开发适配过程及碰到和解决的问题
• DEMO设计、开发、部署过程
• 代码推送开源社区及互动过程

博客打上如下标签：

• 开源（必选）
• 开发者（必选）
• GaussDB数据库（可选）
• 云数据库GaussDB（可选）
• 鲲鹏（可选）
• 昇腾（可选）
• 鸿蒙（可选）
• 对象存储OBS（可选）

3.6 代码推送上游社区

将代码合并到Peewee官网主干代码；更新Peewee官网资料，包括版本说明、开发指南等。

Peewee仓库地址：https://github.com/coleifer/peewee/blob/master/peewee.py

4 验收材料

5 参考资料

• 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview