前言
Python作為一個解釋器,一個程序,如果不導入任何外部模塊或包,就做不了什麼。理解Python如何導入模塊和包将在幾乎所有的場景中都很有幫助。
本文中的所有代碼都是在Linux(Ubuntu)中應用和測試的,Windows和macOS應該(希望)是類似的。
PART 01
當PIP安裝一個包時會發生什麼
當我們使用pip安裝包時:
pip install <pkg_name>
包進入系統範圍的文件夾
/home/<user_name>/.local/lib/python3.x/site-packages
這裡的“系統範圍”是指所有Python程序都可以訪問已安裝的軟件包。
從哪裡進口(import)
當使用import關鍵字導入包時,Python會循環sys. path中的路徑列表。加載它的路徑。
運行這個,查看路徑列表:
import sys
print(sys.path)
這是我的。你的應該類似:
['', '/usr/lib/python36.zip', '/usr/lib/python3.6', '/usr/lib/python3.6/lib-dynload', '/home/andrewzhu/.local/lib/python3.6/site-packages', '/usr/local/lib/python3.6/dist-packages', '/usr/lib/python3/dist-packages', '/usr/lib/python3.6/dist-packages']
第一個空的"表示當前文件夾,因此Python運行時(或import關鍵字)可以訪問位于運行Python腳本的同一文件夾中的任何包。
通過了解這一點,下次如果您想部署一個定制包,而不是從pip或condo。你從Github上竊取/抓取的東西,想讓所有Python程序都能訪問它,不管它位于哪裡。你知道把包裹放在哪裡。
順便說一下,要獲取當前目錄路徑,請運行:
import os
print(os.getcwd())
PART 02
導入模塊的最佳方法是什麼
正如Python的禅宗所說:“顯式比隐式好”。如果你給一些東西命名,比如i, td,幾周後,即使是你,這個程序的作者也不明白這些變量的含義。
所以,
規則1:明确。
Python作為一種腳本語言已經相對較慢了,為了使你的程序更快,需要加載模塊。
規則2:隻需要導入。
如果您正在編寫一個可能被其他程序調用的程序,請注意命名沖突。其他可能在下遊程序中給出相同的名稱,并且可能會受到“類型錯誤異常”的歡迎。
規則3:取正确的名字。
您可能會看到下面列出的許多導入樣式,但是哪一種是最好的,哪一種應該避免?
# style 1
import a_package
# or style 2
import a_package as p
# or style 3
from a_package import a_item
# or style 4
from a_package import *
# or style 5
from a_package import a_item as my_item
樣式1是可以的,但是它将導入這個包中的所有模塊,在導入datetime的情況下。當你想要獲得當前時間時,代碼會像這樣形成:
import datetime
now_time = datetime.datetime.now()
注意,有雙日期時間,如果您正在閱讀一個很長的代碼文件,每當您看到日期時間,将使您認為它是哪個日期時間,它是一個模塊或包?
樣式2将在某種程度上解決這個問題,你可以給datetime一個新的名稱,也許是一個唯一的名稱,像這樣:
import datetime as az_datetime_pkg
now_time = az_datetime_pkg.datetime.now()
az_的意思是,它來自Andrew Zhu, _pkg表示它是從某處導入的包。但是,每次都輸入包名是很繁瑣的。
樣式3解決了繁瑣的問題,通過從…import…樣式,你可以直接調用函數。
from datetime import datetime
now_time = datetime.now()
如果你想盡量避免命名沖突,請使用樣式5。
from datetime import datetime as pkg_datetime_module
now_time = pkg_datetime_module.now()
風格4 ?永遠不要使用import *樣式。因為樣式4打破了上面列出的3個規則。
如果您計劃構建一個供其他人使用的包,那麼有一種方法可以減輕import *事故。
使用__all__。這是一個例子。在你的模塊中。
__all__ = ['pub_fun1','pub_fun2']
def pub_fun1:
return 'hey, this is pub_function1'
def pub_fun2:
return 'hey, this is pub_function2'
def pub_fun3:
return 'sorry, this function is private'
通過這種方式,即使模塊用戶通過import *調用您的包,也隻有pub_fun1和pub_fun2會被通配符導入。Pub_fun3将對調用者保密。
如果你的同事固執地堅持使用import *,你可以把下面他們import *的True和False颠倒過來,來說服他們:
False, True = True, False # works only in python 2.x
Python會颠倒True和False的含義,這就是為什麼我們在命名和導入模塊時需要小心的原因。
PART 03
檢查導入的模塊
當你導入一個模塊時,你如何知道這個模塊的内部?當然,您可以查看文檔,但如果您很懶,不想啟動無聊的文檔怎麼辦?Python提供了一種方便的方式來實現這一點。它是函數dir()。這個内置函數返回目标對象的第一層名稱列表。
比方說,您導入了math模塊。
import math
查看math模塊中有哪些函數。
dir(math)
您将看到一個可供調用的變量和函數列表。
現在運行不帶參數的dir()函數,看看當前模塊中包含了什麼。
dir()
您将在結果列表中看到導入的數學
[
...,
math,
...
]
還有一件事,如果您想删除現有的模塊,可以使用del來删除它。這裡,讓我們從當前運行的程序中删除數學。
del math
使用dir()進行檢查,數學就消失了。
PART 04
創建自己的Python包
在Python中,Function是變量和表達式的容器;類是函數、變量的容器;Module大緻表示一個Python腳本文件,它是類、函數、表達式和變量的容器。Package是一個管理Python模塊的解決方案。一個包是一個特殊的文件夾,包含多個模塊和一個附加的__init__.py文件。
下面是一個示例包結構。如果使用Python 3.3 ,可以省略__init__.py文件
py_package/
- __init__.py
- module1.py
- module2.py
在py_package文件夾内,創建兩個名為module1.py和module2.py的文件。
在module1.py文件中,給出如下代碼,在module2.py文件中,放入你喜歡的任何代碼。
# module1.py file
__all__ = ["module1_pub_func"]
def module1_pub_func():
print('hey, this is a public function from module1')
def module1_pri_func():
print("hey, this is a private function from module1")
現在,在py_package文件夾所在的同一個文件夾中,放置test.py文件。
- py_package/
- ...
- test.py
在test.py文件中,調用新的烘培包。
from py_package.module1 import *
module1_pub_func()
module1_pri_func()
你會得到這樣的結果,這裡的錯誤消息是預期的,因為在你的__all__變量中,你隻允許pub func被調用。
hey, this is a public function from module1
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
~/az_git_folder/azcode/aznote/python/py_create_package/test.py in
2 from py_package.module1 import *
3 module1_pub_func()
----> 4 module1_pri_func()
NameError: name 'module1_pri_func' is not defined
請注意,使用下面所示的代碼導入包是行不通的。谷歌不會告訴你很多,但如果你不知道這個錯誤,可能會困惑你一段時間。
# import the new created package won't works. don't do it.
import py_package import *
# or
import py_package
要調用這個包,您需要顯式地包含module1關鍵字。
還有一件事要提。每個Python模塊/程序都定義了一個__name__變量。如果該模塊/程序是Python執行入口,則__name__将被分配給"__main__"。因此,我們可以使用__name__來檢測程序是否直接執行或是否從其他程序中導入。在設計自定義包時特别有用。
if __name__ == '__main__':
print('running by myself')
else:
print('I am being imported from other module')
更多精彩资讯请关注tft每日頭條,我们将持续为您更新最新资讯!