Python（和 Django）最佳导入实践

Question

在导入代码的各种方法中，是否有一些方法比其他方法更适合使用？此链接http://effbot。简而言之 org/zone/import-confusion.htm 声明这

from foo.bar import MyClass

不是正常情况下导入 MyClass 的首选方法，或者除非您知道自己在做什么。相反，更好的方法是：

import foo.bar as foobaralias

然后在代码中访问 MyClass 使用

foobaralias.MyClass

简而言之，上面引用的链接似乎是说从模块导入所有内容通常更好，而不是而不仅仅是模块的一部分。

但是，我链接的那篇文章确实很旧。

我还听说，至少在 Django 项目的上下文中，最好只导入您想要使用的类，而不是整个模块。据说这种形式有助于避免循环导入错误或至少使 django 导入系统不那么脆弱。有人指出，Django 自己的代码似乎更喜欢“from x import y”而不是“import x”。

假设我正在处理的项目没有使用 __init__.py 的任何特殊功能...（我们所有的 __init__.py 文件都是空的），什么导入方法我应该赞成吗？为什么？

Answer 1

第一个也是主要的导入规则：永远不要使用 from foo import *。

本文讨论的是周期性导入的问题，该问题至今仍存在于结构不良的代码中。我不喜欢周期性进口；它们的存在是一个强烈的信号，表明某些模块做得太多，需要拆分。如果出于某种原因您需要使用无法重新安排的循环导入代码，import foo 是唯一的选择。

对于大多数情况，import foo 和 from foo import MyClass 之间没有太大区别。我更喜欢第二种，因为涉及的输入较少，但我可能使用第一种的原因有几个：

• 模块和类/值具有不同的名称。当导入值的名称与模块无关时，读者可能很难记住特定导入来自何处。

  • 好：将 myapp.utils 导入为 utils； utils.frobnicate()
  • 好：将 myapp.utils 导入为 U； U.frobnicate()
  • 不好：from myapp.utils import frobnicate

• 您正在从一个模块导入大量值。保护您的手指和读者的眼睛。

  • 不好：from myapp.utils import frobnicate, foo, bar, baz, MyClass, SomeOtherClass, # yada yada

Answer 2

对我来说，这取决于具体情况。如果它是一个唯一命名的方法/类（即不是 process() 或类似的东西），并且您将经常使用它，那么请保存输入并只需执行 from foo import MyClass 即可。

如果您要从一个模块导入多个内容，最好只导入该模块，然后执行 module.bar、module.foo、module.baz 等，以保持命名空间干净。

你还说

据说这种形式有助于避免循环导入错误，或者至少使 django 导入系统不那么脆弱。有人指出，Django 自己的代码似乎更喜欢“from x import y”而不是“import x”。

我不知道其中一种方式如何有助于防止循环导入。原因是，即使您执行 from x import y，也会导入所有 x。只有 y 被带入当前命名空间，但整个模块 x 都会被处理。试试这个例子：

在 test.py 中，输入以下内容：

def a():
    print "a"

print "hi"

def b():
    print "b"

print "bye"

然后在 'runme.py' 中，输入：

from test import b

b()

然后只需执行 python runme.py

您将看到以下输出：

hi
bye
b

所以测试中的所有内容.py 已运行，即使您只导入了 b

Answer 3

后者的优点是MyClass的起源更加明确。前者将 MyClass 放在当前命名空间中，以便代码可以不合格地使用 MyClass。因此，对于阅读定义 MyClass 的代码的人来说，这不太明显。