函数（python）

函数（python）

---

---

---

函数是带名字的代码块，用于完成具体的工作。要执行函数定义的特定任务，可调用该函数。需要再程序中多次执行同一项任务时，无需反复编写完成该任务的代码，只需要调用执行该任务的函数，让python运行其中的代码即可。

定义函数

>>> def greet_user():
>>> 	"""显示简单的问候语。"""
>>> 	print("Hello!")
>>> greet_user()
Hello!

本例演示了最简单的函数结构。代码行使用关键字 def 来告诉python，你要定义一个函数。这是函数定义，向 python 指出了函数名，还可能在圆括号内指出函数为完成任务需要什么样的信息。在这里，函数名为 greet_user()，它不需要任何信息就能完成工作，因此括号是空的（即便如此，括号也必不可少）。最后，定义以冒号结尾。
紧跟在 def greet_user(): 后面的所有缩进行构成了函数体。由三个双引号组成的文本时成为文档字符串的注释，描述了函数是做什么的。文档字符串用三个引号括起，python使用它们来生成有关程序中函数的文档。
代码行 print(“Hello!”) 是函数体内的唯一一行代码，因此 greet_user() 只做一项工作：打印Hello!。

向函数传递信息

只需稍作修改，就可让函数greet_user() 不仅向用户显示Hello！，还将用户的名字作为抬头。为此，可在函数定义 def greet_user() 的括号内添加 username。通过在这里添加 username，可让函数接受你给 username 指定的任何值。现在，这个函数要求你调用它时给 username 指定一个值。调用 greet_user() 时，可将一个名字传递给它，如下所示：

>>> def greet_user(username):
>>> 	"""显示简单的问候语。"""
>>> 	print(f"Hello, {username.title()}!")
>>> greet_user('jesse')
Hello, Jesse!

代码 greet_user(‘jesse’) 调用函数 greet_user()，并向它提供执行函数调用print() 所需的信息。

实参和形参

前面定义函数 greet_user() 时，要求给变量 username 指定一个值。调用这个函数并提供这种信息（人名）时，它将打印相应的问候语。
在函数 greet_user() 的定义中，变量 username 是一个形参（parameter），即函数完成工作所需的信息。在代码 greet(‘jesse’) 中，值 ’jesse‘ 是一个实参（argument），即调用函数时传递给函数的信息。调用函数时，将要让函数使用的信息放在圆括号内。在 greet_user(‘jesse’) 中，将实参 ’jesse’ 传递给了函数 greet_user()，这个值被付给了形参 username。

---

传递实参

函数定义中可能包含多个形参，因此函数调用中也可能包含多个实参。向函数传递实参的方式很多：可以使用位置实参，这要求实参的顺序与形参的顺序相同；也可使用关键字实参，其中每个实参都由变量名和值组成；还可使用列表和字典。

位置实参

调用函数时，python必须将函数调用中的每个实参都关联到函数定义中的一个形参。为此，最简单的关联方式是基于实参的顺序。这种关联方式称为位置实参。

>>> def describe_pet(animal_type, pet_name):
>>> 	"""显示宠物的信息。"""
>>> 	print(f"\nI have a {animal_type}.")
>>> 	print(f"My {animal_type}'s name is {pet_name.title()}.")
describe_pet('hamster', 'harry')

这个函数的定义表明，它需要一种动物类型和一个名字。调用 describe_pet() 时，需要按顺序提供一种动物类型和一个名字。例如，在刚才的函数调用中，实参 ‘hamster’ 被赋给形参 animal_type，而实参 ’harry’ 被赋给形参 pet_name。在函数体内，使用这两个形参来显示宠物的信息。

关键字实参

关键字实参时传递给函数的名称值对。因为直接在实参中将名称和值关联起来，所以向函数传递实参时不会混淆。关键字实参让你无需考虑函数调用中的实参顺序，还清楚地指出了函数调用中各个值的用途。

>>> def describe_pet(animal_type, pet_name):
>>> 	"""显示宠物的信息。"""
>>> 	print(f"\nI have a {animal_type}.")
>>> 	print(f"My {animal_type}'s name is {pet_name.title()}.")
>>> describe_pet(animal_type='hamster', pet_name='harry')

