Python函数（二）

Python函数（二）

四、传递列表

经常会发现，向函数传递列表很有用，其中包含的可能是名字、数或更复杂的对象（如字典）。将列表传递给函数后，函数就能直接访问其内容。下面使用函数来提高处理列表的效率。假设有一个用户列表，我们要问候其中的每位用户。下面的示例将包含名字的列表传递给个名为 greet_users() 的函数，这个函数问候列表中的每个人：

代码语言：javascript代码运行次数：0运行复制

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

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

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

代码语言：javascript代码运行次数：0运行复制

Hello, Hannah!
Hello, Ty!
Hello, Margot!

输出完全符合预期。每位用户都看到了一条个性化的问候语。每当需要问候一组用户时，都可调用这个函数。

（一）在函数中修改列表

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

来看一家为用户提交的设计制作D打印模型的公司。需要打印的设计存储在一个列表中，打印后将移到另一个表中。下面是在不使用函数的情况下模拟这个过程的代码：

代码语言：javascript代码运行次数：0运行复制

#首先创建一个列表，其中包含一些要打印的设计。
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)

这个程序首先创建一个需要打印的设计列表，以及一个名为 completed_models 的空列表，每个设计打印后都将移到其中。只要列表 unprinted_designs 中还有设计，while 循环就模拟打印设计的过程：从该列表末尾删除一个设计，将其赋给变量 current_design ，并显示一条消息指出正在打印当前的设计，然后将该设计加人到列表 completed_models中。循环结束后，显示已打印的所有设计：

代码语言：javascript代码运行次数：0运行复制

Printing model: dodecahedron
Printing model: robot pendant
Printing model: phone case

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

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

代码语言：javascript代码运行次数：0运行复制

def print_models(unprinted_designs, completed_models):
    """
    模拟打印每个设计，直到没有未打印的设计为止。
    打印每个设计后，都将其移到列表completed models中。
    """
    while unprinted_designs:
        current_design = unprinted_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)
        
unprinted_designs = ['phone case', 'robot pendant', 'dodecahedron']
completed_models = []

print_models(unprinted_designs, completed_models)
show_completed_models(completed_models)

代码语言：javascript代码运行次数：0运行复制

Printing model: dodecahedron
Printing model: robot pendant
Printing model: phone case

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

定义了函数 print_models() ，它包含两个形参：一个需要打印的设计列表和一个打印好的模型列表。给定这两个列表，该函数模拟打印每个设计的过程:将设计逐个从未打印的设计列表中取出，并加人打印好的模型列表中。定义了函数 show_completed_models() ，它包含一个形参：打印好的模型列表。给定这个列表，函数 show_completed_models() 显示打印出来的每个模型的名称。

这个程序的输出与未使用函数的版本相同，但组织更为有序。完成大部分工作的代码都移到了两个函数中，让主程序更容易理解。只要看看主程序，就会发现这个程序的功能清晰得多：

代码语言：javascript代码运行次数：0运行复制

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

print_models(unprinted_designs, completed_models)
show_completed_models(completed_models)

我们创建了一个未打印的设计列表，还创建了一个空列表，用于存储打印好的模型。接下来，由于已经定义了两个函数，只需调用它们并传入正确的实参即可。我们调用 print_models() 并向它传递两个列表。像预期一样，print_models() 模拟打印设计的过程。接下来，调用 show_completed_models() ，并将打印好的模型列表传递给它，让其能够指出打印了哪些模型。描述性的函数名让别人阅读这些代码时也能明白，尽管没有任何注释。

相比于没有使用函数的版本，这个程序更容易扩展和维护。如果以后需要打印其他设计只需再次调用 print_models() 即可。如果发现需要对打印代码进行修改，只需修改这些代码次，就能影响所有调用该函数的地方。与必须分别修改程序的多个地方相比，这种修改的效率更高。

该程序还演示了这样一种理念：每个函数都应只负责一项具体的工作。第一个函数打印每个设计，第二个显示打印好的模型。这优于使用一个函数来完成这两项工作。编写函数时，如果发现它执行的任务太多，请尝试将这些代码划分到两个函数中。别忘了，总是可以在个函数中调用另一个函数，这有助于将复杂的任务划分成一系列步骤。

