定义函数

下面时一个打印问候语的简单函数,名为greet_user():

  1. def greet_user():
  2. '''显示简单的问候语。'''
  3. print("Hello!")
  4. greet_user()

本例演示了最简单的函数结构。关键字def来告诉Python,你要定义一个函数。这是函数定义,向Python指出了函数名,还可能在圆括号内指出函数为完成任务需要什么样的信息,在这里,函数名为greet_user(),它不需要任何信息就能完成工作,因此括号时空的(即便如此,括号也必不可少)。最后,定义以冒号结尾。
紧跟在 def greet_user():后面的虽有缩进构成了函数体。 '''显示简单的问候语。'''是被称为文档字符串(docstring)的注释,描述了函数时做什么的。文档字符串用三引号括起,Python使用他们来生成有关程序中函数的文档。
要使用这个函数,可调用它,函数调用让Python执行函数的代码。要调用函数,可依次指定函数名以及用圆括号括起的必要信息。

向函数传递信息

  1. def greet_user(username):
  2. '''显示简单的问候语。'''
  3. print(f"Hello,{username.title()}!")
  4. greet_user('bill')

实参和形参

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

传递实参

  • 位置实参,这要求实参的顺序与形参的顺序相同;
  • 关键字实参,其中每个实参都由变量名和值组成
  • 还可以使用列表和字典

位置实参(位置很中重要)

  1. def describe_pet(animal_type, pet_name):
  2. '''显示宠物的信息。'''
  3. print(f"\nI have a {animal_type}.")
  4. print(f"My {animal_type}'s name is {pet_name.title()}.")
  5. describe_pet('hamster', 'harry')
  6. describe_pet('dog', 'willie')

多次调用函数时一种效率极高的工作方式。只需在函数中编写一次描述宠物的代码,然后每当需要描述新宠物时,都调用该函数并向它提供新宠物的信息。即便描述宠物的代码增加到了10行,依然只需使用一行调用函数的代码,就可以描述一个新宠物。

关键字实参

直接在实参中将名称和值关联起来,所以向函数传递实参时不会混淆

  1. def describe_pet(animal_type, pet_name):
  2. '''显示宠物的信息。'''
  3. print(f"\nI have a {animal_type}.")
  4. print(f"My {animal_type}'s name is {pet_name.title()}.")
  5. # 关键字实参的顺序无关紧要,因为Python知道各个值该赋给哪个形参。
  6. describe_pet(animal_type = 'hamset', pet_name = 'harry')
  7. describe_pet(pet_name = 'harry', animal_type = 'hamset')

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

默认值

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

  1. def describe_pet(pet_name, animal_type = 'dog' ):
  2. '''显示宠物的信息。'''
  3. print(f"\nI have a {animal_type}.")
  4. print(f"My {animal_type}'s name is {pet_name.title()}.")
  5. describe_pet(pet_name = 'harry')
  6. describe_pet('harry')

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

返回值

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

返回简单值

  1. def get_formatted_name(first_name, last_name):
  2. '''返回整洁姓名'''
  3. full_name = f"{first_name} {last_name}"
  4. return full_name.title()
  5. musician = get_formatted_name('jimi', 'hendrix')
  6. print(musician)

让实参变成可选的

  1. def get_formatted_name(first_name, last_name, middle_name=''):
  2. '''返回整洁姓名'''
  3. if middle_name:
  4. full_name = f"{first_name} {middle_name} {last_name}"
  5. else:
  6. full_name = f"{first_name} {last_name}"
  7. return full_name.title()
  8. musician = get_formatted_name('jimi', 'hendrix')
  9. print(musician)
  10. musician = get_formatted_name('john', 'hooker', 'lee')
  11. print(musician)

返回字典

  1. def build_person(first_name,last_name,age = None):
  2. '''返回一个字典,其中包含有关一个人的信息'''
  3. person = {'first':first_name, 'last':last_name}
  4. if age:
  5. person['age'] = age
  6. return person
  7. musician = build_person('jimi', 'hendrix',27)
  8. print(musician)

在函数定义中,新增了一个可选参数age,并将其默认值设置为特殊值None(表示变量没有值)。可将None视为占位值。在条件测试中,None相当于False。如果函数调用中包含形参age的值,这个值将被存储到字典中,

结合函数使用while循环

  1. def get_formatted_name(first_name, last_name):
  2. '''返回整洁姓名'''
  3. full_name = f"{first_name} {last_name}"
  4. return full_name.title()
  5. # 这是一个无限循环
  6. while True:
  7. print("\nPlease tell me your name:")
  8. print("(enter 'q' at any time to quit)")
  9. f_name = input("First name: ")
  10. if f_name == 'q':
  11. break
  12. l_name = input('Last name: ')
  13. if l_name == 'q':
  14. break
  15. formatted_name = get_formatted_name(f_name,l_name)
  16. print(f"\nHello, {formatted_name}!")

传递列表

将列表传递给函数后,函数就能直接访问其内容。

  1. def greet_user(names):
  2. '''向列表中的每位用户发出简单的问候'''
  3. for name in names:
  4. msg = f"Hello, {name.title()}"
  5. print(msg)
  6. usernames = ['hannah', 'ty', 'margot']
  7. greet_user(usernames)

