如何在 Python 中进行相对导入？

Question

想象一下这个目录结构：

app/
   __init__.py
   sub1/
      __init__.py
      mod1.py
   sub2/
      __init__.py
      mod2.py

我正在编写mod1 ，我需要从mod2导入一些东西。 我该怎么做？

我尝试了from ..sub2 import mod2但我得到了“在非包中尝试相对导入”。

我用谷歌搜索，但只发现了“ sys.path操作”黑客。 没有干净的方法吗？

---

编辑：我所有的__init__.py目前都是空的

Edit2：我正在尝试这样做，因为 sub2 包含跨子包（ sub1 、 subX等）共享的类。

Edit3：我正在寻找的行为与PEP 366 中描述的相同（感谢 John B）

Answer 1

每个人似乎都想告诉你你应该做什么，而不是仅仅回答问题。

问题是您通过将 mod1.py 作为参数传递给解释器来将模块作为 '__main__' 运行。

来自PEP 328 ：

相对导入使用模块的 __name__ 属性来确定该模块在包层次结构中的位置。 如果模块的名称不包含任何包信息（例如，它被设置为“__main__”），则相对导入将被解析为好像该模块是顶级模块，而不管该模块实际位于文件系统上的哪个位置。

在 Python 2.6 中，他们添加了相对于主模块引用模块的能力。 PEP 366描述了这一变化。

更新：根据 Nick Coghlan 的说法，推荐的替代方法是使用 -m 开关在包内运行模块。

Answer 2

这是对我有用的解决方案：

我执行相对导入，如from ..sub2 import mod2 ，然后，如果我想运行mod1.py那么我转到app的父目录并使用 python -m 开关作为python -m app.sub1.mod1运行模块python -m app.sub1.mod1 。

相对导入出现此问题的真正原因是相对导入通过采用模块的__name__属性来工作。 如果模块直接运行，则__name__设置为__main__并且它不包含有关包结构的任何信息。 并且，这就是为什么 python relative import in non-package错误中抱怨relative import in non-package原因。

因此，通过使用 -m 开关，您可以向 python 提供包结构信息，通过它可以成功解析相关导入。

我在做相对导入时多次遇到这个问题。 而且，在阅读了所有以前的答案之后，我仍然无法弄清楚如何以一种干净的方式解决它，而无需将样板代码放在所有文件中。 （尽管有些评论真的很有帮助，感谢 @ncoghlan 和 @XiongChiamiov）

希望这能帮助那些正在与相对进口问题作斗争的人，因为通过 PEP 真的不好玩。

Answer 3

main.py
setup.py
app/ ->
    __init__.py
    package_a/ ->
       __init__.py
       module_a.py
    package_b/ ->
       __init__.py
       module_b.py

1. 你运行python main.py 。
2. main.py做： import app.package_a.module_a
3. module_a.py确实import app.package_b.module_b

或者 2 或 3 可以使用： from app.package_a import module_a

只要您的 PYTHONPATH 中有app ，这就会起作用。 main.py可以在任何地方。

因此，您编写一个setup.py将整个应用程序包和子包复制（安装）到目标系统的 python 文件夹，并将main.py复制（安装）到目标系统的脚本文件夹。

Answer 4

“Guido 将在包中运行的脚本视为反模式”（拒绝PEP-3122 ）

我花了很多时间试图找到解决方案，阅读 Stack Overflow 上的相关帖子，并对自己说“一定有更好的方法！”。 好像没有。

Answer 5

这是 100% 解决的：

• 应用程序/
  • 主文件
• 设置/
  • local_settings.py

在 app/main.py 中导入 settings/local_setting.py：

主要.py：

import sys
sys.path.insert(0, "../settings")


try:
    from local_settings import *
except ImportError:
    print('No Import')

Answer 6

def import_path(fullpath):
    """ 
    Import a file with full path specification. Allows one to
    import from anywhere, something __import__ does not do. 
    """
    path, filename = os.path.split(fullpath)
    filename, ext = os.path.splitext(filename)
    sys.path.append(path)
    module = __import__(filename)
    reload(module) # Might be out of date
    del sys.path[-1]
    return module

我正在使用此代码段从路径导入模块，希望有帮助

Answer 7

用例子解释nosklo's回答

注意：所有__init__.py文件都是空的。

main.py
app/ ->
    __init__.py
    package_a/ ->
       __init__.py
       fun_a.py
    package_b/ ->
       __init__.py
       fun_b.py

应用程序/package_a/fun_a.py

def print_a():
    print 'This is a function in dir package_a'

应用程序/package_b/fun_b.py

