19、【翻译】模块inspect—Inspectliveobjects

翻译自Python官方文档 &＃xff1a; 29.12. inspect — Inspect live objects 

inspect—检查活动对象

inspect模块提供了几个有用的功能来帮助获取有关活动对象的信息&＃xff0c;例如模块&＃xff0c;类&＃xff0c;方法&＃xff0c;函数&＃xff0c;回溯&＃xff0c;框架对象和代码对象。 例如&＃xff0c;它可以帮助您检查类的内容&＃xff0c;检索方法的源代码&＃xff0c;提取并格式化函数的参数列表&＃xff0c;或者获取显示详细回溯所需的所有信息。

这个模块提供了四种主要的服务&＃xff1a;类型检查&＃xff0c;获取源代码&＃xff0c;检查类和函数以及检查解释器堆栈。

3、使用Signature对象来内省可调用对象

3.3版本的新功能。

Signature对象表示可调用对象的调用签名及其返回注释。 要获得Signature对象&＃xff0c;请使用signature&＃xff08;&＃xff09;函数。

inspect.signature(callable, *, follow_wrapped&＃61;True)

为给定的可调用对象返回一个Signature对象&＃xff1a;

接受各种各样的python callables&＃xff0c;从普通函数和类到functools.partial&＃xff08;&＃xff09;对象。

如果不提供签名&＃xff0c;则引发ValueError;如果不支持该类型的对象&＃xff0c;则引发TypeError。

3.5版新增&＃xff1a;follow_wrapped参数。 传递False以获得可调用对象的签名&＃xff08;callable.__wrapped__ 不会用于打开装饰的可调用对象&＃xff09;。

注意&＃xff1a;在Python的某些实现中&＃xff0c;某些可调用对象可能不是内省的。 例如&＃xff0c;在CPython中&＃xff0c;C中定义的一些内置函数不提供关于它们参数的元数据。

class inspect.Signature(parameters&＃61;None, *, return_annotation&＃61;Signature.empty)

Signature对象代表一个函数的调用签名及其返回注释。对于函数接受的每个参数&＃xff0c;它在其参数集合中存储了一个参数对象。

可选的parameters参数是一系列Parameter对象的序列&＃xff0c;这些参数要经过检验&＃xff0c;以此来保证没有重名的参数&＃xff0c;并且参数的顺序是正确的&＃xff08;例如&＃xff1a;首先是positional-only&＃xff0c;然后是positional-or-keyword&＃xff09;&＃xff0c;以及没有默认值的参数在前&＃xff0c;有默认值的在后。

可选的return_annotation参数可以是任意的Python对象&＃xff0c;值是可调用对象的“返回”注释。

Signature对象是不可变的。 使用Signature.replace&＃xff08;&＃xff09;获得修改后的副本。

在版本3.5中更改&＃xff1a;签名对象是可挑选和可排序的。

empty

　　一种特殊的级别标记&＃xff0c;用于指定缺少返回注释。

parameters

　　参数名称到相应Parameter对象的有序映射。

return_annotation

　　可调用对象的“返回”注释。 如果可调用对象没有“返回”注释&＃xff0c;则此属性设置为Signature.empty。

bind(*args, **kwargs)

　　创建一个从positional和keyword参数到parameters的映射。 如果* args和** kwargs匹配signature&＃xff0c;则返回BoundArguments&＃xff0c;否则引发TypeError。

bind_partial(*args, **kwargs)

　　与Signature.bind&＃xff08;&＃xff09;的工作方式相同&＃xff0c;但允许省略一些必需的参数&＃xff08;模仿functools.partial&＃xff08;&＃xff09;行为&＃xff09;。返回BoundArguments&＃xff0c;如果传入的参数与签名不匹配&＃xff0c;则会引发TypeError。

replace(*[, parameters][, return_annotation])

　　根据调用的replace实例创建新的Signature实例。 可以传递不同的参数&＃xff08;和/或&＃xff09;return_annotation来重写基本签名的相应属性。 要从复制的Signature中删除return_annotation&＃xff0c;请传入Signature.empty。

classmethod from_callable(obj, *, follow_wrapped&＃61;True)

　　为给定的可调用对象返回一个Signature&＃xff08;或其子类&＃xff09;对象。传递follow_wrapped &＃61; False获取对象的签名而不打开其__wrapped__链。该方法简化了Signature的子类化&＃xff1a;

class inspect.Parameter(name, kind, *, default&＃61;Parameter.empty, annotation&＃61;Parameter.empty)

Parameter对象是不可变的。 您可以使用Parameter.replace&＃xff08;&＃xff09;创建修改的副本&＃xff0c;而不是修改Parameter对象。

在版本3.5中更改&＃xff1a;Parameter 对象是可选择的并且可哈希的。

empty

　　一种特殊的级别标记&＃xff0c;用于指定默认值和注释的缺失。

name

　　parameter的名称是字符串。 该名称必须是有效的Python标识符。

　　CPython实现细节&＃xff1a;CPython在用于实现理解和生成器表达式的代码对象上生成形式为.0的隐式参数名称。

　　在版本3.6中进行了更改&＃xff1a;这些参数名称由此模块公开为像隐式0这样的名称。

default

　　参数的默认值。 如果该参数没有默认值&＃xff0c;则该属性设置为Parameter.empty。

annotation

　　参数的注释。 如果该参数没有注释&＃xff0c;则该属性设置为Parameter.empty。

kind

　　描述参数值如何绑定到parameter。 可能的值&＃xff08;可通过Parameter访问&＃xff0c;如Parameter.KEYWORD_ONLY&＃xff09;&＃xff1a;

　　POSITIONAL_ONLY

　　　　该值必须作为positional参数提供。Python没有明确的定义positional参数的语法&＃xff0c;但是许多内置和扩展模块函数&＃xff08;特别是只接受一个或两个参数的函数&＃xff09;接受它们。

　　POSITIONAL_OR_KEYWORD

　　　　值可以作为关键字或positional参数提供&＃xff08;这是用Python实现的函数的标准绑定行为。&＃xff09;

　　VAR_POSITIONAL

　　　　没有绑定到任何其他parameter的positional参数的元组。 这对应于Python函数定义中的* args参数。

　　KEYWORD_ONLY

　　　　值必须作为关键字参数提供。 关键字参数是仅仅在Python函数定义中的*或* args条目之后出现的参数。

　　VAR_KEYWORD

　　　　没有绑定到任何其他parameter的关键字参数的字典。 这对应于Python函数定义中的** kwargs参数。

　　例如&＃xff1a;打印没有默认值的所有关键字参数&＃xff1a;