[[402321]]

本文轉載自微信公眾號「Python中文社區」，作者鞏慶奎。轉載本文請聯系Python中文社區公眾號。

一、什么是代碼對象

Code Object(代碼對象)封裝了 Python 虛擬機的字節碼和虛擬機執行相關信息，可以把字節碼稱為 Python 虛擬機上的匯編語言。

學代碼對象有什么用呢?從其定義可知，字節碼是編譯后的 Python 代碼，學習代碼對象有助于我們理解 Python 虛擬機、編譯過程、執行過程，更加深刻理解 Python 語言特性和疑難點。在解決一些疑難雜癥時，查看代碼對象的字節碼往往有事半功倍的效果。

二、探索代碼對象

Python 程序由代碼塊組成，代碼塊可以是模塊、函數或類，也可以是腳本文件，還可以是python - c 'string'和exec ('string')、eval ('string')中字符串的內容。

兩種方法：

• fun.__code__ 獲取函數 fun 主體的代碼對象
• compile('source code','','exec')獲取代碼塊 source code 的代碼對象

三、一個函數及其代碼對象

我們定義一個函數fun(a,b)，它完成簡單的加法運算。

def fun(a,b): 
    return a+b  

來看它的代碼對象屬性情況，我們重點關注以 co_ 開頭的屬性。

for attr in dir(fun.fun.__code__): 
    if attr.startswith('co_'): 
        print("{attr}:\t{attrs}".format( 
            attrs=getattr(attr=attr,fun.fun.__code__, attr))) 

輸出為：

co_argcount: 2 
co_cellvars: () 
co_code: b'|\x00|\x01\x17\x00S\x00' 
co_consts: (None,) 
co_filename: G:\pythonCodeStudy\manuscript\0 bytecode\fun.py 
co_firstlineno: 1 
co_flags: 67 
co_freevars: () 
co_kwonlyargcount: 0 
co_lnotab: b'\x00\x01' 
co_name: fun 
co_names: () 
co_nlocals: 2 
co_posonlyargcount: 0 
co_stacksize: 2 
co_varnames: ('a', 'b') 

fun 函數主體的代碼對象的屬性意義如下：

• co_argcount 函數形式參數個數，這個只有函數類型代碼塊的代碼對象有，其它類型代碼塊沒有該屬性。
• co_code 字節碼指令序列，字節碼都由操作碼 opcode 和參數 opatg 組成的序列。
• co_const 常量列表，列表內容包括如下：
  • None 函數返回值，系統自帶。
  • 從前往后數所有字面常量：數字和字符串。
  • 內嵌函數代碼對象 code object。
  • 內嵌函數的 qual_name 常量，如：outer..inner。
• co_name 本函數的名字。
• co_varnames 本函數 局部變量 ，不含被引用自由變量，包含形式參數和內嵌函數名。
• co_names 本函數用到的非局部變量，也就是 全局變量、系統內置變量。
• co_nlocals 本函數的局部變量個數。
• co_cellvars cell 變量。
• co_freevars 自由變量。
• co_flag 代碼對象的種類，比如協程、生成器等，其意義定義在 include/code.h 中。
• co_lnotab 計算字節碼偏移量代表的源代碼行號的字節序列。兩個字節序列為一個單位，指示兩條源代碼指令編譯成的字節碼之間偏移多少。
• co_stacksize 執行字節碼指令時，計算棧上最大的項目數，和函數參數個數有關。

Python虛擬機是基于棧的機器，每步函數調用產生棧幀(stack frame)。每個棧幀包含計算棧和塊棧。所有參數壓入計算棧，調用時彈棧，計算后彈出結果，結束本棧幀。

上例中，我們沒有詳細解釋 co_cellvars 和 co_freevars，下面詳細解釋。

3.1 co_cellvars 和 co_freevars

co_cellvars 和 co_freevars 是一個相對的概念。我們寫一個嵌套函數來解釋這兩個概念：函數 outer 中，定義了一個變量 e，被內部嵌套函數 inner 引用;inner 函數內部使用了變量 e，但是并未在該塊內定義之。

def outer(o1, o2='o2'): 
    e = 'enclose' 
 
    def inner(i1, i2='i2'): 
        print(e) 
        return e 
    return inner 
print(outer.__code__.co_cellvars) 
print(outer('i1').__code__.co_freevars) 

