导入语句应该总是在模块的顶部吗?

PEP 8规定:

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

然而，如果我导入的类/方法/函数只在很少的情况下使用，那么在需要时进行导入肯定会更有效吗?

这不是:

class SomeClass(object):

    def not_often_called(self)
        from datetime import datetime
        self.datetime = datetime.now()

比这更有效率?

from datetime import datetime

class SomeClass(object):

    def not_often_called(self)
        self.datetime = datetime.now()

当前回答

为了完成老谋子的回答和最初的问题:

当我们不得不处理循环依赖关系时，我们可以做一些“技巧”。假设我们正在处理模块a.py和b.py，它们分别包含x()和b.y()。然后:

我们可以移动模块底部的from导入之一。我们可以将其中一个from导入移动到实际需要导入的函数或方法中(这并不总是可行的，因为您可能从多个地方使用它)。我们可以把其中一个import改成import，就像import a

总结一下。如果您没有处理循环依赖关系，也没有使用某种技巧来避免它们，那么最好将所有导入放在顶部，因为原因已经在这个问题的其他答案中解释过了。请在做这些“技巧”时附上评论，这总是受欢迎的!：）

其他回答

这是一个只有程序员才能决定的权衡。

Case 1在需要时才导入datetime模块(并进行任何可能需要的初始化)，从而节省了一些内存和启动时间。请注意，“仅在被调用时”导入也意味着“每次被调用时”导入，因此第一次调用之后的每个调用仍然会产生执行导入的额外开销。

情况2通过提前导入datetime来节省一些执行时间和延迟，这样在调用not_often_called()时就会更快地返回，而且也不会在每次调用时都产生导入的开销。

除了效率，如果import语句是…前面。将它们隐藏在代码中会使查找某个组件所依赖的模块变得更加困难。

就我个人而言，我通常遵循PEP，除了单元测试之类的东西，我不希望总是加载这些东西，因为我知道除了测试代码之外，它们不会被使用。

这就像许多其他优化一样——你牺牲了一些可读性来换取速度。正如John提到的，如果您已经完成了分析作业，并且发现这是一个非常有用的更改，并且您需要额外的速度，那么就去做吧。最好把所有其他的导入都放在一起:

from foo import bar
from baz import qux
# Note: datetime is imported in SomeClass below

这是一个引人入胜的讨论。和许多人一样，我从未考虑过这个话题。我不得不在函数中导入，因为我想在我的一个库中使用Django ORM。在导入我的模型类之前，我不得不调用django.setup()，因为这是在文件的顶部，它被拖到完全非django库代码中，因为IoC注入器结构。

我稍微改了一下，最后把django.setup()放在了单例构造函数中，并把相关的导入放在了每个类方法的顶部。现在这运行得很好，但让我感到不安，因为导入不在顶部，而且我开始担心导入的额外时间。然后我来到这里，怀着极大的兴趣阅读了大家对此的看法。

我有很长的c++背景，现在使用Python/Cython。我对此的看法是，为什么不把导入放在函数中，除非它会导致一个概要瓶颈。这就像在你需要变量之前为它们声明空间一样。问题是我有数千行代码，所有的导入都在顶部!所以我想从现在开始，当我有时间的时候，我会在这里和那里改变奇怪的文件。

我采用了将所有导入放在使用它们的函数中，而不是放在模块的顶部的做法。

这样做的好处是能够更可靠地进行重构。当我将一个函数从一个模块移动到另一个模块时，我知道该函数将继续工作，并且保留所有遗留的测试。如果我将导入放在模块的顶部，当我移动一个函数时，我发现我最终要花费大量时间来完成新模块的导入并使其最小化。重构IDE可能会让这一点变得无关紧要。

正如在其他地方提到的那样，有一个速度惩罚。我在我的应用程序中测量了这一点，发现它对我的目的来说是微不足道的。

不需要搜索(例如grep)就能看到所有模块依赖关系也是很好的。然而，我关心模块依赖关系的原因通常是因为我正在安装、重构或移动由多个文件组成的整个系统，而不仅仅是单个模块。在这种情况下，我无论如何都要执行全局搜索，以确保具有系统级依赖关系。因此，我还没有找到全局导入来帮助我在实践中理解一个系统。

我通常把sys的导入放在if __name__=='__main__'检查中，然后将参数(如sys.argv[1:])传递给main()函数。这允许我在sys未被导入的上下文中使用main。

大多数情况下，这对于清晰和明智的做法是有用的，但并不总是如此。下面是模块导入可能存在于其他地方的两个例子。

首先，你可以有一个这样的单元测试模块:

if __name__ == '__main__':
    import foo
    aa = foo.xyz()         # initiate something for the test

其次，您可能需要在运行时有条件地导入一些不同的模块。

if [condition]:
    import foo as plugin_api
else:
    import bar as plugin_api
xx = plugin_api.Plugin()
[...]

在其他情况下，您可能会在代码的其他部分导入。

推荐文章