歡迎光臨
每天分享高質量文章

Python匯入模塊的幾種姿勢

(點擊上方快速關註並設置為星標,一起學Python)

來源:編程派    鏈接
http://codingpy.com/article/python-import-101/

作為一名新手Python程式員,你首先需要學習的內容之一就是如何匯入模塊或包。但是我註意到,那些許多年來不時使用Python的人並不是都知道Python的匯入機制其實非常靈活。在本文中,我們將探討以下話題:

  • 常規匯入(regular imports)
  • 使用from陳述句匯入
  • 相對匯入(relative imports)
  • 可選匯入(optional imports)
  • 本地匯入(local imports)
  • 匯入註意事項

常規匯入

常規匯入應該是最常使用的匯入方式,大概是這樣的:

import sys

你只需要使用import一詞,然後指定你希望匯入的模塊或包即可。通過這種方式匯入的好處是可以一次性匯入多個包或模塊:

import os, sys, time

雖然這節省了空間,但是卻違背了Python風格指南。Python風格指南建議將每個匯入陳述句單獨成行。

有時在匯入模塊時,你想要重命名這個模塊。這個功能很容易實現:

import sys as system

print(system.platform)

上面的代碼將我們匯入的sys模塊重命名為system。我們可以按照和以前一樣的方式呼叫模塊的方法,但是可以用一個新的模塊名。也有某些子模塊必須要使用點標記法才能匯入。

import urllib.error

這個情況不常見,但是對此有所瞭解總是沒有壞處的。

使用from陳述句匯入

很多時候你只想要匯入一個模塊或庫中的某個部分。我們來看看在Python中如何實現這點:

from functools import lru_cache

上面這行代碼可以讓你直接呼叫lrucache。如果你按常規方式匯入functools,那麼你就必須像這樣呼叫lrucache:

functools.lru_cache(*args)

根據你實際的使用場景,上面的做法可能是更好的。在複雜的代碼庫中,能夠看出某個函式是從哪裡匯入的這點很有用的。不過,如果你的代碼維護的很好,模塊化程度高,那麼只從某個模塊中匯入一部分內容也是非常方便和簡潔的。

當然,你還可以使用from方法匯入模塊的全部內容,就像這樣:

from os import *

這種做法在少數情況下是挺方便的,但是這樣也會打亂你的命名空間。問題在於,你可能定義了一個與匯入模塊中名稱相同的變數或函式,這時如果你試圖使用os模塊中的同名變數或函式,實際使用的將是你自己定義的內容。因此,你最後可能會碰到一個相當讓人困惑的邏輯錯誤。標準庫中我唯一推薦全盤匯入的模塊只有Tkinter。

如果你正好要寫自己的模塊或包,有人會建議你在_init_.py檔案中匯入所有內容,讓模塊或者包使用起來更方便。我個人更喜歡顯示地匯入,而非隱式地匯入。

你也可以採取折中方案,從一個包中匯入多個項:

from os import path, walk, unlink

from os import uname, remove

在上述代碼中,我們從os模塊中匯入了5個函式。你可能註意到了,我們是通過多次從同一個模塊中匯入實現的。當然,如果你願意的話,你也可以使用圓括號一次性匯入多個項:

from os import (path, walk, unlink, uname, remove, rename)

這是一個有用的技巧,不過你也可以換一種方式:

from os import path, walk, unlink, uname, remove, rename

上面的反斜杠是Python中的續行符,告訴解釋器這行代碼延續至下一行。

相對匯入

PEP 328介紹了引入相對匯入的原因,以及選擇了哪種語法。具體來說,是使用句點來決定如何相對匯入其他包或模塊。這麼做的原因是為了避免偶然情況下匯入標準庫中的模塊產生衝突。這裡我們以PEP 328中給出的檔案夾結構為例,看看相對匯入是如何工作的:

