Python编程 从入门到实践——第8章 函数

8.1 定义函数

函数是带名字的代码块，用于完成具体的工作。

# greeter.py
# 使用关键字def告诉Python，要进行函数定义，向Python指出了函数名，还可能在圆括号内指出函数为完成任务需要什么样的信息，定义以冒号结尾
def greet_user():
    # 文档字符串注释，描述了函数是做什么的，文档字符串用三引号括起，Python使用它们来生成有关程序中函数的文档
    """显示简单的问候语"""
    print("Hello!")


greet_user()

8.1.1 向函数传递信息

# greeter.py
def greet_user(username):
    """显示简单的问候语"""
    print(f"Hello, {username.title()}!")


greet_user('jesse')

8.1.2 实参和形参

形参：函数完成工作所需的信息
实参：调用函数时传递给函数的信息

8.2 传递实参

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

8.2.1 位置实参

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

# pets.py
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')

一、多次调用函数
可以根据需要调用函数任意次。
二、位置实参的顺序很重要

8.2.2 关键字实参

关键字实参是传递给函数的名称值对，关键字实参让你无需考虑函数调用中的实参顺序，还清楚地指出了函数调用中各个值的用途。使用关键字实参时，务必准确指定函数定义中的形参名。

# pets.py
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')

8.2.3 默认值

编写函数时，可给每个形参指定默认值。在调用函数中给形参提供了实参时，Python将使用指定的实参值；否则，将使用形参的默认值。因此，给形参指定默认值后，可在函数调用中省略相应的实参。使用默认值可简化函数调用，还可清楚地指出函数的典型用法。

# pets.py
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')

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

8.2.4 等效的函数调用

8.2.5 避免实参错误

若提供的实参多于或少于函数完成工作所需的信息时，将出现实参不匹配错误。

8.3 返回值

函数返回的值称为返回值，在函数中，可使用return语句将值返回到调用函数的代码行。

8.3.1 返回简单值

# formatted_name.py
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)

8.3.2 让实参变成可选的

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

# formatted_name.py
def get_formatted_name(first_name, last_name, middle_name=''):
    """返回整洁的姓名"""
    # Python将非空字符串解读为True
    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)

8.3.3 返回字典

# person.py
# 默认值设置为特殊值None，表示变量没有值，可将None视为占位值
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)

8.3.4 结合使用函数和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:")
    print("(enter 'q' at any time to quit)")
    f_name = input("First name: ")
    if f_name == 'q':
        break
    l_name = input("Last name: ")
    if l_name == 'q':
        break
    formatted_name = get_formatted_name(f_name, l_name)
    print(f"Hello, {formatted_name}!")

8.4 传递列表

# greet_users.py
def greet_users(names):
    """向列表中的每位用户发出简单的问候"""
    for name in names:
        msg = f"Hello, {name.title()}!"
        print(msg)


usernames = ['hannah', 'ty', 'margot']
greet_users(usernames)

8.4.1 在函数中修改列表

将列表传递给函数后，函数就可对其进行修改。在函数中对这个列表所做的任何修改都是永久性的。

# printing_models.py
def print_models(unprinted_designs, completed_models):
    """
    模拟打印每个设计，直到没有未打印的设计为止。
    打印每个设计后，都将其移到列表completed_models中
    """
    while unprinted_designs:
        current_design = unprinted_designs.pop()
        print(f"Printing model: {current_design}")
        completed_modules.append(current_design)


def show_completed_models(completed_models):
    """"显示打印好的所有模型"""
    print("The following models have been printed:")
    for completed_model in completed_models:
        print(completed_model)


unprinted_designs = ['phone case', 'robot pendant', 'dodecahedron']
completed_modules = []
print_models(unprinted_designs, completed_modules)
show_completed_models(completed_modules)

8.4.2 禁止函数修改列表

可向函数传递列表的副本而非原件，这样，函数所做的任何修改都只影响副本，而原件丝毫不受影响

print_models(unprinted_designs[:], completed_models)

8.5 传递任意数量的实参

