04-函数参数和文档

关键字参数

• 语法

    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("xiaoming", 18, "北京", "hobby", "eat")

收集参数之关键字收集参数

• 把关键字参数按字典格式存入收集参数

• 语法：

    def func( **kwargs):
        func_body
  
    # 调用：
    func(p1=v1, p2=v2, p3=v3........)

  • kwargs一般约定俗成
  • 调用的时候，把多余的关键字参数放入kwargs
  • 访问kwargs需要按字典格式访问

# 收集参数代码
# 函数模拟一个学生进行自我介绍，但具体内容不清楚
# args把他看做一个list
def stu( *args):
    print("Hello 大家好，我自我介绍以下，简答说两句：")
    # type函数作用是检测变量的类型
    print(type(args))
    for item in args:
        print(item)


stu("xiaoming", 19, "北京", "hobby", "eat")


Hello 大家好，我先自我介绍一下：
<class 'dict'>
name --- xiaoming
age --- 19
addr --- 北京
hobby --- eat

收集参数混合调用的顺序问题

• 收集参数，关键字参数，普通参数可以混合使用
• 使用规则就是，普通参数和关键字参数优先
• 定义的时候一般找普通参数，关键字参数，收集参数tuple，收集参数dict

收集参数的解包问题

• 把参数放入list或者字典中，直接把list/dict中的值放入收集参数中

# 收集参数的解包问题

def stu(*args):
    for i in args:
        print(i)
        
stu("liuying", "liuxiaoyhing", 19, 200)

liuying
liuxiaoyhing
19
200

返回值

• 函数和过程的区别
  • 有无返回值
• 需要用return显示返回内容，
• 如果没有返回，则默认返回None
• 推荐写法，无论有无返回值，最后都要以return 结束

函数文档

• 函数的文档的作用是对当前函数提供使用相关的参考信息
• 文档的写法：
  • 在函数内部开始的第一行使用三引号字符串定义符
  • 一般具有特定格式
  • 参看案例
• 文档查看
  • 使用help函数，形如 help(func)
  • 使用doc, 参看案例

def stu(name, age):
    '''
    这是文档的文字内容
    :param name: 表示学生的姓名
    :param age: 表示学生的年龄
    :return: 此函数没有返回值
    '''
    pass


print(stu.__doc__)


这是文档的文字内容
    :param name: 表示学生的姓名
    :param age: 表示学生的年龄
    :return: 此函数没有返回值