my_package/
    __init__.py
    subpackage1/
        __init__.py
        module_x.py
        module_y.py
    subpackage2/
        __init__.py
        module_z.py
    module_a.py

在本地磁盤上找個地方創建上述檔案和檔案夾。在頂層的_init_.py檔案中,輸入以下代碼:

from . import subpackage1
from . import subpackage2

接下來進入subpackage1檔案夾,編輯其中的_init_.py檔案,輸入以下代碼:

from . import module_x
from . import module_y

現在編輯module_x.py檔案,輸入以下代碼:

from .module_y import spam as ham

def main():
    ham()

最後編輯module_y.py檔案,輸入以下代碼:

def spam():
    print('spam ' * 3)

打開終端,cd至mypackage包所在的檔案夾,但不要進入mypackage。在這個檔案夾下運行Python解釋器。我使用的是IPython,因為它的自動補全功能非常方便:

In [1]: import my_package
In [2]: my_package.subpackage1.module_x
Out[2]: 'my_package.subpackage1.module_x'

from ‘my_package/subpackage1/module_x.py’>
In [3]: my_package.subpackage1.module_x.main()
spam spam spam

相對匯入適用於你最終要放入包中的代碼。如果你編寫了很多相關性強的代碼,那麼應該採用這種匯入方式。你會發現PyPI上有很多流行的包也是採用了相對匯入。還要註意一點,如果你想要跨越多個檔案層級進行匯入,只需要使用多個句點即可。不過,PEP 328建議相對匯入的層級不要超過兩層。

還要註意一點,如果你往modulex.py檔案中添加了if _name__ == ‘_main_’,然後試圖運行這個檔案,你會碰到一個很難理解的錯誤。編輯一下檔案,試試看吧!

from . module_y import spam as ham

def main():
    ham()

if __name__ == '__main__':
    # This won't work!
    main()

現在從終端進入subpackage1檔案夾,執行以下命令:

python module_x.py

如果你使用的是Python 2,你應該會看到下麵的錯誤信息:

Traceback (most recent call last):
  File "module_x.py", line 1, in 
    from . module_y import spam as ham
ValueError: Attempted relative import in non-package

如果你使用的是Python 3,錯誤信息大概是這樣的:

Traceback (most recent call last):
  File "module_x.py", line 1, in 
    from . module_y import spam as ham
SystemError: Parent module '' not loaded, cannot perform relative import

這指的是,module_x.py是某個包中的一個模塊,而你試圖以腳本樣式執行,但是這種樣式不支持相對匯入。

如果你想在自己的代碼中使用這個模塊,那麼你必須將其添加至Python的匯入檢索路徑(import search path)。最簡單的做法如下:

import sys
sys.path.append('/path/to/folder/containing/my_package')
import my_package

註意,你需要添加的是mypackage的上一層檔案夾路徑,而不是mypackage本身。原因是my_package就是我們想要使用的包,所以如果你添加它的路徑,那麼將無法使用這個包。

我們接下來談談可選匯入。

可選匯入(Optional imports)

如果你希望優先使用某個模塊或包,但是同時也想在沒有這個模塊或包的情況下有備選,你就可以使用可選匯入這種方式。這樣做可以匯入支持某個軟體的多種版本或者實現性能提升。以github2包中的代碼為例:

try:
    # For Python 3
    from http.client import responses
except ImportError:  # For Python 2.5-2.7
    try:
        from httplib import responses  # NOQA
    except ImportError:  # For Python 2.4
        from BaseHTTPServer import BaseHTTPRequestHandler as _BHRH
        responses = dict([(k, v[0]) for k, v in _BHRH.responses.items()])

lxml包也有使用可選匯入方式:

try:
    from urlparse import urljoin
    from urllib2 import urlopen
except ImportError:
    # Python 3
    from urllib.parse import urljoin
    from urllib.request import urlopen

正如以上示例所示,可選匯入的使用很常見,是一個值得掌握的技巧。

區域性匯入