函数describe_pet() 还和之前一样，但调用这个函数时，向python明确地指出了各个实参对应的形参。
关键字实参的顺序无关紧要，因为python知道各个值该赋给哪个形参。下面两个函数调用是等效的：

>>> describe_pet(animal_type='hamster', pet_nemt='harry')
>>> describe_pet(pet_name='harry', animal_type='hamster')

注意 使用关键字实参时，务必准确指定函数定义中的形参名（当输入时，会自动出现带符号的形参）。

默认值

编写函数时，可给每个形参指定默认值。在调用函数中给形参提供了实参时，python 将使用指定的实参值；否则，将使用形参的默认值。因此，给形参指定默认值后，可在函数调用中省略相应的实参。使用默认值可简化函数调用，还可清楚地指出函数的典型用法。
例如，如果你发现调用的 describe_pet() 时，描述的大多是小狗，就可将形参 animal_type 的默认值设为 ‘dog’。这样，调用 describe_pet() 来描述小狗时，就可不提供这种信息：

>>> def describe_pet(pet_name, animal_type='dog'):
>>> 	"""显示宠物的信息。"""
>>> 	print(f"\nI have a {animal_type}.")
>>> 	print(f"My {animal_type}'s name is {pet_name.title()}.")
>>> describe_pet(pet_name='willie')

这里修改了函数 describe_pet() 的定义，在其中给形参 animal_type 指定了默认值 ‘dog’。这样，调用这个函数时，如果没有 animal_type 指定值，python 就把这个形参设置为 ‘dog’。
请注意，在这个函数的定义中，修改了形参的排列顺序。因为给 animal_type 指定了默认值，无需通过实参来指定动物类型，所以在函数调用中只包含一个实参——宠物的名字。然而，python 依然将这个实参视为位置实参，因此如果函数调用中只包含宠物的名iz，这个实参将关联到函数定义中的第一个形参。这就是需要将 pet_name 放在形参列表开头的原因（设定默认值的形参，如果不放末尾函数定义会报错，运行不通过）。

注意 使用默认值时，必须先在形参列表中列出没有默认值的形参，再列出有默认值的实参。这让python 依然能够正确解读位置实参。

等效的函数调用

鉴于可混合使用位置实参、关键字实参和默认值，通常有多种等效的函数调用方式：

>>> def describe_pet(pet_name, animal_type='dog'):
describe_pet('willie')
describe_pet(pet_name='willie')
describe_pet('harry', 'hamster')
describe_pet(pet_name='harry', animal_type='hamster')
describe_pet(animal_type='hamster', pet_name='harry')

注意 使用哪种调用方式无关紧要，只要函数调用能生成你期望的输出就行。使用对你来说最容易理解的调用方式即可。

避免实参错误

等你开始使用函数后，如果遇到实参不匹配错误，不要大惊小怪。你提供的实参多余或少于函数完成工作所需的信息时，将出现实参不匹配错误。

---

返回值

函数并非总是直接显示输出，它还可以处理一些数据，并返回一个或一组值。函数返回的值称为返回值。在函数中，可使用 return 语句将返回值返回到调用函数的代码行。返回值让你能够将程序的大部分繁重工作移到函数中去完成，从而简化主程序。

返回简单值

>>> def get_formatted_name(first_name, last_name):
>>> 	"""返回整洁的姓名。"""
>>> 	full_name = f"{first_name} {last_name}"
>>> 	return full_name.title()
>>> musician = get_formatted_name('jimi', 'hendrix')
>>> print(musician)
Jimi Hendrix

函数 get_formatted_name() 的定义通过形参接受名和姓。它将姓和名合而为一，在中间加上一个空格，并将结果赋给变量 full_name。然后，将full_name 的值转换为首字母大写格式，并将结果返回到函数调用行。
调用返回值的函数时，需要提供一个变量，以便将返回的值赋给它。在这里，将返回值赋给了变量 musician。

让实参编程可选的

