3. 函数

1、定义函数

函数的定义：使用关键字def来告诉Python你要定义一个函数。可以根据需要调用函数任意次。

文档字符串（docstring）的注释，描述了函数是做什么的。文档字符串用三引号括起，Python使用它们来生成有关程序中函数的文档。

def describe_pet(animal_type, pet_name):
	"""显示宠物的信息"""
	print("\nI have a " + animal_type + ".")
	print("My " + animal_type + "'s name is " + pet_name.title() + ".")
describe_pet('hamster', 'harry')
describe_pet('dog', 'wangcai')

2、传递实参

a. 位置实参：位置实参是基于实参的顺序。

b. 关键字实参：

传递给函数的名称—值对。直接在实参中将名称和值关联起来，因此向函数传递实参时不会混淆。关键字实参无需考虑函数调用中的实参顺序。

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

c. 默认值：

编写函数时，可给每个形参指定默认值。在调用函数中给形参提供了实参时，Python将使用指定的实参值；否则，将使用形参的默认值。

这种传参方式Python将默认为是位置实参。使用默认值时，在形参列表中必须先列出没有默认值的形参，再列出有默认值的形参。这让Python依然能够正确地解读位置实参。

def describe_pet(pet_name, animal_type='dog'):
	"""显示宠物信息"""
	print("\nI have a " + animal_type + ".")
	print("My " + animal_type + "'s name is " + pet_name.title() + ".")

describe_pet(pet_name="willie")

3、返回值

使用return语句将值返回到调用函数的代码行。

有时候，需要让实参变成可选的，这样使用函数的人就只需在必要时才提供额外的信息。可使用默认值来让实参变成可选的。

def get_formatted_name(first_name, last_name, middle_name=''):
	"""返回整洁的姓名"""
	full_name = first_name + ' ' + middle_name + ' ' + last_name
	return full_name.title()
	
musician = get_formatted_name('LeBron', 'James')
print(musician)

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

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

musician = build_person('jimi', 'hendrix', age=27)
print(musician)

4、传递列表

向函数传递列表很有用，这种列表包含的可能是名字、数字或更复杂的对象（如字典）。将列表传递给函数后，函数就能直接访问其内容。

def greet_users(names):
	"""向列表中的每位用户都发送出简单的问候"""
	for name in names:
		msg = "Hello, " + name.title() + "!"
		print(msg)
		
usernames = ['hannah', 'ty', 'margot']
greet_users(usernames)

将列表传递给函数后，函数就可对其进行修改。在函数中对这个列表所做的任何修改都是永久性的，这让你能够高效地处理大量的数据。这个程序还演示了这样一种理念，即每个函数都应只负责一项具体的工作。

def print_models(unprinted_designs, completed_models):
	"""
	模拟打印每个设计，之道没有未打印的设计为止
	打印每个设计后，都将其移到列表completed_models中
	"""
	while unprinted_designs:
		current_design = unprinted_designs.pop()
		# 模拟根据设计制作3D打印模型的过程
		print("Printing model: " + current_design)
		completed_models.append(current_design)


def show_completed_models(completed_models):
	"""显示打印好的所有模型"""
	for completed_model in completed_models:
		print(completed_model)

unprinted_designs = ['iphone case', 'robot pendant', 'dodecahedron']
completed_models = []

print_models(unprinted_designs, completed_models)
show_completed_models(completed_models)

有时候，需要禁止函数修改列表，可向函数传递列表的副本而不是原件；这样函数所做的任何修改都只影响副本，而丝毫不影响原件。

# 将列表的副本传递给函数
function_name(list_name[:])

5、传递任意数量的实参

有时候，事先不知道函数需要接受多少个实参，好在Python允许函数从调用语句中收集任意数量的实参。

*形参名：星号让Python创建一个名为形参名的空元组，并将收到的所有值都封装到这个元组中。

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

结合使用位置实参和任意数量实参：如果要让函数接受不同类型的实参，必须在函数定义中将接纳任意数量实参的形参放在最后。Python先匹配位置实参和关键字实参，再将余下的实参都收集到最后一个形参中。

def make_pizza(size, *toppings):
	"""概述要制作的披萨"""
	print("\nMaking a " + str(size) + 
		  "-inch pizza with the following toppings:")
	for topping in toppings:
		print("- " + topping)
		
make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

使用任意数量的关键字实参(**形参名)：有时候需要接受任意数量的实参，但预先不知道传递给函数的会是什么样的信息。可将函数编写成能够接受任意数量的键—值对——调用语句提供了多少就接受多少。

def build_people(first, last, **user_info):
	profile = {}
	profile['first_name'] = first
	profile['last_name'] = last
	for key, value in user_info.items():
		profile[key] = value
	return profile

user_profile = build_people('albert', 'einstein', 
							location='princeton', field='physics')
print(user_profile)

6、将函数存储在模块中

函数的优点之一是，使用它们可将代码块与主程序分离。通过给函数指定描述性名称，可让主程序容易理解得多。你还可以更进一步，将函数存储在被称为模块的独立文件中，再将模块导入到主程序中。import语句允许在当前运行的程序文件中使用模块中的代码。

def make_pizza(size, *toppings):
	"""概述要制作的比萨"""
	print("\nMaking a " + str(size) + 
		  "-inch pizza with the following toppings:")
	for topping in toppings:
		print("- " + topping)

导入整个模块：要让函数是可导入的，得先创建模块。模块是扩展名为.py的文件，包含要导入到程序中的代码。导入：import module_name，使用函数：module_name.function_name()

import pizza

pizza.make_pizza(16, 'peppeoni')
pizza.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

导入特定的函数：导入：from module_name import function_0, function_1, function_2。若使用这种语法，调用函数时就无需使用句点。

from pizza import make_pizza

make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

使用as给函数指定别名：如果要导入的函数的名称可能与程序中现有的名称冲突，或者函数的名称太长，可指定简短而独一无二的别名。语法：from module_name import function_name as fn

from pizza import make_pizza as mp

mp(16, 'pepperoni')
mp(12, 'mushrooms', 'green peppers', 'extra cheese')

使用as给模块指定别名：通过给模块指定简短的别名，能够更轻松地调用模块中的函数。语法：import module_name as mn

import pizza as p

p.make_pizza(16, 'pepperoni')
p.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

导入模块中的所有函数：使用星号（*）运算符可让Python导入模块中的所有函数。语法：from module_name import *

from pizza import *

make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

7、函数编写指南

• 应给函数指定描述性名称，且只在其中使用小写字母和下划线。
• 每个函数都应包含简要地阐述其功能的注释，该注释应紧跟在函数定义后面，并采用文档字符串格式。
• 给形参指定默认值 和 函数调用中的关键字实参，等号两边不要有空格：def function_name(parameter_0, parameter_1='default value')
• 如果程序或模块包含多个函数，可使用两个空行将相邻的函数分开，这样将更容易知道前一个函数在什么地方结束，下一个函数从什么地方开始。
• 所有的import语句都应放在文件开头，唯一例外的情形是，在文件开头使用了注释来描述整个程序。