Python/反射

維基教科書,自由的教學讀本
跳至導覽 跳至搜尋

反射(reflection),或稱「自省」(introspection)是指Python腳本可以得到一個對象的類型、class、屬性、方法等信息。 在某些時候,需要執行對象的某個方法,或是需要給對象的某個字段賦值,而方法名或是字段名在編寫代碼時並不能確定,需要通過字符串參數傳遞的形式輸入。

下列函數實現了反射:type(), isinstance(), issubclass(), callable(), dir(), getattr()。

type()函數[編輯]

type()函數用於找出一個對象的類型。如下例各語句的結果為True:

  • type(3) is int
  • type(3.0) is float
  • type(10**10) is int # Python 3
  • type(1 + 1j) is complex
  • type('Hello') is str
  • type([1, 2]) is list
  • type([1, [2, 'Hello']]) is list
  • type({'city': 'Paris'}) is dict
  • type((1,2)) is tuple
  • type(set()) is set
  • type(frozenset()) is frozenset
  • ----
  • type(3).__name__ == "int"
  • type('Hello').__name__ == "str"
  • ----
  • import types, re, Tkinter # For the following examples
  • type(re) is types.ModuleType
  • type(re.sub) is types.FunctionType
  • type(Tkinter.Frame) is types.ClassType
  • type(Tkinter.Frame).__name__ == "classobj"
  • type(Tkinter.Frame()).__name__ == "instance"
  • type(re.compile('myregex')).__name__ == "SRE_Pattern"
  • type(type(3)) is types.TypeType

type()漠視類的繼承:"type(3) is object"產生False,而"isinstance(3, object)"產生True.

相關連結:

isinstance()函數[編輯]

確定一個對象是否為類的一個實例。

下述語句均產生True:

  • isinstance(3, int)
  • isinstance([1, 2], list)
  • isinstance(3, object)
  • isinstance([1, 2], object)
  • import Tkinter; isinstance(Tkinter.Frame(), Tkinter.Frame)
  • import Tkinter; Tkinter.Frame().__class__.__name__ == "Frame"

注意到isinstance提供了比#Type更弱的條件。

函數isinstance與用戶定義的class:

class Plant: pass                        # Dummy class
class Tree(Plant): pass                  # Dummy class derived from Plant
tree = Tree()                            # A new instance of Tree class
print isinstance(tree, Tree)             # True
print isinstance(tree, Plant)            # True
print isinstance(tree, object)           # True
print type(tree) is Tree                 # False
print type(tree).__name__ == "instance"  # True
print tree.__class__.__name__ == "Tree"  # True

外部連結:

issubclass()函數[編輯]

確定一個類是否為另一個類的子類。不考慮實例。

class Plant: pass                        # Dummy class
class Tree(Plant): pass                  # Dummy class derived from Plant
tree = Tree()                            # A new instance of Tree class
print issubclass(Tree, Plant)            # True
print issubclass(Tree, object)           # False in Python 2
print issubclass(int, object)            # True
print issubclass(tree, Plant)            # Error - tree is not a class

外部連結:

鴨子類型[編輯]

鴨子類型提供了反射的間接方式。即使用一個對象時認為它就像某個類型,同時捕捉對象拋出的異常,這些異常可表示對象不支持該類型的某些特性。

外部連結:

Callable[編輯]

判斷一個對象是否可以被調用。一個類具有__call__()方法則是可調用的。

例子:

  • callable(2)
    • Returns False. Ditto for callable("Hello") and callable([1, 2]).
  • callable([1,2].pop)
    • Returns True, as pop without "()" returns a function object.
  • callable([1,2].pop())
    • Returns False, as [1,2].pop() returns 2 rather than a function object.

外部連結:

Dir()函數[編輯]

返回對象屬性的名字的列表。包括方法。

例如:

  • dir(3)
  • dir("Hello")
  • dir([1, 2])
  • import re; dir(re)
    • Lists names of functions and other objects available in the re module for regular expressions.

外部連結:

Getattr()函數[編輯]

給定屬性的名字(作為字符串),返回對象的屬性的值。

例如:

  • getattr(3, "imag")

對象屬性可以通過#Dir獲得

外部連結:

關鍵字[編輯]

Python的所有關鍵字:

import keyword
pykeywords = keyword.kwlist
print keyword.iskeyword("if")      # True
print keyword.iskeyword("True")    # False

外部連結:

內建[編輯]

Python內建的對象與函數:

print dir(__builtins__)           # Output the list
print type(__builtins__.list)     # = <type 'type'>
print type(__builtins__.open)     # = <type 'builtin_function_or_method'>
print list is __builtins__.list   # True
print open is __builtins__.open   # True

Links:

