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

通常,以下工作之一:

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

这是为什么?


当前回答

我在使用Django时经常遇到这种情况,因为很多功能都是从manage.py脚本执行的,但我也想让我的一些模块也可以直接作为脚本运行(理想情况下,你可以让它们成为manage.py指令,但我们还没有)。

这是这样一个项目可能看起来的模型;

├── dj_app
│   ├── models.py
│   ├── ops
│   │   ├── bar.py
│   │   └── foo.py
│   ├── script.py
│   ├── tests.py
│   ├── utils.py
│   └── views.py
└── manage.py

这里的重要部分是manage.py、dj_app/script.py和dj_app/tests.py。我们还有子模块dj_app/ops/bar.py和dj_app/ops/foo.py,它们包含了我们希望在整个项目中使用的更多项目。

问题的根源通常是希望您的dj_app/script.py脚本方法在dj_app/tests.py中包含测试用例,当您运行manage.py测试时会调用这些测试用例。

这是我如何设置项目及其导入的;

# dj_app/ops/foo.py
# Foo operation methods and classes
foo_val = "foo123"

.

# dj_app/ops/bar.py
# Bar operations methods and classes
bar_val = "bar123"

.

# dj_app/script.py
# script to run app methods from CLI

# if run directly from command line
if __name__ == '__main__':
    from ops.bar import bar_val
    from ops.foo import foo_val

# otherwise
else:
    from .ops.bar import bar_val
    from .ops.foo import foo_val

def script_method1():
    print("this is script_method1")
    print("bar_val: {}".format(bar_val))
    print("foo_val: {}".format(foo_val))


if __name__ == '__main__':
    print("running from the script")
    script_method1()

.

# dj_app/tests.py
# test cases for the app
# do not run this directly from CLI or the imports will break
from .script import script_method1
from .ops.bar import bar_val
from .ops.foo import foo_val 

def main():
    print("Running the test case")
    print("testing script method")
    script_method1()

if __name__ == '__main__':
    print("running tests from command line")
    main()

.

# manage.py
# just run the test cases for this example
import dj_app.tests
dj_app.tests.main()

.

从manage.py运行测试用例;

$ python3 manage.py
Running the test case
testing script method
this is script_method1
bar_val: bar123
foo_val: foo123

自行运行脚本;

$ python3 dj_app/script.py
running from the script
this is script_method1
bar_val: bar123
foo_val: foo123

请注意,如果尝试直接运行test.py,则会出现错误,因此不要这样做;

$ python3 dj_app/tests.py
Traceback (most recent call last):
  File "dj_app/tests.py", line 5, in <module>
    from .script import script_method1
ModuleNotFoundError: No module named '__main__.script'; '__main__' is not a package

如果我遇到了更复杂的进口情况,我通常会执行这样的操作来破解它;

import os
import sys
THIS_DIR = os.path.dirname(os.path.realpath(__file__))
sys.path.insert(0, THIS_DIR)
from script import script_method1
sys.path.pop(0)

其他回答

我在尝试编写一个可以作为模块或可执行脚本加载的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“$@”'''

如果以下导入:

from . import something 

不适用于您,这是因为这是python打包导入,不会与您的常规实现一起使用,下面是一个示例来演示如何使用它:

文件夹结构:

.
└── funniest
    ├── funniest
    │   ├── __init__.py
    │   └── text.py
    ├── main.py
    └── setup.py 

内部__init__.py添加:

def available_module(): 
    return "hello world"

text.py添加:

from . import available_module

在setup.py中添加

from setuptools import setup

setup(name='funniest',
  version='0.1',
  description='The funniest joke in the world',
  url='http://github.com/storborg/funniest',
  author='Flying Circus',
  author_email='flyingcircus@example.com',
  license='MIT',
  packages=['funniest'],
  zip_safe=False)

现在,这是安装软件包最重要的部分:

pip install .

在我们的系统中使用相同Python的任何地方,我们现在都可以这样做:

>> import funnies.text as fun
>> fun.available_module() 

这应该输出“hello world”

您可以在main.py中测试它(这不需要安装任何软件包)

这也是main.py

import funniest.text as fun 
print(fun.available_module())

对于那些不同意圭多的人,这里有三句话:

import sys
from pathlib import Path
sys.path.append(str(Path(sys.argv[0]).absolute().parent.parent))

希望有帮助。

值得注意的是,有时是缓存导致了这一切——在将类重新排列到新目录中之后,我尝试了不同的方法,并且在删除__pycache之后,相对导入开始工作__

希望这对外面的人来说是有价值的——我浏览了六篇stackoverflow的帖子,试图找出与上面帖子类似的相对进口。我按照建议设置了所有内容,但仍在运行ModuleNotFoundError:没有名为“my_module_name”的模块

由于我只是在本地开发并四处游玩,所以我没有创建/运行setup.py文件。我显然也没有设置我的巨蟒。

我意识到,当我像以前一样运行代码时,当测试与模块位于同一目录中时,我找不到模块:

$ python3 test/my_module/module_test.py                                                                                                               2.4.0
Traceback (most recent call last):
  File "test/my_module/module_test.py", line 6, in <module>
    from my_module.module import *
ModuleNotFoundError: No module named 'my_module'

然而,当我明确指定路径时,事情就开始工作了:

$ PYTHONPATH=. python3 test/my_module/module_test.py                                                                                                  2.4.0
...........
----------------------------------------------------------------------
Ran 11 tests in 0.001s

OK

因此,如果有人尝试了一些建议,认为他们的代码结构正确,但仍然发现自己处于与我类似的情况,如果您不将当前目录导出到PYTHONPATH,请尝试以下任一操作:

运行代码并显式包含如下路径:$PYTHONPATH=。python3测试/my_module/模块测试.py为了避免调用PYTHONPATH=。,创建一个包含如下内容的setup.py文件,并运行python setup.py开发,将包添加到路径中:

#设置.py从setuptools导入安装程序,find_packages设置(name=“示例”,packages=find_packages())