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

通常,以下工作之一:

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。

仅此而已。

其他回答

我为Python创建了一个新的实验性导入库:ultraimport

它使程序员能够对导入进行更多的控制,并使其明确无误。此外,当导入失败时,它还会提供更好的错误消息。

它允许您执行相对的、基于文件系统的导入,无论您如何运行代码,也无论您当前的工作目录是什么,这些导入始终有效。运行脚本或模块并不重要。您也不必更改sys.path,这可能会产生其他副作用。

然后你会改变

from .mymodule import myfunction

to

import ultraimport
myfunction = ultraimport('__dir__/mymodule.py', 'myfunction')

这样,即使您将代码作为脚本运行,导入也始终有效。

像这样导入脚本时的一个问题是,后续的相对导入可能会失败。ultraimport有一个内置的预处理器来自动重写相关的导入。

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

我尝试了以上所有方法,但都没有效果,结果发现我的包名中错误地包含了-。

简而言之,在__init__.py所在的目录中不要有-。在发现这样的无意义之后,我从未感到欢欣鼓舞。

我在尝试编写一个可以作为模块或可执行脚本加载的python文件时遇到了类似的问题。

安装程序

/path/to/project/
├── __init__.py
└── main.py
    └── mylib/
        ├── list_util.py
        └── args_util.py

具有:

main.py:

#!/usr/bin/env python3
import sys
import mylib.args_util

if __name__ == '__main__':
    print(f'{mylib.args_util.parseargs(sys.argv[1:])=}')

mylib/list_util.py:

def to_int_list(args):
    return [int(x) for x in args]

mylib/args_util.py:

#!/usr/bin/env python3
import sys
from . import list_util as lu

def parseargs(args):
    return sum(lu.to_int_list(args))

if __name__ == '__main__':
    print(f'{parseargs(sys.argv[1:])=}')

输出

$ ./main.py 1 2 3
mylib.args_util.parseargs(sys.argv[1:])=6

$ mylib/args_util.py 1 2 3
Traceback (most recent call last):
  File "/path/to/project/mylib/args_util.py", line 10, in <module>
    from . import list_util as lu
ImportError: attempted relative import with no known parent package

解决方案

我决定使用Bash/Python多语言解决方案。Bash版本的程序只调用python3-m mylib.args_util,然后退出。

Python版本忽略Bash代码,因为它包含在docstring中。

Bash版本忽略Python代码,因为它使用exec停止解析/运行行。

mylib/args_util.py:

#!/bin/bash
# -*- Mode: python -*-
''''true
exec /usr/bin/env python3 -m mylib.args_util "$@"
'''

import sys
from . import list_util as lu

def parseargs(args):
    return sum(lu.to_int_list(args))

if __name__ == '__main__':
    print(f'{parseargs(sys.argv[1:])=}')

输出

$ ./main.py 1 2 3
mylib.args_util.parseargs(sys.argv[1:])=6

$ mylib/args_util.py 1 2 3
parseargs(sys.argv[1:])=6

解释

第1行:#/bin/bash;这是“shebang”线;它告诉交互式shell如何运行该脚本。Python:忽略(注释)Bash:忽略(注释)第2行:#-*-模式:python-*-可选;这被称为“模式线”;它告诉Emacs使用Python语法高亮显示,而不是在读取文件时猜测语言是Bash。Python:忽略(注释)Bash:忽略(注释)第3行:“”“truePython:将其视为以“true”开头的未分配文档字符串\nBash:将其视为三个扩展为true的字符串(其中前两个是空字符串)(即“+”+“true”=“true”);然后它运行为true(它什么都不做)并继续到下一行第4行:exec/usr/bin/env python3-m mylib.args_util“$@”Python:仍然将其视为第3行中文档字符串的一部分。Bash:运行python3-m mylib.args_util,然后退出(它不会分析超出这一行的任何内容)第5行:“”Python:将其视为第3行中文档字符串的结尾。Bash:不解析此行

注意事项

这在Windows上不起作用:解决方法:使用WSL或批处理包装脚本调用python-m mylib.args_util。仅当当前工作目录设置为/path/to/project/时,此操作才有效。解决方法:调用/usr/bin/env时设置PYTHONPATH#!/bin/bash#-*-模式:python-*-“”“真的执行/usr/bin/env python3\PYTHONPATH=“$(cd”$(dirname“$0”)/。。“;pwd)”\-m mylib.args_util“$@”'''