Python系统学习笔记5（函数：四类参数、参数解包、返回值、函数文档的写法和查看）

函数

• 代码的一种组织形式
• 一个函数一般完成一项特定的功能
• 函数使用
  • 函数需要先定义
  • 使用函数，俗称调用

# 定义一个函数
# 只是定义的话不会执行
# 1. def关键字，后跟一个空格
# 2.自定义函数名，推荐小驼峰命名，大驼峰命名只给类用
# 3. 后面括号和冒号不能省，括号内可以由参数
# 4. 函数内所有代码缩进

def func():
    print("我是一个函数")
    print("我要完成一定功能")
print("我结束了")

函数的参数和返回值

1. 参数： 负责给函数传递一些必要的数据或者信息

   • 形参（形式参数）： 在函数定义的时候用到的参数没有具体值，只是一个占位的符号，成为形参
   • 实参（实际参数）： 在调用函数的时候输入的值

2. 返回值： 函数的执行结果

   • 使用return关键字
   • 如果没有return，默认返回一个None
   • 函数一旦执行return语句，则无条件返回，即结束函数的执行

3. 查找函数帮助文档

# 1. 用help函数
help(print)

参数详解

• 参考资料
• python参考资料： headfirst python -> 零基础入门学习python（小甲鱼),本讲义参考的是流畅的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 = "jiangliwen"
a = 22
addr = "我家"

#普通参数调用
stu(n, a, addr)

def stu_key(name="NoName", age=0, addr="NoAddress"):
    print("I am a student.")
    print("My name is {0}, and I am {1} years old, I live in {2}.".format(name, age, addr))

#关键字参数调用
stu_key(age=22, name="jiangliwen", addr="guilin")
stu_key()

收集参数

• 语法

    def func(*args):
        func_body
        按照list使用方式访问args得到传入的参数
        
    调用：
    func(p1, p2, p3, .....)
  

• 把没有位置，不能和定义时的参数位置相对应的参数，放入一个特定的数据结构中

• 参数名args不是必须这么写，但是，我们推荐直接用args，约定俗成

• 参数名args前需要有星号*

• 收集参数可以和其他参数共存

#收集参数
def stu(*args):
    print(type(args))
    for item in args:
        print(item)
        
stu("jiangliwen", 22, "guilin", "student")
stu()# 说明收集参数可以不带任何实参调用，此时收集参数为空tuple

# 如果使用关键字参数格式调用，会出现问题
stu(name="liuying")

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

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

• 语法：

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

• kwargs一般约定俗成

• 调用的时候，把多余的关键字参数放入kwargs

• 访问kwargs需要按字典格式访问

#收集关键字参数
def stu_key(**kwargs):
    print(type(kwargs))
    for k,v in kwargs.items():
        print(k, "-------", v)
 
stu_key(name="jiangliwen", age=22, home="guilin", work="student")
stu_key()# 收集参数可以为空案例

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

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

#收集参数混和调用问题
#stu模拟一个学生的自我介绍
def stu(name, age, *args, hobby="None", **kwargs):
    print("大家好")
    print("我叫{0}，今年{1}岁。".format(name, age))
    if hobby == "None":
        print("我没有爱好")
    else:
        print("我的爱好是{0}。".format(hobby))
    print("-"*50)
    
    for item in args:
        print(item)
    print("-"*50)
    
    for k,v in kwargs.items():  #注意是kwargs.items()，不是kwargs
        print(k, "---------", v)

#调用函数
name = "jiagliwen"
age = 22

stu(name, age)
stu(name, age, hobby="中国象棋")
stu(name, age, "棋萌咖", "象棋小王子", hobby="中国象棋",home="guilin", work="student")

收集参数的解包问题

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

#收集参数的解包问题
def stu(*args):
    print(type(args))
    for i in args:
        print(i,type(i))
        
l = ["jiangliwen", 22, "guilin", "student"]

# 此时，args的表示形式是字典内一个list类型的元素，即 arg = (["liuying", 19, 23, "wangxiaojing"],)
stu(l)

print("-"*80)#此为分隔符

# 此时的调用，我们就需要解包符号，即调用的时候前面加一个星号
stu(*l)

同理，dict类型收集参数一样可以解包，但是

• 对dict类型进行解包，需要用两个星号进行解包

返回值

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

# 返回值示例

def func_1():
    print("有返回值呀")
    return 1

def func_2():
    print("没有返回值")
     
    
f1 = func_1()
print(f1)

f2 = func_2()
print(f2)

函数文档的编写和查看

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

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


print(help(stu))# 查看函数文档，并打印返回值

print("*" * 20)

print(stu.__doc__)# 查看函数文档