《Python从入门到实践》读书笔记——第八章 函数

《Python从入门到实践》读书笔记——第八章 函数

1. 定义函数

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

关键字 def 告诉Python, 要定义一个函数. 这是 函数定义 , 向Python指出了函数名, 还可能在圆括号内指出函数为完成任务需要什么样的信息. 在这里, 函数名为 greet_user(), 它不需要任何信息就能完成工作, 因此括号是空的(即便如此, 括号也必不可少). 最后, 定义以冒号结尾.
紧跟在 def greet_user(): 后面的所有缩进行构成了函数体.

L2处的文本是称为 文档字符串 的注释, 描述了函数是做什么的. 文档字符串用三引号括起, Python 使用它们来生成有关程序中函数的文档

想使用这个函数, 可调用它. 函数调用 让Python 执行函数的代码. 要 调用 函数, 可依次指定函数名以及用圆括号括起的必要信息. 由于这个函数不需要任何信息, 调用它时只需输入 greet_user() 即可

1.1 向函数传递信息

在函数定义 def greet_user() 的括号内添加 username 通过在这里添加 username, 可让函数接受你给 username 指定的任何值. 现在, 这个函数要求你调用它时给 username 指定一个值. 调用 greet_user() 时, 可将一个名字传递给它, 如下所示

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

#
Hello, Jesse

1.2 实参和形参

在函数 greet_user() 的定义中, 变量username 是一个 形参 , 即函数完成工作所需的信息. 在代码 greet_user('jesse') 中, 值’jesse’是一个 实参 , 即调用函数时传递给函数的信息. 调用函数时, 将要让函数使用的信息放在圆括号内. 在 greet_user('jesse') 中, 将实参 ‘jesse’ 传递给了函数 greet_user() , 这个值被赋给了形参 username.

大家有时候会形参、实参不分, 因此如果你看到有人将函数定义中的变量称为实参或将函数调用中的变量称为形参, 不要大惊小怪.

2. 传递实参

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

2.1 位置实参

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')

#
I have a hamster.
My hamster's name is Harry

• 1. 多次调用函数

多次调用函数是一中效率极高的工作方式. 在函数中, 可根据需要使用任意数量的位置实参, Python将按顺序将函数调用中的实参关联到函数定义中相应的实参.

• 2. 位置实参的顺序很重要

2.2 关键字实参

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

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')

在使用关键字实参时, 务必准确指定函数定义中的形参名

2.3 默认值

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

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()}")

# 基于这种定义, 在任何情况下都必须给 pet_name 提供实参, 如果要描述的动物不是小狗, 还必须在函数调用中给 animal_type 提供实参

# 一条名为willie的小狗
describe_pet('harry')

# 一只名为Harry的仓鼠
describe_pet(pet_name='harry', animal_type='hamster')

2.4 避免实参错误

3. 返回值

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

3.1 返回简单值

def get_formatted_name(first_name, last_name):
    """返回整洁的姓名"""
    full_name = f"{first_name} {last_name}"
    return full_name

musician = get_formatted_name('jimi', 'hendrix')
print(musician)

调用返回值的函数时, 需要提供一个变量, 以便将返回的值赋给它. 在这里, 将返回值赋给了变量 musician. 输出为整洁的姓名.

3.2 让实参变为可选的

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', 'hookler', 'lce')
print(musician)

在本例中,姓名是根据三个可能提供的部分创建的, 中间名是可选的, 因此在函数定义中最后列出该形参, 并将默认值设置为空字符串.
这个修改后的版本不仅适用于只有名和姓的人, 而且还适用于还有中间名的人.

3.3 返回字典

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)

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

3.4 结合使用函数和while循环

def get_formatted_name(first_name, last_name):
    """返回整洁的姓名"""
    full_name = f"{first_name} {last_name}"
    return full_name

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"\nHello, {formatted_name}!")

4. 传递列表

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

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

#
Hello, Hannah!
Hello, Margot!

4.1 在函数中修改列表

将列表传递给函数后, 函数就可对其进行修改. 在函数中对这个列表所做的任何修改都是永久性的, 这让你能够高效地处理大量数据.

# 首先创建一个列表, 其中包含一些要打印的设计.
unprinted_designs = ['phone case', 'robot pendant', 'dodecahedron']
completed_models = []

