使用 `nox-poetry` 在你的 Python 项目中实现高效自动化测试与构建-优快云博客

使用 `nox-poetry` 在你的 Python 项目中实现高效自动化测试与构建

nox-poetryUse Poetry inside Nox sessions项目地址:https://gitcode.com/gh_mirrors/no/nox-poetry

1. 项目目录结构及介绍

由于直接提供的是文档引用而非具体的项目源代码分析，我们将基于常规Python项目结合nox-poetry使用场景来概述一个理想化的目录结构及其组成部分。实际项目可能根据开发需求有所不同。

your_project/
│
├── your_project/          # 应用代码所在目录
│   ├── __init__.py
│   └── ...                 # 其他应用相关文件或模块
│
├── pyproject.toml         # 主要配置文件，用于Poetry管理依赖及项目信息
├── README.md              # 项目说明文件
├── tests/                 # 测试代码存放目录
│   ├── __init__.py
│   └── test_your_module.py # 示例测试文件
├── noxfile.py             # Nox配置文件，结合nox-poetry定义自动化任务
└── setup.cfg              # 可选，额外的配置文件，有时用于指定编译或测试参数

your_project: 包含应用程序的核心代码。
pyproject.toml: 使用Poetry管理项目依赖，包括版本、依赖项等。
tests: 测试代码的存储位置。
noxfile.py: 核心在于此，通过nox-poetry定义自动化测试、部署等会话。
setup.cfg: 辅助配置文件，并非必须，但可用于更细粒度的控制。

2. 项目的启动文件介绍

在本上下文中，“启动文件”指的是与自动化工作流紧密相关的noxfile.py。这个文件是使用nox-poetry的关键：

# noxfile.py 示例
from nox_poetry import session

@session(python=["3.10", "3.9"])
def tests(session):
    """运行测试案例"""
    session.install("pytest")  # 安装测试工具
    session.run("pytest")      # 运行测试

这段脚本声明了一个名为tests的Nox会话，它支持Python 3.10和3.9版本。它安装了pytest并通过Poetry确保依赖符合锁文件规定的版本，然后执行测试。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml是使用Poetry的项目的核心配置文件。它不仅记录了项目的基本信息（如name, version），还定义了项目的依赖关系及其版本范围。示例内容如下：

[tool.poetry]
name = "your_project"
version = "0.1.0"
description = "A brief description."
authors = ["Your Name <you@example.com>"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
nox-poetry = "^1.0.0"
pytest = "^6.2.5"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

这部分配置指定了项目依赖（dependencies）和开发时依赖（dev-dependencies），其中nox-poetry是为集成Nox所必需的。