python3 第十六章 - 函数

函数是组织好的，可重复使用的，用来实现单一，或相关联功能的代码段。
函数能提高应用的模块性，和代码的重复利用率。你已经知道Python提供了许多内建函数，比如print()。但你也可以自己创建函数，这被叫做用户自定义函数。

1、语法

Python 定义函数使用 def 关键字，一般格式如下：

def 函数名（参数列表）:
    函数体

默认情况下，参数值和参数名称是按函数声明中定义的的顺序匹配起来的。

定义一个由自己想要功能的函数，以下是简单的规则：

• 函数代码块以 def 关键词开头，后接函数标识符名称和圆括号 ()。
• 任何传入参数和自变量必须放在圆括号中间，圆括号之间可以用于定义参数。
• 函数的第一行语句可以选择性地使用文档字符串——用于存放函数说明。
• 函数内容以冒号起始，并且缩进。
• return [表达式] 结束函数，选择性地返回一个值给调用方。不带表达式的return相当于返回 None。

实例：

def hello():
    return 'Hello world'

def say(msg):
    print(msg)

def sun(num1, num2):
    print('num1 + num2 =', num1, num2)

2、函数调用

Python内置了很多有用的函数，我们可以直接调用。要调用一个函数，需要知道函数的名称和参数，比如求绝对值的函数abs，只有一个参数：

print('100的绝对值：', abs(100))
print('-20的绝对值：', abs(-20))

以上代码，输出：

100的绝对值： 100
-20的绝对值： 20

定义一个函数：给了函数一个名称，指定了函数里包含的参数，和代码块结构。
这个函数的基本结构完成以后，你可以通过另一个函数调用执行，也可以直接从 Python 命令提示符执行。

3、参数传递 

在 python 中，类型属于对象，变量是没有类型的：

a=[1,2,3]

a="Python"

以上代码中，[1,2,3] 是 List 类型，"Python" 是 String 类型，而变量 a 是没有类型，它仅仅是一个对象的引用（一个指针），可以是 List 类型对象，也可以指向 String 类型对象。

python 函数的参数传递：

• 不可变类型：类似 c++ 的值传递，如 整数、字符串、元组。如fun（a），传递的只是a的值，没有影响a对象本身。比如在 fun（a）内部修改 a 的值，只是修改另一个复制的对象，不会影响 a 本身。
• 可变类型：类似 c++ 的引用传递，如 列表，字典。如 fun（la），则是将 la 真正的传过去，修改后fun外部的la也会受影响

python 中一切都是对象，严格意义我们不能说值传递还是引用传递，我们应该说传不可变对象和传可变对象。

什么是可更改(mutable)与不可更改(immutable)对象？

在 python 中，str, tuple, 和 number 是不可更改的对象，而 list,dict 等则是可以修改的对象。例如：

不可变类型：变量赋值 a=5 后再赋值 a=10，这里实际是新生成一个 int 值对象 10，再让 a 指向它，而 5 被丢弃，不是改变a的值，相当于新生成了a。

可变类型：变量赋值 la=[1,2,3,4] 后再赋值 la[2]=5 则是将 list la 的第三个元素值更改，本身la没有动，只是其内部的一部分值被修改了。

不可变对象在函数里修改了参数，原始的参数是不会改变的。例如：

def ChangeInt(a):
    a = 10

b = 2
ChangeInt(b)
print(b) # 结果是 2

实例中有 int 对象 2，指向它的变量是 b，在传递给 ChangeInt 函数时，按传值的方式复制了变量 b，a 和 b 都指向了同一个 Int 对象，在 a=10 时，则新生成一个 int 值对象 10，并让 a 指向它。

可变对象在函数里修改了参数，那么原始的参数也被改变了。例如：

# 可写函数说明
def changeme(mylist):
    "修改传入的列表"
    mylist.append([1, 2, 3, 4])
    print("函数内取值: ", mylist)
    return

# 调用changeme函数
mylist2 = [10, 20, 30]
changeme(mylist2)
print("函数外取值: ", mylist2)

传入函数的和在末尾添加新内容的对象用的是同一个引用。故输出结果如下：

函数内取值:  [10, 20, 30, [1, 2, 3, 4]]
函数外取值:  [10, 20, 30, [1, 2, 3, 4]]

4、参数

• 必需参数
• 关键字参数
• 默认参数
• 不定长参数

什么是必需参数？必需参数须以正确的顺序传入函数。调用时的数量必须和声明时的一样。下面的实例中调用say()函数，你必须传入一个参数，不然会出现语法错误：

def say(msg):
    print(msg)  # 打印传入的参数

#调用say
say('hello world')

以上代码，输出：

hello world

但，我们如下调用时，就会报错：

def say(msg):
    print(msg)  # 打印传入的参数

#调用say
say()

以上代码，报错：

TypeError: say() missing 1 required positional argument: 'msg'

调用函数的时候，如果传入的参数数量不对，会报TypeError的错误，并且Python会明确地告诉你。

如果传入的参数数量是对的，但参数类型不能被函数所接受，也会报TypeError的错误，并且给出错误信息：str是错误的参数类型：

print(abs('abc'))

以上代码，会报错：

TypeError: bad operand type for abs(): 'str'

