我来过这里:

http://www.python.org/dev/peps/pep-0328/http://docs.python.org/2/tutorial/modules.html#packagesPython包:相对导入python相对导入示例代码不起作用python 2.5中的相对导入Python中的相对导入Python:禁用相对导入

还有很多我没有复制的URL,有些在SO上,有些在其他网站上,当时我以为我会很快找到解决方案。

永远重复出现的问题是:我如何解决这个“试图在非包中相对导入”消息?

ImportError: attempted relative import with no known parent package

我在pep-0328上创建了一个完全相同的包副本:

package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py

导入是从控制台完成的。

我确实在相应的模块中创建了名为垃圾邮件和鸡蛋的函数。很自然,它不起作用。答案显然在我列出的第四个URL中,但对我来说都是校友。我访问的一个URL上有这样的回复:

相对导入使用模块的name属性来确定该模块在包层次结构中的位置。如果模块的名称不包含任何包信息(例如,它被设置为“main”),则无论模块在文件系统上的实际位置如何,都会将相对导入解析为顶级模块。

上面的回答看起来很有希望,但对我来说都是象形文字。所以我的问题是,如何让Python不返回给我“尝试在非包中相对导入”?据推测,有一个答案涉及-m。

有人能告诉我为什么Python会给出这个错误消息,“非包”是什么意思,为什么以及如何定义“包”,以及准确的答案,让幼儿园的学生很容易理解。


当前回答

根据Lars的建议,我将这种方法包装在一个实验性的新导入库中:ultraimport

它使程序员能够更好地控制导入,并允许基于文件系统的导入。因此,您可以从脚本进行相对导入。父包不是必需的。无论您如何运行代码或当前的工作目录是什么,ultraimport都将始终有效,因为ultraimport使导入变得明确。您不需要更改sys.path,也不需要try/except块来有时执行相对导入,有时执行绝对导入。

然后你可以在somefile.py中写下类似的内容:

import ultraimport
foo = ultraimport('__dir__/foo.py')

__dir__是superimport()的调用程序somefile.py的目录。foo.py将与somefile.py位于同一目录中。

像这样导入脚本时需要注意的一点是,如果它们包含进一步的相对导入。ultraimport有一个内置的预处理器,用于将后续的相对导入重写为ultraimports,以便它们继续工作。尽管如此,由于最初的Python导入是不明确的,所以目前这有点有限,您只能做这么多。

其他回答

相对导入使用模块的name属性来确定该模块在包层次结构中的位置。如果模块的名称不包含任何包信息(例如,它被设置为“main”),则无论模块在文件系统上的实际位置如何,都会将相对导入解析为顶级模块。

为PyPi编写了一个小python包,可能有助于了解这个问题。如果希望能够从包/项目中运行包含包含高级包的导入的python文件,而不直接在导入文件的目录中,则该包可以作为变通方法。https://pypi.org/project/import-anywhere/

这里有一个通用的方法,经过修改以适合作为示例,我现在正在使用它来处理作为包编写的Python库,这些库包含相互依赖的文件,我希望能够在其中逐个测试其中的部分。让我们调用这个lib.foo,假设它需要访问函数f1和f2的lib.fileA,以及Class3类的lib.file B。

我加入了一些打印调用,以帮助说明这是如何工作的。实际上,您可能希望删除它们(也可能删除from __future_import print_function行)。

这个特定的例子太简单了,无法显示何时我们真的需要在sys.path中插入一个条目。(当我们有两个或更多级别的包目录,然后使用os.path.dirname(os.path.deirname(__file__))时,请参阅Lars的回答,了解我们确实需要它的情况,但在这里也不会有什么问题。)在sys.path测试中不使用if_i也足够安全。但是,如果每个导入的文件都插入了相同的路径,例如,如果fileA和fileB都想从包中导入实用程序,这会多次将sys.path与相同的路径混淆,因此最好在样板中的sys.path中不包含if_i。

from __future__ import print_function # only when showing how this works

if __package__:
    print('Package named {!r}; __name__ is {!r}'.format(__package__, __name__))
    from .fileA import f1, f2
    from .fileB import Class3
else:
    print('Not a package; __name__ is {!r}'.format(__name__))
    # these next steps should be used only with care and if needed
    # (remove the sys.path manipulation for simple cases!)
    import os, sys
    _i = os.path.dirname(os.path.abspath(__file__))
    if _i not in sys.path:
        print('inserting {!r} into sys.path'.format(_i))
        sys.path.insert(0, _i)
    else:
        print('{!r} is already in sys.path'.format(_i))
    del _i # clean up global name space

    from fileA import f1, f2
    from fileB import Class3

... all the code as usual ...

if __name__ == '__main__':
    import doctest, sys
    ret = doctest.testmod()
    sys.exit(0 if ret.failed == 0 else 1)

这里的想法是这样的(请注意,在python2.7和python3.x中,这些功能都是相同的):

如果作为import lib或from lib运行import foo作为从普通代码导入的常规包,__package是lib,__name__是lib.foo。我们采用第一个代码路径,从.fileA导入,等等。如果以python-lib/foo.py运行,__package__将为None,__name__将为__main__。我们采用第二个代码路径。lib目录已经在sys.path中,因此不需要添加它。我们从fileA等导入。如果在lib目录中作为python-foo.py运行,则行为与情况2相同。如果在lib目录中以python-mfoo的形式运行,则行为类似于情况2和3。但是,指向lib目录的路径不在sys.path中,因此我们在导入之前添加它。如果我们运行Python,然后导入foo,这同样适用。(由于.在sys.path中,所以我们实际上不需要在这里添加路径的绝对版本。这就是我们希望从.otherlib.fileC import…中执行的更深层次的包嵌套结构的地方。如果不这样做,可以完全省略所有sys.path操作。)

