.describe() python_【python小白上路系列】函数

第二个周末持续加班了，体力严重透支。

在本章中，你将学习编写函数 。函数是带名字的代码块，用于完成具体的工作。

要执行函数定义的特定任务，可调用该函数。需要在程序中多次执行同一项任务时，你无需反复编写完成该任务的代码，而只需调用执行该任务的函数，让Python运行其中的代码。你将发现，通过使用函数，程序的编写、阅读、测试和修复都将更容易。

在本章中，你还会学习向函数传递信息的方式。你将学习如何编写主要任务是显示信息的函数，还有用于处理数据并返回一个或一组值的函数。最后，你将学习如何 将函数存储在被称为模块的独立文件中，让主程序文件的组织更为有序。

8.1 定义函数

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

def greet_user():    print("Hello")greet_user()

运行结果：

8.1.1 向函数传达信息

只需稍作修改，就可以让函数greet_user() 不仅向用户显示Hello! ，还将用户的名字用作抬头。为此，可在函数定义def greet_user() 的括号内添加username 。

通过在这里添加username ，就可让函数接受你给username指定的任何值。现在，这个函数要求你调用它时给username 指定一个值。调用greet_user() 时，可将一个名字传递给它，如下所示：

#传递参数def greeter_user(username):    print("Hello, " + username.title() + "!")greeter_user('charles')

运行结果：

8.1.2 实参和形参

前面定义函数greet_user() 时，要求给变量username 指定一个值。调用这个函数并提供这种信息(人名)时，它将打印相应的问候语。

在函数greet_user() 的定义中，变量username 是一个形参 ——函数完成其工作所需的一项信息。在代码greet_user('jesse') 中，值'jesse' 是一个实参 。实参是调用函数时传递给函数的信息。我们调用函数时，将要让函数使用的信息放在括号内。在greet_user('jesse') 中，将实参'jesse' 传递给了函数greet_user() ，这个值被存储在形参username 中。

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

8.2 传递实参

鉴于函数定义中可能包含多个形参，因此函数调用中也可能包含多个实参。向函数传递实参的方式很多，可使用位置实参 ，这要求实参的顺序与形参的顺序相同；也可使用关键字实参 ，其中每个实参都由变量名和值组成；还可使用列表和字典。下面来依次介绍这些方式。

8.2.1 位置实参

你调用函数时，Python必须将函数调用中的每个实参都关联到函数定义中的一个形参。为此，最简单的关联方式是基于实参的顺序。这种关联方式被称为位置实参 。

为明白其中的工作原理，来看一个显示宠物信息的函数。这个函数指出一个宠物属于哪种动物以及它叫什么名字，如下所示：

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

运行结果：

1.调用函数多次

你可以根据需要调用函数任意次。要再描述一个宠物，只需再次调用describe_pet() 即可：

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

运行结果：

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

使用位置实参来调用函数时，如果实参的顺序不正确，结果可能出乎意料：

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('harry', 'hamster')

运行结果：

明显顺序错啦

8.2.2 关键字实参

关键字实参是传递给函数的名称—值对。你直接在实参中将名称和值关联起来了，因此向函数传递实参时不会混淆(不会得到名为Hamster的harry这样的结果)。关键字实参让你无需考虑函数调用中的实参顺序，还清楚地指出了函数调用中各个值的用途。

下面来重新编写pets.py，在其中使用关键字实参来调用describe_pet() ：

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

运行结果:

8.2.3 默认值

编写函数时，可给每个形参指定默认值 。在调用函数中给形参提供了实参时，Python将使用指定的实参值；否则，将使用形参的默认值。因此，给形参指定默认值后，可在函数调用中省略相应的实参。使用默认值可简化函数调用，还可清楚地指出函数的典型用法。

例如，如果你发现调用describe_pet() 时，描述的大都是小狗，就可将形参animal_type 的默认值设置为'dog' 。这样，调用describe_pet() 来描述小狗时，就可不提供这种信息：

#默认值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')

运行结果：

我第一次把位置写反了，然后报错了，下面给出了解释

请注意，在这个函数的定义中，修改了形参的排列顺序。由于给animal_type 指定了默认值，无需通过实参来指定动物类型，因此在函数调用中只包含一个实参——宠物的名字。然而，Python依然将这个实参视为位置实参，因此如果函数调用中只包含宠物的名字，这个实参将关联到函数定义中的第一个形参。这就是需要将pet_name 放在形参列表开头的原因所在。

既然是位置实参，调用函数的方式可以更简化：

describe_pet('willie')

运行结果同上。

注意 使用默认值时，在形参列表中必须先列出没有默认值的形参，再列出有默认值的实参。这让Python依然能够正确地解读位置实参。

8.2.4 等效的参数调用

鉴于可混合使用位置实参、关键字实参和默认值，通常有多种等效的函数调用方式。请看下面的函数describe_pets() 的定义，其中给一个形参提供了默认值：

def describe_pet(pet_name, animal_type='dog'):

