學習粗淺的python import技巧

10 min readFeb 17, 2019

ABSTRACT

很慚愧的，之前我除了使用pip下載模組以外，不知道怎麼從其他地方import模組進來。目前因為研究室要嘗試用一個舊版的angr模組，沒辦法使用pip直接下載，必須從github上下載後，再checkout到舊版。所以才想要開始學習python是如何import模組的，順便寫一些學習過程中看到的東西當作紀錄，來輔助我軟爛不勘的記憶能力，如果內容有錯麻煩來糾正我一下吧！

Module & Package

sample_package/                #a package
├── __init__.py
├── sample_module.py           #a module
└── sample_module_import.py    #a module

Module

Package內的一個檔案。

Package

通常會是一個目錄，而該目錄底下會有一個__init__.py檔案。__init__.py檔案的用途可以參考REFERENCE[16],[17],[18],[19]。

Import

import可以作用的東西:

module(.py檔)
package
內建module
c或c++擴展

Package內互相引用

這裡在REFERENCE[3]已經有很詳細的敘述了，寫得很好，誠心建議有興趣可以看一下，甚至還有sample code在github上!!

Absolute Import

用絕對路徑引用module，缺點是會把package名稱寫死，以後會不好改動名稱。

Relative Import

用相對路徑引用module。

Absolute Import v.s. Relative Import

test_package/
├── __init__.py
├── module1.py
├── subpackage1
│   ├── __init__.py
│   ├── module2.py
│   └── module3.py
├── subpackage2
│   ├── __init__.py
└── └── module4.py----------------------------------------
#假設我們現在的位置在test_package/subpackage1/module2.py#想import在同一個subpackage下的module3.py
(absolute)from test_package.subpackage1 import module3
(relative)from . import module3
#想import在不同subpackage下的module4.py
(absolute)from test_package.subpackage2 import module4
(relative)from ..subpackage2 import module4
#想import在test_package下的module1.py
(absolute)from test_package import module1
(relative)from .. import module1
#想import在同一個subpackage下的module3.py的function mod3
(absolute)from test_package.subpackage1.module3 import mod3
(relative)from .module3 import mod3

外部引用Package--試著自己做一個簡單的Package

在shell輸入下面的指令，可以看到一連串像路徑的陣列，我是選擇在/home/[username]/anaconda3/lib/python3.7/site-packages這個資料夾裡面新增一個資料夾test_package。

python3
>>import sys
>>sys.path
['', '/home/[username]/anaconda3/lib/python37.zip', '/home/[username]/anaconda3/lib/python3.7', '/home/[username]/anaconda3/lib/python3.7/lib-dynload', '/home/[username]/anaconda3/lib/python3.7/site-packages', '/home/[username]/anaconda3/lib/python3.7/site-packages/firstblood-0.0.1-py3.7.egg']

假設目前的目錄長的是像下面這樣。

test_package/                   #a package
├── __init__.py
└── hi.py                       #a module

__init__.py可以是空的，hi.py 裡面可以寫一些簡單的function，像是下面這樣短短幾行。

#hi.py
def hello():
  print("hello!")

這樣就可以使用這個超小型的package了！

python3                              #進入python3的指令介面
>>from test_package.hi import hello  #從test_package這個package裡面的hi這個module拿出hello這個function
>>hello()
hello!
>>from test_package import hi        #從test_package這個package裡面import hi這個module
>>hi.hello()
hello!注意，下面兩個例子要先from test_package import hi才會成功
>>import test_package                #直接import這個package
>>test_package.hi.hello()
hello!
>>import test_package as hihi        #怕跟其他package或module撞名還可以用as改成自己喜歡的名稱
>>hihi.hi.hello()
hello!