问题:导入函数内部是pythonic吗?
PEP 8说:
- 导入总是放在文件的顶部,紧随任何模块注释和文档字符串之后,以及模块全局变量和常量之前。
占用时,我违反了PEP8。有时,我在函数中导入了东西。通常,如果存在仅在单个函数中使用的导入,则执行此操作。
有什么意见吗?
编辑(我觉得导入函数的原因可能是个好主意):
主要原因:它可以使代码更清晰。
- 在查看函数代码时,我可能会问自己:“函数/类xxx是什么?” (在函数内部使用xxx)。如果我的所有导入都在模块顶部,则必须去那里确定xxx是什么。使用时,这更成问题
from m import xxx
。看到m.xxx
该功能可能会告诉我更多信息。取决于什么m
:它是众所周知的顶级模块/软件包(import m
)?还是子模块/包(from a.b.c import m
)? - 在某些情况下,具有与使用xxx接近的位置的额外信息(“ xxx是什么?”)可以使功能更易于理解。
回答 0
从长远来看,我想您会喜欢将大多数导入都放在文件顶部的方式,这样一来您就可以一目了然地判断模块需要导入的内容有多复杂。
如果要在现有文件中添加新代码,通常会在需要的地方进行导入,然后,如果代码保留下来,则可以通过将导入行移到文件顶部来使事情变得更永久。
还有一点,我更喜欢ImportError
在运行任何代码之前获取一个异常-作为健全性检查,因此这是在顶部导入的另一个原因。
我pyChecker
用来检查未使用的模块。
回答 1
在这方面,我有两次违反PEP 8的情况:
- 循环导入:模块A导入模块B,但是模块B中的某些东西需要模块A(尽管这通常表明我需要重构模块以消除循环依赖)
- 插入pdb断点:
import pdb; pdb.set_trace()
这很方便,我不想放在import pdb
可能要调试的每个模块的顶部,并且很容易记住在删除断点时要删除导入。
除了这两种情况外,最好将所有内容放在首位。它使依赖关系更加清晰。
回答 2
这是我们使用的四个导入用例
import
(和from x import y
和import x as y
)在顶部导入选择。在顶部。
import settings if setting.something: import this as foo else: import that as foo
有条件的导入。与JSON,XML库等一起使用。在顶部。
try: import this as foo except ImportError: import that as foo
动态导入。到目前为止,我们只有一个例子。
import settings module_stuff = {} module= __import__( settings.some_module, module_stuff ) x = module_stuff['x']
请注意,这种动态导入不会引入代码,而是引入以Python编写的复杂数据结构。这有点像腌制的数据,只是我们手工腌制了。
这或多或少都在模块的顶部
这是使代码更清晰的方法:
保持模块简短。
如果我将所有导入内容都放在模块顶部,则必须去那里确定名称。如果模块很短,那很容易做到。
在某些情况下,使多余的信息靠近名称的使用位置可使该功能更易于理解。如果模块很短,那很容易做到。
回答 3
请记住一件事:不必要的导入可能会导致性能问题。因此,如果此函数经常被调用,则最好将导入放在顶部。当然,这是一种优化,因此,如果有一个有效的案例可以证明,在函数内部的导入比在文件顶部的导入更清晰,那么在大多数情况下,这会降低性能。
如果您正在使用IronPython,则会被告知最好导入内部函数(因为在IronPython中编译代码可能很慢)。因此,您也许可以找到一种导入内部函数的方法。但是除此之外,我认为与常规作斗争是不值得的。
通常,如果存在仅在单个函数中使用的导入,则执行此操作。
我想提出的另一点是,这可能是潜在的维护问题。如果添加的功能使用的模块以前仅由一个功能使用,会发生什么情况?您是否还记得将导入添加到文件顶部?还是要扫描每个功能的导入?
FWIW,在某些情况下,在函数内部导入是有意义的。例如,如果要在cx_Oracle中设置语言,则需要在导入之前设置NLS _
LANG环境变量。因此,您可能会看到如下代码:
import os
oracle = None
def InitializeOracle(lang):
global oracle
os.environ['NLS_LANG'] = lang
import cx_Oracle
oracle = cx_Oracle
回答 4
对于自测模块,我之前已经打破了此规则。也就是说,它们通常仅用于支持,但是我为它们定义了一个主要版本,因此,如果您自己运行它们,则可以测试其功能。在那种情况下,我有时会导入getopt
而cmd
只是进入main,因为我希望阅读代码的人可以清楚地知道这些模块与模块的正常运行无关,仅包含在测试中。
回答 5
来自关于 两次加载模块 -为什么不两者都?
脚本顶部的导入将指示依赖关系,并且该函数中的另一个导入将使该函数更具原子性,同时由于连续导入的成本较低,因此似乎不会造成任何性能劣势。
回答 6
只要它import
不from x import *
,您就应该将它们放在顶部。它仅向全局命名空间添加一个名称,并且您坚持使用PEP8。此外,如果以后需要在其他地方使用它,则无需四处移动。
没什么大不了的,但是由于几乎没有区别,所以我建议按照PEP 8的说明进行操作。
回答 7
看看sqlalchemy中使用的替代方法:依赖项注入:
@util.dependencies("sqlalchemy.orm.query")
def merge_result(query, *args):
#...
query.Query(...)
注意导入的库如何在装饰器中声明,并作为参数传递给函数!
这种方法使代码更整洁,并且比语句快4.5倍import
!
基准:https : //gist.github.com/kolypto/589e84fbcfb6312532658df2fabdb796
回答 8
在既是“正常”模块又可以执行的模块中(即 if __name__ == '__main__':
-section),我通常导入仅在主要部分内执行模块时使用的模块。
例:
def really_useful_function(data):
...
def main():
from pathlib import Path
from argparse import ArgumentParser
from dataloader import load_data_from_directory
parser = ArgumentParser()
parser.add_argument('directory')
args = parser.parse_args()
data = load_data_from_directory(Path(args.directory))
print(really_useful_function(data)
if __name__ == '__main__':
main()
回答 9
还有另一种(可能是“角落”)情况,这种情况可能会对import
内部很少使用的功能有利:缩短启动时间。
我曾经在小型IoT服务器上运行一个相当复杂的程序来碰壁,它接受来自串行线路的命令并执行操作,可能是非常复杂的操作。
将import
语句放在文件顶部意味着在服务器启动之前已处理所有导入;因为import
名单中包括jinja2
,lxml
,signxml
等“重物”(和SoC是不是很厉害),这意味着分钟的第一个指令之前实际执行。
OTOH将大多数导入放置在功能中,我能够在几秒钟内使服务器在串行线上“运行”。当然,当实际需要模块时,我必须付出代价(注意:这也可以通过import
在空闲时间内生成后台任务来缓解)。