彻底搞懂Python 中的 import 与 from import

以下文章来源&作者:青南(谢乾坤)

摄影:产品经理;kingname 的第一套乐高

你好,我是谢乾坤,前网易高级数据挖掘工程师。现任微软最有价值专家(Python 方向),有6年 Python 开发经验,善于解决各种业务场景下的棘手问题,进一步提升代码质量。

对不少 Python 初学者来说,Python 导入其他模块的方式让他们很难理解。什么时候用 import xxx ?什么时候用 from xxx import yyy ?什么时候用 from xxx.yyy import zzz ?什么时候用 from xxx import *

这篇文章,我们来彻底搞懂这个问题。

系统自带的模块

以正则表达式模块为例,我们经常这样写代码:

import re
target = 'abc1234xyz'
re.search('(d+)', target)

但有时候,你可能会看到某些人这样写代码:

from re import search
target = 'abc1234xyz'
search('(d+)', target)

那么这两种导入方式有什么区别呢?

我们分别使用 type 函数来看看他们的类型:

>>> import re
>>> type(re)
<class 'module'>
>>> from re import search
>>> type(search)
<class 'function'>

如下图所示:

可以看到,直接使用 import re 导入的 re 它是一个 module 类,也就是模块。我们把它成为 正则表达式模块 。而当我们 from re import search 时,这个 search 是一个 function 类,我们称呼它为 search 函数

一个模块里面可以包含多个函数。

如果在你的代码里面,你已经确定只使用 search 函数,不会再使用正则表达式里面的其他函数了,那么你使用两种方法都可以,没什么区别。

但是,如果你要使用正则表达式下面的多个函数,或者是一些常量,那么用第一种方案会更加简洁清晰。

例如:

import re
re.search('c(.*?)x', flags=re.S)
re.sub('[a-zA-Z0-9]', '***', target, flags=re.I)

在这个例子中,你分别使用了 re.searchre.subre.Sre.I 。后两者是常量,用于忽略换行符和大小写。

但是,如果你使用 from re import search, sub, S, I 来写代码,那么代码就会变成这样:

import re
search('c(.*?)x', flags=S)
sub('[a-zA-Z0-9]', '***', target, flags=I)

看起来虽然简洁了,但是,一旦你的代码行数多了以后,你很容易忘记 SI 这两个变量是什么东西。而且我们自己定义的函数,也很有可能取名为 sub 或者 search ,从而覆盖正则表达式模块下面的这两个同名函数。这就会导致很多难以觉察的潜在 bug。

再举一个例子。Python 的 datetime 模块,我们可以直接 import datetime ,此时我们导入的是一个 datetime 模块,如下图所示:

但是如果你写为 from datetime import datetime ,那么你导入的 datetime 是一个 type 类:

因为这种方式导入的 datetime ,它就是Python 中的一种类型,用于表示包含日期和时间的数据。

这两种导入方式导入的 datetime ,虽然名字一样,但是他们的意义完全不一样,请大家观察下面两种写法:

import datetime
now = datetime.datetime.now()
one_hour_ago = now - datetime.timedelta(hours=1)
from datetime import datetime, timedelta
now = datetime.now()
one_hour_ago = now - timedelta(hours=1)

第二种写法看似简单,但实则改动起来却更为麻烦。例如我还需要增加一个变量 today 用于记录今日的日期。

对于第一段代码,我们只需要增加一行即可:

today = datetime.date.today()

但对于第二行来说,我们需要首先修改导入部分的代码:

from datetime import datetime, timedelta, date

然后才能改代码: today = date.today()

这样一来你就要修改两个地方,反倒增加了负担。

第三方库

在使用某些第三方库的代码里面,我们会看到类似这样的写法:

from lxml.html import fromstring
selector = fromstring(HTML)

但是我们还可以写为:

from lxml import html
selector = html.fromstring(HTML)

但是,下面这种写法会导致报错:

import lxml
selector = lxml.html.fromstring(HTML)

那么这里的 lxml.html 又是什么东西呢?

这种情况多常见于一些特别大型的第三方库中,这种库能处理多种类型的数据。例如 lxml 它既能处理 xml 的数据,又能处理 html 的数据,于是这种库会划分子模块, lxml.html 模块专门负责 html 相关的数据。

自己来实现多种导入方法

我们现在自己来写代码,实现这多种导入方法。

我们创建一个文件夹 DocParser ,在里面分别创建两个文件 main.pyutil.py ,他们的内容如下:

util.py 文件:

def write():
print('write 函数被调用!')

main.py 文件:

import util
util.write()

运行效果如下图所示:

现在我们把 main.py 的导入方式修改一下:

from util import write
write()

依然正常运行,如下图所示

 当两个文件在同一个文件夹下面,并且该文件夹里面没有__init__.py 文件时,两种导入方式等价。

现在,我们来创建一个文件夹 microsoft ,里面再添加一个文件 parse.py

def read():
print('我是 microsoft 文件夹下面的 parse.py 中的 read函数')

如下图所示:

此时我们在 main.py 中对它进行调用:

parse.read()

运行效果如下图所示:

我们也可以用另一种方法:

from microsoft.parse import read
read()

运行效果如下图所示:

但是,你不能直接导入 microsoft ,如下图所示:

无论你使用的是 import xxx 还是 from xxx.yyy.zzz.www import qqq ,你导入进来的东西,要不就是一个模块(对应到.py 文件的文件名),或者是某个.py 文件中的函数名、类名、变量名。

无论是 import xxx 还是 from xxx import yyy ,你导入进来的都不能是一个文件夹的名字。

可能有这样一种情况,就是某个函数名与文件的名字相同,例如:

microsoft 文件夹里面有一个 microsoft.py 文件,这个文件里面有一个函数叫做 microsoft ,那么你的代码可以写为:

from microsoft import microsoft`
microsoft.microsoft()

但请注意分辨,这里你导入的还是模块,只不过 microsoft.py 文件名与它所在的文件夹名恰好相同而已。

总结

无论是使用 import 还是 from import ,第一个要求是代码能够正常运行,其次,根据代码维护性,团队编码风格来确定选择哪一种方案。

如果我们只会使用到某个模块下面的一个函数(或者常量、类)并且名字不会产生混淆,可识别性高,那么 from 模块名 import 函数名 这没有什么问题。

如果我们会用到一个模块下面的多个函数,或者是我们将要使用的函数名、常量名、类名可能会让人产生混淆(例如 re.S、re.I),那么这种情况下, import 模块名 然后再 模块名.xxx 来调用会让代码更加清晰,更好维护。

但无论什么情况下,都禁止使用 from xxx import * 这种写法,它会给你带来无穷无尽的噩梦。

更多内容

Python 开发中的坑不在少数。不仅会严重破坏代码的稳定性,还会影响项目代码开发效率,自身的职业发展甚至是工作状态。

其实,我们并不是不想解决问题、并不是甘于编写所谓“漏洞百出”的代码。只是不知道问题出在哪里、为什么会出现、应该怎样修改。

多年的业务开发,我详尽记录了多个真实发生的错误、坑点,并提炼出 42 章节的 《Python 业务开发常见错误案例集》 视频课程。

错误坑点主要分为代码编写、开发思想两类。

点击链接,查看视频课详情: https://ke.sifou.com/course/1…

课程学习导图如下: https://ke.sifou.com/course/1…

SegmentFault
我还没有学会写个人说明!
上一篇

全球七大洲全部出现疫情:偏远南极洲大陆已发现新冠确诊病例

下一篇

标杆参访|走进GXG,领略企业中台非凡价值!

你也可能喜欢

评论已经被关闭。

插入图片