徹底搞懂Python 中的 import 與 from import

攝影:產品經理

kingname 的第一套樂高

對不少 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中對它進行調用:

from microsoft import parse

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 *這種寫法,它會給你帶來無窮無盡的噩夢。

未完待續

在明天的文章中,我們來講講還有一種寫法from . import xxx,以及當文件夾中存在__init__.py時,導入方式又有什麼變化。

近期熱門:

由菜鳥學Python原班人馬打造的公衆號【程序員GitHub】,專注於分享GitHub上有趣的資源包括,Python,Java,Go語言前端學習等優質的學習資源,爆料程序員圈的新鮮趣事,熱門乾貨,職場感悟,感興趣的小夥伴可以來捧場!

程序員GitHub

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章