有时候，需要让实参变成可选的，这样使用函数的人就能只在必要时提供额外的信息。可使用默认值来让实参变成可选的。
例如，假设要扩展函数 get_formatted_name()，使其同时处理中间名。为此可将其修改成类似于下面这样：

>>> def get_formatted_name(first_name, middle_name, last_name):
>>> 	"""返回整洁的姓名。"""
>>> 	full_name = f"{first_name} {middle_name} {last_name}"
>>> 	return full_name.title()
>>> musician = get_formatted_name('john', 'lee', 'hooker')
>>> print(musican)
John Lee Hooker

并非所有的人都有中间名，但如果调用这个函数时只提供了名和姓，它将不能正确运行。为了让中间名变成可选的，可给形参 middle_name 指定一个空的默认值，并在用户没有提供中间名时不使用这个形参不适用这个形参。为让 get_formatted_name() 在没有提供中间名时依然可行，可将形参 middle_name 的默认值设置为空字符串，并将其移到形参列表的末尾：

>>> def get_formatted_name(first_name, last_name, middle_name=''):
>>> 	"""返回整洁的姓名。"""
>>> 	if middle_name:
>>> 		full_name = f"{first_name} {middle_name} {last_name}"
>>> 	else:
>>> 		full_name = f"{first_name} {last_name}"
>>> 	return full_name.title()
>>> musician = get_formatted_name('jimi', 'hendrix')
>>> print(musician)
>>> musician = get_formatted_name('john', 'hooker', 'lee')
>>> print(musician)

在本例中，姓名是根据三个可能提供的部分创建的。由于人都有名和姓，因此在函数定义中首先列出了这两个形参。中间名是可选的，因此可在函数定义中最后列出该形参，并将其默认值设置为空字符串。
在函数体中，检查是否使用了中间名。python 将非空字符串解读为True，因此如果函数调用中提供了中间名，if middle_name 将为 True。如果提供了中间名，就将名、中间名和姓合并为姓名，再将其修改为首字母大写格式，并返回到函数调用行。在函数调用行，将返回的值赋给变量 musician，然后将这个变量的值打印出来。如果没有提供中间名，middle_name 将为空字符串，导致 if 测试未通过，进而执行 else 代码块：只是用名和姓来生成姓名，并将格式社招的姓名返回给函数调用行。在函数调用行，将返回的值赋给变量musician，然后这个变量的值被打印出来。
调用这个函数时，如果只想指定名和姓，调用起来将非常简单。如果还要指定中间名，就必须确保它是最后一个实参，这样python才能正确地将位置实参关联到形参。

返回字典

函数可返回任何类型的值，包括列表和字典等较复杂的数据结构：

>>> def build_person(first_name, last_name):
>>> 	"""返回一个字典，其中包含有关一个人的信息。"""
>>> 	person = {'first': first_name, 'last': last_name}
>>> 	return person
>>> musician = build_person('jimi', 'hendrix')
>>> print(musician)

函数 buile_person() 接受名和姓，并将这些值放到字典中。存储 first_name 的值时，使用的键为 ‘first’，而存储 last_name 时，使用的键为 ‘last’。最后，返回表示人的整个字典。
这个函数接受简单的文本信息，并将其放在一个更合适的数据结构中，让你不仅能打印这些信息，还能以其他方式处理它们。当前，字符串 ‘jimi’ 和 ‘hendrix’ 被标记为名和姓。你可以轻松地扩展这个函数，使其接受可选值，如中间名、年龄、职业和其他任何要存储的信息。例如，下面的修改让你能存储年龄：

>>> def build_person(first_name, last_name, age=None):
>>> 	"""返回一个字典，其中包含有关一个人的信息。"""
>>> 	person = {'first': first_name, 'last': last_name}
>>> 	if age:
>>> 		person['age'] = age
>>> 	return person
>>> musician = build_person('jimi', 'hendrix', age=27)
>>> print(musician)
{'first': 'jimi', 'last': 'hendrix', 'age': 27}

