2.7. 函数

函数

函数是程序中可以复用的部件。函数允许你为一个语句块取一个特定名字;通过使用这个特定的名字,你就可以随时随地地调用这个语句块了。这个过程被称为 调用 这个函数。我们已经使用过许多内置(built-in)的函数了,比如 lenrange

不管是什么编程语言,在「编写任何稍有一些复杂度的软件」这件事情上,函数的概念可能都是最为 重要的组成部分;因此在这一章中,我们将会从各种角度来对函数进行探索。

我们使用 def 关键字来定义函数。紧接着这个关键字,我们定义该函数的 标识符 名称;然后再跟上一对小括号,小括号中可能包含一些变量的名字;最后,我们再在这一行的末尾写上一个冒号。而接下来便会是一个语句块,它也是该函数的一部分。下面这个例子将会展示上面所说的这些内容,它其实相当简单:

例 (保存为 function1.py):

def say_hello():
    # 属于该函数的语句块
    print('hello world')
# 函数结束

say_hello()  # 调用函数
say_hello()  # 再次调用函数

输出:

$ python function1.py
hello world
hello world

它是如何执行的

我们使用上面所描述的语法,定义了一个叫做 say_hello 的函数。这个函数不接受任何参数,因此小括号中也就没有声明任何变量。函数的参数就是函数的输入,因此我们可以向函数传入不同的值,然后根据这些值返回相应的结果。

需要注意的是,在上面的例子中,我们能够 2 次调用相同的函数,这也就意味着对于同一个功能我们不需要再次编写相同的代码了。

函数参数

函数的参数就是调用函数时你提供给函数的值,这样函数就可以用这些值 一些事情。这些参数就像变量一样,只不过参数的值是在调用函数时定义的,在函数运行时参数已经被赋值了。

参数在函数定义时在圆括号内指定,并用逗号分割,def func_name(para1, para2)。当我们调用函数时,我们用同样的方式提供值。注意到我们使用的术语——函数定义时括号中的参数叫做 形参,而调用函数时提供的参数叫 实参

例子(保存为 function_param.py):

def print_max(a, b):
    if a > b:
        print(a, 'is maximum')
    elif a == b:
        print(a, 'is equal to', b)
    else:
        print(b, 'is maximum')

# 直接传递字面量
print_max(3, 4)

x = 5
y = 7

# 传递变量作为实参
print_max(x, y)

运行以上代码输出:

$ python function_param.py
4 is maximum
7 is maximum

代码的工作原理

这里我们定义了一个叫做 print_max 的函数,它接收两个形参 ab。我们通过一对简单的 if..else 语句来找到最大的那个数,并将它打印到屏幕上。

第一次调用 print_max 时,我们直接把数字,即实参,传递给它。第二次调用时,我们先把数字赋值给变量 xy,然后用 print_max(x, y) 的形式调用函数,这会把实参 x 的值传给形参 a,实参 y 的值传给形参 b
 print_max 在这两种情况下都能正常工作。

局部变量

当你在一个函数中声明变量时,这些变量与函数外部使用的重名的其它变量没有任何关系——即,变量名对于函数来讲是 局部的(只在函数内部有效) 。我们称之为变量的 作用域 。从变量名被定义的地方开始,所有的变量都具有作用域,即声明变量时所处的语句块。

示例(保存为function_local.py):

x = 50

def func(x):
    print('x is', x)
    x = 2
    print('Changed local x to', x)

func(x)
print('x is still', x)

输出:

$ python function_local.py
x is 50
Changed local x to 2
x is still 50

它的工作原理

当我们在函数体的第一行中,第一次打印输出变量名为 x 的  的时候, Python 会将主语句块(位于函数定义的上面)中声明的参数值打印输出。

接下来,我们将值 2 赋给 x 。对于我们定义的函数来讲, x 是局部的。因此,当我们改变函数中 x的值时,主语句块中定义的 x 不会受到任何影响。

程序的最后一个 print 语句,我们用它来显示主语句块中定义的 x 的值,从而确认它实际上不会受到前面调用的函数中局部赋值的影响。

global 语句

不在任何函数或类的定义内的变量也叫做程序的顶级 top level 变量,如果你要在函数内给这种变量赋值,你需要告诉 Python 这个变量并非本地变量,它是一个 全局变量。为此我们需要使用 global 语句。不使用 global 语句你就不可能给在函数外定义的变量赋值。

