
poetry的`new`命令自2021年4月起已变更其项目初始化行为。现在,执行`poetry new`不再自动创建`test_*.py`测试文件,并且`__init__.py`文件默认为空。这一变化旨在提供更灵活的初始化方式,开发者应参照最新官方文档,并根据项目需求手动配置测试结构,以确保项目遵循最新的最佳实践。
Poetry new 命令行为变更详解
Poetry作为一款现代化的Python依赖管理和项目打包工具,以其简洁高效的特性受到了广大开发者的青睐。然而,随着其版本的迭代,某些默认行为也发生了变化。其中一个显著的改变是关于poetry new命令在项目初始化时对测试文件和__init__.py文件的处理。
在此前的版本中,当开发者使用poetry new
然而,自2021年4月起,Poetry的这一默认行为已被修改。此项变更(具体可追溯到此提交)旨在提供更灵活的项目初始化方式。现在,执行poetry new命令后:
-
不再自动创建测试文件: 项目根目录下的tests/文件夹(如果存在)将不再包含自动生成的test_
.py文件。 - __init__.py文件默认为空: 在项目包目录(例如rp_poetry/)及其子目录中生成的__init__.py文件将是空的,不再包含版本信息或其他默认内容。
这一变化意味着Poetry在项目初始化时更加“轻量化”和“不干预”,将测试结构的搭建和__init__.py文件的具体内容留给开发者根据实际需求自行决定。
如何正确初始化和配置新项目
鉴于上述行为变更,开发者在初始化Poetry项目时应注意以下几点:
1. 使用 poetry new 初始化项目
首先,像往常一样使用poetry new命令创建新项目:
poetry new my-new-project
执行此命令后,my-new-project的目录结构将如下所示:
my-new-project/
├── pyproject.toml
├── README.md
├── my_new_project/
│ └── __init__.py # 此文件将为空
└── tests/
└── __init__.py # 此文件将为空可以看到,tests/目录下没有自动生成的测试文件。
2. 手动配置测试环境
如果项目需要测试,开发者需要手动创建测试文件并配置测试框架(如pytest)。
步骤示例:
-
安装测试框架: 通常,pytest是一个流行的选择。通过Poetry将其添加到开发依赖中:
cd my-new-project poetry add pytest --group dev
或者在pyproject.toml中手动添加:
[tool.poetry.group.dev.dependencies] pytest = "^7.0" # 根据需要选择版本
然后运行 poetry install。
-
创建测试文件: 在tests/目录下手动创建测试文件,例如tests/test_example.py:
# tests/test_example.py from my_new_project import __version__ def test_version(): assert __version__ == "0.1.0" # 假设你在pyproject.toml中定义了版本 -
运行测试: 使用Poetry运行测试:
poetry run pytest
3. __init__.py 文件处理
对于__init__.py文件,如果需要定义包的版本或其他元数据,应手动添加。例如,在my_new_project/__init__.py中:
# my_new_project/__init__.py __version__ = "0.1.0"
这与Poetry早期版本自动填充版本号的行为不同,现在需要开发者自行管理。
注意事项与最佳实践
- 查阅最新文档: 鉴于Poetry的快速发展,强烈建议开发者始终查阅官方最新文档。旧教程(尤其是2021年4月之前的教程)可能包含过时的信息。
- 版本控制: 将pyproject.toml、poetry.lock以及所有源代码和测试文件纳入版本控制,以确保团队成员之间的一致性。
- 灵活性: 尽管不再自动生成测试文件,但这为开发者提供了更大的灵活性,可以根据项目的具体需求和偏好(例如使用unittest而不是pytest,或采用不同的测试文件命名约定)来构建测试结构。
- 项目结构规范: 尽管Poetry不再强制,但遵循Python社区普遍接受的项目结构规范(如将测试放在tests/目录中)仍然是良好的实践。
总结
Poetry new 命令的行为变更是一项旨在提升工具灵活性的设计决策。开发者现在需要更加主动地配置项目的测试环境和__init__.py文件内容。通过理解这些变化并遵循最新的官方文档和最佳实践,可以确保您的Poetry项目始终保持健康、高效且易于维护。