附錄[編輯]

  • 內建方法:訪問對象的屬性
    • dir([obj]):返回包含obj大多數屬性名的列表(會有一些特殊的屬性不包含在內)。obj的默認值是當前的模塊對象。
    • hasattr(obj, attr):檢查obj是否有一個名為attr的值的屬性,返回一個布爾值。
    • getattr(obj, attr):返回obj中名為attr值的屬性的值,例如如果attr為'bar',則返回obj.bar。
    • setattr(obj, attr, val):將給obj的名為attr的值的屬性賦值為val。例如如果attr為'bar',則相當於obj.bar = val。
    •  isinstance(object, classinfo):檢查object是不是classinfo中列舉出的類型,返回布爾值。classinfo可以是一個具體的類型,也可以是多個類型的元組或列表。
  •  元數據屬性
    • 模塊(module)
      • __doc__: 文檔字符串。如果模塊沒有文檔,這個值是None。
      • __name__: 始終是定義時的模塊名;即使你使用import .. as 為它取了別名,或是賦值給了另一個變量名。
      • __dict__: 包含了模塊里可用的屬性名-屬性的字典;也就是可以使用模塊名.屬性名訪問的對象。
      • __file__: 包含了該模塊的文件路徑。需要注意的是內建的模塊沒有這個屬性,訪問它會拋出異常
    • 類(class)
      • __doc__: 文檔字符串。如果類沒有文檔,這個值是None。
      • __name__: 始終是定義時的類名。
      • __dict__: 包含了類里可用的屬性名-屬性的字典;也就是可以使用類名.屬性名訪問的對象。
      • __module__: 包含該類的定義的模塊名;需要注意,是字符串形式的模塊名而不是模塊對象。
      • __bases__: 直接父類對象的元組;但不包含繼承樹更上層的其他類,比如父類的父類。
    • 實例(instance) 是指類實例化以後的對象。
      • __dict__: 包含了可用的屬性名-屬性字典。
      • __class__: 該實例的類對象。對於類Cat,cat.__class__ == Cat 為 True。
    • 內建函數和方法(built-in functions and methods):內建的(built-in)模塊是指使用C寫的模塊,可以通過sys模塊的builtin_module_names字段查看都有哪些模塊是內建的。這些模塊中的函數和方法可以使用的屬性比較少,不過一般也不需要在代碼中查看它們的信息。
      • __doc__: 函數或方法的文檔。
      • __name__: 函數或方法定義時的名字。
      • __self__: 僅方法可用,如果是綁定的(bound),則指向調用該方法的類(如果是類方法)或實例(如果是實例方法),否則為None。
      • __module__: 函數或方法所在的模塊名。
    • 函數(function)特指非內建的函數。注意,在類中使用def定義的是方法,方法與函數雖然有相似的行為,但它們是不同的概念。
      • __doc__: 函數的文檔;另外也可以用屬性名func_doc。
      • __name__: 函數定義時的函數名;另外也可以用屬性名func_name。
      • __module__: 包含該函數定義的模塊名;同樣注意,是模塊名而不是模塊對象。
      • __dict__: 函數的可用屬性;另外也可以用屬性名func_dict。函數也是對象,可以使用函數.屬性名訪問屬性(賦值時如果屬性不存在將新增一個),或使用內置函數has/get/setattr()訪問。不過,在函數中保存屬性的意義並不大。
      • func_defaults: 這個屬性保存了函數的參數默認值元組;因為默認值總是靠後的參數才有,所以不使用字典的形式也是可以與參數對應上的。
      • func_code: 這個屬性指向一個該函數對應的code對象,code對象中定義了其他的一些特殊屬性,將在下文中另外介紹。
      • func_globals: 這個屬性指向定義函數時的全局命名空間。
      • func_closure: 這個屬性僅當函數是一個閉包時有效,指向一個保存了所引用到的外部函數的變量cell的元組,如果該函數不是一個內部函數,則始終為None。這個屬性也是只讀的。
    • 方法(method):方法雖然不是函數,但可以理解為在函數外面加了一層外殼。另外還有兩種特殊的方法分別是類方法(class method)和靜態方法(static method)。類方法還是方法,不過因為需要使用類名調用,所以他始終是綁定的;而靜態方法可以看成是在類的命名空間裏的函數(需要使用類名調用的函數),它只能使用函數的屬性,不能使用方法的屬性。
      • __doc__: 與函數相同。
      • __name__: 與函數相同。
      • __module__: 與函數相同。
      • im_func: 使用這個屬性可以拿到方法裏實際的函數對象的引用。另外如果是2.6以上的版本,還可以使用屬性名__func__。
      • im_self: 如果是綁定的(bound),則指向調用該方法的類(如果是類方法)或實例(如果是實例方法),否則為None。如果是2.6以上的版本,還可以使用屬性名__self__。
      • im_class: 實際調用該方法的類,或實際調用該方法的實例的類。注意不是方法的定義所在的類,如果有繼承關係的話。
    • 生成器(generator):生成器是調用一個生成器函數(generator function)返回的對象,多用於集合對象的疊代。
      • __iter__: 僅僅是一個可疊代的標記。
      • gi_code: 生成器對應的code對象。
      • gi_frame: 生成器對應的frame對象。
      • gi_running: 生成器函數是否在執行。生成器函數在yield以後、執行yield的下一行代碼前處於frozen狀態,此時這個屬性的值為0。
      • next|close|send|throw: 這是幾個可調用的方法,並不包含元數據信息,如何使用可以查看生成器的相關文檔。
    • 代碼塊(code):可以由類原始碼、函數原始碼或是一個簡單的語句代碼編譯得到。這裏我們只考慮它指代一個函數時的情況;可以使用函數的func_code屬性獲取到它。code的屬性全部是只讀的。
      • co_argcount: 普通參數的總數,不包括*參數和**參數。
      • co_names: 所有的參數名(包括*參數和**參數)和局部變量名的元組。
      • co_varnames: 所有的局部變量名的元組。
      • co_filename: 原始碼所在的文件名。
      • co_flags: 這是一個數值,每一個二進制位都包含了特定信息。較關注的是0b100(0x4)和0b1000(0x8),如果co_flags & 0b100 != 0,說明使用了*args參數;如果co_flags & 0b1000 != 0,說明使用了**kwargs參數。另外,如果co_flags & 0b100000(0x20) != 0,則說明這是一個生成器函數(generator function)。
    • 棧幀(frame):表示程序運行時函數調用棧中的某一幀。函數沒有屬性可以獲取它,因為它在函數調用時才會產生,而生成器則是由函數調用返回的,所以有屬性指向棧幀。想要獲得某個函數相關的棧幀,則必須在調用這個函數且這個函數尚未返回時獲取。可以使用sys模塊的_getframe()函數、或inspect模塊的currentframe()函數獲取當前棧幀。這裏列出來的屬性全部是只讀的。
      • f_back: 調用棧的前一幀。
      • f_code: 棧幀對應的code對象。
      • f_locals: 用在當前棧幀時與內建函數locals()相同,但你可以先獲取其他幀然後使用這個屬性獲取那個幀的locals()。
      • f_globals: 用在當前棧幀時與內建函數globals()相同,但你可以先獲取其他幀……。
    • 追蹤(traceback):是在出現異常時用於回溯的對象,與棧幀相反。由於異常時才會構建,而異常未捕獲時會一直向外層棧幀拋出,所以需要使用try才能見到這個對象。可以使用sys模塊的exc_info()函數獲得它,這個函數返回一個元組,元素分別是異常類型、異常對象、追蹤。traceback的屬性全部是只讀的。
      • tb_next: 追蹤的下一個追蹤對象。
      • tb_frame: 當前追蹤對應的棧幀。
      • tb_lineno: 當前追蹤的行號。
  • inspect模塊提供了一系列函數用於幫助使用自省。列出較常用的一些函數:
    • 檢查對象類型
      • ismodule|isclass|isfunction|ismethod|isbuiltin 檢查對象是否為模塊、類、函數、方法、內建函數或方法。
      • isroutine(obj) 檢查對象是否為函數、方法、內建函數或方法等等可調用類型。
      • isinstance(obj, collections.Callable):可以直接調用就需要是True
    • 獲取對象信息
      • getmembers(object[, predicate]):是dir()的擴展版,它會將dir()找到的名字對應的屬性一併返回,形如[(name, value), ...]。參數predicate是一個方法的引用,如果指定,則應當接受value作為參數並返回一個布爾值,如果為False,相應的屬性將不會返回。使用is*作為第二個參數可以過濾出指定類型的屬性。
      • getmodule(object):返回object的定義所在的模塊對象。
      • get{file|sourcefile}(object):獲取object的定義所在的模塊的文件名|原始碼文件名(如果沒有則返回None)。用於內建的對象(內建模塊、類、函數、方法)上時會拋出TypeError異常。
      • get{source|sourcelines}(object): 獲取object的定義的原始碼,以字符串|字符串列表返回。代碼無法訪問時會拋出IOError異常。只能用於module/class/function/method/code/frame/traceack對象。
      • getargspec(func): 僅用於方法,獲取方法聲明的參數,返回元組,分別是(普通參數名的列表, *參數名, **參數名, 默認值元組)。如果沒有值,將是空列表和3個None。如果是2.6以上版本,將返回一個命名元組(Named Tuple),即除了索引外還可以使用屬性名訪問元組中的元素。
      • getargvalues(frame):僅用於棧幀,獲取棧幀中保存的該次函數調用的參數值,返回元組,分別是(普通參數名的列表, *參數名, **參數名, 幀的locals())。如果是2.6以上版本,將返回一個命名元組(Named Tuple),即除了索引外還可以使用屬性名訪問元組中的元素。
      • getcallargs(func[, *args][, **kwds]): 返回使用args和kwds調用該方法時各參數對應的值的字典。這個方法僅在2.7版本中才有。
      • getmro(cls): 返回一個類型元組,查找類屬性時按照這個元組中的順序。如果是新式類,與cls.__mro__結果一樣。但舊式類沒有__mro__這個屬性,直接使用這個屬性會報異常,所以這個方法還是有它的價值的。
      • currentframe(): 返回當前的棧幀對象。


外部連結[編輯]