基于这种定义，在任何情况下都必须给pet_name 提供实参；指定该实参时可以使用位置方式，也可以使用关键字方式。如果要描述的动物不是小狗，还必须在函数调用中给animal_type 提供实参；同样，指定该实参时可以使用位置方式，也可以使用关键字方式。

下面对这个函数的所有调用都可行：

def describe_pet(pet_name,animal_type = 'dog'):    print("\nI have a " + animal_type + ".")    print("My " + animal_type + "'s name is " + pet_name.title() + ".")#一条名为willie的狗describe_pet('willie')describe_pet(pet_name = 'willie')#一只名为Harry的仓鼠describe_pet('harry','hamster')describe_pet(pet_name = 'harry',animal_type ='hamster')describe_pet(animal_type = 'hamster',pet_name = 'harry')

运行结果：

8.2.5 避免实参错误

等你开始使用函数后，如果遇到实参不匹配错误，不要大惊小怪。你提供的实参多于或少于函数完成其工作所需的信息时，将出现实参不匹配错误。例如，如果调用函数describe_pet() 时没有指定任何实参，结果将如何呢？

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

运行结果：

Python读取函数的代码，并指出我们需要为哪些形参提供实参，这提供了极大的帮助。这也是应该给变量和函数指定描述性名称的另一个原因；如果你这样做了，那么无论对于你，还是可能使用你编写的代码的其他任何人来说，Python提供的错误消息都将更有帮助。

如果提供的实参太多，将出现类似的traceback，帮助你确保函数调用和函数定义匹配。

8.3 返回值

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

8.3.1 返回简单值

下面来看一个函数，它接受名和姓并返回整洁的姓名：

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)

运行结果：

8.3.2 让实参变成可选的

有时候，需要让实参变成可选的，这样使用函数的人就只需在必要时才提供额外的信息。可使用默认值来让实参变成可选的。
例如，假设我们要扩展函数get_formatted_name() ，使其还处理中间名。为此，可将其修改成类似于下面这样：

def get_formatted_name(first_name,middle_name,last_name):    full_name = first_name + ' ' + middle_name + ' ' + last_name    return full_name.title()musician = get_formatted_name('john','lee','hooker')print(musician)

运行结果：

然而，并非所有的人都有中间名，但如果你调用这个函数时只提供了名和姓，它将不能正确地运行。为让中间名变成可选的，可给实参middle_name 指定一个默认值——空字符串，并在用户没有提供中间名时不使用这个实参。为让get_formatted_name() 在没有提供中间名时依然可行，可给实参middle_name 指定一个默认值——空字符串，并将其移到形参列表的末尾：

def get_formatted_name(first_name,last_name,middle_name = ''):    full_name = first_name + ' ' + middle_name + ' ' + last_name    return full_name.title()musician = get_formatted_name('john','hooker')print(musician)

运行结果：

8.3.3 返回字典

函数可返回任何类型的值，包括列表和字典等较复杂的数据结构。例如，下面的函数接受姓名的组成部分，并返回一个表示人的字典：

def build_person(first_name,last_name):    person = {'first':first_name,'last':last_name}    return personmusician = build_person('jimi','hendrix')print(musician)

运行结果：

这个函数接受简单的文本信息，将其放在一个更合适的数据结构中，让你不仅能打印这些信息，还能以其他方式处理它们。当前，字符串'jimi' 和'hendrix' 被标记为名和姓。你可以轻松地扩展这个函数，使其接受可选值，如中间名、年龄、职业或你要存储的其他任何信息。例如，下面的修改让你还能存储年龄：

def build_person(first_name,last_name,age = ''):    person = {'first':first_name,'last':last_name}    if age:        person['age'] = age    return personmusician = build_person('jimi','hendrix',age = 27)print(musician)

运行结果：

8.3.4 结合使用函数和while循环

可将函数同本书前面介绍的任何Python结构结合起来使用。例如，下面将结合使用函数get_formatted_name() 和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:")    f_name = input("First name:")    l_name = input("Last name:")    formatted_name = get_formatted_name(f_name,l_name)    print("\nHello, " + formatted_name + "!")

在这个示例中，我们使用的是get_formatted_name() 的简单版本，不涉及中间名。其中的while 循环让用户输入姓名：依次提示用户输入名和姓。

但这个while 循环存在一个问题：没有定义退出条件。请用户提供一系列输入时，该在什么地方提供退出条件呢？我们要让用户能够尽可能容易地退出，因此每次提示用户输入时，都应提供退出途径。每次提示用户输入时，都使用break 语句提供了退出循环的简单途径：

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 + "!")

运行结果：

8.4 传递列表

你经常会发现，向函数传递列表很有用，这种列表包含的可能是名字、数字或更复杂的对象(如字典)。将列表传递给函数后，函数就能直接访问其内容。下面使用函数来提高处理列表的效率。

假设有一个用户列表，我们要问候其中的每位用户。下面的示例将一个名字列表传递给一个名为greet_users() 的函数，这个函数问候列表中的每个人：

#向每位用户发出简单的问候def greet_users(names):    for name in names:        msg = "Hello, " + name.title() + "!"        print(msg)usernames = ['hannah','ty','margot']greet_users(usernames)