當你在區域性作用域中匯入模塊時,你執行的就是區域性匯入。如果你在Python腳本檔案的頂部匯入一個模塊,那麼你就是在將該模塊匯入至全域性作用域,這意味著之後的任何函式或方法都可能訪問該模塊。例如:

import sys  # global scope
def square_root(a):
    # This import is into the square_root functions local scope
    import math
    return math.sqrt(a)

def my_pow(base_num, power):
    return math.pow(base_num, power)

if __name__ == '__main__':
    print(square_root(49))
    print(my_pow(2, 3))

這裡,我們將sys模塊匯入至全域性作用域,但我們並沒有使用這個模塊。然後,在squareroot函式中,我們將math模塊匯入至該函式的區域性作用域,這意味著math模塊只能在squareroot函式內部使用。如果我們試圖在my_pow函式中使用math,會引發NameError。試著執行這個腳本,看看會發生什麼。

使用區域性作用域的好處之一,是你使用的模塊可能需要很長時間才能匯入,如果是這樣的話,將其放在某個不經常呼叫的函式中或許更加合理,而不是直接在全域性作用域中匯入。老實說,我幾乎從沒有使用過區域性匯入,主要是因為如果模塊內部到處都有匯入陳述句,會很難分辨出這樣做的原因和用途。根據約定,所有的匯入陳述句都應該位於模塊的頂部。

匯入註意事項

在匯入模塊方面,有幾個程式員常犯的錯誤。這裡我們介紹兩個。

  • 迴圈匯入(circular imports)
  • 改寫匯入(Shadowed imports,暫時翻譯為改寫匯入)

先來看看迴圈匯入。

迴圈匯入

如果你創建兩個模塊,二者相互匯入對方,那麼就會出現迴圈匯入。例如:

# a.py
import b

def a_test():
    print("in a_test")
    b.b_test()

a_test()

然後在同個檔案夾中創建另一個模塊,將其命名為b.py。

import a

def b_test():
    print('In test_b"')
    a.a_test()

b_test()

如果你運行任意一個模塊,都會引發AttributeError。這是因為這兩個模塊都在試圖匯入對方。簡單來說,模塊a想要匯入模塊b,但是因為模塊b也在試圖匯入模塊a(這時正在執行),模塊a將無法完成模塊b的匯入。我看過一些解決這個問題的破解方法(hack),但是一般來說,你應該做的是重構代碼,避免發生這種情況。

改寫匯入

當你創建的模塊與標準庫中的模塊同名時,如果你匯入這個模塊,就會出現改寫匯入。舉個例子,創建一個名叫math.py的檔案,在其中寫入如下代碼:

import math

def square_root(number):
    return math.sqrt(number)

square_root(72)

現在打開終端,試著運行這個檔案,你會得到以下回溯信息(traceback):

Traceback (most recent call last):
  File "math.py", line 1, in 
    import math
  File "/Users/michael/Desktop/math.py", line 6, in 
    square_root(72)
  File "/Users/michael/Desktop/math.py", line 4, in square_root
    return math.sqrt(number)
AttributeError: module 'math' has no attribute 'sqrt'

這到底是怎麼回事?其實,你運行這個檔案的時候,Python解釋器首先在當前運行腳本所處的的檔案夾中查找名叫math的模塊。在這個例子中,解釋器找到了我們正在執行的模塊,試圖匯入它。但是我們的模塊中並沒有叫sqrt的函式或屬性,所以就丟擲了AttributeError。

總結

在本文中,我們講了很多有關匯入的內容,但是還有部分內容沒有涉及。PEP 302中介紹了匯入鉤子(import hooks),支持實現一些非常酷的功能,比如說直接從github匯入。Python標準庫中還有一個importlib模塊,值得查看學習。當然,你還可以多看看別人寫的代碼,不斷挖掘更多好用的妙招。

    已同步到看一看
    赞(0)

    分享創造快樂