问题

PEP8具有将导入置于文件顶部的规则：

导入总是放在文件的顶部，紧随任何模块注释和文档字符串之后，以及模块全局变量和常量之前。

但是，在某些情况下，我可能想要执行以下操作：

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

import my_module

在这种情况下，pep8命令行实用程序会标记我的代码：

E402模块级别导入不在文件顶部

通过sys.path修改达到PEP8的最佳方法是什么？

为什么

我有这段代码，因为我遵循的是《The Hitchhiker's Guide to Python》中给出的项目结构。

该指南建议我有一个与my_module文件夹分开的tests文件夹，这两个文件夹都位于同一目录中。如果我要访问my_module从tests，我想我需要添加..到sys.path

通常foo/tests，我的项目的子目录中有多个带有测试的文件，而我正在测试的模块位于中foo/src。为了从foo/tests没有导入错误的情况下运行测试，我创建了一个foo/tests/pathmagic.py看起来像这样的文件；

"""Path hack to make tests work."""

import os
import sys

bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
modpath = os.sep.join(bp + ['src'])
sys.path.insert(0, modpath)

然后在每个测试文件中，使用

import pathmagic  # noqa

作为第一个导入。“ noqa”注释可防止pycodestyle/pep8抱怨未使用的导入。

如果只有少量导入，则可以在这些import行上忽略PEP8 ：

import sys
sys.path.insert("..", 0)
import my_module  # noqa: E402

还有另一种解决方法。

import sys
... all your other imports...

sys.path.insert("..", 0)
try:
    import my_module
except:
    raise

我一直在努力解决类似的问题，而且我认为我找到了比可接受答案更好的解决方案。

创建一个pathmagic执行实际sys.path操作的模块，但在上下文管理器中进行更改：

"""Path hack to make tests work."""

import os
import sys

class context:
    def __enter__(self):
        bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
        modpath = os.sep.join(bp + ['src'])
        sys.path.insert(0, modpath)

    def __exit__(self, *args):
        pass

然后，在测试文件中（或在需要的地方）执行以下操作：

import pathmagic

with pathmagic.context():
    import my_module
    # ...

这样，您就不会从flake8 / pycodestyle收到任何投诉，也不需要特殊的注释，并且该结构似乎很有意义。

为了使内容更加整洁，请考虑实际还原__exit__块中的路径，尽管这可能会导致延迟导入（如果将模块代码放在上下文之外）会引起问题，因此可能不值得这样做。

编辑：刚刚在回答另一个问题时看到了一个简单得多的技巧：assert pathmagic在您的导入内容下添加以避免noqa注释。

您是否已经尝试过以下方法：

import sys
from importlib import import_module

sys.path.insert("..", 0)

# import module
my_mod = import_module('my_module')

# get method or function from my_mod
my_method = getattr(my_mod , 'my_method')

为了符合pep8，您应该将项目路径包含在python路径中，以便执行相对/绝对导入。

为此，您可以看一下以下答案：将目录永久添加到PYTHONPATH

这个问题已经有几种解决方案可以工作，但是如果您有许多非初始导入，并且不想用# noqa: E402（或使用其他建议之一来注释）每个注释，则以下内容适用于整个块：

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

if True:  # noqa: E402
    import my_module_1
    import my_module_2
    ...