【Python随笔】如何提取python函数的接口定义信息

我们可以看到里面的一些关键属性：

• __name__：函数名字。
• __qualname__：函数的合法名称
  • 比如在class A中定义一个函数f，那么A.f.__name__是f，而A.f.__qualname__是A.f
• __doc__：函数注释文本
• __annotations__：函数参数注释信息
  • 一般开发时候注释信息都是参数名以及对应的数据类型，因此有了这个就可以对函数的入参进行合法校验。当然，明显也利好一些IoC机制的底层开发的需求。
  • 返回值对应的数据类型，可以在return这个key下找
• __defaults__：位置参数/非强制关键字参数的默认值的tuple
• __kwdefaults__：强制关键字参数的默认值的dict
• __module__：函数所属的模块
• __code__：函数所包含的代码段对象

除了通过dir的方式获取这些关键属性之外，通过inspect库的getmembers函数也可以实现类似的效果。对于inspect库的用法，可以参考官方文档。

在上述的__annotations__属性中，我们能够提取到标注的参数数据结构类型。对于str、int这种一般型数据就直接标注对应的类型；而对于一些泛型则需要标注为typing，比如说typing.Dict、typing.Any等等。

针对typing的用法，可以参考官方文档。不过本文计划进一步探索typing对象的相关信息。

我们用一段代码就能粗略对typing的各类对象信息看个明白：

print('typing.Dict:')
dtype = typing.Dict[str, typing.Union[
    typing.List[int],
    typing.Tuple[bool, str],
    typing.Callable[[float, int], typing.NoReturn]
]]
pprint.pprint(dtype.__dict__)
print('typing.Union:')
utype = dtype.__dict__['__args__'][1]
pprint.pprint(utype.__dict__)
print('typing.List:')
ltype = utype.__dict__['__args__'][0]
pprint.pprint(ltype.__dict__)
print('typing.Tuple:')
ttype = utype.__dict__['__args__'][1]
pprint.pprint(ttype.__dict__)
print('typing.Callable:')
ftype = utype.__dict__['__args__'][2]
pprint.pprint(ftype.__dict__)
print('typing.NoReturn:')
norettype = ftype.__dict__['__args__'][-1]
print(norettype._name)
print(isinstance(norettype, typing._SpecialForm))

输出结果：

typing.Dict:
{'__args__': (,
              typing.Union[typing.List[int], typing.Tuple[bool, str], typing.Callable[[float, int], typing.NoReturn]]),
 '__origin__': ,
 '__parameters__': (),
 '__slots__': None,
 '_inst': False,
 '_name': 'Dict'}
typing.Union:
{'__args__': (typing.List[int],
              typing.Tuple[bool, str],
              typing.Callable[[float, int], typing.NoReturn]),
 '__module__': 'typing',
 '__origin__': typing.Union,
 '__parameters__': (),
 '__slots__': None,
 '_inst': True,
 '_name': None}
typing.List:
{'__args__': (,),
 '__origin__': ,
 '__parameters__': (),
 '__slots__': None,
 '_inst': False,
 '_name': 'List'}
typing.Tuple:
{'__args__': (, ),
 '__origin__': ,
 '__parameters__': (),
 '__slots__': None,
 '_inst': False,
 '_name': 'Tuple'}
typing.Callable:
{'__args__': (, , typing.NoReturn),
 '__origin__': ,
 '__parameters__': (),
 '__slots__': None,
 '_inst': True,
 '_name': 'Callable'}
typing.NoReturn:
NoReturn
True

对于一些容器类型的对象，通过__dict__['__args__']就能够获得里面的数据类型标注，从而对容器对象合法性进行检查。对于一些隶属于typing._SpecialForm的对象，比如Any、NoReturn等，可以通过_name属性来判断具体是哪个。

code对象（函数的函数体）的信息，从上面的属性导出情况可知，我们可以通过__code__来获取函数的函数体对象。

通过dir或者inspect等方式，可以导出code对象的属性：

codeobj = myprinter.__code__
pprint.pprint(objdict(codeobj))

打印结果是：

{'__class__': ,
 '__delattr__': ,
 '__dir__': [忽略],
 '__doc__': 'code(argcount, posonlyargcount, kwonlyargcount, nlocals, '
            'stacksize,n'
            '      flags, codestring, constants, names, varnames, filename, '
            'name,n'
            '      firstlineno, lnotab[, freevars[, cellvars]])n'
            'n'
            'Create a code object.  Not for the faint of heart.',
 '__eq__': ,
 '__format__': ,
 '__ge__': ,
 '__getattribute__': ,
 '__gt__': ,
 '__hash__': -7836529936335626281,
 '__init__': None,
 '__init_subclass__': None,
 '__le__': ,
 '__lt__': ,
 '__ne__': ,
 '__new__': ,
 '__reduce__': ,
 '__reduce_ex__': ,
 '__repr__': '',
 '__setattr__': ,
 '__sizeof__': 176,
 '__str__': '',
 '__subclasshook__': NotImplemented,
 'co_argcount': 2,
 'co_cellvars': (),
 'co_code': b'tx00|x02x83x01|x00x17x00|x01x17x00}x03tx01|x03'
            b'dx01dx02x8dx02x01x00dx03|x03fx02Sx00',
 'co_consts': ('hello world', '', ('end',), True),
 'co_filename': 'H:\Projects\Python\playground\datastruct\functionobj.py',
 'co_firstlineno': 12,
 'co_flags': 67,
 'co_freevars': (),
 'co_kwonlyargcount': 1,
 'co_lnotab': b'x00x02x10x01x0cx01',
 'co_name': 'myprinter',
 'co_names': ('str', 'print'),
 'co_nlocals': 4,
 'co_posonlyargcount': 1,
 'co_stacksize': 4,
 'co_varnames': ('s', 'e', 'prefix', 'msg'),
 'replace': }