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

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

当前回答

当函数被调用0次或1次时，第一种变体确实比第二种更有效。然而，对于第二次和后续调用，“导入每个调用”方法实际上效率较低。请参阅此链接，了解一种通过“惰性导入”将两种方法的优点结合起来的惰性加载技术。

但除了效率之外，还有其他原因可以解释为什么你会更喜欢其中一种。一种方法是让阅读代码的人更清楚地了解这个模块所具有的依赖关系。它们也有非常不同的失败特征——如果没有“datetime”模块，第一个将在加载时失败，而第二个直到方法被调用才会失败。

补充说明:在IronPython中，导入可能比在CPython中要昂贵一些，因为代码基本上是在导入时被编译的。

其他回答

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

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

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

我不太担心预先加载模块的效率。模块占用的内存不会很大(假设它足够模块化)，启动成本可以忽略不计。

在大多数情况下，您希望在源文件的顶部加载模块。对于阅读代码的人来说，它可以更容易地区分哪个函数或对象来自哪个模块。

在代码的其他地方导入模块的一个很好的理由是，如果它在调试语句中使用。

例如:

do_something_with_x(x)

我可以用:

from pprint import pprint
pprint(x)
do_something_with_x(x)

当然，在代码的其他地方导入模块的另一个原因是，如果您需要动态导入它们。这是因为你几乎没有任何选择。

我不太担心预先加载模块的效率。模块占用的内存不会很大(假设它足够模块化)，启动成本可以忽略不计。

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

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

补充说明:在IronPython中，导入可能比在CPython中要昂贵一些，因为代码基本上是在导入时被编译的。

除了已经给出的优秀答案之外，值得注意的是导入的位置不仅仅是风格的问题。有时，模块具有需要首先导入或初始化的隐式依赖项，而顶层导入可能会导致违反所需的执行顺序。

这个问题经常出现在Apache Spark的Python API中，在导入任何pyspark包或模块之前，你需要初始化SparkContext。最好将pyspark导入放在保证SparkContext可用的范围内。

推荐文章