Python虛擬機器中的Code obejct有什麼作用

Code Object 資料結構

typedef struct {
    PyObject_HEAD
    int co_argcount;		/* #arguments, except *args */
    int co_kwonlyargcount;	/* #keyword only arguments */
    int co_nlocals;		/* #local variables */
    int co_stacksize;		/* #entries needed for evaluation stack */
    int co_flags;		/* CO_..., see below */
    PyObject *co_code;		/* instruction opcodes */
    PyObject *co_consts;	/* list (constants used) */
    PyObject *co_names;		/* list of strings (names used) */
    PyObject *co_varnames;	/* tuple of strings (local variable names) */
    PyObject *co_freevars;	/* tuple of strings (free variable names) */
    PyObject *co_cellvars;      /* tuple of strings (cell variable names) */
    /* The rest aren't used in either hash or comparisons, except for
       co_name (used in both) and co_firstlineno (used only in
       comparisons).  This is done to preserve the name and line number
       for tracebacks and debuggers; otherwise, constant de-duplication
       would collapse identical functions/lambdas defined on different lines.
    */
    unsigned char *co_cell2arg; /* Maps cell vars which are arguments. */
    PyObject *co_filename;	/* unicode (where it was loaded from) */
    PyObject *co_name;		/* unicode (name, for reference) */
    int co_firstlineno;		/* first source line number */
    PyObject *co_lnotab;	/* string (encoding addr<->lineno mapping) See
				   Objects/lnotab_notes.txt for details. */
    void *co_zombieframe;     /* for optimization only (see frameobject.c) */
    PyObject *co_weakreflist;   /* to support weakrefs to code objects */
} PyCodeObject;

下面是code object 當中各個欄位的作用：

• 首先需要了解程式碼區塊這個概念，所謂程式碼區塊就是一個小的python 程式碼，被當作一個小的單元整體執行。在 python 當中常見的程式碼區塊區塊有：函數體、類別的定義、一個模組。

• argcount，這個表示一個程式碼區塊的參數個數，這個參數只對函數體程式碼區塊有用，因為函數可能會有參數，例如上面的pycdemo.py 是一個模組而不是一個函數，因此這個參數對應的值為0 。

• co_code，這個物件的具體內容就是一個位元組序列，儲存真實的python 字節碼，主要是用於python 虛擬機執行的，在本篇文章當中暫時不詳細分析。

• co_consts，這個字段是一個列表類型的字段，主要是包含一些字串常數和數值常數，例如上面的 "__main__" 和 100 。

• co_filename，這個欄位的意義就是對應的來源檔案的檔案名稱。

• co_firstlineno，這個欄位的意思是 python 原始檔當中第一行程式碼出現的行數，這個欄位在進行偵錯的時候非常重要。

• co_flags，這個欄位的主要意義就是標識這個 code object 的型別。 0x0080 表示這個 block 是協程，0x0010 表示這個 code object 是嵌套的等等。

• co_lnotab，這個欄位的意思主要是用來計算每個字節碼指令對應的原始碼行數。

• co_varnames，這個欄位的主要意義是表示在一個 code object 本地定義的一個名字。

• co_names，和 co_varnames 相反，表示非本地定義但在 code object 當中使用的名字。

• co_nlocals，這個欄位表示在一個 code object 當中本地使用的變數個數。

• co_stackszie，因為 python 虛擬機器是堆疊式計算機，這個參數的值表示這個堆疊需要的最大的值。

• co_cellvars，co_freevars，這兩個欄位主要和巢狀函數和函數閉包有關，我們在後續的文章當中將詳細解釋這個欄位。

CodeObject 詳細分析

現在我們使用一些實際的範例來分析特定的 code object 。

import dis
import binascii
import types

d = 10


def test_co01(c):
    a = 1
    b = 2
    return a + b + c + d

在前面的文章當中我們提到一個函數是包含一個code object 對象，test_co01 的code object 物件的輸出結果（完整程式碼見co01）如下所示：

