0

0

掌握 Poetry new 命令:理解其行为变更与项目初始化策略

花韻仙語

花韻仙語

发布时间:2025-11-26 14:02:23

|

438人浏览过

|

来源于php中文网

原创

掌握 Poetry new 命令:理解其行为变更与项目初始化策略

poetry 的 `new` 命令在项目初始化行为上发生了显著变化。自 2021 年 4 月起,它不再默认生成测试文件(如 `test_*.py`),且 `__init__.py` 文件也默认为空。本文将深入解析这些变更,指导用户如何适应新的初始化流程,并强调查阅最新官方文档的重要性,以确保项目设置的准确性与高效性。

理解 Poetry 项目初始化行为的演进

Poetry 作为一个现代 Python 依赖管理和打包工具,其设计理念之一是提供简洁高效的开发体验。然而,软件工具会随着时间的推移和社区反馈进行迭代更新,Poetry 也不例外。一个重要的行为变更发生在 2021 年 4 月,具体体现在其 poetry new 命令的项目初始化流程上。

在此变更之前,当用户执行 poetry new 命令时,Poetry 会自动在项目根目录下创建一个 tests 目录,并在其中生成一个示例测试文件(通常是 test_.py)。此外,项目模块内的 __init__.py 文件也可能包含一些默认内容。

然而,为了提供更灵活、更少侵入性的项目骨架,Poetry 团队决定调整这一默认行为。根据相关提交记录,自该时间点起:

  1. 不再自动生成测试文件: poetry new 命令不再默认创建 tests 目录及其内部的 test_*.py 文件。
  2. __init__.py 文件默认为空: 生成的 Python 包结构中的 __init__.py 文件将是空的。

这一变化旨在让开发者对项目的初始结构拥有更大的控制权,允许他们根据具体需求自行决定测试框架和模块初始化方式。

应对行为变更:项目初始化与测试设置的最佳实践

由于 Poetry 的行为发生了变化,一些早期的教程或文档可能未能及时更新,导致用户在使用新版 Poetry 时发现与教程描述不符的情况。为了确保项目能够正确初始化并顺利进行测试开发,以下是一些推荐的实践方法:

1. 初始化项目

使用 poetry new 命令创建新项目的基础步骤保持不变:

poetry new my-project

执行此命令后,Poetry 会创建一个名为 my-project 的目录,其中包含以下基本结构:

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

可以看到,tests 目录和 test_my_project.py 文件并未自动生成,且 my_project/__init__.py 是空的。

2. 手动设置测试环境

由于 Poetry 不再自动生成测试文件,您需要手动创建测试目录和文件。

步骤一:创建 tests 目录

在项目根目录下创建 tests 目录:

mkdir my-project/tests

步骤二:创建测试文件

AI at Meta
AI at Meta

Facebook 旗下的AI研究平台

下载

在 tests 目录下创建您的测试文件,例如 test_example.py。您可以根据需要选择不同的测试框架(如 pytest 或 unittest)。

以 pytest 为例,创建一个简单的测试文件 my-project/tests/test_example.py:

# my-project/tests/test_example.py

from my_project import __version__

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

步骤三:安装测试依赖

如果您使用 pytest,需要将其添加到开发依赖中:

cd my-project
poetry add pytest --group dev

然后,您就可以运行测试了:

poetry run pytest

3. 关于 __init__.py 文件

__init__.py 文件是 Python 包的标志,它的存在告诉 Python 解释器该目录是一个包。当它为空时,意味着该包没有默认的初始化逻辑或需要导出的顶层对象。

在大多数情况下,空的 __init__.py 文件是完全可以接受的。只有当您需要执行以下操作时,才需要向其中添加内容:

  • 定义包的元数据: 例如 __version__、__author__ 等。
  • 简化模块导入: 将子模块或子包中的特定函数、类直接导入到父包的命名空间,以便用户可以直接从父包导入,而无需深入到子模块。

例如,如果您希望在 my_project/__init__.py 中定义版本信息,可以这样修改:

# my-project/my_project/__init__.py

__version__ = "0.1.0"

这样,其他模块就可以通过 from my_project import __version__ 来访问版本号。

关键注意事项与总结

  1. 始终查阅最新官方文档: 这是最重要的建议。Poetry 的官方文档(python-poetry.org/docs/)是获取最新、最准确信息的最佳来源。当您遇到与教程不符的行为时,第一时间应参考官方文档,尤其是 CLI 命令部分的说明。
  2. 理解工具演进: 软件工具会不断发展。过时的教程虽然有参考价值,但不能完全依赖。理解工具行为可能发生变化是现代软件开发者的基本素养。
  3. 自定义项目结构: Poetry 的新行为赋予了开发者更大的自由度。您可以根据项目的具体需求,自由选择测试框架、目录结构和模块初始化方式。

通过理解 Poetry new 命令的最新行为,并结合官方文档和最佳实践,您将能够更高效、更准确地初始化和管理您的 Python 项目。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

758

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

639

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

761

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1265

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

548

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

709

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 3.6万人学习

Django 教程
Django 教程

共28课时 | 3.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号