結果。

('e',) 
('e',) 

故此，我們知道：

• co_cellvars 是被內部嵌套塊(函數)引用的變量組成的元組。外部函數創建特殊的 cell 對象存儲該變量，cell 對象的生存周期超過了定義它的外部函數。這句話理解就是：外部變量執行完之后，清理現場，它的變量都消失了，但 cell 對象不消失，仍然存在。這也就是所謂 * cell 變量*
• co_freevars 就塊內使用，但是并未在該塊內定義的變量(不含全局變量、內置變量)。也就是當前塊(函數) 引用的外部 cell 變量 組成的元組，和上個 co_cellvars 是相對的概念

這兩個是一體兩面的變量。

• 外部變量 outer 作用域里，創建了變量 e 以及變量 inner (函數)。
• 因為嵌套函數 inner 使用了外部變量 e ，所以在 outer 函數里， e 是作為 cell 變量，綁定到特殊的 cell 對象里。
• 這個特殊的 cell 對象和 inner 綁定在了一起，這樣 outer 作用域消失的時候， inner 內部借由 cell 對象訪問到了 e 這個變量，它對 inner 函數來說是(來自 cell 對象的)自由變量。

掌握自由變量的概念，是編寫帶狀態函數、裝飾器的基礎。

四、字節碼細節

字節碼看起來就像亂碼，如上文 fun 函數的字節碼：co_code : b '|\ x00 |\ x01 \ x17 \ x00S \ x00 '。

根據上文，字節碼由一位操作碼和一位參數組成的序列。讓我們分析細節。

co_code [0]表示第一個操作碼|，這是 ASCII 碼 124 表示的字符，在 include/opcode.h 中，可以看到 124 是 LOAD_FAST 操作碼，這是對局部變量列表進行的加載操作。其它類似的：比如 LOAD_CONST 就是對字面常量列表操作，LOAD_GLOBAL 是對全局變量操作。

如果操作碼不帶參數，參數可以省略。這里的第一個操作碼的參數是 co_code[1] 為 0x00 。

因此，這個完整的字節碼操作是把局部變量列表 co_varnames 的第 0x00 索引內容 a ，壓入計算棧棧頂。

字節序列看起來比較費勁，讓我們用 dis.dis(fun)來反匯編代碼，得到字節碼如下。

2           0 LOAD_FAST                0 (a) 
            2 LOAD_FAST                1 (b) 
            4 BINARY_ADD 
            6 RETURN_VALUE 

這樣看起來就很簡單了。

• 第一列 2 表示源代碼的第二行，也就是return a+b這一條。
• 第二列的 0 表示該條操作碼相對字節碼開頭的偏移量，LOAD_FAST 表示操作碼，0 表示參數，(a)是由 dis 生成的，即局部變量元組第 0 個元素 a。本條將變量 a 壓入計算棧。
• 以此類推第二條，將局部變量 b 壓入計算棧。
• 第三條 BINARY_ADD 沒有參數，它是求和，將 a 和 b 彈出，求和，結果壓入計算棧棧頂。
• 第四條 RETURN_VALUE 彈出結果，結束本棧幀。

Python 編譯產生 pyc 文件：Python3 之前是在本地目錄產生，之后是在 pycache 目錄下。我們打開上例產生的 pyc 文件，使用十六進制查看，能明顯發現，編譯的字節碼就直接在 PYC 文件里。

五、其它代碼塊代碼對象

上例中，我們對函數進行反匯編，使用的是 dis.dis(fun)指令，這里的 fun 是函數。

第二部分說過得到代碼對象有兩種方法，當我們對其它代碼對象進行 compile 時，實際是對該模塊進行反編譯。如果此時該代碼塊里有函數，只會產生代碼對象，不會產生真正的函數對象。

比如如下語句：print(dis.dis(compile('def fun(a,b): return a+b', '', 'exec')))，輸出如下。可見此時的函數只是一個代碼對象，作為常量載入，MAKE_FUNCTION 后，賦值給 fun 局部變量。

1           0 LOAD_CONST               0 (<code object fun at 0x00A67B18, file 
", line 1>) 
            2 LOAD_CONST               1 ('fun') 
            4 MAKE_FUNCTION            0 
            6 STORE_NAME               0 (fun) 
            8 LOAD_CONST               2 (None) 
           10 RETURN_VALUE 

六、總結