19、【翻译】模块inspect — Inspect live objects

翻译自Python官方文档 : 29.12. inspect — Inspect live objects 

inspect—检查活动对象

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

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

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

3.3版本的新功能。

Signature对象表示可调用对象的调用签名及其返回注释。 要获得Signature对象,请使用signature()函数。

inspect.signature(callable, *, follow_wrapped=True)

为给定的可调用对象返回一个Signature对象:

>>> from inspect import signature
>>> def foo(a, *, b:int, **kwargs):
...     pass

>>> sig = signature(foo)

>>> str(sig)
'(a, *, b:int, **kwargs)'

>>> str(sig.parameters['b'])
'b:int'

>>> sig.parameters['b'].annotation
<class 'int'>

接受各种各样的python callables,从普通函数和类到functools.partial()对象。

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

3.5版新增:follow_wrapped参数。 传递False以获得可调用对象的签名(callable.__wrapped__ 不会用于打开装饰的可调用对象)。

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

 

class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)

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

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

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

Signature对象是不可变的。 使用Signature.replace()获得修改后的副本。

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

empty

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

parameters

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

return_annotation

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

bind(*args**kwargs)

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

bind_partial(*args**kwargs)

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

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

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

>>> def test(a, b):
...     pass
>>> sig = signature(test)
>>> new_sig = sig.replace(return_annotation="new return anno")
>>> str(new_sig)
"(a, b) -> 'new return anno'"

classmethod from_callable(obj*follow_wrapped=True)

  为给定的可调用对象返回一个Signature(或其子类)对象。传递follow_wrapped = False获取对象的签名而不打开其__wrapped__链。该方法简化了Signature的子类化:

class MySignature(Signature):
    pass
sig = MySignature.from_callable(min)
assert isinstance(sig, MySignature)

class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)

Parameter对象是不可变的。 您可以使用Parameter.replace()创建修改的副本,而不是修改Parameter对象。

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

empty

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

name

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

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

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

default

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

annotation

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

kind

  描述参数值如何绑定到parameter。 可能的值(可通过Parameter访问,如Parameter.KEYWORD_ONLY):

  POSITIONAL_ONLY

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

  POSITIONAL_OR_KEYWORD

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

  VAR_POSITIONAL

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

  KEYWORD_ONLY

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

  VAR_KEYWORD

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

  例如:打印没有默认值的所有关键字参数:

>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     if (param.kind == param.KEYWORD_ONLY and
...                        param.default is param.empty):
...         print('Parameter:', param)
Parameter: c
原文地址:https://www.cnblogs.com/zwb8848happy/p/8849999.html