Python自省的详解

简介: Python自省的详解

首先通过一个例子来看一下本文中可能用到的对象和相关概念。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

coding: UTF-8

import sys # 模块,sys指向这个模块对象
import inspect
def foo(): pass # 函数,foo指向这个函数对象
//代码效果参考:https://v.youku.com/v_show/id_XNjQwMDE5ODQ3Ng==.html

class Cat(object): # 类,Cat指向这个类对象
def init(self, name='kitty'):
self.name = name
def sayHi(self): # 实例方法,sayHi指向这个方法对象,使用类或实例.sayHi访问
print self.name, 'says Hi!' # 访问名为name的字段,使用实例.name访问

cat = Cat() # cat是Cat类的实例对象

print Cat.sayHi # 使用类名访问实例方法时,方法是未绑定的(unbound)
print cat.sayHi # 使用实例访问实例方法时,方法是绑定的(bound)
有时候我们会碰到这样的需求,需要执行对象的某个方法,或是需要对对象的某个字段赋值,而方法名或是字段名在编码代码时并不能确定,需要通过参数传递字符串的形式输入。举个具体的例子:当我们需要实现一个通用的DBM框架时,可能需要对数据对象的字段赋值,但我们无法预知用到这个框架的数据对象都有些什么字段,换言之,我们在写框架的时候需要通过某种机制访问未知的属性。