什么是关键字参数？关键字参数和函数调用关系紧密，函数调用使用关键字参数来确定传入的参数值。使用关键字参数允许函数调用时参数的顺序与声明时不一致，因为 Python 解释器能够用参数名匹配参数值。

我们来看实例：

#  申明一个函数say，第一个参数为：name，第二个参数为：msg
def say(name, msg):
    print('%s 说：%s' %(name, msg))  # 打印传入的参数

# 普通方式调用say()
say('roy', 'hello world')

# 用关键字参数的方式调用say()
say(msg='这是用关键字参数的方式调用的', name='roy')

以上代码，输出：

roy 说：hello world
roy 说：这是用关键字参数的方式调用的

我们可以看出，在第二次调用的时候，我们根本没有按照函数申明时的参数顺序去传递参数，但也是正确的输出了内容。

什么是默认参数？调用函数时，如果没有传递参数，则会使用默认参数。以下实例中如果没有传入 msg 参数，则使用默认值：

#  申明一个函数say，第一个参数为：name，第二个参数为：msg
def say(name, msg='hello world'):
    print('%s 说：%s' %(name, msg))  # 打印传入的参数

# 调用
say('roy')

以上代码，输出：

roy 说：hello world

设置默认参数时，有几点要注意：

一是必选参数在前，默认参数在后，否则Python的解释器会报错（思考一下为什么默认参数不能放在必选参数前面）；

二是如何设置默认参数。当函数有多个参数时，把变化大的参数放前面，变化小的参数放后面。变化小的参数就可以作为默认参数。

什么是不定长参数？你可能需要一个函数能处理比当初声明时更多的参数。这些参数叫做不定长参数，和上述几种参数不同，声明时不会命名。基本语法如下：

def functionname([formal_args,] *var_args_tuple ):
   "函数_文档字符串"
   function_suite
   return [expression]

加了星号（*）的变量名会存放所有未命名的变量参数。如果在函数调用时没有指定参数，它就是一个空元组。我们也可以不向函数传递未命名的变量。如下实例：

# 可写函数说明
def printinfo(arg1, *vartuple):
    "打印任何传入的参数"
    print("输出: ")
    print(arg1)
    for var in vartuple:
        print(var)
    return

# 调用printinfo 函数
printinfo(10)
printinfo(70, 60, 50)

以上代码，输出：

输出:
10
输出:
70
60
50

了解了这四种参数的形式了，我们来说下另一种参数传递的方式：分拆参数列表

例如，内建的range()函数期待单独的start和stop参数。如果它们不能单独地获得，可以编写带有*操作的函数调用，来从一个列表或元组分拆出参数：

print(list(range(0, 3)))

args = [0, 3]
print(list(range(*args)))  # range(*args) 等价于 range(0, 3)

以上代码，输出：

[0, 1, 2]
[0, 1, 2]

你会发现，range(*args) 等价于 range(0, 3)，在上例中列表中的第一个元素被传递给了range()函数的第一个参数，第二个元素被传递给了函数的第二个参数。要注意的是，列表里的元素个数必须和函数必需参数的个数对应

同样的风格，字典可以通过**操作传递关键字参数：

def parrot(voltage, state='a stiff', action='voom'):
    print("-- This parrot wouldn't", action, end=' ')
    print("if you put", voltage, "volts through it.", end=' ')
    print("E's", state, "!")

d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}

parrot(**d)

以上代码，输出：

-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !

你会发现，字典的key会对照函数的参数，一一把key对应的value传入给函数

5、return语句

return [表达式] 语句用于退出函数，选择性地向调用方返回一个表达式。不带参数值的return语句返回None。

实例：

#  这是一个有return语句的函数
def hello():
    return 'Hello world'

#  这是一个有return语句的函数，默认返回None
def say(msg):
    print(msg)

#  调用 hello 并把它的结果赋值给 变量
msg = hello()
print(msg)

# 调用 say
say('您好')

以上代码，输出：

Hello world
您好

6、注释

函数的第一行语句可以选择性地使用文档字符串——用于存放函数说明，例如：

def test():
    """
    this is test
    :return: int string
    """
    return 1

可以调用 __doc__ 查看函数的文档：

def test():
    """
    this is test
    :return: int string
    """
    return 1

print(test.__doc__)

以上代码，输出：

    this is test
    :return: int string

在python3中你还可以这样为函数添加注释：

def dog(name:str, age:(1, 99), species:'狗狗的品种') -> tuple:
    return (name, age, species)

如上，可以使用:对参数逐个进行注释，注释内容可以是任何形式，比如参数的类型、作用、取值范围等等，返回值使用->标注，所有的注释都会保存至函数的属性。

查看这些注释可以通过 __annotations__ 获取，结果会议字典的形式返回：

def dog(name:str, age:(1, 99), species:'狗狗的品种') -> tuple:
    return (name, age, species)

print(dog.__annotations__)

以上代码，输出：

{'name': <class 'str'>, 'age': (1, 99), 'species': '狗狗的品种', 'return': <class 'tuple'>}

另外，使用函数注释并不影响默认参数的使用：

def dog(name:str ='dobi', age:(1, 99) =3, species:'狗狗的品种' ='Labrador') -> tuple:
    return (name, age, species)

print(dog())

以上代码，输出：

('dobi', 3, 'Labrador')