PEP8 - 使用 sys.path 导入不在文件顶部

Question

问题

PEP8 有一条关于将导入放在文件顶部的规则：

导入总是放在文件的顶部，就在任何模块 cmets 和文档字符串之后，模块全局变量和常量之前。

但是，在某些情况下，我可能想做一些类似的事情：

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

import my_module

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

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

通过sys.path 修改实现 PEP8 合规性的最佳方法是什么？

为什么

我有这个代码是因为我关注The Hitchhiker's Guide to Python 中给出的the project structure。

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

Answer 1

如果只有几个导入，您可以忽略那些 import 行上的 PEP8：

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

Answer 2

通常我在项目的子目录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 抱怨未使用的导入。

Answer 3

还有另一种解决方法。

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

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

Answer 4

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

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

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

Answer 5

我刚刚在一个类似的问题上苦苦挣扎，我想我找到了一个比接受的答案更好的解决方案。

创建一个 pathmagic 模块来执行实际的 sys.path 操作，但在 context manager 内进行更改：

"""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 的任何抱怨，你不需要特殊的 cmets，而且结构似乎很有意义。

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

---

编辑：刚刚在answer to a different question 中看到了一个更简单的技巧：在您的导入下添加assert pathmagic 以避免noqa 注释。

Answer 6

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

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

Answer 7

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

为此，您可以看看这个答案：Permanently add a directory to PYTHONPATH

Answer 8

由于要添加的路径是相对于脚本的，所以可以使用相对路径来解决。

from ..mypath import mymodule 
from ..mypath.mysubfolder import anothermodule

那么就不需要再使用sys.path.insert()了。 Lint 不再抱怨了。