《流畅的Python》5.8,5.9 获取关于参数的信息和函数注解 总结

1，理解param.kind含义：给形参传递参数的方式，是位置传递，还是关键字传递

2，框架可以使用bind方法在真正调用函数前验证参数；

框架和IDE等工具可以使用这些信息验证代码；

注解只是元数据，可以供IDE、框架和装饰器等工具使用。

 

3，执行下面语句可以得到一个signature对象，

import inspect

sig = inspect.signature(func)

sig.parameters属性
for name, param in sig.parameters.items():
    pass


sig.return_annotation属性

sig.bind(实参).arguments属性
for name, value in sig.bind(实参).arguments属性.items():
    pass

 

 

 

 

 

def clip(text,  max_len = 80):
    end = None
    if len(text) > max_len:
        space_before = text.rfind(" ", 0, max_len)
        if space_before >= 0 :
            end = space_before
        else:
            space_after = text.rfind(" ", max_len)
        
        if space_after >= 0:
            end = space_after
        
        if end is None:
            end = len(text)
            
    return text[:end].rstrip(" ")



# print(clip.__defaults__)
# print(clip.__kwdefaults__)

# a = clip.__code__.co_varnames
# print(a)
# print(type(a))
# print(clip.__code__.co_argcount)


#和上面clip函数唯一的区别是参数中添加了/, *
def clip1(text, /,*,max_len = 80):
    pass



#测试函数注解，即声明函数的类型，返回值的类型
def clip2(text : str,  max_len:'int >0' = 80) -> str:
    pass

 

 

 

 

from inspect import signature
from clip import clip, clip1, clip2

sig = signature(clip)
sig1 = signature(clip1)
print(sig)
print(str(sig))
print("sig.parameters:\n",sig.parameters, '\n')
print('sig.parameters.items():\n',sig.parameters.items(), '\n')
print('sig.parameters.keys():\n',sig.parameters.keys(), '\n')
print('sig.parameters.values():\n',sig.parameters.values(), '\n')

for i in sig.parameters.values():
    print("parameter对象类型：",type(i))    #<class 'inspect.Parameter'>
print(" ")


#以下两种对比param.kind返回值
print("clip函数的param.kind值：")
for name, param in sig.parameters.items():
    print(param.kind, ':', name,"=", param.default ,',',param.annotation  )


print("\nclip1函数的param.kind值：")

for name1, param1 in sig1.parameters.items():
    print(param1.kind , ':', name ,"=", param1.default  )
    
print('\n查看各函数的参数的声明，即注解：')
print(clip.__annotations__) 
print(clip1.__annotations__) 
print(clip2.__annotations__) # {'text': <class 'str'>, 'max_len': 'int >0', 'return': <class 'str'>}


print("\n返回值的注解：")
sig2 = signature(clip2)
print(sig2.return_annotation)


print("\n对比两种 ")
for param in sig2.parameters.values():
   #示例使用的是note形式，学习这种方法
    note = repr(param.annotation).ljust(13)
    note1 = param.annotation
    print(type(note1))
    print(note, ':', param.name, '=', param.default)
    print(note1, ':', param.name, '=', param.default)
    
    
    

 

 

从运行结果可以看到，

clip函数中的text和max_len参数可以通过POSITIONAL_OR_KEYWORD传递实参；

而clip1函数中text只能通过POSITIONAL_ONLY传递实参，而max_len只能通过KEYWORD_ONLY传递实参；

 

 

 

下面例子还使用了bind方法，

#注意：传值给可变参数*content时，一定不要带上content=什么什么，如果带上content，则会被attrs捕获当成字典
def tag(name,  *content,  cls=None, **attrs):
    #注意：传值给可变参数*content时，一定不要带上content=什么什么，如果带上content，则会被attrs捕获当成字典
    print('name:',name, ',','content:', content, ',','cls:', cls,',','attrs:', attrs)
    """生成一个或多个HTML标签"""
    if cls is not None:
        attrs['class'] = cls
  
    if attrs:
        attr_str = ' '.join('%s="%s"'%(attr, value)  for attr, value  in sorted(attrs.items()))
    else:
        attr_str = ''

    if content:
        return '\n'.join('<%s %s>%s</%s>'%
                         (name, attr_str, c, name) for c in content)
    else:
        return '<%s %s />'%(name, attr_str)




#为了查看param.kind所有值，添加了city参数
def tag1(name,/, city, *content,  cls=None, **attrs):
    pass



print(tag('br'), '\n')

print(tag('p', 'hello'), '\n')

print(tag('p', 'hello', 'world'), '\n')

print(tag('p', 'hello', id=33), '\n')

print(tag('p', 'hello', 'world', cls='sidebar'), '\n')

print(tag(content='testing', name="img"), '\n')
#即使名字和可变参数名*content相同，也会被attrs捕获

my_tag = {'name': 'img', 'title': 'Sunset Boulevard',
      'src': 'sunset.jpg', 'cls': 'framed' }
print(tag(**my_tag), '\n')


print("下面测试 inspect模块：")


import inspect

sig = inspect.signature(tag)
sig1 = inspect.signature(tag1)

print(sig)
print(sig.parameters)

print('\ntag函数中各参数传递实参的方式：')
for _, param in sig.parameters.items():
    print(param.kind )

print('\ntag1函数中各参数传递实参的方式：')
for _, param1 in sig.parameters.items():
    print(param1.kind)



my_tag2 = {'name': 'img', 'title': 'Sunset Boulevard',
      'src': 'sunset.jpg', 'cls': 'framed' }

#通过bind方法传递实参
bound_args = sig.bind(**my_tag2)  
print(bound_args)
print(bound_args.arguments)

# print(type(bound_args.arguments)) 

for name, value in bound_args.arguments.items():
    print(name, '=', value)