我想从同一目录中的另一个文件导入一个函数。

通常,以下工作之一:

from .mymodule import myfunction
from mymodule import myfunction

…但另一个给了我一个错误:

ImportError: attempted relative import with no known parent package
ModuleNotFoundError: No module named 'mymodule'
SystemError: Parent module '' not loaded, cannot perform relative import

这是为什么?


当前回答

TL;博士

您只能相对导入同一包中另一个模块内的模块。

概念澄清

我们在books/docs/articles中看到了很多示例代码,它们向我们展示了如何相对导入模块,但当我们这样做时,它失败了。

原因是,简单地说,我们没有按照python模块机制的预期运行代码,即使代码编写得完全正确。这就像某种运行时的事情。

模块加载取决于您如何运行代码。这就是困惑的根源。

什么是模块?

当且仅当模块被另一个文件导入时,它才是python文件。给定一个文件mod.py,它是一个模块吗?是和否,如果您运行python-mod.py,它不是一个模块,因为它没有导入。

什么是套餐?

包是包含Python模块的文件夹。

顺便说一下,如果您不需要任何包初始化或自动加载子模块,那么python 3.3中不需要__init__.py。您不需要在目录中放置空白__init__.py。

这证明只要有文件被导入,包就只是一个文件夹。


真实答案

现在,这个描述变得更加清晰了。

您只能相对导入同一包中另一个模块内的模块。

给定目录:

. CWD
|-- happy_maker.py # content: print('Sends Happy')
`-- me.py # content: from . import happy_maker

运行python-me.py,我们尝试了没有已知父包的相对导入

me.py是直接运行的,它不是一个模块,我们不能在其中使用相对导入。

解决方案1

使用import happy_maker而不是from。导入happy_maker

解决方案2

将工作目录切换到父文件夹。

. CWD
|-- happy
|   |-- happy_maker.py
    `-- me.py

运行python-m happy.me。

当我们在包含happy的目录中时,happy是一个包,me.py,happy_maker.py是模块,我们现在可以使用相对导入,我们仍然希望运行me.py。所以我们使用-m,这意味着将模块作为脚本运行。


Python习语

. CWD
|-- happy
|   |-- happy_maker.py # content: print('Sends Happy')
|   `-- me.py # content: from . import happy_maker
`-- main.py # content: import happy.me

这种结构就是python习语。main是我们的脚本,Python中的最佳实践。最后,我们到达了那里。


兄弟姐妹或祖父母

另一个常见需求:

.
|-- happy
|   |-- happy_maker.py
|   `-- me.py
`-- sad
    `-- sad_maker.py

我们想在me.py中导入sad_maker,怎么做?

首先,我们需要在同一个包中实现快乐和悲伤,所以我们必须升级到目录级别。然后从。。伤心地在me.py中导入sadmaker。

仅此而已。

其他回答

我需要从主项目目录运行python3才能使其正常工作。

例如,如果项目具有以下结构:

project_demo/
├── main.py
├── some_package/
│   ├── __init__.py
│   └── project_configs.py
└── test/
    └── test_project_configs.py

解决方案

我将在文件夹project_demo/中运行python3,然后执行

from some_package import project_configs

不幸的是,这个模块需要在包中有时需要作为脚本运行。知道我怎么做吗实现这一目标?

这样的布局很常见。。。

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()

…一个肌肉热模块。。。

#!/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()

…还有一个像这样的男人。。。

#!/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

……但它有些冗长,与#/usr/bin/env python3。

对于这种情况,最简单的解决方法是避免使用相对导入,而只使用。。。

from mymodule import as_int

…虽然,如果它不是唯一的,或者您的包结构更复杂,您需要在PYTHONPATH中包含包含您的包目录的目录,并这样做。。。

from mypackage.mymodule import as_int

…或者如果你想让它“开箱即用”,你可以先用这个。。。

import sys
import os

SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
sys.path.append(os.path.dirname(SCRIPT_DIR))

from mypackage.mymodule import as_int

这是一种痛苦,但有一个线索,为什么在一封由某个Guido van Rossum写的电子邮件中。。。

我对这件事和任何其他提议的无聊事都持反对态度__机械唯一的用例似乎是运行发生的脚本生活在模块的目录中,我一直认为反模式。要让我改变主意,你必须说服我它不是。

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

SystemError:未加载父模块“”,无法执行相对导入

这意味着您正在以脚本的形式运行包内的模块。在包中混合脚本是很棘手的,应该尽可能避免。使用包装脚本来导入包并运行脚本函数。

如果您的顶级目录名为foo,位于PYTHONPATH模块搜索路径上,并且您在那里有一个包栏(这是一个需要__init__.py文件的目录),则脚本不应该放在栏中,而应该最好放在foo中。

请注意,脚本与这里的模块不同,因为它们被用作python命令的文件名参数,可以使用python<filename>,也可以通过#!(shebang)线。它直接作为__main__模块加载(这就是为什么__name__==“__main__”:在脚本中工作),并且没有包上下文可用于构建相对导入。

您的选项

如果可以,可以使用setuptools(或po诗或flit,这有助于简化打包)打包项目,并创建控制台脚本入口点;使用pip安装项目,然后创建知道如何正确导入包的脚本。您可以使用pipinstall-e在本地安装软件包。,所以它仍然可以被编辑。否则,永远不要使用python路径/to/packagename/file.py,始终使用python路径/tio/script.py,script.py可以从packagename导入。。。。作为备用方案,可以使用-m命令行开关告诉Python导入一个模块,并将其用作__main__文件。这对于shebang行不起作用,因为已经没有脚本文件了。如果使用python-m foo.bar,并且在sys.path目录中找到foo/bar.py,则会使用正确的包上下文将其导入并作为__main__执行。如果bar也是一个包,在foo/中,它必须有一个__main__.py文件(所以foo/bar/__main__.p是sys.path目录的路径)。在极端情况下,通过直接设置__package__来添加Python用于解析相对导入的元数据;文件foo/bar/spam.py(可作为foo.bar.spam导入)被赋予全局__package__=“foo.bar”。它只是另一个全局文件,如__file__和__name__,在导入时由Python设置。

在sys.path上

以上所有内容都要求您的包可以导入,这意味着它需要在sys.path中列出的目录(或zip文件)中找到。这里也有几个选项:

找到路径/to/script.py的目录(因此路径/to)会自动添加到sys.path。执行python路径/to/foo.py会将路径/to添加到sys_path。如果您打包了项目(使用setuptools、po诗、flit或其他Python打包工具)并安装了它,那么该包已经添加到正确的位置。作为最后的手段,请自己将正确的目录添加到sys.path。如果包可以相对于脚本文件定位,请使用脚本全局命名空间中的__file__变量(例如,使用pathlib.Path对象,HERE=Path(__file__).resolve()。parent是文件所在目录的引用,作为绝对路径)。

对于PyCharm用户:

我还收到了ImportError:尝试在没有已知父包的情况下进行相对导入,因为我正在添加。表示法来消除PyCharm解析错误。PyCharm错误地报告无法找到:

lib.thing导入函数

如果您将其更改为:

.lib.thing导入函数

它会使错误静音,但随后会出现前面提到的ImportError:尝试相对导入,但没有已知的父包。忽略PyCharm的解析器。这是错误的,代码运行良好,尽管它说了什么。

太长,读不下去了通过在python脚本的入口点添加以下内容,将脚本路径附加到系统路径。

import os.path
import sys
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)))

现在,您可以在PyCharma和Terminal中运行项目了!!