# 模拟打印每个设计, 知道没有未打印的设计为止.
# 打印每个设计后, 都将其移到列表 completed_models 中
while unprinted_designs:
    current_design = unprinted_designs.pop()
    print(f"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: phone case

The following models have been printed:
dodecahedron
robot pendant
phone case

为重新组织这些代码, 可编写两个函数, 每个都做一件具体的工作. 大部分代码与原来相同, 只是效率更高. 第一个函数负责处理打印设计的工作, 第二个概述打印了哪些设计

def print_models(uprighted_designs, completed_models):
    """
    模拟打印每个设计, 直到没有未打印的设计为止.
    打印每个设计后, 都将其移到列表 completed_models 中
    """
    while uprighted_designs:
        current_design = uprighted_designs.pop()
        print(f"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)

uprighted_designs = ['phone case', 'robot pendant', 'dodecahedron']
completed_models = []

print_models(uprighted_designs, completed_models)
show_completed_models(completed_models)

相比于没有使用函数的版本, 这个程序更容易扩展和维护, 修改的效率更高.
该程序还演示了这样一种理念: 每个函数都应只负责一项具体的工作. 第一个函数打印每个设计, 第二个显示打印好的模型. 这优于使用一个函数来完成这两项工作. 编写函数时, 如果发现执行的任务太多, 请尝试将这些代码划分到两个函数中. 别忘了, 总是可以在一个函数中调用另一个函数, 这有助于将复杂的函数划分成一系列步骤.

4.2 禁止函数修改列表

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

要将列表的副本传递给副本, 可以像下面这样做
function_name(list_name[:])

如在上面的例子中使用 print_models(uprinted_designs[:], completed_models) 这样函数 print_models() 依然能够完成工作, 应为它获得了所有未打印设计的名称, 但使用的是列表 upriinted_models 的副本, 而不是列表本身. 像以前一样, 列表completed_models 也将包含打印好的模型的名称, 但函数所做的修改不会影响到 unprinted_designs

虽然向函数传递列表的副本可保留原始列表的内容, 但除非有充分的理由, 否则还是应该将原始列表传递给函数. 这是因为让函数使用现成的列表可避免花时间和内存创建副本, 从而提高效率, 在处理大型列表时尤其如此.

5. 传递任意数量的实参

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

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

#
Making a pizza with the following toppings:
- pepperoni

Making a pizza with the following toppings:
- mushrooms
- green peppers
- extra cheese

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

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

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')
make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

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

5.2 使用任意数量的位置实参

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 中的名称值对

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

6. 将函数存储在模块中

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

6.1 导入整个模块

要让函数是可导入的, 得先创建模块. 模块 是扩展名为 .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}")

创建的模块,再调用 make_pizza() 两次

import pizza

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

Python读取这个文件时, 代码行 import pizza 让 Python 打开文件 pizza.py, 并将其中的所有函数都复制到这个程序中. 你看不到复制的代码, 因为在这个程序运行时,Python在幕后复制了这些代码. 你只需知道, 在making_pizzas.py 中, 可使用pizza.py 中定义的所有函数
要调用被导入模块中的函数, 可指定被导入模块的名称pizza 和函数名 make_pizza(),并用句点分隔.

这就是一种导入方法: 只需编写一条 import 语句并在其中指定模块名, 就可在程序中使用该模块中的所有函数.如果使用这种 import 语句导入了名为 module_name.py 的整个模块,就可使用下面的语法来使用其中的任何一个函数

module_name.function_name()

6.2 导入特定的函数

语法如下

from module_name import function_name

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

from module_name import function_0, function_1, function_2

from pizza import make_pizza

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

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

6.3 使用as给函数指定别名

如果要导入函数的名称可能与程序中现有的名称冲突, 或者函数的名称太长, 可指定简短而独一无二的 别名 : 函数的另一个名称, 类似于外号. 要个函数取这种特殊外号, 需要在 导入它时 指定

from pizza import make_pizza as mp
mp(16, 'pepproni')
mp(12, 'mushrooms', 'green peppers', 'extra cheese')

语法

from module_name import function_name as fn

6.4 使用as给模块指定别名

通过给模块指定简短的别名,让你能够更轻松的调用模块中的函数.

import pizza as p

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

语法

import module_name as mn

6.5 导入模块中的所有函数

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

from pizza import *

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

使用并非自己编写的大型模块时, 最好不要采用这种导入方法

7. 函数编写指南

• 应给函数指定描述性名称,且在其中使用小写字母和下划线
• 每个函数都应该包含简要地概述其功能的注释,该注释应该紧跟在函数定义后面,并采用文档字符串格式
• 给形参指定默认值时, 等号两边不要有空格

def function_name(parameter_0, parameter_1='default value')

• 对于函数调用中的关键字实参, 也应该遵循这种规定

function_name(value_0, parameter_1='value')

• 代码行的长度不要超过79字符, 如果函数定义的长度超过了79字符,可在函数定义中输出左括号后按回车键,并在下一行按两次Tab, 从而将形参列表和只缩进一层的函数体区分开来. 大多数编辑器对自动对齐后续参数列表行

def function_name(
        parameter_0, parameter_1, parameter_2,
        parameter_3, parameter_4, parameter_5):
    function body...

• 如果程序或模块包含多个函数,可使用 两个空行 将相邻的函数分开.
• 所有 import 语句都应该放在文件开头. 唯一例外的情形是, 在文件开头使用了注释来描述整个程序.