我正在编写一个新的 python 包以供其他人使用。为了演示它应该如何使用，我正在编写一个演示脚本来执行新包的主要部分。
这样做的惯例是什么，以便其他人可以轻松找到脚本？它应该是一个单独的模块（用什么名称）？它应该位于包的根目录中吗？出包了吗？在__init__.py?
问问题
335 次
2 回答
4
它应该是一个单独的模块（用什么名称）？
演示/some_useful_name.py
演示目录包含演示脚本。同样，测试目录包含所有单元测试。
它应该位于包的根目录中吗？
不，它不是包装的一部分。这是一个演示。
出包了吗？
是的。
在初始化.py?
绝不。
一个包裹有两条生命。(1) 作为卸载源，(2) 在 lib/site-packages 作为安装代码。
“源”应包括 README、setup.py、演示目录、测试目录和包本身。
顶级“源”setup.py 应该只安装包。演示和测试未安装。作为下载的一部分，它们会被抛在后面。
于 2011-10-06T10:22:17.350 回答
3
我从来没有见过任何真正的约定，但我个人把它放在一个主要的哨兵里面__init__.py，这样它就可以通过python -m somepackage.
于 2011-10-06T07:33:18.930 回答