第051讲：函数（XI）- 函数文档、类型注释、内省

小古比鱼

本节讲了几个有趣的概念——首先是函数文档，也就是函数的说明书，只需使用字符串（三引号多行字符串）即可创建，写在函数最顶部，函数主体之前，可使用help()函数进行查看；其次是类型注释，也就是函数作者为函数参数类型及返回值类型写的提示，是函数作者的一种期望，可以违反，这也是Python 3为满足用户需求催生出的新特性，还可以使用第三方模块Mypy让Python帮忙真正做一下类型检测；最后是内省，也叫自省，是程序运行时进行自我检测的机制，通过一些特殊的属性来实现，如__name__获取函数名，__annotations__获取类型注释，__doc__获取函数文档等。总之，这些都是与函数息息相关的“冷知识”，在现实开发中常会用到。期待后续有关类、对象以及魔法方法的介绍！

fishcyou

函数文档：

1. def exchange(dollar, rate=6.5):
   
2.     """
   
3.     功能：汇率转换，美元 -> 人民币
   
4.     参数：
   
5.     - dollar 美元数量
   
6.     - rate 汇率，默认值是 6.5
   
7.     返回值：
   
8.     - 人民币的数量
   
9.     """
   
10.     return dollar * rate
    
11. 
    
12. help(exchange)
    
13. >>>
    
14. Help on function exchange in module __main__:
    
15. 
    
16. exchange(dollar, rate=6.5)
    
17.     功能：汇率转换，美元 -> 人民币
    
18.     参数：
    
19.     - dollar 美元数量
    
20.     - rate 汇率，默认值是 6.5
    
21.     返回值：
    
22.     - 人民币的数量
    
23. 
    
24. exchange(20)
    
25. >>>
    
26. 130.0

复制代码

内省也叫自省，是程序运行时进行自我检测的机制，通过一些特殊的属性来实现。
如果想获取我们之前定义的exchange函数文档：

1. print(exchange.__doc__)
   
2. 
   
3.     功能：汇率转换，美元 -> 人民币
   
4.     参数：
   
5.     - dollar 美元数量
   
6.     - rate 汇率，默认值是 6.5
   
7.     返回值：
   
8.     - 人民币的数量

复制代码

类型注释是给人看的，程序默认是不会检测的。

1. def times(s:list[int], n:int = 3) -> list:
   
2.     return s * n
   
3. 
   
4. times([1, 2, 3])
   
5. >>>
   
6. [1, 2, 3, 1, 2, 3, 1, 2, 3]
   
7. 
   
8. # :后面的为类型注释

复制代码

炎凉来寻

打卡

chenjinchao

卡打

墨墨在努力吖

>>> def times(s:list[int],n:int=2) -> list:
        return s*n

Traceback (most recent call last):
  File "<pyshell#40>", line 1, in <module>
    def times(s:list[int],n:int=2) -> list:
TypeError: 'type' object is not subscriptable
>>> def times(s:dict[str,int],n:int=2)->list:
        return list(s.keys())*n

Traceback (most recent call last):
  File "<pyshell#43>", line 1, in <module>
    def times(s:dict[str,int],n:int=2)->list:
TypeError: 'type' object is not subscriptable “类型对象不可下标”！！！

是因为版本太低吗？我现在用的是3.7.3

求解答

migu_sm1

Learning...3.10版一切正常.

lxping

打卡

andyleesh

打卡，本节理论和概念比较强，还可以