笔记

还有一个怪癖。如果你在外面做这件事:

$ python2 lib.foo

or:

$ python3 lib.foo

行为取决于lib/__init__.py的内容。如果存在并且为空,则一切正常:

Package named 'lib'; __name__ is '__main__'

但如果lib/__init__.py本身导入例程,以便它可以将routine.name直接导出为lib.name,则会得到:

$ python2 lib.foo
Package named 'lib'; __name__ is 'lib.foo'
Package named 'lib'; __name__ is '__main__'

也就是说,模块被导入两次,一次通过包导入,另一次作为__main__导入,以便运行主代码。Python 3.6及更高版本对此发出警告:

$ python3 lib.routine
Package named 'lib'; __name__ is 'lib.foo'
[...]/runpy.py:125: RuntimeWarning: 'lib.foo' found in sys.modules
after import of package 'lib', but prior to execution of 'lib.foo';
this may result in unpredictable behaviour
  warn(RuntimeWarning(msg))
Package named 'lib'; __name__ is '__main__'

警告是新的,但关于行为的警告不是。这是一些人所说的双重进口陷阱的一部分。(更多详情请参见第27487期。)Nick Coghlan表示:

下一个陷阱存在于所有当前版本的Python(包括3.3)中,可以总结为以下一般准则:“永远不要将包目录或包中的任何目录直接添加到Python路径”。

请注意,虽然我们在这里违反了该规则,但我们只在加载的文件未作为包的一部分加载时才这样做,并且我们的修改专门设计为允许我们访问该包中的其他文件。(而且,正如我所指出的,我们可能根本不应该对单级包这样做。)如果我们想更加干净,我们可以将其重写为,例如:

    import os, sys
    _i = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    if _i not in sys.path:
        sys.path.insert(0, _i)
    else:
        _i = None

    from sub.fileA import f1, f2
    from sub.fileB import Class3

    if _i:
        sys.path.remove(_i)
    del _i

也就是说,我们修改sys.path足够长的时间以实现导入,然后将其恢复原样(如果并且仅当我们添加了一个_i副本时,删除一个_ii副本)。

我有一个类似的问题,我不想更改Python模块搜索路径,并且需要从脚本中相对地加载模块(尽管上面BrenBarn很好地解释了“脚本不能相对地全部导入”)。

所以我使用了以下黑客。不幸的是,它依赖于imp模块自从3.4版本被弃用,转而使用importlib。(importlib也有可能吗?我不知道。)不过,目前黑客还是可以使用的。

从驻留在subpackage2文件夹中的脚本访问subpackage1中的moduleX成员的示例:

#!/usr/bin/env python3

import inspect
import imp
import os

def get_script_dir(follow_symlinks=True):
    """
    Return directory of code defining this very function.
    Should work from a module as well as from a script.
    """
    script_path = inspect.getabsfile(get_script_dir)
    if follow_symlinks:
        script_path = os.path.realpath(script_path)
    return os.path.dirname(script_path)

# loading the module (hack, relying on deprecated imp-module)
PARENT_PATH = os.path.dirname(get_script_dir())
(x_file, x_path, x_desc) = imp.find_module('moduleX', [PARENT_PATH+'/'+'subpackage1'])
module_x = imp.load_module('subpackage1.moduleX', x_file, x_path, x_desc)

# importing a function and a value
function = module_x.my_function
VALUE = module_x.MY_CONST

一种更干净的方法似乎是修改Federico提到的用于加载模块的sys.path。

#!/usr/bin/env python3

if __name__ == '__main__' and __package__ is None:
    from os import sys, path
    # __file__ should be defined in this case
    PARENT_DIR = path.dirname(path.dirname(path.abspath(__file__)))
   sys.path.append(PARENT_DIR)
from subpackage1.moduleX import *

以下是一个我不建议使用的解决方案,但在某些情况下可能很有用,因为模块根本没有生成:

import os
import sys
parent_dir_name = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
sys.path.append(parent_dir_name + "/your_dir")
import your_script
your_script.a_function()

因此,在与许多其他人一起对此吹毛求疵之后,我在本文中看到了Dorian B发布的一篇笔记,它解决了我在开发用于web服务的模块和类时遇到的具体问题,但我也希望能够在编写代码时使用PyCharm中的调试器工具对它们进行测试。要在自包含的类中运行测试,我将在类文件的末尾包含以下内容:

if __name__ == '__main__':
   # run test code here...

但是如果我想在同一个文件夹中导入其他类或模块,那么我就必须将所有的导入语句从相对表示法更改为本地引用(即删除点(.))。但是在阅读了Dorian的建议后,我尝试了他的“一行”,结果成功了!我现在可以在PyCharm中进行测试,当我在另一个被测试的类中使用该类时,或者当我在web服务中使用它时,我可以将测试代码留在原地!

# import any site-lib modules first, then...
import sys
parent_module = sys.modules['.'.join(__name__.split('.')[:-1]) or '__main__']
if __name__ == '__main__' or parent_module.__name__ == '__main__':
    from codex import Codex # these are in same folder as module under test!
    from dblogger import DbLogger
else:
    from .codex import Codex
    from .dblogger import DbLogger

if语句检查我们是否将此模块作为main运行,或者它是否正在另一个作为main测试的模块中使用。也许这是显而易见的,但我在这里提供了这条注释,以防其他人对上述相关进口问题感到沮丧,可以利用它。