在函数定义中，新增了一个可选形参age，并将其默认值设置为 None（表示变量没有值）。可将 None 视为占位值。在条件测试中，None 相当于 False。如果函数调用中包含形参 age 的值，这个值将被存储到字典中。在任何情况下，这个函数都会存储人的姓名，但可进行修改，使其同时存储有关人的其他信息。

结合使用函数和while循环

>>> def get_formatted_name(first_name, last_name):
>>> 	"""返回整洁的姓名。"""
>>> 	full_name = f"{first_name} {last_name}"
>>> 	return full_name.title()
>>> # 这是一个无限循环！
>>> while True:
>>> 	print("\nPlease tell me your name: ")
>>> 	f_name = input("First name('q' to end): ")
>>> 	if f_name == 'q':
>>> 		break
>>> 	l_name = input("Last name('q' to end): ")
>>> 	if l_name == 'q':
>>> 		break
>>> 	formatted_name = get_formatted_name(f_name, l_name)
>>> 	print(f"\nHello, {formatted_name}!")

---

传递列表

假设有一个用户列表，我们要问候其中的每位用户。下面的示例将包含名字的列表传递给一个名为 greet_users() 的函数，这个函数问候列表中的每个人：

>>> def greet_users(names):
>>> 	"""向列表中的每位用户发出简单的问候。"""
>>> 	for name in names:
>>> 		msg = f"Hello, {name.title()}!"
>>> 		print(msg)
>>> usernames = ['hannah', 'ty', 'margot']
>>> greet_user(usernames)
Hello, Hannah!
Hello, Ty!
Hello, Margot!

我们将 greet_users() 定义为接受一个名字列表，并将其赋给形参 names。这个函数遍历收到的列表，并对其中的每位用户打印一条问候语。

禁止函数修改列表

有时候，需要禁止函数修改列表。例如，假设你有一个未打印的设计列表，并编写了一个函数将这些设计移到打印好的模型列表中。你可能会做出这样的决定：即便打印好了所有的设计，也要保留原来的未打印的设计列表，以供备案。但由于你将所有的设计都移出了 unprinted_designs，这个列表变成了空的，原来的列表都没有了。为解决这问题，可向函数传递列表的副本而非原件。这样，函数所作的任何修改都只影响副本，而原件丝毫不受影响。
要将列表的福分传递给函数，可以像下面这样做：

function_name(list_name[:])

切片表示法[:]创建列表的副本。如果不想清空未打印的设计列表，可像下面这样调用 print_models():

print_models(unprinted_designs[:], completed_models)。

这样函数 print_models() 依然能够完成工作，因为它获得了所有未打印的设计的名称，但是用的是列表 unprinted_designs 的副本，而不是列表unprinted_designs 本身。像以前一样，列表 completed_models 也将包含打印好的模型的名称，但函数所做的修改不会影响到列表 unprinted_designs。
虽然向函数传递列表的副本可保留原始列表的内容，但除非有充分的理由，否则还是应该将原始列表传递给函数。这是因为让函数使用现成的列表可避免花时间和内存创建副本，从而提高效率，在处理大型列表时尤其如此。

---

传递任意数量的实参

有时候，预先不知道函数需要接受多少个实参，好在python 允许函数从调用语句中收集任意数量的实参。
例如，来看一个制作披萨的函数，它需要接受很多配料，但无法预先确定顾客要多少种配料。下面的函数只有一个形参 *toppings，但不管调用语句提供了多少实参，这个形参会将它们统统收入囊中：

>>> def make_pizza(*toppings):
>>> 	"""打印顾客点的所有配料。"""
>>> 	print(toppings)
>>> make_pizza('pepperoni')
>>> make_pizza('mushrooms', 'green peppers', 'extra cheese')

形参名 *toppings 中的星号让python创建一个名为 toppings 的空元组，并将收到的所有值都封装到这个元组中。函数体内的函数调用 print() 通过生成输出，证明python 能够处理使用一个之来调用函数的情形，也能处理使用三个值来调用函数的情形。它以类似的方式处理不同的调用。注意：python将实参封装到一个元组中，即便函数只收到一个值：

('pepperoni',)
('mushroom', 'green peppers', 'extra cheese')