from app.package_a.fun_a import print_a
def print_b():
    print 'This is a function in dir package_b'
    print 'going to call a function in dir package_a'
    print '-'*30
    print_a()

主文件

from app.package_b import fun_b
fun_b.print_b()

如果你运行$ python main.py它返回：

This is a function in dir package_b
going to call a function in dir package_a
------------------------------
This is a function in dir package_a

• main.py 做： from app.package_b import fun_b
• fun_b.py from app.package_a.fun_a import print_a

所以文件夹package_b中的文件使用了文件夹package_a中的文件，这就是你想要的。 对？？

Answer 8

不幸的是，这是一个 sys.path hack，但效果很好。

我在另一层遇到了这个问题：我已经有一个指定名称的模块，但它是错误的模块。

我想做的是以下内容（我工作的模块是module3）：

mymodule\
   __init__.py
   mymodule1\
      __init__.py
      mymodule1_1
   mymodule2\
      __init__.py
      mymodule2_1


import mymodule.mymodule1.mymodule1_1  

请注意，我已经安装了 mymodule，但是在我的安装中我没有“mymodule1”

我会得到一个 ImportError 因为它试图从我安装的模块中导入。

我试图做一个 sys.path.append，但没有奏效。 什么工作是一个sys.path.insert

if __name__ == '__main__':
    sys.path.insert(0, '../..')

有点像黑客，但让它全部工作！ 所以请记住，如果您希望决定覆盖其他路径，那么您需要使用 sys.path.insert(0, pathname) 使其工作！ 这对我来说是一个非常令人沮丧的症结，很多人说要对 sys.path 使用“追加”函数，但是如果您已经定义了一个模块，这将不起作用（我发现它的行为非常奇怪）

Answer 9

让我把它放在这里供我自己参考。 我知道这不是好的 Python 代码，但我需要一个我正在处理的项目的脚本，我想把脚本放在scripts目录中。

import os.path
import sys
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))

Answer 10

正如@EvgeniSergeev 在对 OP 的评论中所说，您可以使用以下命令从任意位置的.py文件导入代码：

import imp

foo = imp.load_source('module.name', '/path/to/file.py')
foo.MyClass()

这是从这个 SO answer 中获取的。

Answer 11

看看http://docs.python.org/whatsnew/2.5.html#pep-328-absolute-and-relative-imports 。 你可以做

from .mod1 import stuff

Answer 12

从Python 文档，

在 Python 2.5 中，您可以使用from __future__ import absolute_import指令将导入的行为切换为绝对from __future__ import absolute_import 。 这种绝对导入行为将成为未来版本（可能是 Python 2.7）的默认设置。 一旦绝对导入成为默认值， import string将始终找到标准库的版本。 建议用户尽可能多地使用绝对导入，因此最好在代码中from pkg import string开始编写

Answer 13

除了约翰 B 所说的，似乎设置__package__变量应该有所帮助，而不是更改__main__可能会搞砸其他事情。 但据我测试，它并没有完全正常工作。

我有同样的问题，PEP 328 或 366 都没有完全解决问题，因为到一天结束时，就我所知，两者都需要将包的头部包含在sys.path 。

我还应该提到我没有找到如何格式化应该进入这些变量的字符串。 是"package_head.subfolder.module_name"还是什么？

Answer 14

我发现将“PYTHONPATH”环境变量设置到顶部文件夹更容易：

bash$ export PYTHONPATH=/PATH/TO/APP

然后：

import sub1.func1
#...more import

当然，PYTHONPATH 是“全局的”，但它还没有给我带来麻烦。

Answer 15

您必须将模块的路径附加到PYTHONPATH ：

export PYTHONPATH="${PYTHONPATH}:/path/to/your/module/"

Answer 16

类似于Роман Арсеньев的回答，但如果你想回到两个目录：

返回两个目录：

app/
   __init__.py
   sub1/
      __init__.py
      mod1.py          ------*
      subsub1/               |
         __init__.py   mod1 and mod4  
         mod4.py       ------|
   sub2/                     |
      __init__.py           into
      mod2.py                |
      subsub2/              mod3
         __init__.py         |
           mod3.py     <-----*

将 mod1 导入 mod3：

import sys
sys.path.insert(1, '../../')

from sub1 import mod1
from sub1.subsub1 import mod

Answer 17

此方法查询并自动填充路径：

import os
import inspect
currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
parentdir = os.path.dirname(currentdir)
os.sys.path.insert(1, parentdir)
# print("currentdir = ", currentdir)
# print("parentdir=", parentdir)