（二）禁止函数修改列表

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

要将列表的副本传递给函数，可以像下面这样做：

代码语言：javascript代码运行次数：0运行复制

function_name(list_name[:])

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

代码语言：javascript代码运行次数：0运行复制

print_models(unprinted_designs[:],completed_models) 

这样函数 print_models() 依然能够完成工作，因为它获得了所有未打印的设计的名称，但使用的是列表 unprinted_designs 的副本，而不是列表 unprinted_designs 本身。像以前一样，列表 completed_models 也将包含打印好的模型的名称，但函数所做的修改不会影响到列表 unprinted_designs 。

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

五、传递任意数量的实参

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

例如，来看一个制作比萨的函数，它需要接受很多配料，但无法预先确定顾客要多少种配料。下面的函数只有一个形参 *toppings ，但不管调用语句提供了多少实参，这个形参会将它们统统收人囊中：

代码语言：javascript代码运行次数：0运行复制

def make_pizza(*toppings):
    """打印顾客点的所有配料。"""
    print(toppings)

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

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

代码语言：javascript代码运行次数：0运行复制

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

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

代码语言：javascript代码运行次数：0运行复制

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

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

不管收到一个值还是三个值，这个函数都能妥善处理：

代码语言：javascript代码运行次数：0运行复制

Making a pizza with the following toppings:
- pepperoni

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

不管函数收到的实参是多少个，这种语法都管用。

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

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

例如，如果前面的函数还需要一个表示比萨尺寸的形参，必须将其放在形参 *toppings 的前面：

代码语言：javascript代码运行次数：0运行复制

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

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

现在，每个比萨都有了尺寸和一系列配料，而且这些信息按正确的顺序打印出来了——首先是尺寸，然后是配料：

代码语言：javascript代码运行次数：0运行复制

Making a 16-inch pizza with the following toppings:
- pepperoni

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

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

（二）使用任意数量的关键字实参

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

代码语言：javascript代码运行次数：0运行复制

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='physics' ），并将返回的 user_info 赋给变量 user_profile，再打印该变量：

代码语言：javascript代码运行次数：0运行复制

{'location': 'princeton', 'field': 'physics', 'first_name': 'albert', 'last_name': 'einstein'}

在这里，返回的字典包含用户的名和姓，还有求学的地方和所学专业。调用这个函数时，不管额外提供多少个键值对，它都能正确地处理。

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

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

六、将函数存储在模块中

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

通过将函数存储在独立的文件中，可隐藏程序代码的细节，将重点放在程序的高层逻辑上。这还能让你在众多不同的程序中重用函数。将函数存储在独立文件中后，可与其他程序员共享这些文件而不是整个程序。知道如何导人函数还能让你使用其他程序员编写的函数库。

导入模块的方法有多种，下面对每种进行简要的介绍。

（一）导入整个模块

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

代码语言：javascript代码运行次数：0运行复制

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() 两次：

代码语言：javascript代码运行次数：0运行复制

import pizza

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

Python 读取这个文件时，代码行 import pizza 让 Python 打开文件 pizza.py ，并将其中的所有函数都复制到这个程序中。你看不到复制的代码，因为在这个程序即将运行时，Python 在幕后复制了这些代码。只需知道，在 making_pizzas.py 中，可使用 pizza.py 中定义的所有函数。

要调用被导入模块中的函数，可指定被导入模块的名称 pizza 和函数名 make_pizza() ，并用句点分隔。这些代码的输出与没有导入模块的原始程序相同：

代码语言：javascript代码运行次数：0运行复制

Making a 16-inch pizza with the following toppings:
- pepperoni

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

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

代码语言：javascript代码运行次数：0运行复制

module_name.function_name()

（二）导入特定的函数

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

代码语言：javascript代码运行次数：0运行复制

from module_name import function_name

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

代码语言：javascript代码运行次数：0运行复制

from module_name import function_0, function_1, function_2

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

代码语言：javascript代码运行次数：0运行复制

from pizza import make_pizza

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

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

（三）使用 as 给函数指定别名

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