现在，可以将函数调用 print() 替换为一个循环，遍历配料列表并对顾客点的披萨进行描述：

>>> def make_pizza(*toppings):
>>> 	"""概述要制作的披萨。"""
>>> 	print("\nMaking a pizza with the following toppings: ")
>>> 	for topping in toppings:
>>> 		print(f"- topping")
>>> make_pizza('pepperoni')
Making a pizza with the following toppings:
- pepperoni
>>> make_pizza('mushroom', 'green peppers', 'extra cheese')
Making a pizza with the following toppings:
- mushroom
- green peppers
- extra cheese

结合使用位置实参和任意数量实参

如果要让函数接受不同类型的实参，必须在函数定义中将接纳任意数量实参的形参放在最后。python先匹配位置实参和关键字实参，再将余下的实参都收集到最后一个形参中。
例如，如果前面的函数还需要一个表示披萨尺寸的形参，必须将其放在形参 *toppings 的前面：

>>> def make_pizza(size, *toppings):
>>> 	"""概述要制作的披萨。"""
>>> 	print(f"\nMaking a {size}-inch pizza with the following toppings:")
>>> 	for topping in toppings:
>>> 		print(f"- {topping}")
>>> make_pizza(16, 'pepperoni')
Making a 16-inch pizza with the following toppings:
- pepperoni
>>> make_pizza(12, 'mushroom', 'green pepers', 'extra cheese')
Making a 12-inch pizza with the following toppings:
- mushroom
- green peppers
- extra cheese

基于上述函数定义，python将收到的第一个值赋给形参 size，并将其他所有的值都存储在元组 toppings中。在函数调用中，首先指定表示披萨尺寸的实参，再根据需要指定任意数量的配料。

你经常会看到通用形参名 *args，它也收集任意数量的位置实参。

使用任意数量的关键字实参。

有时候，需要接受任意数量的实参，但预先不知道传递给函数的会是什么样的信息。在这种情况下，可将函数编写成能够接受任意数量的键值对——调用语句提供了多少就接受多少。一个这样的示例是创建用户简介：你知道将收到有关用户的信息，但不确定会是什么样的信息。在下面的示例中，函数 build_profile() 接受名和姓，还接受任意数量的关键字实参：

>>> def build_profile(first, last, **user_info):
>>> 	"""创建一个字典，其中包含我们知道的有关用户的一切。"""
>>> 	user_info['first_name'] = first
>>> 	user_info['last_name'] = last
>>> 	return user_info
>>> user_profile = build_profile('albert', 'einstein', location='princeton', field='physics')
>>> print(user_profile)

函数 build_profile() 的定义要求提供名和姓，同时允许根据需要提供任意数量的名称值对。形参 **user_info 中的两个星号让python创建一个名为 user_info 的空字典，并将收到的所有名称值对都放到这个字典中。在这个函数中，可以像访问其他字典那样访问 user_info 中的名称值对。在 build_profile() 的函数体内，将名和姓加入了字典 user_info 中，因为总是会从用户那里收到这两项信息，而这两项信息没有放到这个字典中。接下来，将字典 user_info 返回导函数调用行。
我们调用 build_profile()，向它传递名（‘albert’）、姓（’einstein’）和两个键值对（location=‘princeton’ 和 field=‘physis’），并将返回的 user_info 赋给变量 user_profile，再打印该变量。

函数编写时，能以各种方式混合使用位置实参、关键字实参和任意数量的实参。知道这些实参类型大有脾益，因为阅读别人编写的代码时会经常见到它们。要正确地使用这些类型的实参并知道其使用时机，需要经过一定的练习。就目前而言，牢记使用最简单的方法来完成任务就好。

注意 你经常会看到形参名 **kwargs，它用于收集任意数量的关键字实参。

将函数存储在模块中