预先不知道函数需要接受多少个实参，Python允许函数从调用语句中收集任意数量的实参

# pizza.py
# 形参名*toppings中的型号让Python创建一个名为toppings的元组，并将接收到的所有值都封装到这个元组中
def make_pizza(*toppings):
	"""打印顾客点的所有配料"""
	print(toppings)
	
make_pizza('pepperoni')
make_pizza('mushrooms', 'green peppers', 'extra cheese')

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

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

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

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

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

# user_profile.py
# 形参**user_info中的两个星号让Python创建一个名为user_info的空字典，并将收到的所有名称值对都放到这个字典中。
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', 'elinstein', location='princeton', field='physics')
print(user_profile)

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

8.6 将函数存储在模块中

将函数存储在称为模块的独立文件中，再将模块导入到主程序中。Import语句允许在当前运行的程序文件中使用模块中的代码。

8.6.1 导入整个模块

模块是扩展名为.py的文件。

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


# making_pizzas.py
# 让Python打开文件pizza.py，并将其中的所有函数都复制到这个程序中
import pizza
# 要调用被导入模块中的函数，可指定被导入模块的名称pizza和函数名make_pizza()，并用句点分隔
pizza.make_pizza(16, 'pepperoni')
pizza.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

8.6.2 导入特定的函数

# 还可以导入模块中的特定函数
from module_name import function_name
# 通过用逗号分隔函数名，可根据需要从模块中导入任意数量的函数
from module_name import function_0, function_1, function_2

from pizza import make_pizza
# 使用这种语法时，调用函数时无需使用句点。由于在import语句中显式地导入了函数make_pizza()，调用时只需指定其名称即可
make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

8.6.3 使用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')

8.6.4 使用as给模块指定别名

import module_name as mn
import pizza as p
p.make_pizza(16, 'pepperoni')
p.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

8.6.5 导入模块中的所有函数

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

from pizza import *
make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

8.7 函数编写指南

1、应给函数指定描述性名称，且只在其中使用小写字母和下划线。给模块命名时也应遵守上述约定。
2、每个函数都应包含简要地阐述其功能的注释。该注释应紧跟在函数定义后面，并采用文档字符串格式。
3、给形参指定默认值时，等号两边不要有空格。对于函数调用中的关键字实参，也应遵守这种约定。
4、使用两个空行将相邻的函数分开。
5、所有import语句都应放在文件开头。

8.8 小结

在本章中，你学习了：如何编写函数，以及如何传递实参，让函数能够访问完成其工作所需的信息；如何使用位置实参和关键字实参，以及如何接受任意数量的实参；显示输出的函数和返回值的函数；如何将函数同列表、字典、if语句和while循环结合起来使用；如何将函数存储在称为模块的独立文件中，让程序文件更简单、更易于理解。最后，你学习了函数编写指南，遵循这些指南可让程序时钟结构良好，并对你和其他人来说易于阅读。
程序员的目标之一是，编写简单的代码来完成任务，而函数有助于你实现这样的目标。它们让你编写好代码块并确定其能够正确运行后，就可置之不理。确定函数能够正确地完成其工作后，你就可以接着投身于下一个编码任务。
函数让你编写代码一次后，想重用它们多少次就重用多少次。需要运行函数中的代码时，只需编写一行函数调用代码，就可让函数完成其工作。需要修改函数的行为时，只需修改一个代码块，而所做的修改将影响调用这个函数的每个地方。
使用函数让程序更容易阅读，而良好的函数名概述了程序各个部分的作用。相对于阅读一系列的代码块，阅读这一系列函数调用让你能够更快地明白程序的作用。
函数还让代码更容易测试和调试。如果程序使用一系列的函数来完成其任务，而其中的每个函数都完成一项具体的工作，测试和维护起来将容易得多：可编写分别调用每个函数的程序，并测试每个函数是否在它可能遇到的各种情形下都能正确地运行。经过这样的测试后你就能充满信心，深信每次调用这些函数时，它们都将正确地运行。
在第9章，你将学习编写类。类将函数和数据整洁地封装起来，让你能够灵活而高效地使用它们。