Python-函数参数和文档
四类参数
- 普通参数
- 默认参数
- 关键字参数
- 收集参数
关键字参数开始
-
语法
def func(p1=v1, p2=v2.....): func_body 调用函数: func(p1=value1, p2=value2.......)
-
比较麻烦,但也有好处:
- 不容易混淆, 一般实参和形参只是按照位置一一对应即可,容易出错
- 使用关键字参数,可以不考虑参数位置
# 关键字参数案例 def stu(name, age, addr): print("I am a student") print("我叫 {0}, 我今年 {1}岁了, 我住{2}".format(name, age, addr)) n = "jingjing" a = 18 addr = "我家" # 普通参数,只按照位置传递,容易出错 stu(a, n, addr) def stu_key(name="No name", age=0, addr="No addr"): print("I am a student") print("我叫 {0}, 我今年 {1}岁了, 我住{2}".format(name, age, addr)) n = "jingjing" a = 18 addr = "我家" # 普通参数,只按照位置传递,容易出错 stu_key(age=a, name=n, addr=addr) 输出结果如下: I am a student 我叫 18, 我今年 jingjing岁了, 我住我家 I am a student 我叫 jingjing, 我今年 18岁了, 我住我家
收集参数
-
把没有位置,不能和定义时的参数位置相对应的参数,放入一个特定的数据结构中
-
语法
def func(*args): func_body 按照list使用方式访问args得到传入的参数 调用: func(p1, p2, p3, .....)
-
参数名args不是必须这么写,但是,我们推荐直接用args,约定俗成
-
参数名args前需要由星号
-
收集参数可以和其他参数共存
# 收集参数代码 # 函数模拟一个学生进行自我介绍,但具体内容不清楚 # args把他看做一个list def stu( *args): print("Hello 大家好,我自我介绍以下,简答说两句:") # type函数作用是检测变量的类型 print(type(args)) for item in args: print(item) stu("liuying", 18, "北京大通州区", "wangxiaojing", "single") stu("周大神") 输出结果如下: Hello 大家好,我自我介绍以下,简答说两句: <class 'tuple'> liuying 18 北京大通州区 wangxiaojing single Hello 大家好,我自我介绍以下,简答说两句: <class 'tuple'> 周大神
# 收集参数案例 # 说明收集参数可以不带任何实参调用,此时收集参数为空tuple stu() 输出结果如下: Hello 大家好,我自我介绍以下,简答说两句: <class 'tuple'>
# 如果使用关键字参数格式调用,会出现问题 stu(name="liuying") 输出结果如下: --------------------------------------------------------------------------- TypeError Traceback (most recent call last) <ipython-input-12-b698f7b62960> in <module>() 1 # 如果使用关键字参数格式调用,会出现问题 ----> 2 stu(name="liuying") TypeError: stu() got an unexpected keyword argument 'name'
收集参数之关键字收集参数
-
把关键字参数按字典格式存入收集参数
-
语法:
def func( **kwargs): func_body # 调用: func(p1=v1, p2=v2, p3=v3........)
- kwargs一般约定俗成
- 调用的时候,把多余的关键字参数放入kwargs
- 访问kwargs需要按字典格式访问
# 收集参数案例 # 自我介绍 # 调用的时候需要使用关键字参数调用 def stu( **kwargs): # 在函数体内对于kwargs的使用不用带星号 print("Hello 大家好,我先自我介绍一下:") print(type(kwargs)) # 对于字典的访问,python2 和python3有区别 for k,v in kwargs.items(): print(k, "---", v) stu(name="liuying", age=19, addr="北京大通州区", lover="王晓静", work="Teacher") print("*" * 50) stu(name="周大神") 输出结果如下: Hello 大家好,我先自我介绍一下: <class 'dict'> name --- liuying age --- 19 addr --- 北京大通州区 lover --- 王晓静 work --- Teacher ************************************************** Hello 大家好,我先自我介绍一下: <class 'dict'> name --- 周大神 # 收集参数可以为空案例 stu() 输出结果如下: Hello 大家好,我先自我介绍一下: <class 'dict'>
收集参数混合调用的顺序问题
- 收集参数,关键字参数,普通参数可以混合使用
- 使用规则就是,普通参数和关键字参数优先
- 定义的时候一般找普通参数,关键字参数,收集参数tuple,收集参数dict
# 收集参数混合调用案例 # stu模拟一个学生的自我介绍 def stu(name, age, *args, hobby="没有", **kwargs): print("Hello 大家好") print("我叫 {0}, 我今年{1}大了。".format(name, age)) if hobby == "没有": print("我没有爱好, so sorry") else: print("我的爱好是{0}".format(hobby)) print("*" * 20) for i in args: print(i) print("#" * 30) for k,v in kwargs.items(): print(k, "---", v) # 开始调用函数 name = "liuying" age = 19 # 调用的不同格式 stu(name, age) stu(name, age, hobby="游泳") stu(name, age, "王晓静", "刘石头", hobby="游泳", hobby2="烹饪", hobby3="跟不同女生聊天") 输出结果如下: Hello 大家好 我叫 liuying, 我今年19大了。 我没有爱好, so sorry ******************** ############################## Hello 大家好 我叫 liuying, 我今年19大了。 我的爱好是游泳 ******************** ############################## Hello 大家好 我叫 liuying, 我今年19大了。 我的爱好是游泳 ******************** 王晓静 刘石头 ############################## hobby2 --- 烹饪 hobby3 --- 跟不同女生聊天
收集参数的解包问题
- 把参数放入list或者字典中,直接把list/dict中的值放入收集参数中
- 语法:参看案例
# 收集参数的解包问题 def stu(*args): print("哈哈哈哈哈") # n 用来表示循环次数 # 主要用来调试 n = 0 for i in args: print(type(i)) print(n) n += 1 print(i) #stu("liuying", "liuxiaoyhing", 19, 200) l = ["liuying", 19, 23, "wangxiaojing"] #stu(l) # 此时,args的表示形式是字典内一个list类型的元素,即 arg = (["liuying", 19, 23, "wangxiaojing"],) # 很显然跟我们最初的想法违背 # 此时的调用,我们就需要解包符号,即调用的时候前面加一个星号 stu(*l) 输出结果如下: 哈哈哈哈哈 <class 'str'> 0 liuying <class 'int'> 1 19 <class 'int'> 2 23 <class 'str'> 3 wangxiaojing
同理,dict类型收集参数一样可以解包,但是
- 对dict类型进行解包
- 需要用两个星号进行解包
返回值
- 函数和过程的区别
- 有无返回值
- 需要用return显示返回内容,
- 如果没有返回,则默认返回None
- 推荐写法,无论有无返回值,最后都要以return 结束
# 返回值示例 def func_1(): print("有返回值呀") return 1 def func_2(): print("没有返回值") f1 = func_1() print(f1) f2 = func_2() print(f2) 输出结果如下: 有返回值呀 1 没有返回值 None
函数文档
- 函数的文档的作用是对当前函数提供使用相关的参考信息
- 文档的写法:
- 在函数内部开始的第一行使用三引号字符串定义符
- 一般具有特定格式
- 参看案例
- 文档查看
- 使用help函数,形如 help(func)
- 使用doc, 参看案例
# 文档案例 # 函数stu是模拟一个学生的自我介绍的内容 def stu(name, age, *args): ''' 这是第一行 这是第二行 这是第三行 ''' print("This is hanshu stu") # 查看函数文档 help(stu) stu.__doc__ 输出结果如下: Help on function stu in module __main__: stu(name, age, *args) 这是第一行 这是第二行 这是第三行 '\n 这是第一行\n 这是第二行\n 这是第三行\n '
def stu(name, age): ''' 这是文档的文字内容 :param name: 表示学生的姓名 :param age: 表示学生的年龄 :return: 此函数没有返回值 ''' pass print(help(stu)) print("*" * 20) print(stu.__doc__) 输出结果如下: Help on function stu in module __main__: stu(name, age) 这是文档的文字内容 :param name: 表示学生的姓名 :param age: 表示学生的年龄 :return: 此函数没有返回值 None ******************** 这是文档的文字内容 :param name: 表示学生的姓名 :param age: 表示学生的年龄 :return: 此函数没有返回值