Python項目中如何優雅的import

前言

• 之前有一篇關於Python編碼規范的隨筆, 但是寫的比較雜亂, 因為提到了import語句, 在篇文章中, 我專門來講Python項目中如何更好的import

標准庫與第三方庫的導入

• 導入一個模塊, 如果模塊名太長, 則使用import as; 如果是導入子模塊, 則使用from import as

• 如果需要導入類的, 則使用from import導入類, 如果要導入某一個模塊的多各類的話, 則類名使用逗號分隔

• 示例

  1. 導入sklearn中的svm中的SVC類

  
  import sklearn.svm
  from sklearn.svm import SVC
  

  2. 導入numpy中的random模塊

  
  import numpy.random as nprand
  

• 總結: 如果導入類的話, 一定是import somemod 和 from somemod import class兩個語句組成的; 如果導入一個不同的模塊的則, 則一般就是import somemod

項目模塊導入

• 項目目錄

wxoa ›› tree -Cl
.
├── main.py
├── test
└── wxoa
    ├── __init__.py
    ├── __pycache__
    │   └── __init__.cpython-35.pyc
    ├── entity
    │   ├── __init__.py
    │   ├── __pycache__
    │   │   ├── __init__.cpython-35.pyc
    │   │   └── user.cpython-35.pyc
    │   └── user.py
    └── util
        ├── __init__.py
        ├── __pycache__
        │   ├── __init__.cpython-35.pyc
        │   └── ioutil.cpython-35.pyc
        └── ioutil.py

7 directories, 12 files

• 主程序為main.py, 項目名為wxoa, 存放源代碼的目錄也叫wxoa, 也是一個python package
• 導入規則(在第一次寫這篇文章的時候我喜歡相對導入(以為google的sklearn是采用這種方式的, 但是在test中使用的是絕對導入(sklearn在test.py函數中直接使用絕對路徑, 因為已經寫好的sklearn已經安裝到了python路徑中了(sklearn的test是在這種情況下進行測試的), 而一般我們的項目是沒有安裝到python路徑中)), 但是官方建議絕對導入, 如果要使用絕對導入有不報錯的話, 我的方法是這只軟鏈接)

  • 存在python package(所以這里不包含main.py)中的python文件包導入的規則

    • 使用from . import somemod導入當前目錄下的模塊
    • 使用from ..somemod import submod導入上一級目錄的somemod目錄下的submod模塊
    • 如果名稱太長則使用as縮減

  • 不在python package(就是這里的main.py和test目錄下的文件)中的python文件的導入規則

    • 使用from somemod.submod.subsubmod import some導入, 注意這里不使用.號起頭, 關於使用., ..的作用在下面會說明, 如果使用了.起頭則會報錯, 提示父模塊沒有加載
    • 其中somemod就是我們的源碼的python package包名, 在這里就是wxoa
    • 如果名稱太長則使用as縮減

關於.和..

• 在包導入中, 如果出現了.和..起頭, 則會涉及到package(不是module)的關系, ..表示上一級package, 這個上一級package需要有一個__init__.py才是合法的, .表示當前package, 當前package需要有一個__init__.py才是合法的

• .和..涉及到的python程序的啟動項, 這里會比較復雜, 簡而言之, 在涉及到..表示的上級package的時候, 如果python程序的啟動文件就是在這里則Python解釋器不會認為..表示的上級目錄的package是一個合法的目錄, 盡管有__init__.py文件, 因此會報錯; 這樣就給代碼測試帶來的麻煩, 不能直接在使用..和.中直接測試代碼, 也就是

  if __name__ == '__main__':
      pass
  

因為這樣已啟動程序就會報錯, 所以報錯, 在下面提出解決方案

關於.和..帶來的麻煩的解決方案

• 和上面展示的項目目錄一樣, 主啟動程序, 項目源代碼(主要是模塊), 測試代碼分離, main.py在項目目錄下, test(普通的文件夾, 存放python測試文件, 運行的時候cd ..目錄, 也就是在醒目目錄下, 使用python -m test.test1 執行程序)也在項目目錄下, 項目源代碼就是wxoa
• 在main.py和test目錄下的python文件中導入自己項目中的模塊, 就不要使用.和..起頭了, 否則會報錯, 而是使用絕對路徑, 如這里的, from wxoa.service import user

關於import

• import在默認的情況下是查看__name__屬性判斷是否加載的, 如果這個模塊是__main__則它就是top level(頂級)的, 沒有上一級目錄, 所以from .. import ....是會把報錯的, 在python3中的添加了__package__來解決這個問題, 在執行有from ..import ...的文件的時候, 使用python -m pkg.modname 執行modname.py文件, 將__package__從None改為pkg.modname才能正確的運行程序, 當__package__生效的時候, __name__在導入模塊的時候會被忽略

不建議使用全路徑導入, 這樣情況必須安裝第三方庫才能使用, 否則一定會出現import錯誤, 提示路徑找不到

關於Python編程

• 雖然Python是面向對象編程, 但是通過開源項目you-get發現, 可以將Python理解為面向模塊開發, 模塊在Python也是對象, 面向模塊開發會讓一切都輕松起來, 模塊中定義的全局變量為其屬性, 模塊中的函數為其方法, 如果多個函數有聯系, 再考慮將其封裝到一個類中, 在調用該模塊的時候, 一般通過一個模塊函數返回對象, 不用讓用戶過多的考慮__init__()方法的參數, 直接在模塊函數中配置好信息返回即可
• 加入我們開發一個util工具箱, 則建立一個util包(和Java的包一樣), 在里面創建strings.py, log.py等模塊(類似於Java中的一些.java文件), 在log.py模塊文件中定義一些需要的函數, 函數之間有某種聯系或者為了方便起見可以定義類封裝

關於模塊設計

• 示例:

  • 創建一個工具包, 該包中有關於字符串和IO操作的內容
  1. 首先考慮都放在一個模塊文件中, 文件他們都是工具, 放在util.py中是可以的
  2. 接着考慮到我們不需要創建strings和io的類, 因為工具我們只需要一個就可以, 這與模塊是一樣的特性, 所以將所有的操作寫成函數, 如果這樣的話, 模塊中沒有類對函數進行分類, 函數都在util.py中會很混亂, 所以將util.py升級為util包, 創建strings.py和io.py, 將對應的函數放入對應的模塊文件中

• 示例1:

  • 坦克游戲
  1. 考慮放到game.py模塊下
  2. tank, bullet, wall等都是游戲中的對象, 並且他們與工具類不同, 他們不只是一個對象, 而是可以創建很多, 與模塊特性不同, 所有把他們都寫成類, 在game文件中通過類划分是可行的方案