《Python编程：从入门到实践》笔记（二）＜函数与模块＞

函数是带名字的代码块，用于完成具体的工作。要执行函数定义的特定任务，可调用该函数。需要在程序中多次执行同一项任务时，无需反复编写完成该任务的代码，而只需调用执行该任务的函数，让Python运行其中的代码。

一、定义函数

使用关键字def 来告诉Python你要定义一个函数。向Python指出函数名，在括号内指出函数为完成其任务需要什么样的信息。

函数名为greet_user()，它不需要任何信息就能完成其工作，因此括号是空的。最后，定义以冒号结尾。
紧跟在def greet_user(): 后面的所有缩进行构成了函数体。
文档字符串用三引号括起，Python使用它们来生成有关程序中函数的文档注释。
代码行print(“Hello!”)是函数体内的唯一一行代码，greet_user() 只做一项工作：打印Hello!。

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

greet_user()

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

向函数传递信息

在函数定义def greet_user()的括号内添加username，就可让函数接受给username 指定的任何值。调用greet_user() 时，可将一个名字传递给它，如下所示：

def greet_user(username):
"""显示简单的问候语"""
    print("Hello, " + username.title() + "!")

greet_user('jesse')

Hello, Jesse!

实参和形参

前面定义函数greet_user() 时，要求给变量username 指定一个值。调用这个函数并提供这种信息（人名）时，它将打印相应的问候语。
在函数greet_user() 的定义中，变量username 是一个形参 — 函数完成其工作所需的一项信息。
在代码greet_user(‘jesse’) 中，值’jesse’是一个实参。实参是调用函数时传递给函数的信息。我们调用函数时，将让函数使用的信息放在括号内。在greet_user(‘jesse’)中，将实参’jesse’传递给了函数greet_user()，这个值被存储在形参username 中。

二、传递实参

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

位置实参

调用函数时，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')
describe_pet('dog', 'willie')

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

I have a dog.
My dog's name is Willie.

关键字实参

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

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

默认值

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

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

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')
describe_pet(animal_type='hamster', pet_name='harry')

I have a dog.
My dog's name is Willie.

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

三、返回值

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

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

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)

Jimi Hendrix

让实参变成可选的

有时候，需要让实参变成可选的，这样使用函数的人就只需在必要时才提供额外的信息。
使用默认值来让实参变成可选的。

要扩展函数get_formatted_name()，使其还处理中间名。 并非所有的人都有中间名，为让中间名变成可选的，可给实参middle_name 指定一个默认值——空字符串，并在用户没有提供中间名时不使用这个实参。

def get_formatted_name(first_name, last_name, middle_name=''):
    """返回整洁的姓名"""
    if middle_name:
        full_name = first_name + ' ' + middle_name + ' ' + last_name
    else:
        full_name = first_name + ' ' + last_name
    return full_name.title()

musician = get_formatted_name('jimi', 'hendrix')
print(musician)
musician = get_formatted_name('john', 'hooker', 'lee')
print(musician)

Jimi Hendrix
John Lee Hooker

返回字典

函数可返回任何类型的值，包括列表和字典等较复杂的数据结构。
如返回字典：

def build_person(first_name, last_name, age=''):
    person = {'first': first_name, 'last': last_name}
    if age:
        person['age'] = age
    return person

musician = build_person('jimi', 'hendrix', age=27)
print(musician)

{‘first’: ‘jimi’, ‘last’: ‘hendrix’, ‘age’: 27}

四、传递列表

访问列表

将列表传递给函数后，函数就能直接访问其内容。下面使用函数来提高处理列表的效率。

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

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

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

修改列表

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

定义函数print_models()，它包含两个形参：一个需要打印的设计列表和一个打印好的模型列表。给定这两个列表，这个函数模拟打印每个设计的过程：将设计逐个地从未打印的设计列表中取出，并加入到打印好的模型列表中。

定义函数show_completed_models()，它包含一个形参：打印好的模型列表。 给定这个列表，函数show_completed_models() 显示打印出来的每个模型的名称。

def print_models(unprinted_designs, completed_models):
    while unprinted_designs:
        current_design = unprinted_designs.pop()
        print("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 = ['iphone case', 'robot pendant', 'dodecahedron']
completed_models = []

print_models(unprinted_designs, completed_models)
show_completed_models(completed_models)

有时候，需要禁止函数修改列表，向函数传递列表的副本，这样函数所做的任何修改都只影响副本，而丝毫不影响原件。

print_models(unprinted_designs[:], completed_models)

五、传递任意数量的实参

形参名*toppings 中的星号让Python创建一个名为toppings 的空元组，并将收到的所有值都封装到这个元组中。Python将实参封装到一个元组中，即便函数只收到一个值也如此：

def make_pizza(*toppings):
    print(toppings)

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

(‘pepperoni’,)
(‘mushrooms’, ‘green peppers’, ‘extra cheese’)

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

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

有时候，需要接受任意数量的实参，但预先不知道传递给函数的会是什么样的信息。在这种情况下，可将函数编写成能够接受任意数量的键—值对——调用语句提供了多少就接受多少。

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

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 profile
user_profile = build_profile('albert', 'einstein',
                             location='princeton',
                             field='physics')
print(user_profile)

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

六、模块

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

导入整个模块

要让函数是可导入的，得先创建模块。模块是扩展名为.py的文件，包含要导入到程序中的代码。

创建一个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() 两次。调用被导入的模块中的函数，可指定导入的模块的名称pizza 和函数名make_pizza()，并用句点分隔它们。

import pizza

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

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

导入模块中的特定函数

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

from module_name import function_name

若使用这种语法，调用函数时就无需使用句点。由于我们在import 语句中显式地导入了函数make_pizza()，因此调用它时只需指定其名称。

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

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

from module_name import function_0, function_1, function_2

使用as 给函数指定别名

如果要导入的函数的名称可能与程序中现有的名称冲突，或者函数的名称太长，可指定简短而独一无二的别名——函数的另一个名称，类似于外号。要给函数指定这种特殊外号，需要在导入它时这样做。下面给函数make_pizza() 指定了别名mp()。这是在import 语句中使用make_pizza as mp 实现的，关键字as 将函数重命名为你提供的别名：

from pizza import make_pizza as mp

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

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

import pizza as p

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

导入模块中的所有函数

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

from pizza import *

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

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

七、函数编写指南

编写函数时，需要牢记几个细节。

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

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

3. 给形参指定默认值时，等号两边不要有空格，对于函数调用中的关键字实参，也应遵循这种约定。

4. 建议代码行的长度不要超过79字符，这样只要编辑器窗口适中，就能看到整行代码。 如果形参很多，导致函数定义的长度超过了79字符，可在函数定义中输入左括号后按回车键，并在下一行按两次Tab键，从而将形参列表和只缩进一层的函数体区分开来。大多数编辑器都会自动对齐后续参数列表行，使其缩进程度与你给第一个参数列表行指定的缩进程度相同。

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

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