Python 3中的相对导入

不幸的是，这个模块需要在包中，有时还需要作为脚本运行。知道如何实现吗？

这样的布局很普遍...

main.py
mypackage/
    __init__.py
    mymodule.py
    myothermodule.py

... mymodule.py像这样...

#!/usr/bin/env python3

# Exported function
def as_int(a):
    return int(a)

# Test function for module  
def _test():
    assert as_int('1') == 1

if __name__ == '__main__':
    _test()

......一个myothermodule.py像这样...

#!/usr/bin/env python3

from .mymodule import as_int

# Exported function
def add(a, b):
    return as_int(a) + as_int(b)

# Test function for module  
def _test():
    assert add('1', '1') == 2

if __name__ == '__main__':
    _test()

... main.py这样的...

#!/usr/bin/env python3

from mypackage.myothermodule import add

def main():
    print(add('1', '1'))

if __name__ == '__main__':
    main()

...在您运行main.py或时效果很好mypackage/mymodule.py，但mypackage/myothermodule.py由于相对导入而失败，...

from .mymodule import as_int

您应该运行它的方式是...

python3 -m mypackage.myothermodule

...但是它有点冗长，并且与诸如的shebang行混合得不好#!/usr/bin/env python3。

假设名称mymodule是全局唯一的，这种情况下最简单的解决方法是避免使用相对导入，而只需使用...

from mymodule import as_int

...尽管它不是唯一的，或者您的包结构更复杂，您仍需要在中包含包含包目录的目录PYTHONPATH，并按以下步骤进行操作...

from mypackage.mymodule import as_int

...或者如果您希望它“开箱即用”工作，则可以PYTHONPATH使用此方法首先获取in代码...

import sys
import os

PACKAGE_PARENT = '..'
SCRIPT_DIR = os.path.dirname(os.path.realpath(os.path.join(os.getcwd(), os.path.expanduser(__file__))))
sys.path.append(os.path.normpath(os.path.join(SCRIPT_DIR, PACKAGE_PARENT)))

from mypackage.mymodule import as_int

这有点痛苦，但是有一个线索可以说明为什么某位Guido van Rossum写的电子邮件中 ...

我对此表示怀疑，也对任何其他提议的__main__机械装置都为-1 。唯一的用例似乎是正在运行的脚本，它们恰好位于模块目录中，我一直将其视为反模式。为了让我改变主意，您必须说服我不要。

在程序包中运行脚本是否是反模式是主观的，但就我个人而言，我发现它在包含一些自定义wxPython小部件的程序包中非常有用，因此我可以为任何源文件运行脚本以wx.Frame仅显示包含该小部件用于测试目的。