如果函数内没有同名变量,你可以使用在函数外部定义的变量。但是我们并不鼓励你这样做,并且这种行为是应当避免的,因为这样做会使程序的读者感到疑惑,他们不知道这个变量到底是在哪里定义的。如果使用 global 则可以清楚的表示变量实在函数外部定义的。

例子(保存为 function_global.py):

x = 50

def func():
    global x

    print('x is', x)
    x = 2
    print('Changed global x to', x)

func()
print('Value of x is', x)

程序输出:

$ python function_global.py
x is 50
Changed global x to 2
Value of x is 2

代码是如何工作的?

global 用于声明 x 是一个全局变量,因此当我们在函数内为 x 赋值时,主程序快中的 x 的值也改变了。

你可以在一个 global 语句中同时指定多个全局变量,就像这样:global x, y, z

默认参数值

对于某些函数,你可能想让某些形参是 可选的,并在用户没有指定这些形参的值时,使用默认值。你可以通过默认形参值来实现这个功能。你可以在函数定义时给某些形参名后加上赋值操作符 = 与对应形参的默认值,这样就为形参指定了默认值。

注意,形参的默认值必须是常数。更准确的说,默认值是不可改变的——这会在后面的章节中详细解释。从现在起,你应当记住这一点。

例子(保存为 function_default.py):

def say(message, times=1):
    print(message * times)

say('Hello')
say('World', 5)

程序输出:

$ python function_default.py
Hello
WorldWorldWorldWorldWorld

代码是如何工作的?

say 函数用于多次输出指定的字符串。如果我们不指定输出次数,它只会默认打印一次。我们通过将默认值 1 赋给形参 times 来实现这一点。

第一次使用 say 函数时,我们只提供了一个字符串,程序也只打印了字符串一次。第二次我们同时指定了字符串和打印次数 5,表明我们希望打印 5 次字符串。

小心

只有形参列表末尾的参数才能指定默认值,即你不能在声明参数列表时先声明有默认值的形参,然后再声明没有默认值的形参。

这是因为给形参赋值是按照实参的顺序进行的。例如函数声明 def func(a, b=5) 是有效的,而函数声明 def func(a=5, b) 是 无效的

关键字参数

如果你的一些函数需要许多参数,而你只想指定其中的一部分。那么你可以通过为这些参数命名来给它们赋值,这叫做 关键字参数。我们使用名字(关键字)而不是位置来给函数指定实参,虽然前面我们一直这样做。

这样做有两个优势:其一,这样给函数传递参数时更加简单,因为我们不需要担心参数的位置。其二,我们可以只给我们想要改变的参数赋值,让其他参数使用默认值。

例子(另存为 function_keyword.py):

def func(a, b=5, c=10):
    print('a is', a, 'and b is', b, 'and c is', c)

func(3, 7)
func(25, c=24)
func(c=50, a=100)

输出:

$ python function_keyword.py
a is 3 and b is 7 and c is 10
a is 25 and b is 5 and c is 24
a is 100 and b is 5 and c is 50

代码是如何工作的?

函数 func 共三个参数。一个没有默认值的参数,以及两个有默认值的参数。

第一种用法 func(3, 7)。形参 a 得到值 3,形参 b 得到值 7,形参 c 得到默认值 10

第二种用法 func(25, c=24)。按顺序,形参 a 得到值 25。然后形参 c 通过关键字得到值 24。形参 b 得到默认值 5

第三种用法 func(c=50, a=100)。我们使用关键字来指定所有的值。注意到,尽管在函数定义中,ac 之前定义,我们仍可以在指定形参 a 之前指定形参 c

可变参数

有时候你可能想要定义一个能接收 任意个 数参数的函数。例如定义一个参数个数可变的函数,你可以通过使用星号 * 来实现这个功能。

示例(另存为 function_varargs.py):

def total(a=5, *numbers, **phonebook):
    print('a', a)

    # 遍历元组中的所有项
    for single_item in numbers:
        print('single_item', single_item)

    # 遍历字典中的所有项
    for first_part, second_part in phonebook.items():
        print(first_part,second_part)

print(total(10,1,2,3,Jack=1123,John=2231,Inge=1560))

输出:

