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

Question

问题

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

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

但是,在某些情况下,我可能想要做以下事情:

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

import my_module

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

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

实现PEP8符合sys.path修改的最佳方法是什么？

为什么

我有这个代码,因为我遵循了Hitchhiker的Python指南中给出的项目结构.

该指南建议我有一个my_module文件夹,与文件夹分开tests,两者都在同一目录中.如果我要访问my_module从tests,我想我需要添加..到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

我刚刚在类似的问题上苦苦挣扎，我想我找到了一个比公认的答案稍微好一点的解决方案。

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

"""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评论。