GINO 项目教程
项目地址: https://gitcode.com/gh_mirrors/gi/gino 1. 项目的目录结构及介绍
gino/
├── docs/
│ ├── ...
│ └── ...
├── mysql_tests/
│ ├── ...
│ └── ...
├── src/
│ └── gino/
│ ├── __init__.py
│ ├── ...
│ └── ...
├── tests/
│ ├── ...
│ └── ...
├── .codacy.yml
├── .coveragerc
├── .editorconfig
├── .gitignore
├── AUTHORS.rst
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.rst
├── HISTORY.rst
├── LICENSE
├── Makefile
├── PATRONS.md
├── README.rst
├── SECURITY.md
├── poetry.lock
├── pyproject.toml
└── pytest.ini
目录结构介绍
- docs/: 存放项目的文档文件，通常包含项目的使用说明、API文档等。
- mysql_tests/: 存放与MySQL相关的测试代码。
- src/gino/: 项目的核心代码，包含GINO的主要实现。
- tests/: 存放项目的测试代码，用于确保代码的正确性和稳定性。
- .codacy.yml: Codacy配置文件，用于代码质量检查。
- .coveragerc: 代码覆盖率配置文件。
- .editorconfig: 编辑器配置文件，用于统一代码风格。
- .gitignore: Git忽略文件配置。
- AUTHORS.rst: 项目贡献者列表。
- CODE_OF_CONDUCT.md: 项目行为准则。
- CONTRIBUTING.rst: 贡献指南。
- HISTORY.rst: 项目历史记录。
- LICENSE: 项目许可证。
- Makefile: 用于构建和管理的Makefile。
- PATRONS.md: 项目赞助者列表。
- README.rst: 项目介绍和使用说明。
- SECURITY.md: 安全相关信息。
- poetry.lock: Poetry依赖锁定文件。
- pyproject.toml: Poetry项目配置文件。
- pytest.ini: Pytest配置文件。
2. 项目的启动文件介绍
GINO项目没有明确的“启动文件”，因为它是一个库，而不是一个独立的应用程序。通常，用户会在自己的项目中导入GINO库并使用它。例如：
from gino import Gino
db = Gino()
# 定义模型
class User(db.Model):
__tablename__ = 'users'
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String)
# 启动应用程序
async def main():
await db.set_bind('postgresql://user:password@localhost/dbname')
await db.gino.create_all()
# 创建用户
user = await User.create(name='John Doe')
print(user.id, user.name)
if __name__ == '__main__':
import asyncio
asyncio.run(main())
3. 项目的配置文件介绍
GINO项目的配置主要通过代码进行，而不是通过配置文件。用户可以在代码中设置数据库连接字符串、日志级别等。例如：
from gino import Gino
db = Gino()
# 设置数据库连接
db.bind = 'postgresql://user:password@localhost/dbname'
# 其他配置
db.echo = True # 开启SQL日志
此外，项目中还包含一些配置文件，如.coveragerc用于代码覆盖率配置，.editorconfig用于统一代码风格，pyproject.toml用于Poetry依赖管理等。这些配置文件通常用于开发和测试环境，而不是生产环境。