$ python function_varargs.py
a 10
single_item 1
single_item 2
single_item 3
Inge 1560
John 2231
Jack 1123
None

代码是如何工作的?

当我们声明一个带星号的参数 *param 时,从这个参数开始,之后的所有参数都会被收集进入一个名为 param 的元组中。

类似的,当我们定义了一个带两个星号的参数 **param 时,从这个参数开始,之后的所有参数都会被收入名为 param 的字典中。

我们会在后面的章节中探索元组和字典。

return 语句

return 语句用于从一个函数 返回,即跳出这个函数。我们也可以从函数跳出时 返回一个值,返回值是可选的。

示例(另存为 function_return.py):

def maximum(x, y):
    if x > y:
        return x
    elif x == y:
        return 'The numbers are equal'
    else:
        return y

print(maximum(2, 3))

输出:

$ python function_return.py
3

代码是如何工作的?

当你给函数提供两个数字作为参数时,maximum 函数会返回参数中的最大值。它用一对简单的 if..else 语句来找到并 返回 最大值。

注意没有返回值的 return 语句等价于 return NoneNone 在 Python 是一种代表「没有任何东西」特殊的类型。例如:如果一个变量的值是 None,则说明这个变量尚未被赋值或值已被清空。

如果你的函数没有 return 语句,系统会自己在函数的结尾添加 return None 语句。你可以通过 print(some_function()) 来观察这一点,其中 some_function 函数没有 return 语句:

def some_function():
    pass

输出

>>> print(some_function())
None

pass 语句在 Python 中用于表示一个空的语句块,通常用于占位。

小提示:Python 的内置函数中,有一个名为 max 的函数,已经实现了「找到最大值」的功能.你应该尽可能使用内置函数,而不是用上面的 maximum 函数或自己实现的版本。

文档字符串——DocStrings

Python 有一个十分美妙的特性 文档字符串 (documentation strings),通常简称为 DocStrings。DocStrings 是一个十分重要的工具,你应该多使用它,它能让你的程序变得更加简单易懂。神奇的是,在程序运行时,我们也能查看 DocStrings。

示例(另存为 function_docstring.py):

def print_max(x, y):
    '''Prints the maximum of two numbers.

    The two values must be integers.'''
    # 如果有必要,将参数转为整数
    x = int(x)
    y = int(y)

    if x > y:
        print(x, 'is maximum')
    else:
        print(y, 'is maximum')

print_max(3, 5)
print(print_max.__doc__)

输出:

$ python function_docstring.py
5 is maximum
Prints the maximum of two numbers.

    The two values must be integers.

代码是如何工作的?

一个函数逻辑上第一行的字符串是这个函数的 DocStrings。注意到 模块 和  都有各自的 DocStrings,我们会在对应的章节介绍它们。

DocStrings 的书写惯例是:首行首字母大写,结尾有句号;第二行为空行;第三行以后为详细的描述。我们 强烈建议 你在编写任何非平凡函数时都遵守这种惯例,那些只有几行的平凡函数可以不遵守这个惯例。

我们可以通过 print_max 函数的  __doc__ 属性来访问它的 DocStrings,注意:属性 doc 的前后都有两个下划线。你只需要记住 Python 把 任何 东西都当作对象,这也包括函数。我们会在 这一章介绍对象相关的知识。

如果你在 Python 中已经尝试过 help(),那么你已经见识到 DocStings 的用处了。help() 函数做的事情就是抓取对应函数的 __doc__ 属性,并以美观的方式打印出来。你可以对上面编写的函数尝试这一点,只需要在代码的最后加上一行 help(print_max) 。记住 按 q 可以退出 help

自动化工具也可以以同样的方式从你的程序中提取文档。因此我 强烈建议 在你的每个非平凡程序中都使用 DocStings。你的 Python 发行版附带的 pydoc 命令用起来和使用 DocStings 的 help() 函数类似。 

小结

我们已经学习了函数的方方面面的知识,但我们仍然有没学到的地方。不过这些知识在我们的日常使用中已经足够了。想进一步了解函数相关的知识,可以翻阅 Python 官方文档中的 函数语法 章节和 内置函数 章节。

接下来,我们将学到如何创建和使用 Python 模块。

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
贡献者:1
讨论数量: 0
发起讨论 只看当前版本


暂无话题~