Poetrynew命令与__init__.py行为详解

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《Poetry new 命令：文件与__init__.py行为解析》，这篇文章主要讲到等等知识，如果你对文章相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

Poetry 的 `new` 命令行为在2021年4月发生了重要变更。此后，它不再默认生成 `test_*.py` 测试文件，并且 `__init__.py` 文件也会被创建为空。这一变化旨在简化项目初始化流程并与现代Python打包实践对齐。因此，用户在遵循旧教程时应注意此差异，并始终查阅Poetry的最新官方文档以获取准确信息，测试文件需手动创建。

Poetry new 命令的行为演变

在Poetry早期版本中，当用户执行 poetry new 命令来创建一个新项目时，Poetry会自动生成一个包含基本项目结构、一个空的 __init__.py 文件以及一个预设的 test_.py 测试文件的目录。这种行为对于初学者来说可能很方便，但随着Python生态系统的发展和最佳实践的演变，这种默认行为被重新评估。

2021年4月，Poetry的核心开发团队通过一次重要的提交（commit 85f922dfddb8d8e61408b5d8e53f3bffb6beb2b2b）修改了 poetry new 命令的默认行为。主要变更点如下：

1. 不再自动生成测试文件：poetry new 命令不再默认创建 test_.py 文件。这意味着新创建的项目将不会在 tests/ 目录下包含任何测试骨架文件。
2. __init__.py 文件默认为空：项目模块中的 __init__.py 文件（例如 my_project/__init__.py）现在默认创建为空，而不是包含版本信息或其他样板代码。这与Python 3.3+ 以来包的隐式命名空间包（Implicit Namespace Packages）和更简洁的包定义趋势保持一致。

这些变化旨在提供一个更精简、更符合现代Python项目结构的起始点，让开发者可以根据自己的需求和偏好来配置测试和包结构。

当前工作流与最佳实践

鉴于 poetry new 命令行为的改变，开发者在初始化项目时需要调整其工作流。

1. 项目初始化

使用 poetry new 命令创建项目，其输出将只包含最基本的项目骨架：

poetry new my-project

执行上述命令后，my-project 目录结构大致如下：

my-project/
├── pyproject.toml
├── README.md
├── my_project/
│   └── __init__.py
└── tests/

请注意，tests/ 目录下不会有任何 test_*.py 文件，且 my_project/__init__.py 文件是空的。

2. 手动创建测试文件

由于不再自动生成测试文件，开发者需要手动创建并组织测试。推荐使用流行的测试框架，如 pytest。

首先，将 pytest 添加为开发依赖：

cd my-project
poetry add pytest --group dev

然后，在 tests/ 目录下手动创建测试文件，例如 tests/test_example.py：

# tests/test_example.py

from my_project import __version__

def test_version():
    assert __version__ == "0.1.0" # 假设pyproject.toml中定义了版本

为了使上述测试通过，你可能需要在 my_project/__init__.py 中定义 __version__：

# my_project/__init__.py

__version__ = "0.1.0"

最后，运行测试：

poetry run pytest

3. __init__.py 的作用

现在 __init__.py 默认为空，这符合Python 3.3+ 版本的包定义规范。在许多情况下，一个空的 __init__.py 足以将目录标记为一个Python包。如果你需要公开包的版本信息、进行包级别的初始化操作或暴露特定的模块/函数，你可以在 __init__.py 中添加相应代码。

例如，为了从包外部导入版本信息，你可以在 my_project/__init__.py 中定义：

# my_project/__init__.py

__version__ = "0.1.0"

# 你也可以在这里导入包内的其他模块，例如：
# from .module_a import some_function

4. 查阅最新文档

由于Python工具链和最佳实践的快速发展，教程和工具行为可能会随时间而变化。因此，强烈建议在学习和使用Poetry时，始终查阅其官方文档的最新版本。官方文档是获取最准确、最权威信息的来源。

• Poetry 官方文档：https://python-poetry.org/docs/
• poetry new 命令文档：https://python-poetry.org/docs/cli/#new

总结与建议

Poetry new 命令的行为变更反映了Python社区对项目初始化和包管理实践的演进。虽然这可能导致一些旧教程与当前Poetry版本不符，但理解这些变化有助于开发者更好地利用Poetry构建和管理项目。

核心要点包括：

• 测试文件需手动创建：不再依赖Poetry自动生成测试骨架。
• __init__.py 默认为空：根据需要自行填充，以定义版本或进行包初始化。
• 始终参考最新官方文档：这是避免混淆和获取最新最佳实践的关键。

通过适应这些变化，开发者可以更灵活、高效地使用Poetry管理Python项目。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。