code
   argcount 1
   nlocals 3
   stacksize 2
   flags 0043 0x43
   code b'6401007d01006402007d02007c01007c0200177c0000177400001753'
  9           0 LOAD_CONST               1 (1)
              3 STORE_FAST               1 (a)

 10           6 LOAD_CONST               2 (2)
              9 STORE_FAST               2 (b)

 11          12 LOAD_FAST                1 (a)
             15 LOAD_FAST                2 (b)
             18 BINARY_ADD
             19 LOAD_FAST                0 (c)
             22 BINARY_ADD
             23 LOAD_GLOBAL              0 (d)
             26 BINARY_ADD
             27 RETURN_VALUE
   consts
      None
      1
      2
   names ('d',)
   varnames ('c', 'a', 'b')
   freevars ()
   cellvars ()
   filename '/tmp/pycharm_project_396/co01.py'
   name 'test_co01'
   firstlineno 8
   lnotab b'000106010601'

• 字段argcount 的值等於1，表示函數有一個參數，這個函數test_co01 有一個參數c 是相互對應的。

• 欄位 nlocals 的值等於 3，說明在函數 test_co01 當中一個總共實現了三個函數本地變數 a, b, c 。

• 欄位 names，對應程式碼程式碼當中的 co_names，根據前面的定義就是 d 這個全域變數在函數 test_co01 當中使用，但是卻沒有在函數當中定義了。

• 欄位 varnames，這就表示在本地定義使用的變數了，在函數 test_co01 當中主要有三個變數 a, b, c 。

• 欄位 filename，就是 python 檔案的位址了。

• 欄位 firstlineno 說明函數的第一行出現在對應 python 程式碼的 第 8 行。

Flags 欄位詳細分析

我們具體使用python3.5 的原始碼進行分析，在cpython 虛擬機器的具體實作如下所示（Include/code.h )：

/* Masks for co_flags above */
#define CO_OPTIMIZED	0x0001
#define CO_NEWLOCALS	0x0002
#define CO_VARARGS	0x0004
#define CO_VARKEYWORDS	0x0008
#define CO_NESTED       0x0010
#define CO_GENERATOR    0x0020
/* The CO_NOFREE flag is set if there are no free or cell variables.
   This information is redundant, but it allows a single flag test
   to determine whether there is any extra work to be done when the
   call frame it setup.
*/
#define CO_NOFREE       0x0040

/* The CO_COROUTINE flag is set for coroutine functions (defined with
   ``async def`` keywords) */
#define CO_COROUTINE            0x0080
#define CO_ITERABLE_COROUTINE   0x0100

如果flags 欄位和上面的各個巨集定義進行& 運算，如果得到的結果大於0，則說明符合對應的條件。

上面的巨集定義的意義如下所示：

• CO_OPTIMIZED，這個欄位表示code object 是被最佳化過的，使用函數本地定義的變數。

• CO_NEWLOCALS，這個欄位的意義就是當這個 code object 的程式碼被執行的時候會給堆疊框架當中的 f_locals 物件建立一個 dict 物件。

• CO_VARARGS，表示這個 code object 物件是否含有位置參數。

• CO_VARKEYWORDS，表示這個 code object 是否含有關鍵字參數。

• CO_NESTED，表示這個 code object 是個巢狀函數。

• CO_GENERATOR，表示這個 code object 是一個產生器。

• CO_COROUTINE，表示這個 code object 是一個協程函數。

• CO_ITERABLE_COROUTINE，表示 code object 是一個可迭代的協程函數。

• CO_NOFREE，這個表示法沒有 freevars 和 cellvars，也就是沒有函式閉包。

現在再分析一下前面的函數 test_co01 的 flags，他對應的值等於 0x43，則說明這個函數滿足三個特性分別是 CO_NEWLOCALS，CO_OPTIMIZED 和 CO_NOFREE。

freevars & cellvars

我们使用下面的函数来对这两个字段进行分析：

def test_co02():
    a = 1
    b = 2

    def g():
        return a + b
    return a + b + g()

上面的函数的信息如下所示（完整代码见co02）：