在函数中修改列表

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

  1. # 首先创建一个列表,其中包含一些要打印的设计
  2. unprinted_designs = ['phone case', 'robot pendant', 'dodecahedron']
  3. completed_models = []
  4. # 模拟打印每个设计,知道没有未打印的设计为止。
  5. # 打印每个设计后,都将其移到列表 completed_models 中。
  6. while unprinted_designs:
  7. current_design = unprinted_designs.pop()
  8. print(f"Print model:{current_design}")
  9. completed_models.append(current_design)
  10. # 显示打印好的所有模型
  11. print("\nThe following models have been printed:")
  12. for completed_model in completed_models:
  13. print(completed_model)

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

  1. def print_models(unprinted_designs, completed_models):
  2. '''
  3. 模拟打印每个设计,直到没有未打印的设计为止。
  4. 打印每个设计后,都将其移到列表 completed_models 中
  5. '''
  6. while unprinted_designs:
  7. current_design = unprinted_designs.pop()
  8. print(f"Printing model:{current_design}")
  9. completed_models.append(current_design)
  10. def show_completed_models(completed_models):
  11. '''显示打印好的所有模型'''
  12. print("\nThe following modles have been printed:")
  13. for completed_model in completed_models:
  14. print(completed_model)
  15. unprinted_designs = ['phone case', 'robot pendant', 'dodecahedron']
  16. completed_models = []
  17. print_models(unprinted_designs,completed_models)
  18. show_completed_models(completed_models)

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

禁止函数修改列表

可向函数传递列表的副本而为原件,这样,函数所做的任何修改都只影响副本,而原件丝毫不受影响。
要将列表的副本传递给函数,可以像下面这样做:

  1. function_name(list_name[:])

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

  1. print_models(unprinted_models[:], completed_models)

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

传递任意数量的实参

  1. def make_pizza(*toppings):
  2. '''打印顾客点的所有配料。'''
  3. print(toppings)
  4. make_pizza('pepperoni')
  5. make_pizza('mushrooms','green peppers', 'extra cheese')

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

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

  1. def make_pizza(*toppings):
  2. '''概述要制作的披萨'''
  3. print("\nMake a pizza with the following topping:")
  4. for topping in toppings:
  5. print(f"- {topping}")
  6. make_pizza('pepperoni')
  7. make_pizza('mushrooms','green peppers', 'extra cheese')

image.png

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

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

  1. def make_pizza(size, *toppings):
  2. '''概述要制作的披萨'''
  3. print(f"\nMake a {size} pizza with the following topping:")
  4. for topping in toppings:
  5. print(f"- {topping}")
  6. make_pizza(16,'pepperoni')
  7. make_pizza(12,'mushrooms','green peppers', 'extra cheese')

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

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

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

  1. def build_profile(first,last, **user_info):
  2. '''创建一个字典,其中包含我们知道的有关用户的一切。'''
  3. user_info['fist_name'] = first
  4. user_info['last_name'] = last
  5. return user_info
  6. user_profile = build_profile('albert', 'einstein',location = 'princetion',field='physics')
  7. print(user_profile)

image.png :::info 函数build_profile()的定义要求提供名和姓,同时允许根据需要提供任意数量的名称值对。形参**user_info中的两个星号让Python创建一个名为user_info的空字典,并将收到的所有名称值对都放到这个字典中。在这个函数中,可以像访问其他字典那样访问user_info中的名称值对。 :::

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

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

将函数存储在模块中

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

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

导入整个模块

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

  1. def make_pizza(size, *toppings):
  2. '''概述要制作的披萨'''
  3. print(f"\nMaking a {size}-inch pizza with the following toppings:")
  4. for topping in toppings:
  5. print(f"- {topping}")

接下来,在pizza.py所在的目录中创建一个名为 making_pizzas.py 的文件。这个文件导入刚创建的模块,再调用 make_pizza() 两次:

  1. import pizza
  2. pizza.make_pizza(16, 'pepperoni')
  3. pizza.make_pizza(12,'mushroom','green peppers', 'extra cheese')

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

导入特定的函数

导入方法如下:

  1. from module_name import function_name

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

  1. from module_name import function_0, function_1, function_2

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

  1. from pizza import make_pizza
  2. make_pizza(16, 'pepperoni')
  3. make_pizza(12,'mushroom','green peppers', 'extra cheese')

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

使用 as 给函数指定别名

  1. import pizza as p
  2. p.make_pizza(16, 'pepperoni')
  3. p.make_pizza(12,'mushroom','green peppers', 'extra cheese')

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

  1. import module_name as mn

导入模块中的所有函数

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

  1. from pizza import *
  2. make_pizza(16, 'pepperoni')
  3. make_pizza(12,'mushroom','green peppers', 'extra cheese')

:::tips 由于导入了每个函数,可通过名称来调用每个函数,而无须使用句点表示法。然而,使用并非自己编写的大型模块时,最好不要采用这种导入方法。这是因为如果模块中有函数的名称与当前项目中使用的名称相同,可能导致意想不到的结果:Python可能遇到多个名称相同的函数或变量,进而覆盖函数,而不是分别导入所有的函数。
最佳的做法是,要么只导入需要使用的函数,要么导入整个模块并使用句点表示法。这让代码更清晰,更容易阅读和理解。 ::: IMG_20211006_222742_1.jpg
IMG_20211006_222753.jpg