python - 如何为基本包设置配置 __main__.py、__init__.py 和 __setup__.py？

Question

背景:

我有一个像这样的目录结构:

Package/
    setup.py
    src/
        __init__.py
        __main__.py 
        code.py

我希望能够以多种不同的方式运行代码。

pip install Package然后 python然后 from Package import *

python -m Package哪个应该做 __main__.py 中的事情

python __main__.py这也应该做 __main__.py 中的事情但这一次，我们假设您下载的是源代码而不是 pip installing .

现在我已经让前两个工作了，但是设置很困惑:

setup.py:

setup(
    name='Package',
    packages=['Package'],
    package_dir={'Package': 'src'},
    ...
    entry_points={ 'console_scripts': ['Package = src.__main__:main' ] }

__init__.py:

from Package.code import .......

__main__.py:

from . import .......

对我来说更有意义的是在这两种情况下都写

from code import ........

但这给了我导入错误。

题:

我拥有它的方式真的是唯一的方式吗？

最重要的是，我如何支持第三个用例？现在， python __main__.py throw

File "__main__.py", line 10, in <module>
    from . import code
ImportError: cannot import name 'class defined in code.py'

笔记:

我读过了

https://chriswarrick.com/blog/2014/09/15/python-apps-the-right-way-entry_points-and-scripts/

http://setuptools.readthedocs.io/en/latest/setuptools.html

这里的许多问题看起来像这个，但没有回答我上面的问题。

Answer 1

您几乎拥有所需的一切(甚至更多)!我会采用以下设置:

代码.py :

foo = 1

__init__.py:

from .code import foo

在这里做一个相对导入，因为 __init__.py将在导入整个包时使用。请注意，我们使用 . 显式地将导入标记为相对导入。 -syntax 因为这是 Python 3 所必需的(如果您使用了 from __future__ import absolute_import，则在 Python 2 中)。

__main__.py:

from Package import foo

print('foo = ', foo)

这是包的主脚本，所以我们使用绝对 import陈述。通过这样做，我们假设包已经安装(或者至少已经放在路径上)；这就是处理包裹的方式!您可能认为这与您的第三个用例冲突，但实际上没有理由不这样做 pip install在处理包裹时。这真的没什么大不了的(尤其是在使用 virtualenv 时)!

如果您关心的是修改源文件并通过运行 __main__.py 轻松观察更改文件然后你可以简单地使用 -e 安装包(“可编辑”)开关: pip install -e . (假设您在目录 Package 中)。但是，对于您当前的目录结构，这将不起作用，因为 -e开关将放置一个 egg-link到包含 setup.py 的目录文件;此目录不包含名为 Package 的包但是 src相反(我有 a question about that )。

相反，如果您遵循约定以包本身命名包源的根目录(例如 Package)，则使用 -e 进行安装。不是问题:Python 确实找到了所需的包 Package在对应目录中:

$ tree Package/
Package/
├── setup.py
└── Package   <-- Renamed "src" to "Package" because that's the package's name.
    ├── code.py
    ├── __init__.py
    └── __main__.py

这也让您可以省略 package_dir={'Package': 'src'} 的额外定义。在 setup.py .

关于setup.py的说明 :对于您指定的三个用例，无需定义入口 pip 。也就是说，您可以跳过该行 entry_points={ 'console_scripts': ['Package = src.__main__:main' ] } .通过运送 __main__.py模块 python -m Package将很容易执行此模块中的代码。您还可以添加额外的 if 子句:

def main():
    print('foo = ', foo)

if __name__ == '__main__':
    main()

另一方面，入口 pip 让您可以直接执行 __main__.main 中的代码。来自 CLI；正在运行 $ Package会执行相应的代码。

回顾

最重要的是，我总是使用 pip install在处理包裹时。为什么不呢，特别是如果您已经创建了 setup.py文件？如果要“实时”应用对包的更改，则可以使用 -e 进行安装。开关(这可能需要重命名 src 文件夹，见上文)。因此，您的第三个用例将显示为“下载源代码和 pip install (-e) Package(在 virtualenv 中)；然后您可以运行 python __main__.py”。

编辑

运行 __main__.py没有 pip install
如果您不想通过 pip 安装软件包但仍然可以运行 __main__.py脚本，我仍然会采用上述设置。然后我们需要确保 from Package import ...语句仍然成功，这可以通过扩展导入路径来实现(请注意，这需要将 src 目录重命名为包的名称!)。

修改 PYTHONPATH
对于 Linux bash，您可以按如下方式设置 Pythonpath:

export PYTHONPATH=$PYTHONPATH:/path/to/Package

或者，如果您与 __main__.py 位于同一目录中:

export PYTHONPATH=$PYTHONPATH:`cd ..; pwd`

当然，不同的操作系统有不同的方法。

扩展 __main__.py 中的路径

您(或者您的同事)可以将以下几行添加到脚本的顶部(在 from Package import ... 语句之前):

import sys
sys.path.append('/path/to/Package')

扩展 sitecustomize.py 中的路径

您可以放置​​一个名为 sitecustomize.py 的模块在 lib/python3.5/site-packages/ Python 安装目录，其中包含以下行:

import sys
sys.path.append('/path/to/Package')

创建一个单独的顶级 main.py脚本

所以你会有以下布局:

$ tree Package/
Package/
├── main.py   <-- Add this file.
├── setup.py
└── src
    ├── code.py
    ├── __init__.py
    └── __main__.py

哪里 main.py包含

import src.__main__

现在 __main__.py被视为 src 的一部分包和相对导入将起作用。
而不是运行 python src/__main__.py你会跑 python main.py现在。