18、【转载】python中inspect模块

转载自：https://blog.csdn.net/weixin_35955795/article/details/53053762

前言

我在学习到实战Day5 - python教程 - 廖雪峰的官方网站时，遇到了inspect模块，之前对这个inspect模块一无所知啊，所以本着打破砂锅问到底的精神，决定对inspect模块做一些探究。

根据度娘搜到的，inspect模块主要提供了四种用处：

(1). 对是否是模块，框架，函数等进行类型检查。

(2). 获取源码

(3). 获取类或函数的参数的信息

(4). 解析堆栈

我在这次课程中，只用到了第三种用处，即获取类或函数的参数的信息，下面我来探究一下。

探究

结合我正在学习的课程，我自己也对inspect做了一些探究。根据在课程中用到的一些函数及方法，我做了一个python脚本。

# test
import inspect

def fn(a, b=0, *c, d, e=1, f='hello', **g):
    pass

sig = inspect.signature(fn)
print("inspect.signature（fn)的值是:%s" % sig)  #(a, b=0, *c, d, e=1, f='hello', **g)
print("inspect.signature（fn)的类型：%s" % (type(sig)))  #<class 'inspect.Signature'>
print("
")

params = sig.parameters
print("signature.paramerters属性的值是:%s" % params)  #OrderedDict([('a', <Parameter "a">), ('b', <Parameter "b=0">), ('c', <Parameter "*c">), ('d', <Parameter "d">), ('e', <Parameter "e=1">), ('f', <Parameter "f='hello'">), ('g', <Parameter "**g">)])
print("ignature.paramerters属性的类型是%s" % type(params))    #<class 'mappingproxy'>
print("
")

for name, param in params.items():
    print('*' * 20, 'Start', '*' * 20)

    print("mappingproxy.items()返回的两个值分别是：%s和%s" % (name, param))
    print("mappingproxy.items()返回的两个值的类型分别是：%s和%s" % (type(name), type(param)))  #<class 'str'>和<class 'inspect.Parameter'>
    print("
")

    k = param.kind
    print("Parameter.kind属性的值是:%s" % k)
    print("Parameter.kind属性的类型是:%s" % type(k))   #<enum '_ParameterKind'>
    print("
")

    dft = param.default
    print("Parameter.default的值是: %s" % dft)
    print("Parameter.default的属性是: %s" % type(dft))

    print('*' * 20, 'End', '*' * 20)
    print("
")


pk = inspect.Parameter.POSITIONAL_OR_KEYWORD
print("inspect.Parameter.POSITIONAL_OR_KEYWORD的值是:%s" % pk)
print("inspect.Parameter.POSITIONAL_OR_KEYWORD的类型是:%s" % type(pk))

ko = inspect.Parameter.KEYWORD_ONLY
print("inspect.Parameter.KEYWORD_ONLY的值是:%s" % ko)
print("inspect.Parameter.KEYWORD_ONLY的类型是:%s" % type(ko))

执行以上脚本，将得到如下输出：

inspect.signature（fn)的值是:(a, b=0, *c, d, e=1, f='hello', **g)
inspect.signature（fn)的类型：<class 'inspect.Signature'>


signature.paramerters属性的值是:OrderedDict([('a', <Parameter "a">), ('b', <Parameter "b=0">), ('c', <Parameter "*c">), ('d', <Parameter "d">), ('e', <Parameter "e=1">), ('f', <Parameter "f='hello'">), ('g', <Parameter "**g">)])
ignature.paramerters属性的类型是<class 'mappingproxy'>


******************** Start ********************
mappingproxy.items()返回的两个值分别是：a和a
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:POSITIONAL_OR_KEYWORD
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: <class 'inspect._empty'>
Parameter.default的属性是: <class 'type'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：b和b=0
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:POSITIONAL_OR_KEYWORD
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: 0
Parameter.default的属性是: <class 'int'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：c和*c
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:VAR_POSITIONAL
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: <class 'inspect._empty'>
Parameter.default的属性是: <class 'type'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：d和d
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:KEYWORD_ONLY
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: <class 'inspect._empty'>
Parameter.default的属性是: <class 'type'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：e和e=1
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:KEYWORD_ONLY
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: 1
Parameter.default的属性是: <class 'int'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：f和f='hello'
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:KEYWORD_ONLY
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: hello
Parameter.default的属性是: <class 'str'>
******************** End ********************


******************** Start ********************
mappingproxy.items()返回的两个值分别是：g和**g
mappingproxy.items()返回的两个值的类型分别是：<class 'str'>和<class 'inspect.Parameter'>


Parameter.kind属性的值是:VAR_KEYWORD
Parameter.kind属性的类型是:<enum '_ParameterKind'>


Parameter.default的值是: <class 'inspect._empty'>
Parameter.default的属性是: <class 'type'>
******************** End ********************


inspect.Parameter.POSITIONAL_OR_KEYWORD的值是:POSITIONAL_OR_KEYWORD
inspect.Parameter.POSITIONAL_OR_KEYWORD的类型是:<enum '_ParameterKind'>
inspect.Parameter.KEYWORD_ONLY的值是:KEYWORD_ONLY
inspect.Parameter.KEYWORD_ONLY的类型是:<enum '_ParameterKind'>

总结

• inspect.signature（fn)将返回一个inspect.Signature类型的对象，值为fn这个函数的所有参数

• inspect.Signature对象的paramerters属性是一个mappingproxy（映射）类型的对象，值为一个有序字典（Orderdict)。

  • 这个字典里的key是即为参数名，str类型

  • 这个字典里的value是一个inspect.Parameter类型的对象，根据我的理解，这个对象里包含的一个参数的各种信息

• inspect.Parameter对象的kind属性是一个_ParameterKind枚举类型的对象，值为这个参数的类型（可变参数，关键词参数，etc）

• inspect.Parameter对象的default属性：如果这个参数有默认值，即返回这个默认值，如果没有，返回一个inspect._empty类。