code
   argcount 0
   nlocals 1
   stacksize 3
   flags 0003 0x3
   code
      b'640100890000640200890100870000870100660200640300640400860000'
      b'7d0000880000880100177c00008300001753'
 15           0 LOAD_CONST               1 (1)
              3 STORE_DEREF              0 (a)

 16           6 LOAD_CONST               2 (2)
              9 STORE_DEREF              1 (b)

 18          12 LOAD_CLOSURE             0 (a)
             15 LOAD_CLOSURE             1 (b)
             18 BUILD_TUPLE              2
             21 LOAD_CONST               3 (<code object g at 0x7f133ff496f0, file "/tmp/pycharm_project_396/co01.py", line 18>)
             24 LOAD_CONST               4 (&#39;test_co02.<locals>.g&#39;)
             27 MAKE_CLOSURE             0
             30 STORE_FAST               0 (g)

 20          33 LOAD_DEREF               0 (a)
             36 LOAD_DEREF               1 (b)
             39 BINARY_ADD
             40 LOAD_FAST                0 (g)
             43 CALL_FUNCTION            0 (0 positional, 0 keyword pair)
             46 BINARY_ADD
             47 RETURN_VALUE
   consts
      None
      1
      2
      code
         argcount 0
         nlocals 0
         stacksize 2
         flags 0013 0x13
         code b&#39;8800008801001753&#39;
 19           0 LOAD_DEREF               0 (a)
              3 LOAD_DEREF               1 (b)
              6 BINARY_ADD
              7 RETURN_VALUE
         consts
            None
         names ()
         varnames ()
         freevars (&#39;a&#39;, &#39;b&#39;)
         cellvars ()
         filename &#39;/tmp/pycharm_project_396/co01.py&#39;
         name &#39;g&#39;
         firstlineno 18
         lnotab b&#39;0001&#39;
      &#39;test_co02.<locals>.g&#39;
   names ()
   varnames (&#39;g&#39;,)
   freevars ()
   cellvars (&#39;a&#39;, &#39;b&#39;)
   filename &#39;/tmp/pycharm_project_396/co01.py&#39;
   name &#39;test_co02&#39;
   firstlineno 14
   lnotab b&#39;0001060106021502&#39;

从上面的输出我们可以看到的是，函数 test_co02 的 cellvars 为 ('a', 'b')，函数 g 的 freevars 为 ('a', 'b')，cellvars 表示在其他函数当中会使用本地定义的变量，freevars 表示本地会使用其他函数定义的变量。

再来分析一下函数 test_co02 的 flags，他的 flags 等于 0x3 因为有闭包的存在因此 flags 不会存在 CO_NOFREE，也就是少了值 0x0040 。

stacksize

这个字段存储的是在函数在被虚拟机执行的时候所需要的最大的栈空间的大小，这也是一种优化手段，因为在知道所需要的最大的栈空间，所以可以在函数执行的时候直接分配指定大小的空间不需要在函数执行的时候再去重新扩容。

def test_stack():
    a = 1
    b = 2
    return a + b

上面的代码相关字节码等信息如下所示：

code
   argcount 0
   nlocals 2
   stacksize 2
   flags 0043 0x43
   code b'6401007d00006402007d01007c00007c01001753'
   #					  字节码指令		 # 字节码指令参数 # 参数对应的值
 24           0 LOAD_CONST               1 (1)
              3 STORE_FAST               0 (a)

 25           6 LOAD_CONST               2 (2)
              9 STORE_FAST               1 (b)

 26          12 LOAD_FAST                0 (a)
             15 LOAD_FAST                1 (b)
             18 BINARY_ADD
             19 RETURN_VALUE
   consts
      None # 下标等于 0 的常量
      1 	 # 下标等于 1 的常量
      2		 # 下标等于 2 的常量
   names ()
   varnames ('a', 'b')
   freevars ()
   cellvars ()

我们现在来模拟一下执行过程，在模拟之前我们首先来了解一下上面几条字节码的作用：

LOAD_CONST，将常量表当中的下标等于 i 个对象加载到栈当中，对应上面的代码 LOAD_CONST 的参数 i = 1。因此加载测常量等于 1 。因此现在栈空间如下所示：

STORE_FAST，将栈顶元素弹出并且保存到 co_varnames 对应的下标当中，根据上面的字节码参数等于 0 ，因此将 1 保存到 co_varnames[0] 对应的对象当中。

LOAD_CONST，将下标等于 2 的常量加载进入栈中。

STORE_FAST，将栈顶元素弹出，并且保存到 varnames 下标为 1 的对象。

LOAD_FAST，是取出 co_varnames 对应下标的数据，并且将其压入栈中。我们直接连续执行两个 LOAD_FAST 之后栈空间的布局如下：

BINARY_ADD，这个字节码指令是将栈空间的两个栈顶元素弹出，然后将两个数据进行相加操作，然后将相加得到的结果重新压入栈中。

RETURN_VALUE，将栈顶元素弹出并且作为返回值返回。

从上面的整个执行过程来看整个栈空间使用的最大的空间长度为 2 ，因此 stacksize = 2 。

以上是Python虛擬機器中的Code obejct有什麼作用的詳細內容。更多資訊請關注PHP中文網其他相關文章！