运行结果：

8.4.1 在函数中修改列表

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

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

#首先创建一个列表，其中包含一些要打印的设计unprinted_designs = ['iphone case','rebot pendent','dodecahedron']complete_models = []#模拟打印每个设计，直到没有未打印的设计为止#打印每个设计后，都将其移到列表completed_models中while unprinted_designs:    current_design = unprinted_designs.pop()    #模拟根据设计制作3D打印模型的过程：    print("Printing model: " + current_design)    complete_models.append(current_design)# 显示打印好的模型print("\nThe following models have been printed:")for complete_model in complete_models:    print(complete_model)

运行结果：

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

#函数优化

def print_models(unprinted_designs,complete_models):     while unprinted_designs:        current_design = unprinted_designs.pop()        #模拟根据设计制作3D打印模型的过程：        print("Printing model: " + current_design)        complete_models.append(current_design)def show_completed_models(complete_models):    print("\nThe following models have been printed:")    for complete_model in complete_models:        print(complete_model)unprinted_designs = ['iphone case','rebot pendent','dodecahedron']complete_models = []print_models(unprinted_designs,complete_models)show_completed_models(complete_models)

运行结果同上。

8.4.2 禁止函数修改列表

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

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

function_name(list_name[:])

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

print_models(unprinted_designs[:], completed_models)

8.5 传递任意数量的实参

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

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

def make_pizza(*toppings):    print(toppings)make_pizza('pepperoni')make_pizza('mushrooms','green peppers','extra cheese')

运行结果：

现在，我们可以将这条print 语句替换为一个循环，对配料列表进行遍历，并对顾客点的比萨进行描述：

def make_pizza(*toppings):    print("\nMaking a pizza with the following toppings:")    for topping in toppings:        print("- " + topping)make_pizza('pepperoni')make_pizza('mushrooms','green peppers','extra cheese')

运行结果：

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

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

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

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

运行结果：

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

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

def build_profile(first,last,**user_info):    profile = {}    profile['first_name'] = first    profile['last_name'] = last    for key,value in user_info.items():        profile[key] = value    return profileuser_profile = build_profile('albert','einstein',location='princeton',field='physics')print(user_profile)

运行结果：

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

8.6 将函数存储在模块中

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

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

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

8.6.1 导入整个模块

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

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的文件，这个文件导入刚创建的模块，再调用make_pizza() 两次：

import pizzapizza.make_pizza(16,'pepperoni')pizza.make_pizza(12,'mushrooms','green peppers','extra cheese')

运行结果：

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

8.6.2 导入特定的函数

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

from module_name import function_name

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

from module_name import function_0, function_1, function_2

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

from pizza import make_pizzamake_pizza(16,'pepperoni')make_pizza(12,'mushrooms','green peppers','extra cheese')

这部分确实很有用啊。

8.6.3 使用as给函数制定别名

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

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

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

通用语法如下：

from module_name import function_name as fn

8.6.4 使用as给模块制定别名

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

import pizza as pp.make_pizza(16, 'pepperoni')p.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

通用语法如下：

import module_name as mn

8.6.5 导入模块中的所有函数

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

from pizza import *make_pizza(16, 'pepperoni')make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')

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

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

from module_name import *

8.7 函数编写指南

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

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

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

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 语句都应放在文件开头，唯一例外的情形是，在文件开头使用了注释来描述整个程序。

8.8 小结

今天这章东西有点多啊，给我学吐血了快
在本章中，你学习了：

• 如何编写函数，以及如何传递实参，让函数能够访问完成其工作所需的信息；

• 如何使用位置实参和关键字实参，以及如何接受任意数量的实参；

• 显示输出的函数和返回值的函数

• 如何将函数同列表、字典、if 语句和while 循环结合起来使用。

• 如何将函数存储在被称为模块的独立文件中，让程序文件更简单、更易于理解。

• 学习了函数编写指南，遵循这些指南可让程序始终结构良好，并对你和其他人来说易于阅读。

程序员的目标之一是，编写简单的代码来完成任务，而函数有助于你实现这样的目标。它们让你编写好代码块并确定其能够正确运行后，就可置之不理。确定函数能够正确地完成其工作后，你就可以接着投身于下一个编码任务。

函数让你编写代码一次后，想重用它们多少次就重用多少次。需要运行函数中的代码时，只需编写一行函数调用代码，就可让函数完成其工作。需要修改函数的行为时，只需修改一个代码块，而所做的修改将影响调用这个函数的每个地方。

使用函数让程序更容易阅读，而良好的函数名概述了程序各个部分的作用。相对于阅读一系列的代码块，阅读一系列函数调用让你能够更快地明白程序的作用。

函数还让代码更容易测试和调试。如果程序使用一系列的函数来完成其任务，而其中的每个函数都完成一项具体的工作，测试和维护起来将容易得多：你可编写分别调用每个函数的程序，并测试每个函数是否在它可能遇到的各种情形下都能正确地运行。经过这样的测试后你就能信心满满，深信你每次调用这些函数时，它们都将正确地运行。

今天就到这里吧，明天出门上班！