使用函数的优点之一是可将代码块与主程序分离。通过给函数指定描述性名称，可让主程序容易理解得多。你还可以更进一步，将函数存储在称为模块得独立文件中，再将模块导入到主程序中。import 语句允许在当前运行得程序文件中使用模块中的代码。
通过将函数存储在独立的文件中，可隐藏程序代码的细节，将重点放在程序的高层逻辑上。这还能让你在众多不同的程序中重用函数。将函数存储在独立文件中后，可与其他程序员共享这些文件，而不是整个程序。知道如何导入函数还能让你使用其他程序员编写的函数库。

导入整个模块

要让函数是可导入的，得先创建模块。模块是扩展名为 .py 的文件，包含要导入到程序中的代码。下面来创建一个包含函数 make_pizza() 的模块。为此，将文件 pizza.py 中除函数 make_pizza() 之外的其他代码删除：

>>> def make_pizza(size, *toppings):
>>> 	"""概述要制作的披萨。"""
>>> 	print(f"\nMaking a {size}-inch pizza with the following toppings:")
>>> 	for topping in toppings:
>>> 		print(f"- {topping}")

接下来，在 pizza.py 所在的目录中创建一个名为 making_pizzas.py 的文件。这个文件导入刚创建的模块，在调用 make_pizza() 两次：

>>> import pizza
>>> pizza.make_pizza(16, 'pepperoni')
Making 16-inch pizza with the following toppings:
- pepperoni

python 读取这个文件时，代码行 import pizza 让 python 打开文件 pizza.py，并将其中的所有函数都复制到这个程序中。你看不到复制的代码，因为在这个程序即将运行时，python在幕后复制了这些代码。你只需知道，在 making_pizzas.py 中，可使用 pizza.py 中定义的所有函数。
要调用被导入模块中的函数，可指定被导入模块的名称 pizza 和函数名 make_pizza()，并用句点分隔。这些代码的输入与没有导入模块的原始程序相同。
这就是一种导入方法：只需编写一条 import 语句并在其中指定模块名，就可在程序中使用该模块中的所有函数。如果使用这种 import 语句导入了名为 module_name.py 的整个模块，就可使用下面的语法来使用其中任何一个函数：

module_name.function_name()

导入特定的函数

还可以导入模块中的特定函数，这种导入方法的语法如下：

from module_name import functiono_name

通过用逗号分隔函数名，可根据需要从模块中导入任意数量的函数：

from module_name import function_0, function_1, function_2

对于前面的 making_pizzas.py 示例，如果只想导入要使用的函数，代码将类似于下面这样：

from pizza import make_pizza
make_pizza(16, 'pipperoni')

使用这种语法时，调用函数时无需使用句点。由于在 import 语句中显式地导入了函数的 make_pizza()，调用时只需指定其名称即可。

使用as给函数指定别名

如果要导入函数的名称可能与程序中现有的名称冲突，或者函数的名字太长，可指定简短而独一无二的别名：函数的另一个名称，类似于外号。要给函数取这种特殊外号，需要在导入它时指定。
下面给函数 make_pizza() 指定了别名 mp()。这是在 import 语句中使用 make_pizza as mp 实现的，关键字 as 将函数重命名为指定的别名：

from pizza import make_pizza as mp
mp(16, 'pepperoni')

指定别名的通用语法如下：

from module_name import function_name as fn

使用as给模块指定别名

还可以给模块指定别名：

import module_name as mn

导入模块中的所有函数

使用星号（*）运算符可让 python 导入模块中的所有函数：

from pizza import *
make_pizza(16, 'pepperoni')

import 语句中的星号让python 将模块 pizza 中的每个函数都复制到这个程序文件中。由于导入了每个函数，可通过名称来调用每个函数，而无须使用句点表示法。然而，使用并非自己编写的大型模块时，最好不要采用这种导入方法。这是因为如果模块中有函数名称与当前项目中使用的名称相同，可能导致意想不到的结果：python 可能遇到多个名称相同的函数或变量，进而覆盖函数，而不是分别导入所有的函数。
最佳的做法是，要么知道如需要使用的函数，要么导入整个模块并使用句点表示法。这让代码更清晰，更容易阅读和理解。这里之所以介绍这种导入方法，只是想让你在阅读别人编写的代码时，能够理解类似于下面的 import 语句：

from module_name import *