下面给函数 make_pizza() 指定了别名 mp() 。这是在 import 语句中使用 make_pizza as mp 实现的，关键字 as 将函数重命名为指定的别名：

代码语言：javascript代码运行次数：0运行复制

from pizza import make_pizza as mp

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

上面的 import 语句将函数 make_pizza() 重命名为 mp() 。在这个程序中，每当需要调用 make_pizza() 时，都可简写成 mp() 。Python 将运行 make_pizza() 中的代码，避免与这个程序可能包含的函数 make_pizza() 混淆。

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

代码语言：javascript代码运行次数：0运行复制

from module_name import function_name as fn

（四）使用 as 给模块指定别名

还可以给模块指定别名。通过给模块指定简短的别名（如给模块 pizza 指定别名 p ），让你能够更轻松地调用模块中的函数。相比于 _pizza() ， pizza() 更为简洁：

代码语言：javascript代码运行次数：0运行复制

import pizza as p

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

上述 import 语句给模块 pizza 指定了别名 p ，但该模块中所有函数的名称都没变。要调用函数 make_pizza() ，可编写代码 _pizza() 而非 _pizza() 。这样不仅代码更简洁，还让你不用再关注模块名，只专注于描述性的函数名。这些函数名明确指出了函数的功能，对于理解代码而言，比模块名更重要。

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

代码语言：javascript代码运行次数：0运行复制

import module_name sa mn

（五）导入模块中的所有函数

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

代码语言：javascript代码运行次数：0运行复制

from pizza import *

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

import 语句中的星号让 Python 将模块 pizza 中的每个函数都复制到这个程序文件中。由于导入了每个函数，可通过名称来调用每个函数，而无须使用句点表示法。然而，使用并非自己编写的大型模块时，最好不要采用这种导入方法。这是因为如果模块中有函数的名称与当前项目中使用的名称相同，可能导致意想不到的结果：Python 可能遇到多个名称相同的函数或变量，进而覆盖函数，而不是分别导入所有的函数。

最佳的做法是，要么只导人需要使用的函数，要么导人整个模块并使用句点表示法。这让代码更清晰，更容易阅读和理解。这里之所以介绍这种导入方法，只是想让你在阅读别人编写的代码时，能够理解类似于下面的 import 语句：

代码语言：javascript代码运行次数：0运行复制

from module_name import *

七、函数编写指南

编写函数时，需要牢记几个细节。应给函数指定描述性名称，且只在其中使用小写字母和下划线。描述性名称可帮助你和别人明白代码想要做什么。给模块命名时也应遵循上述约定。

每个函数都应包含简要地闸述其功能的注释。该注释应紧跟在函数定义后面，并采用文档字符串格式。文档良好的函数让其他程序员只需阅读文档字符串中的描述就能够使用他。他们完全可以相信代码如描述的那样运行，并且只要知道函数的名称、需要的实参以及返回值的类型，就能在自己的程序中使用它。

给形参指定默认值时，等号两边不要有空格：

代码语言：javascript代码运行次数：0运行复制

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

对于函数调用中的关键字实参，也应遵循这种约定：

代码语言：javascript代码运行次数：0运行复制

function_name(value_0, parameter_1='value') 

PEP 8 建议代码行的长度不要超过79字符，这样只要编辑器窗口适中，就能看到整行代码。如果形参很多，导致函数定义的长度超过了79字符，可在函数定义中输入左括号后按回车键，并在下一行按两次 Tab 键，从而将形参列表和只缩进一层的函数体区分开来。

大多数编辑器会自动对齐后续参数列表行，使其缩进程度与你给第一个参数列表行指定的缩进程度相同：

代码语言：javascript代码运行次数：0运行复制

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

如果程序或模块包含多个函数，可使用两个空行将相邻的函数分开，这样将更容易知道前一 个函数在什么地方结束，下一个函数从什么地方开始。

所有 import 语句都应放在文件开头。唯一例外的情形是，在文件开头使用了注释来描述整个程序。

本文参与 腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。 原始发表：2024-02-18，如有侵权请联系 cloudcommunity@tencent 删除前往查看模型设计python程序函数