也有接口模块的 python 库的一般约定？

Question

现在我有一个具有以下布局的项目：

foo/
  __init__.py
  __main__.py
  foo.py

在这种情况下，foo.py实际上是主api文件，因此开发人员应该执行“from foo import foo”，但我还想让最终用户只需运行 ~$ foo 并获得一个界面。

当我安装 distutils 时，会创建 /usr/bin/__main__.py 因为 (a) 我不知道如何使用 distutils，[不太重要] 并且 (b) 我不知道确定什么通常被认为是正确的事情。

据我所知，我有三个选择：

1. 使 distutils 更智能，以便 setup.py install 创建 符号链接 /usr/bin/foo -> $PYTHONLIB/foo/__main__.py。这是我的 直接的直觉，我也许能弄清楚该怎么做， 虽然我想做的事情都感觉像是黑客 我还没有发现有人谈论这个。

2. 在分发之前将 __main__.py 重命名为 foo，并将调用修改为 distutils 的设置为 setup(scripts=['foo'], ...)。这与 (1) 非常相似，除了它发生的时间，我认为。

3. 只是不要在库包中包含接口。我觉得 像这样主要取决于库/接口的大小 看看它是否有意义。

我还没有看到很多包含 __main__.py 的软件包（如果有的话），所以我不确定是否人们不使用它们或者我没有使用正确的软件包。事实上，我找不到任何涉及 __main__.py 和 distutils 的博客文章或文章，这一事实表明，它并不是一个特别受欢迎的组合。

Answer 1

调用模块 __main__.py 是一个坏主意，因为该名称具有特殊含义。而是在 __init__ 中使用 主哨兵。 py 并创建一个执行 exec python -m foo 的脚本。

Answer 2

将 Ignacio Vazquez-Abrams 的答案与一些谷歌搜索相结合，导致我发现 这篇关于使用 _main_.py 的文章，我想我可能会采用如下布局：

foo/
    foo/
        __main__.py
        ...
    scripts/
        foo

where scripts/foo 只是

#!/bin/sh
exec python foo "$@"

这看起来会干净地安装，并且让人们无需安装即可使用我的模块，只需执行python path/to/foo即可。