sqlacodegen 项目使用教程

1. 项目目录结构及介绍

sqlacodegen/
├── src/
│   └── sqlacodegen/
│       ├── __init__.py
│       ├── codegen.py
│       ├── generators/
│       │   ├── __init__.py
│       │   ├── declarative.py
│       │   ├── dataclasses.py
│       │   ├── sqlmodels.py
│       │   └── tables.py
│       └── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_codegen.py
│   └── test_utils.py
├── .gitignore
├── pre-commit-config.yaml
├── CHANGES.rst
├── CONTRIBUTING.rst
├── LICENSE
├── README.rst
└── pyproject.toml

目录结构介绍

• src/sqlacodegen/: 项目的主要代码目录，包含了核心的代码生成逻辑。
  • codegen.py: 核心代码生成模块。
  • generators/: 包含不同类型的代码生成器，如 declarative.py, dataclasses.py, sqlmodels.py, tables.py。
  • utils.py: 工具函数模块。
• tests/: 测试代码目录，包含项目的单元测试。
• .gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• CHANGES.rst: 项目变更日志。
• CONTRIBUTING.rst: 贡献指南。
• LICENSE: 项目许可证。
• README.rst: 项目介绍和使用说明。
• pyproject.toml: 项目配置文件，包含依赖和构建配置。

2. 项目启动文件介绍

项目的启动文件是 src/sqlacodegen/codegen.py。这个文件包含了主要的代码生成逻辑，负责读取数据库结构并生成相应的 SQLAlchemy 模型代码。

主要功能

• 读取数据库结构: 通过 SQLAlchemy 连接到数据库，读取表结构。
• 生成模型代码: 根据读取的表结构，生成相应的 SQLAlchemy 模型代码。
• 支持多种生成器: 支持生成 declarative, dataclasses, sqlmodels, tables 等多种类型的代码。

3. 项目配置文件介绍

项目的配置文件是 pyproject.toml。这个文件使用 TOML 格式，包含了项目的依赖、构建配置等信息。

主要配置项

• [tool.poetry]: 使用 Poetry 进行依赖管理。
  • name: 项目名称。
  • version: 项目版本。
  • description: 项目描述。
  • authors: 项目作者。
  • license: 项目许可证。
• [tool.poetry.dependencies]: 项目依赖。
  • python: 支持的 Python 版本。
  • sqlalchemy: SQLAlchemy 依赖。
  • inflect: 可选依赖，用于命名转换。
• [tool.poetry.dev-dependencies]: 开发依赖。
  • pytest: 用于单元测试。
• [build-system]: 构建系统配置。
  • requires: 构建所需的依赖。
  • build-backend: 构建后端。

通过 pyproject.toml 文件，可以方便地管理项目的依赖和构建配置，确保项目在不同环境中的一致性。