8 第八章 函数
定义函数
# 定义了一个打招呼的函数
def greet_user():
"""显示简单的问候语"""
print("Hello!")
greet_user()
# def 用来定义函数
# greet_user 指的是函数的名字
# () 括号里可以指定参数用来接收信息，也可以不指定参数
# 定义以冒号结尾！！！
# """文档字符串""": 用来描述函数的功能，python使用他们
# 来生成有关程序中函数的文档
# greet_user() 用来调用函数
# 输出为: Hello!
# 向函数传递信息
def greet_user(username):
"""显示简单的问候语"""
print("Hello, " + username.title() + "!")
greet_user('jesse')
# Hello, Jesse!
# 实参、形参
def greet_user(username):
"""显示简单的问候语"""
print("Hello, " + username.title() + "!")
greet_user('jesse')
# username: 形参
# 'jesse': 实参
传递实参
# 位置实参
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')
# 'hamster' -> animal_type
# 'harry' -> pet_name
# 可调用函数多次
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', 'willie')
# 关键字实参
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(animal_type='hamster', pet_name='harry')
# describe_pet(animal_type='hamster', pet_name='harry')
# describe_pet(pet_name='harry', animal_type='hamster') 这两个等效
# 默认值
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')
describe_pet(pet_name='harry', animal_type='hamster')
# I have a dog.
# My dog's name is Willie.
# I have a hamster.
# My dog's name is harry.
# 使用默认值时，在形参列表中必须先列出没有默认值的形参，
# 再列出有默认值的实参。这让Python依然能够正确地解读位置实参。
返回值
def get_formatted_name(first_name, last_name):
"""返回整洁的姓名"""
full_name = first_name + ' ' + last_name
return full_name.title()
musician = get_formatted_name('jimi', 'hendrix')
print(musician)
# Jimi Hendrix
# 让实参变成可选的
def get_formatted_name(first_name, last_name, middle_name=''):
"""返回整洁的姓名"""
if middle_name: # 非空字符串为True，空字符串为False
full_name = first_name + ' ' + middle_name + ' ' + last_name
else:
full_name = first_name + ' ' + last_name
return full_name.title()
musician = get_formatted_name('jimi', 'hendrix')
print(musician) # Jimi Hendrix
musician = get_formatted_name('john', 'hooker', 'lee')
print(musician) # John Lee Hooker
# 返回字典
def build_person(first_name, last_name):
"""返回一个字典，其中包含有关一个人的信息"""
person = {'first': first_name, 'last': last_name}
return person
musician = build_person('jimi', 'hendrix')
print(musician)
# {'first': 'jimi', 'last': 'hendrix'}
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)
# {'first': 'jimi', 'last': 'hendrix', 'age': 27}
# 函数中使用while循环
# 函数中使用while循环
def get_formatted_name(first_name, last_name):
"""返回整洁的姓名"""
full_name = 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("\nHello, " + formatted_name + "!")
# Python代码中若有制表符和空格就会导致索引错误，需要将制表符替换成空格
# 推荐 一个制表符=4个空格
传递列表
def greet_users(names):
"""向列表中的每位用户都发出简单的问候"""
for name in names:
msg = "Hello, " + name.title() + "!"
print(msg)
usernames = ['hannah', 'ty', 'margot']
greet_users(usernames)
# Hello, Hannah!
# Hello, Ty!
# Hello, Margot!
3D打印初版：
# 首先创建一个列表，其中包含一些要打印的设计
unprinted_designs = ['iphone case', 'robot pendant', 'dodecahedron']
completed_models = []
# 模拟打印每个设计，直到没有未打印的设计为止
# 打印每个设计后，都将其移到列表completed_models中
while unprinted_designs:
current_design = unprinted_designs.pop()
#模拟根据设计制作3D打印模型的过程
print("Printing model: " + current_design)
completed_models.append(current_design)
# 显示打印好的所有模型
print("\nThe following models have been printed:")
for completed_model in completed_models:
print(completed_model)
# Printing model: dodecahedron
# Printing model: robot pendant
# Printing model: iphone case
# The following models have been printed:
# dodecahedron
# robot pendant
# iphone case
3D打印代码重构版：
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):
"""显示打印好的所有模型"""
print("\nThe following models have been printed:")
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)
# 这里的 实参 和 形参 操作的是同一个 列表
# 很像C语言的指针传递，将 实参的地址 传递给 形参的地址
# 这个程序更容易扩展和维护
# 如果以后需要打印其他设计，只需再次调用print_models() 即可
# 如果我们发现需要对打印代码进行修改，只需修改这些代码一次，就能影响所有调用该函数的地方
# 这个程序还演示了这样一种理念，
# 即每个函数都应只负责一项具体的工作;
# 第一个函数打印每个设计，而第二个显示打印好的模型，这优于使用一个函数来完成两项工作
# 编写函数时，如果你发现它执行的任务太多，可以尝试将这些代码划分到多个函数中；
# 别忘了，总是可以在一个函数中调用另一个函数，这有助于将复杂的任务划分成一系列的步骤
# 不传递原列表，创建副本
function_name(list_name[:])
# 切片表示法[:] 创建列表的副本
print_models(unprinted_designs[:], completed_models)
# 不会清空未打印的设计列表
# 除非有充分的理由需要传递副本，否则还是应该将原始列表传递给函数，
# 因为让函数使用现成列表可避免花时间和内存创建副本，从而提高效率，
# 在处理大型列表时尤其如此
传递任意数量的实参
def make_pizza(*toppings):
"""打印顾客点的所有配料"""
print(toppings)
make_pizza('pepperoni')
make_pizza('mushrooms', 'green peppers', 'extra cheese')
# ('pepperoni',)
# ('mushrooms', 'green peppers', 'extra cheese')
# 形参名 *toppings 中的星号让Python创建一个名为 toppings 的空元组，
# 并将收到的所有值都封装到这个元组中
# 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')
# Making a 16-inch pizza with the following toppings:
# - pepperoni
# Making a 12-inch pizza with the following toppings:
# - mushrooms
# - green peppers
# - extra cheese
# 形参 **user_info 中的两个星号让Python创建一个名为 user_info 的空字典，
# 并将收到的所有 名称—值对 都封装到这个字典中
def build_profile(first, last, **user_info):
"""创建一个字典，其中包含我们知道的有关用户的一切"""
profile = {}
profile['last_name'] = last
for key, value in user_info.items():
profile[key] = value
return profile
user_profile = build_profile('albert', 'einstein',
location='princeton',
field='physics')
print(user_profile)
# {'first_name': 'albert', 'last_name': 'einstein',
# 'location': 'princeton', 'field': 'physics'}
将函数存储在模块中
# 可将函数存储在被称为 模块 的独立文件中，
# 再将模块 导入 到主程序中
# import 语句允许在当前运行的程序文件中使用模块中的代码
# 通过将函数存储在独立的文件中，可隐藏程序代码的细节，将重点放在程序的高层逻辑上
# 可在众多不同的程序中重用函数
# 将函数存储在独立文件中后，可与其他程序员共享这些文件而不是整个程序
# 导入函数还能让我们使用其他程序员编写的函数库
# 导入整个模块
# 模块 是扩展名为.py的文件，包含要导入到程序中的代码
# pizza.py
def make_pizza(size, *toppings):
"""概述要制作的比萨"""
print("\nMaking a " + str(size) +
"-inch pizza with the following toppings:")
for topping in toppings:
print("- " + topping)
# 在pizza.py所在的目录中创建另一个名为making_pizzas.py的文件
# making_pizzas.py
# import pizza 让Python打开文件pizza.py，并将其中的所有函数都复制到这个程序中。
# 程序运行时，Python在幕后复制这些代码
import pizza
pizza.make_pizza(16, 'pepperoni')
pizza.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
# 要调用被导入的模块中的函数，
# 可指定导入的 模块的名称pizza 和 函数名make_pizza()，并用句点分隔它们
# 通用模板
# import module_name.py
# module_name.function_name()
# 导入特定的函数: 使用这种语法，调用函数时就无需使用句点
# from module_name import function_name
# 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')
# 导入模块中的所有函数
from module_name import *
from pizza import *
make_pizza(16, 'pepperoni')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
# 可通过名称来调用每个函数，而无需使用句点表示法
# 然而，使用并非自己编写的大型模块时，最好不要采用这种导入方法：
# 如果模块中有函数的名称与你的项目中使用的名称相同，Python可能遇到多个名称相同的函数或变量，
# 进而覆盖函数，而不是分别导入所有的函数
# 最佳的做法是: 只导入你需要使用的函数 or 导入整个模块并使用句点表示法
函数编写指南
应给函数指定描述性名称，且只在其中使用小写字母和下划线；
描述性名称可帮助你和别人明白代码想要做什么；
给模块命名时也应遵循上述约定；
每个函数都应包含简要地阐述其功能的注释，该注释应紧跟在函数定义后面，并采用文档字符串格式；
文档良好的函数让其他程序员只需阅读文档字符串中的描述就能够使用它：
他们完全可以相信代码如描述的那样运行，
只要知道函数的名称、需要的实参以及返回值的类型，就能在自己的程序中使用它；
给形参指定默认值时，等号两边不要有空格：
def function_name(parameter_0, parameter_1='default value')
对于函数调用中的关键字实参，也应遵循这种约定：
function_name(value_0, parameter_1='value')
PEP 8（https://www.python.org/dev/peps/pep-0008/ ）建议代码行的长度不要超过79字符，这样只要编辑器窗口适中，就能看到整行代码；
如果形参很多，导致函数定义的长度超过了79字符，可在函数定义中输入左括号后按回车键，并在下一行按两次Tab键，从而将形参列表和只缩进一层的函数体区分开来
def function_name(
parameter_0, parameter_1, parameter_2,
parameter_3, parameter_4, parameter_5):
function body...
如果程序或模块包含多个函数，可使用两个空行将相邻的函数分开，这样将更容易知道前一个函数在什么地方结束，下一个函数从什么地方开始；
所有的 import 语句都应放在文件开头，唯一例外的情形是，在文件开头使用了注释来描述整个程序
小结
如何编写函数，以及如何传递实参，让函数能够访问完成其工作所需的信息；
如何使用位置实参和关键字实参，以及如何接受任意数量的实参；
显示输出的函数和返回值的函数；
如何将函数同列表、字典、if 语句和while 循环结合起来使用;
如何将函数存储在被称为 模块 的独立文件中，让程序文件更简单、更易于理解;
学习了函数编写指南，遵循这些指南可让程序始终结构良好，并对你和其他人来说易于阅读；
程序员的目标之一是，编写简单的代码来完成任务，而函数有助于你实现这样的目标；
它们让你编写好代码块并确定其能够正确运行后，就可置之不理；
确定函数能够正确地完成其工作后，你就可以接着投身于下一个编码任务；
函数让你编写代码一次后，想重用它们多少次就重用多少次；
需要运行函数中的代码时，只需编写一行函数调用代码，就可让函数完成其工作；
需要修改函数的行为时，只需修改一个代码块，而所做的修改将影响调用这个函数的每个地方；
使用函数让程序更容易阅读，而良好的函数名概述了程序各个部分的作用；
相对于阅读一系列的代码块，阅读一系列函数调用让你能够更快地明白程序的作用；
函数还让代码更容易测试和调试；
如果程序使用一系列的函数来完成其任务，而其中的每个函数都完成一项具体的工作，测试和维护起来将容易得多：
你可编写分别调用每个函数的程序，并测试每个函数是否在它可能遇到的各种情形下都能正确地运行；
经过这样的测试后你就能信心满满，深信你每次调用这些函数时，它们都将正确地运行
人生便是艺术。