这个机制被称为反射(反过来让对象告诉我们他是什么),或是自省(让对象自己告诉我们他是什么,好吧我承认括号里是我瞎掰的- -#),用于实现在运行时获取未知对象的信息。反射是个很吓唬人的名词,听起来高深莫测,在一般的编程语言里反射相对其他概念来说稍显复杂,一般来说都是作为高级主题来讲;但在Python中反射非常简单,用起来几乎感觉不到与其他的代码有区别,使用反射获取到的函数和方法可以像平常一样加上括号直接调用,获取到类后可以直接构造实例;不过获取到的字段不能直接赋值,因为拿到的其实是另一个指向同一个地方的引用,赋值只能改变当前的这个引用而已。

  1. 访问对象的属性
    以下列出了几个内建方法,可以用来检查或是访问对象的属性。这些方法可以用于任意对象而不仅仅是例子中的Cat实例对象;Python中一切都是对象。

1
2
3
4
5
6
7
8
9
10
11
cat = Cat('kitty')

print cat.name # 访问实例属性
cat.sayHi() # 调用实例方法

print dir(cat) # 获取实例的属性名,以列表形式返回
if hasattr(cat, 'name'): # 检查实例是否有这个属性
setattr(cat, 'name', 'tiger') # same as: a.name = 'tiger'
print getattr(cat, 'name') # same as: print a.name

getattr(cat, 'sayHi')() # same as: cat.sayHi()
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。

  1. 访问对象的元数据
    当你对一个你构造的对象使用dir()时,可能会发现列表中的很多属性并不是你定义的。这些属性一般保存了对象的元数据,比如类的name属性保存了类名。大部分这些属性都可以修改,不过改动它们意义并不是很大;修改其中某些属性如function.func_code还可能导致很难发现的问题,所以改改name什么的就好了,其他的属性不要在不了解后果的情况下修改。

接下来列出特定对象的一些特殊属性。另外,Python的文档中有提到部分属性不一定会一直提供,下文中将以红色的星号*标记,使用前你可以先打开解释器确认一下。

2.0. 准备工作:确定对象的类型
在types模块中定义了全部的Python内置类型,结合内置方法isinstance()就可以确定对象的具体类型了。

isinstance(object, classinfo):
检查object是不是classinfo中列举出的类型,返回布尔值。classinfo可以是一个具体的类型,也可以是多个类型的元组或列表。
types模块中仅仅定义了类型,而inspect模块中封装了很多检查类型的方法,比直接使用types模块更为轻松,所以这里不给出关于types的更多介绍,如有需要可以直接查看types模块的文档说明。本文第3节中介绍了inspect模块。

2.1. 模块(module)
doc: 文档字符串。如果模块没有文档,这个值是None。
name: 始终是定义时的模块名;即使你使用import .. as 为它取了别名,或是赋值给了另一个变量名。 dict: 包含了模块里可用的属性名-属性的字典;也就是可以使用模块名.属性名访问的对象。
file: 包含了该模块的文件路径。需要注意的是内建的模块没有这个属性,访问它会抛出异常!
1
2
3
4
5
import fnmatch as m
print m.doc.splitlines()[0] # Filename matching with shell patterns.
//代码效果参考:https://v.youku.com/v_show/id_XNjQwNjYyODc4NA==.html

print m.name # fnmatch
print m.file # /usr/lib/python2.6/fnmatch.pyc
print m.dict.items()[0] # ('fnmatchcase', )
2.2. 类(class)
doc: 文档字符串。如果类没有文档,这个值是None。
name: 始终是定义时的类名。 dict: 包含了类里可用的属性名-属性的字典;也就是可以使用类名.属性名访问的对象。
module: 包含该类的定义的模块名;需要注意,是字符串形式的模块名而不是模块对象。
*bases: 直接父类对象的元组;但不包含继承树更上层的其他类,比如父类的父类。
1
2
3
4
5
print Cat.doc # None
print Cat.name # Cat
print Cat.module # main
print Cat.bases # (,)
print Cat.dict # {'module': 'main', ...}
2.3. 实例(instance)
实例是指类实例化以后的对象。

dict: 包含了可用的属性名-属性字典。 class: 该实例的类对象。对于类Cat,cat.class == Cat 为 True。
1
2
3
print cat.dict
print cat.class
print cat.class == Cat # True
2.4. 内建函数和方法(built-in functions and methods)
根据定义,内建的(built-in)模块是指使用C写的模块,可以通过sys模块的builtin_module_names字段查看都有哪些模块是内建的。这些模块中的函数和方法可以使用的属性比较少,不过一般也不需要在代码中查看它们的信息。

doc: 函数或方法的文档。
name: 函数或方法定义时的名字。
self: 仅方法可用,如果是绑定的(bound),则指向调用该方法的类(如果是类方法)或实例(如果是实例方法),否则为None。
*module: 函数或方法所在的模块名。
2.5. 函数(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。这个属性也是只读的。
下面的代码演示了func_closure:

1
2
3
4
5
6
7
8
9
10
11
12

coding: UTF-8

def foo():
n = 1
def bar():
print n # 引用非全局的外部变量n,构造一个闭包
n = 2
return bar

closure = foo()
print closure.func_closure

使用dir()得知cell对象有一个cell_contents属性可以获得值

print closure.func_closure[0].cell_contents # 2

相关文章
|
1月前
|
并行计算 数据库 数据库管理
Python中starmap有什么用的?
Python中starmap有什么用的?
33 6
|
1月前
|
数据采集 机器学习/深度学习 人工智能
Python可以应用于多个领域
【5月更文挑战第6天】Python广泛应用于Web开发(Django, Flask)、数据科学(NumPy, pandas, scikit-learn)、人工智能&机器学习、自动化运维测试、游戏(Pygame, Panda3D)、网络爬虫、数据挖掘及科学工程计算。其丰富的库支持使其在各领域都表现出强大功能。
36 0
|
1月前
|
Python
1194: 最简单的题(python)
1194: 最简单的题(python)
|
数据采集 存储 数据挖掘
Python应用 | 我喜欢看什么美剧(一)
Python应用 | 我喜欢看什么美剧(一)
90 0
Python应用 | 我喜欢看什么美剧(一)
|
Python
Python生日蛋糕
Hello,小伙伴们晚上好吖!前两天博主满20岁啦(要开始奔三辽呜呜呜),这几天收到了不少小伙伴们的祝福,浪漫的小博主想送给大家一份不一样的生日蛋糕,感谢大家对俺滴支持!
122 0
|
人工智能 前端开发 JavaScript
更多了解 Python: 一些有趣的知识介绍
更多了解 Python: 一些有趣的知识介绍
96 0
更多了解 Python: 一些有趣的知识介绍
|
数据采集 机器学习/深度学习 人工智能
初识 Python
人生苦短,我用 Python —— Life is short, you need Python
|
数据采集 运维 算法
|
Java Unix 程序员
Python-01-前世今生
Python-01-前世今生
201 0
|
SQL Java 关系型数据库
数据持久化技术(Python)的使用
数据持久化技术(Python)的使用