持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第24天,点击查看活动详情
- 函数是带名字的代码块,用于完成具体的工作。
- 要执行函数定义的特定任务,可调用该函数。
- 需要在程序中多次执行同一项任务时,无须反复编写完成该任务的代码,只需要调用执行该任务的函数,让Python运行其中的代码即可
一、定义函数:
❶处的代码行使用关键字def来告诉Python,你要定义一个函数。这是函数定义,向Python指出了函数名,还可能在圆括号内指出函数为完成任务需要什么样的信息。在这里,函数名为greet_user(),它不需要任何信息就能完成工作,因此括号是空的(即便如此,括号也必不可少)。最后,定义以冒号结尾。
紧跟在def greet_user():后面的所有缩进行构成了函数体。❷处的文本是称为文档字符串(docstring)的注释,描述了函数是做什么的。文档字符串用三引号括起,Python使用它们来生成有关程序中函数的文档。
代码行print("Hello!")(见❸)是函数体内的唯一一行代码,因此greet_user()只做一项工作:打印Hello!。
要使用这个函数,可调用它。函数调用让Python执行函数的代码。要调用函数,可依次指定函数名以及用圆括号括起的必要信息,如❹处所示。由于这个函数不需要任何信息,调用它时只需输入greet_user()即可。和预期一样,它打印Hello!:
向函数传递信息:
稍作修改,就可让函数greet_user()不仅向用户显示Hello!,还将用户的名字作为抬头。为此,可在函数定义defgreet_user()的括号内添加username。通过在这里添加username,可让函数接受你给username指定的任何值。现在,这个函数要求你调用它时给username指定一个值。调用greet_user()时,可将一个名字传递给它
代码greet_user('jesse')调用函数greet_user(),并向它提供执行函数调用print()所需的信息。这个函数接受你传递给它的名字,并向这个人发出问候:
同样,greet_user('sarah')调用函数greet_user()并向它传递'sarah',从而打印Hello, Sarah!。可根据需要调用函数greet_user()任意次,调用时无论传入什么名字,都将生成相应的输出。
实参和形参:
前面定义函数greet_user()时,要求给变量username指定一个值。调用这个函数并提供这种信息(人名)时,它将打印相应的问候语。
在函数greet_user()的定义中,变量username是一个形参(parameter),即函数完成工作所需的信息。
在代码greet_user('jesse')中,值'jesse'是一个实参(argument),即调用函数时传递给函数的信息。
调用函数时,将要让函数使用的信息放在圆括号内。在greet_user('jesse')中,将实参'jesse'传递给了函数greet_user(),这个值被赋给了形参username。
参数传递过程: 实参 ------> 形参
二、传递实参:
- 函数定义中可能包含多个形参,因此函数调用中也可能包含多个实参。
- 向函数传递实参的方式很多:可使用位置实参,这要求实参的顺序与形参的顺序相同;也可使用关键字实参,其中每个实参都由变量名和值组成;还可使用列表和字典。
位置实参:
- 调用函数时,Python必须将函数调用中的每个实参都关联到函数定义中的一个形参。为此,最简单的关联方式是基于实参的顺序。这种关联方式称为位置实参。
这个函数的定义表明,它需要一种动物类型和一个名字(见❶)。调用describe_pet()时,需要按顺序提供一种动物类型和一个名字。
例如,在刚才的函数调用中,实参'hamster'被赋给形参animal_type,而实参'harry'被赋给形参pet_name(见❷)。
在函数体内,使用了这两个形参来显示宠物的信息
多次调用函数:
第二次调用describe_pet()函数时,向它传递了实参'dog'和'willie'。与第一次调用时一样,Python将实参'dog'关联到形参animal_type,并将实参'willie'关联到形参pet_name。与前面一样,这个函数完成了任务,但打印的是一条名为Willie的小狗的信息。至此,有一只名为Harry的仓鼠,还有一条名为Willie的小狗:
多次调用函数是一种效率极高的工作方式。只需在函数中编写一次描述宠物的代码,然后每当需要描述新宠物时,都调用该函数并向它提供新宠物的信息。即便描述宠物的代码增加到了10行,依然只需使用一行调用函数的代码,就可描述一个新宠物。
在函数中,可根据需要使用任意数量的位置实参,Python将按顺序将函数调用中的实参关联到函数定义中相应的形参。
位置实参的顺序很重要:
- 使用位置实参来调用函数时,如果实参的顺序不正确,结果可能出乎意料:
关键字实参:
- 关键字实参是传递给函数的名称值对。因为直接在实参中将名称和值关联起来,所以向函数传递实参时不会混淆(不会得到名为Hamster的harry这样的结果)。
- 关键字实参让你无须考虑函数调用中的实参顺序,还清楚地指出了函数调用中各个值的用途。
函数describe_pet()还和之前一样,但调用这个函数时,向Python明确地指出了各个实参对应的形参。看到这个函数调用时,Python知道应该将实参'hamster'和'harry'分别赋给形参animal_type和pet_name。输出正确无误,指出有一只名为Harry的仓鼠。
关键字实参的顺序无关紧要,因为Python知道各个值该赋给哪个形参。下面两个函数调用是等效的:
注意:使用关键字实参时,务必准确指定函数定义中的形参名。
默认值:
- 编写函数时,可给每个形参指定默认值。在调用函数中给形参提供了实参时,Python将使用指定的实参值;否则,将使用形参的默认值。
- 因此,给形参指定默认值后,可在函数调用中省略相应的实参。使用默认值可简化函数调用,还可清楚地指出函数的典型用法。
这里修改了函数describe_pet()的定义,在其中给形参animal_type指定了默认值'dog'。这样,调用这个函数时,如果没有给animal_type指定值,Python就将把这个形参设置为'dog':
请注意,在这个函数的定义中,修改了形参的排列顺序。因为给animal_type指定了默认值,无须通过实参来指定动物类型,所以在函数调用中只包含一个实参——宠物的名字。然而,Python依然将这个实参视为位置实参,因此如果函数调用中只包含宠物的名字,这个实参将关联到函数定义中的第一个形参。这就是需要将pet_name放在形参列表开头的原因。
现在,使用这个函数的最简单方式是在函数调用中只提供小狗的名字:
注意:使用默认值时,必须先在形参列表中列出没有默认值的形参,再列出有默认值的实参。这让Python依然能够正确地解读位置实参。
等效的函数调用:
- 鉴于可混合使用位置实参、关键字实参和默认值,通常有多种等效的函数调用方式。
- 请看下面对函数describe_pet()的定义,其中给一个形参提供了默认值:
def describe_pet(pet_name = 'willie',animal_type ='dog'):
- 基于这种定义,在任何情况下都必须给pet_name提供实参。指定该实参时可采用位置方式,也可采用关键字方式。如果要描述的动物不是小狗,还必须在函数调用中给animal_type提供实参。同样,指定该实参时可以采用位置方式,也可采用关键字方式。
这些函数调用的输出与前面的示例相同。
注意:使用哪种调用方式无关紧要,只要函数调用能生成你期望的输出就行。使用对你来说最容易理解的调用方式即可。
避免实参错误:
-
等你开始使用函数后,如果遇到实参不匹配错误,不要大惊小怪。你提供的实参多于或少于函数完成工作所需的信息时,将出现实参不匹配错误。
-
Python读取函数的代码并指出需要为哪些形参提供实参,这提供了极大的帮助。这也是应该给变量和函数指定描述性名称的另一个原因:如果这样做了,那么无论对于你,还是可能使用你编写的代码的其他任何人来说,Python提供的错误消息都将更有帮助。
-
如果提供的实参太多,将出现类似的traceback,帮助你确保函数调用和函数定义匹配。
三、返回值
- 函数并非总是直接显示输出,它还可以处理一些数据,并返回一个或一组值。函数返回的值称为返回值。
- 在函数中,可使用return语句将值返回到调用函数的代码行。
- 返回值让你能够将程序的大部分繁重工作移到函数中去完成,从而简化主程序。
返回简单值:
函数get_formatted_name()的定义通过形参接受名和姓(见❶)。它将姓和名合而为一,在中间加上一个空格,并将结果赋给变量full_name(见❷)。然后,将full_name的值转换为首字母大写格式,并将结果返回到函数调用行(见❸)。
调用返回值的函数时,需要提供一个变量,以便将返回的值赋给它。在这里,将返回值赋给了变量musician(见❹)。
让实参变成可选的:
- 有时候,需要让实参变成可选的,这样使用函数的人就能只在必要时提供额外的信息。可使用默认值来让实参变成可选的。
- 只要同时提供名、中间名和姓,这个函数就能正确运行。它根据这三部分创建一个字符串,在适当的地方加上空格,并将结果转换为首字母大写格式:
在本例中,姓名是根据三个可能提供的部分创建的。由于人都有名和姓,因此在函数定义中首先列出了这两个形参。中间名是可选的,因此在函数定义中最后列出该形参,并将其默认值设置为空字符串(见❶)。
在函数体中,检查是否提供了中间名。Python将非空字符串解读为True,因此如果函数调用中提供了中间名,ifmiddle_name将为True(见❷)。如果提供了中间名,就将名、中间名和姓合并为姓名,再将其修改为首字母大写格式,并返回到函数调用行。在函数调用行,将返回的值赋给变量musician,然后这个变量的值被打印出来。如果没有提供中间名,middle_name将为空字符串,导致if测试未通过,进而执行else代码块(见❸):只使用名和姓来生成姓名,并将格式设置好的姓名返回给函数调用行。在函数调用行,将返回的值赋给变量musician,然后这个变量的值被打印出来。
调用这个函数时,如果只想指定名和姓,调用起来将非常简单。如果还要指定中间名,就必须确保它是最后一个实参,这样Python才能正确地将位置实参关联到形参(见❹)。
返回字典:
- 函数可返回任何类型的值,包括列表和字典等较复杂的数据结构。
- 在函数定义中,新增了一个可选形参age,并将其默认值设置为特殊值None(表示变量没有值)。可将None视为占位值。在条件测试中,None相当于False。如果函数调用中包含形参age的值,这个值将被存储到字典中。在任何情况下,这个函数都会存储人的姓名,但可进行修改,使其同时存储有关人的其他信息。
结合使用函数和while循环:
-
在本例中,使用的是get_formatted_name()的简单版本,不涉及中间名。while循环让用户输入姓名:依次提示用户输入名和姓(见❶)。
-
但这个while循环存在一个问题:没有定义退出条件。请用户提供一系列输入时,该在什么地方提供退出途径呢?要让用户能够尽可能容易地退出,因此每次提示用户输入时,都应提供退出途径。每次提示用户输入时,都使用break语句提供退出循环的简单途径:
- 我们添加了一条消息来告诉用户如何退出,然后在每次提示用户输入时,都检查他输入的是否是退出值。
- 如果是,就退出循环。现在,这个程序将不断地问候,直到用户输入的姓或名为'q':
四、传递列表:
- 你经常会发现,向函数传递列表很有用,其中包含的可能是名字、数或更复杂的对象(如字典)。将列表传递给函数后,函数就能直接访问其内容。下面使用函数来提高处理列表的效率。
- 我们将greet_users()定义为接受一个名字列表,并将其赋给形参names。这个函数遍历收到的列表,并对其中的每位用户打印一条问候语。❶处定义了一个用户列表usernames,然后调用greet_users()并将该列表传递给它:
在函数中修改列表:
- 将列表传递给函数后,函数就可对其进行修改。在函数中对这个列表所做的任何修改都是永久性的,这让你能够高效地处理大量数据。
- 这个程序首先创建一个需要打印的设计列表,以及一个名为completed_models的空列表,每个设计打印后都将移到其中。只要列表unprinted_designs中还有设计,while循环就模拟打印设计的过程:从该列表末尾删除一个设计,将其赋给变量current_design,并显示一条消息指出正在打印当前的设计,然后将该设计加入到列表completed_models中。循环结束后,显示已打印的所有设计:
- 为重新组织这些代码,可编写两个函数,每个都做一件具体的工作。大部分代码与原来相同,只是效率更高。第一个函数负责处理打印设计的工作,第二个概述打印了哪些设计:
-
❶处定义了函数print_models(),它包含两个形参:一个需要打印的设计列表和一个打印好的模型列表。给定这两个列表,该函数模拟打印每个设计的过程:将设计逐个从未打印的设计列表中取出,并加入打印好的模型列表中。
-
❷处定义了函数show_completed_models(),它包含一个形参:打印好的模型列表。给定这个列表,函数show_completed_models()显示打印出来的每个模型的名称。
-
这个程序的输出与未使用函数的版本相同,但组织更为有序。完成大部分工作的代码都移到了两个函数中,让主程序更容易理解。只要看看主程序,就会发现这个程序的功能清晰得多:
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,这个列表变成了空的,原来的列表没有了。为解决这个问题,可向函数传递列表的副本而非原件。这样,函数所做的任何修改都只影响副本,而原件丝毫不受影响。
- 将列表的副本传递给函数,可以像下面这样做:
function_name(list_name_[:])
- 切片表示法[:]创建列表的副本。在printing_models.py中,如果不想清空未打印的设计列表,可像下面这样调用print_models():
- 这样函数print_models()依然能够完成工作,因为它获得了所有未打印的设计的名称,但使用的是列表unprinted_designs的副本,而不是列表unprinted_designs本身。像以前一样,列表completed_models也将包含打印好的模型的名称,但函数所做的修改不会影响到列表unprinted_designs。
- 虽然向函数传递列表的副本可保留原始列表的内容,但除非有充分的理由,否则还是应该将原始列表传递给函数。这是因为让函数使用现成的列表可避免花时间和内存创建副本,从而提高效率,在处理大型列表时尤其如此。
五、传递任意数量的实参:
-
有时候,预先不知道函数需要接受多少个实参,好在Python允许函数从调用语句中收集任意数量的实参。
-
例如,来看一个制作比萨的函数,它需要接受很多配料,但无法预先确定顾客要多少种配料。下面的函数只有一个形参*toppings,但不管调用语句提供了多少实参,这个形参会将它们统统收入囊中:
- 形参名*toppings中的星号让Python创建一个名为toppings的空元组,并将收到的所有值都封装到这个元组中。函数体内的函数调用print()通过生成输出,证明Python能够处理使用一个值来调用函数的情形,也能处理使用三个值来调用函数的情形。它以类似的方式处理不同的调用。注意,Python将实参封装到一个元组中,即便函数只收到一个值:
- 现在,可以将函数调用print()替换为一个循环,遍历配料列表并对顾客点的比萨进行描述:
- 不管收到一个值还是三个值,这个函数都能妥善处理:
- 不管函数收到的实参是多少个,这种语法都管用。
结合使用位置实参和任意数量实参
- 如果要让函数接受不同类型的实参,必须在函数定义中将接纳任意数量实参的形参放在最后。
- Python先匹配位置实参和关键字实参,再将余下的实参都收集到最后一个形参中。
- 基于上述函数定义,Python将收到的第一个值赋给形参size,并将其他所有值都存储在元组toppings中。在函数调用中,首先指定表示比萨尺寸的实参,再根据需要指定任意数量的配料。现在,每个比萨都有了尺寸和一系列配料,而且这些信息按正确的顺序打印出来了——首先是尺寸,然后是配料:
- 注意:你经常会看到通用形参名*args,它也收集任意数量的位置实参。
使用任意数量的关键字实参:
- 有时候,需要接受任意数量的实参,但预先不知道传递给函数的会是什么样的信息。在这种情况下,可将函数编写成能够接受任意数量的键值对——调用语句提供了多少就接受多少。一个这样的示例是创建用户简介:你知道将收到有关用户的信息,但不确定会是什么样的信息。在下面的示例中,函数build_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,再打印该变量:
六、将函数存储在模块中:
- 使用函数的优点之一是可将代码块与主程序分离。通过给函数指定描述性名称,可让主程序容易理解得多。你还可以更进一步,将函数存储在称为模块的独立文件中,再将模块导入到主程序中。import语句允许在当前运行的程序文件中使用模块中的代码。
- 通过将函数存储在独立的文件中,可隐藏程序代码的细节,将重点放在程序的高层逻辑上。这还能让你在众多不同的程序中重用函数。将函数存储在独立文件中后,可与其他程序员共享这些文件而不是整个程序。知道如何导入函数还能让你使用其他程序员编写的函数库。
导入整个模块:
- 要让函数是可导入的,得先创建模块。模块是扩展名为.py的文件,包含要导入到程序中的代码。下面来创建一个包含函数make_pizza()的模块。为此,将文件pizza.py中除函数make_pizza()之外的其他代码删除:
- 接下来,在pizza.py所在的目录中创建一个名为making_pizzas.py的文件。这个文件导入刚创建的模块,再调用make_pizza()两次:
- Python读取这个文件时,代码行import pizza让Python打开文件pizza.py,并将其中的所有函数都复制到这个程序中。你看不到复制的代码,因为在这个程序即将运行时,Python在幕后复制了这些代码。你只需知道,在making_pizzas.py中,可使用pizza.py中定义的所有函数。
- 要调用被导入模块中的函数,可指定被导入模块的名称pizza和函数名make_pizza(),并用句点分隔(见❶)。这些代码的输出与没有导入模块的原始程序相同:
- 这就是一种导入方法:只需编写一条import语句并在其中指定模块名,就可在程序中使用该模块中的所有函数。如果使用这种import语句导入了名为module_name.py的整个模块,就可使用下面的语法来使用其中任何一个函数:
module_name.function_name()
导入特定的函数:
- 还可以导入模块中的特定函数,这种导入方法的语法如下:
from module_name import function_name()
- 通过用逗号分隔函数名,可根据需要从模块中导入任意数量的函数:
from module_name import function_0,function_1,function_2
- 对于前面的making_pizzas.py示例,如果只想导入要使用的函数,代码将类似于下面这样:
- 使用这种语法时,调用函数时无须使用句点。由于在import语句中显式地导入了函数make_pizza(),调用时只需指定其名称即可。
使用as给函数指定别名:
-
如果要导入函数的名称可能与程序中现有的名称冲突,或者函数的名称太长,可指定简短而独一无二的别名:函数的另一个名称,类似于外号。要给函数取这种特殊外号,需要在导入它时指定。
-
下面给函数make_pizza()指定了别名mp()。这是在import语句中使用make_pizza as mp实现的,关键字as将函数重命名为指定的别名:
- 上面的import语句将函数make_pizza()重命名为mp()。在这个程序中,每当需要调用make_pizza()时,都可简写成mp()。Python将运行make_pizza()中的代码,避免与这个程序可能包含的函数make_pizza()混淆。
from module_name import function_name as 别名
使用as给模块指定别名:
- 还可以给模块指定别名。通过给模块指定简短的别名(如给模块pizza指定别名p),让你能够更轻松地调用模块中的函数。相比于pizza.make_pizza(),p.make_pizza()更为简洁:
- 上述import语句给模块pizza指定了别名p,但该模块中所有函数的名称都没变。要调用函数make_pizza(),可编写代码p.make_pizza()而非pizza.make_pizza()。这样不仅代码更简洁,还让你不用再关注模块名,只专注于描述性的函数名。这些函数名明确指出了函数的功能,对于理解代码而言,比模块名更重要。
- 给模块指定别名的通用语法如下:
import module_name as 别名
导入模块中的所有函数:
- 使用星号(*)运算符可让Python导入模块中的所有函数:
- import语句中的星号让Python将模块pizza中的每个函数都复制到这个程序文件中。由于导入了每个函数,可通过名称来调用每个函数,而无须使用句点表示法。然而,使用并非自己编写的大型模块时,最好不要采用这种导入方法。这是因为如果模块中有函数的名称与当前项目中使用的名称相同,可能导致意想不到的结果:Python可能遇到多个名称相同的函数或变量,进而覆盖函数,而不是分别导入所有的函数。
- 最佳的做法是,要么只导入需要使用的函数,要么导入整个模块并使用句点表示法。这让代码更清晰,更容易阅读和理解。这里之所以介绍这种导入方法,只是想让你在阅读别人编写的代码时,能够理解类似于下面的import语句:
from module_name import *
七、函数编写指南:
-
编写函数时,需要牢记几个细节。应给函数指定描述性名称,且只在其中使用小写字母和下划线。描述性名称可帮助你和别人明白代码想要做什么。给模块命名时也应遵循上述约定。
-
每个函数都应包含简要地阐述其功能的注释。该注释应紧跟在函数定义后面,并采用文档字符串格式。文档良好的函数让其他程序员只需阅读文档字符串中的描述就能够使用它。他们完全可以相信代码如描述的那样运行,并且只要知道函数的名称、需要的实参以及返回值的类型,就能在自己的程序中使用它。
# 给形参指定默认值时,等号两边不要有空格
def function_name(parameter_0,parameter_1 = 'default value')
# 对于函数调用中的关键字实参,也应遵循这种约定:
function_name(value_0,parameter_1 = 'value')
- PEP 8建议代码行的长度不要超过79字符,这样只要编辑器窗口适中,就能看到整行代码。如果形参很多,导致函数定义的长度超过了79字符,可在函数定义中输入左括号后按回车键,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。
- 大多数编辑器会自动对齐后续参数列表行,使其缩进程度与你给第一个参数列表行指定的缩进程度相同:
def function_name(parameter_0,parameter_1.parameter_2,parameter_3,parameter_4,parameter_5):
function body...
-
如果程序或模块包含多个函数,可使用两个空行将相邻的函数分开,这样将更容易知道前一个函数在什么地方结束,下一个函数从什么地方开始。所有import语句都应放在文件开头。唯一例外的情形是,在文件开头使用了注释来描述整个程序。
-
所有import语句都应放在文件开头。唯一例外的情形是,在文件开头使用了注释来描述整个程序。