自省?使用inspect模块探测python对象内容!
python中一切皆对象,这使得python有着天然的 自省 特性,即能够运行过程中获取对象自身由哪些属性和方法组成。在阅读python源码和基于第三方库开发时,查看获取某个对象的具体构成内容很有必要。python自带的inspect模块便提供了将对象的各个成员总结出来并具有良好可读性的功能。
1.挑战python自省反射的原住民
不使用模块inspect,仅使用内置函数,也能实现自省和反射的功能。
自省意味着获取对象的属性和方法; 反射 通过字符串映射的方式获取或者修改对象的方法或者属性(比如以某个属性的名字字符串作为参数传入某个函数),是自省的一种具体实现方法。Python学习交流群:1004391443,这里有资源共享,技术解答,还有小编从最基础的Python资料到项目实战的学习资料都有整理,希望能帮助你更了解python,学习python
python中相关功能的内置函数如下:
dir(obj)->将对象的所有属性、方法以列表形式返回
hasattr(obj,name_str)->判断objec是否有name_str这个方法或者属性
getattr(obj,name_str)->获取object对象中与name_str同名的方法或者函数
setattr(obj,name_str,value)->为object对象设置一个以name_str为名的value方法或者属性
delattr(obj,name_str)->删除object对象中的name_str方法或者属性
复制代码
但是使用inspect.getmembers(obj)这个方法能够获取到更详尽的自省信息,且可读性更佳,下面将其和dir内置函数进行比较:
import inspect
示例对象--某个函数
def foo(a: int, b: str) -> int:
return a + int(b)
dir(foo)
-->['annotations', 'call', 'class',...]
inspect.getmembers(foo)
-->[
('annotations', {'a': <class 'int'>, 'b': <class 'str'>, 'return': <class 'int'>}),
('call', <method-wrapper 'call' of function object at 0x032C7B70>),
('class', <class 'function'>),
...]
复制代码
可以看到使用dir()仅仅获得一个字符串列表,而使用inspect.getmembers()可以获得每个属性的类型信息。
2.更高的类型检查
我们知道可以使用type(),isinstance()等内置函数进行类型检查,常用于基本数据类型或者对象实例的class判别,比如:
type(1)==int #比较数据类型
isinstance(cat,Cat) #比较对象实例是否属于某个类
复制代码
但如果要进行更"元"一点的类型比较呢?比如判断一个对象是否为一个模组,一个内置函数,一个生成器,甚至一个 await 表达式:
import inspect
inspect.ismodule(inspect) # 检查 inspect 是否为模组
True
inspect.ismethod(inspect) # 检查 inspect 是否为对象方法
False
inspect.isfunction(len) # 检查 len 是否为函数
True
inspect.isbuiltin(len) # 检查 len 是否为内置函数
True
inspect.isgenerator(inspect) # 检查 inspect 是否为生成器
False
inspect.isawaitable(inspect) # 检查 inspect 是否可用于 await 表达式
False
复制代码
因此,使用inspect.isXXX 方法可以进行更高级的类型判断。
3.操作函数参数签名
python3中新增了函数注解,提示作用大于 约束作用 (没有约束):
def foobar(a: int, b: "it's b", c: str = 5) -> tuple:
return a, b, c
复制代码
python原生有annotations属性用于获取函数注解:
foobar.annotations
{'a': int, 'b': "it's b", 'c': str, 'return': tuple}
复制代码
使用inspect模块同样可用获取到函数(callable)的参数信息。
inspect.signature 获取到函数参数的对象Signature,包括两个常用参数:
Signature.parameters 参数值的名字和类型
Signature.return_annotation 返回值类型
def foo(name, a: int, b: float):
... pass
...
sig = inspect.signature(foo)
sig
<Signature (name, a:int, b:float)>
str(sig)
'(name, a:int, b:float)'
sig.parameters
OrderedDict([('name', <Parameter "name">), ('a', <Parameter "a:int">), ('b', <Parameter "b:float">)])
复制代码
Signature.bind 将具体参数绑定到对象Signature上,获得BoundArguments对象(保存了参数信息)
args = ('foobar', 10)
kwargs = {'b': 23.4}
bound = sig.bind(*args, **kwargs) # bind args to signature parameters
bound
<BoundArguments (name='foobar', a=10, b=23.4)>
bound.arguments['name']
'foobar'
bound.arguments['a']
10
bound.arguments['b']
23.4
复制代码
综上,使用inspect可以将函数形参和实参封装为对象,对进一步操作具有意义。
4.受到钦定的类型检查实现
使用inspect获取到参数对象后,结合函数注解属性annotations,可以写一个很优雅的强制类型检查装饰器。
from functools import wraps
def checked(func):
ann=func.annotations
sig=inspect.signature(func)
@wraps(func)
def wrapper(args,kwargs):
bound=sig.bind(args,kwargs)
for k,v in bound.arguments.items():
if k in ann:
assert isinstance(v,ann[k]),f'Type Error Expected {ann[k]}'
return func(args,*kwargs)
return wrapper
@checked
... def add(a: int, b: int) -> int:
... while b:
... a, b = b, a % b
... return a
add(2.7, 3.6)
Traceback (most recent call last):
AssertionError: Type Error Expected <class 'int'>
add(27, 36)
9
sig = inspect.signature(foo)
>>> sig
<Signature (name, a:int, b:float)>
>>> str(sig)
'(name, a:int, b:float)'
>>> sig.parameters
OrderedDict([('name', <Parameter "name">), ('a', <Parameter "a:int">), ('b', <Parameter "b:float">)])
复制代码
Signature.bind 将具体参数绑定到对象Signature上,获得BoundArguments对象(保存了参数信息)
>>> args = ('foobar', 10)
>>> kwargs = {'b': 23.4}
>>> bound = sig.bind(args, kwargs) # bind args to signature parameters
>>> bound
<BoundArguments (name='foobar', a=10, b=23.4)>
>>> bound.arguments['name']
'foobar'
>>> bound.arguments['a']
10
>>> bound.arguments['b']
23.4
复制代码
综上,使用inspect可以将函数形参和实参封装为对象,对进一步操作具有意义。
4.受到钦定的类型检查实现
使用inspect获取到参数对象后,结合函数注解属性annotations,可以写一个很优雅的强制类型检查装饰器。
from functools import wraps
def checked(func):
ann=func.annotations
sig=inspect.signature(func)
@wraps(func)
def wrapper(args,kwargs):
bound=sig.bind(args,kwargs)
for k,v in bound.arguments.items():
if k in ann:
assert isinstance(v,ann[k]),f'Type Error Expected {ann[k]}'
return func(args,**kwargs)
return wrapper
>>> @checked
... def add(a: int, b: int) -> int:
... while b:
... a, b = b, a % b
... return a
>>> add(2.7, 3.6)
Traceback (most recent call last):
AssertionError: Type Error Expected <class 'int'>
>>> add(27, 36)
9
复制代码
综上,没有额外在装饰器参数中指明所需要检查类型,直接利用python自省的特性和inspect获取到函数的参数和类型要求,完成强制类型检查。