如何在 Python 3 中定义函数

简介

函数 是一组执行操作的指令块，一旦定义，就可以被重复使用。函数使代码更加模块化，允许您反复使用相同的代码。

Python 中有许多内置函数，您可能熟悉其中一些，包括：

• print() 用于将对象打印到终端
• int() 用于将字符串或数字数据类型转换为整数数据类型
• len() 返回对象的长度

函数名称包括括号，并且可能包括参数。

在本教程中，我们将介绍如何定义自己的函数以在编码项目中使用。

先决条件

您应该已经安装了 Python 3，并在计算机或服务器上设置了编程环境。如果您还没有设置编程环境，可以参考适用于您的操作系统（Ubuntu、CentOS、Debian 等）的本地编程环境或服务器编程环境的安装和设置指南。

定义函数

让我们从将经典的“Hello, World!”程序转换为函数开始。

我们将在我们选择的文本编辑器中创建一个新的文本文件，并将程序命名为 hello.py。然后，我们将定义函数。

使用 def 关键字定义函数，后面跟着您选择的名称，然后是一组括号，其中包含函数将接受的任何参数（它们可以为空），最后以冒号结尾。

在这种情况下，我们将定义一个名为 hello() 的函数：

def hello():

这设置了创建函数的初始语句。

接下来，我们将添加第二行，缩进 4 个空格，以提供函数执行的指令。在这种情况下，我们将在控制台打印 Hello, World!：

def hello():
    print("Hello, World!")

我们的函数现在已经完全定义，但是如果此时运行程序，将不会发生任何事情，因为我们没有调用函数。

因此，在我们定义的函数块之外，让我们使用 hello() 调用函数：

def hello():
    print("Hello, World!")

hello()

现在，让我们运行程序：

python hello.py

您应该收到以下输出：

Hello, World!

函数可以比我们上面定义的 hello() 函数更复杂。例如，我们可以在函数块内部使用 for 循环、条件语句等。

例如，下面定义的函数利用条件语句检查 name 变量的输入是否包含元音字母，然后使用 for 循环迭代 name 字符串中的字母。

# 定义函数 names()
def names():
    # 使用输入设置 name 变量
    name = str(input('输入您的姓名：'))
    # 检查 name 是否包含元音字母
    if set('aeiou').intersection(name.lower()):
        print('您的姓名包含元音字母。')
    else:
        print('您的姓名不包含元音字母。')

    # 迭代 name
    for letter in name:
        print(letter)

# 调用函数
names()

我们上面定义的 names() 函数设置了一个条件语句和一个 for 循环，展示了如何在函数定义中组织代码。但是，根据我们的程序意图以及我们想要如何设置代码，我们可能希望将条件语句和 for 循环定义为两个单独的函数。

在程序中定义函数使我们的代码模块化和可重用，这样我们可以在不重写它们的情况下调用相同的函数。

使用参数

到目前为止，我们已经看过了不带参数的函数，但是我们可以在函数定义中的括号内定义参数。

参数 是函数定义中的命名实体，指定函数可以接受的参数。

让我们创建一个小程序，接受参数 x、y 和 z。我们将创建一个函数，以不同的配置将这些参数相加。然后函数将打印这些和。然后我们将调用函数并将数字传递给函数。

def add_numbers(x, y, z):
    a = x + y
    b = x + z
    c = y + z
    print(a, b, c)

add_numbers(1, 2, 3)

我们为 x 参数传递了数字 1，为 y 参数传递了数字 2，为 z 参数传递了数字 3。这些值与它们给出的顺序中的每个参数相对应。

程序基本上根据我们传递给参数的值执行以下数学运算：

a = 1 + 2
b = 1 + 3
c = 2 + 3

函数还打印 a、b 和 c，根据上面的数学运算，我们期望 a 等于 3，b 等于 4，c 等于 5。让我们运行程序：

python add_numbers.py

3 4 5

当我们将 1、2 和 3 作为参数传递给 add_numbers() 函数时，我们收到了预期的输出。

参数通常在函数定义中被定义为变量。当您运行方法时，可以为它们分配值，将参数传递给函数。

关键字参数

除了按顺序调用参数外，您还可以在函数调用中使用关键字参数，在这种情况下，调用者通过参数名称标识参数。

使用关键字参数时，您可以无序使用参数，因为 Python 解释器将使用提供的关键字将值与参数匹配。

让我们创建一个函数，用于显示用户的个人资料信息。我们将以 username（预期为字符串）和 followers（预期为整数）的形式向其传递参数。

# 使用参数定义函数
def profile_info(username, followers):
    print("用户名：" + username)
    print("粉丝数：" + str(followers))

在函数定义语句中，username 和 followers 包含在 profile_info() 函数的括号中。函数的代码块打印有关用户的信息作为字符串，利用这两个参数。

现在，我们可以调用函数并为其分配参数：

def profile_info(username, followers):
    print("用户名：" + username)
    print("粉丝数：" + str(followers))

# 使用上述分配的参数调用函数
<^>profile_info("sammyshark", 945)<^>

# 使用关键字参数调用函数
<^>profile_info(username="AlexAnglerfish", followers=342)<^>

在第一个函数调用中，我们填写了用户名为 sammyshark，粉丝数为 945 的信息，而在第二个函数调用中，我们使用了关键字参数，为参数变量分配了值。

让我们运行程序：

python profile.py

用户名：sammyshark
粉丝数：945
用户名：AlexAnglerfish
粉丝数：342

输出显示了两个用户的用户名和粉丝数。

这也允许我们修改参数的顺序，就像在下面的相同程序的不同调用示例中一样：

def profile_info(username, followers):
    print("用户名：" + username)
    print("粉丝数：" + str(followers))

# 更改参数的顺序
<^>profile_info(followers=820, username="cameron-catfish")<^>

当我们再次使用 python profile.py 命令运行程序时，我们将收到以下输出：

用户名：cameron-catfish
粉丝数：820

因为函数定义保持了 print() 语句的相同顺序，如果我们使用关键字参数，传递参数的顺序就不重要。

默认参数值

我们还可以为一个或两个参数提供默认值。让我们为 followers 参数创建一个默认值为 1 的默认值：

def profile_info(username, <^>followers=1<^>):
    print("用户名：" + username)
    print("粉丝数：" + str(followers))

现在，我们可以仅为用户名函数分配值，并且粉丝数将自动默认为 1。如果我们愿意，我们也可以更改粉丝数。

def profile_info(username, followers=1):
    print("用户名：" + username)
    print("粉丝数：" + str(followers))

profile_info(username="JOctopus")
profile_info(username="sammyshark", followers=945)

当我们使用 python profile.py 命令运行程序时，我们将收到以下输出：

用户名：JOctopus
粉丝数：1
用户名：sammyshark
粉丝数：945

通过为具有默认值的每个参数跳过定义值，可以让我们跳过为每个参数定义值。

返回值

您可以将参数值传递给函数，函数也可以生成一个值。

函数可以使用 return 语句生成一个值，该语句将退出函数并可选地将表达式传递回调用者。如果使用没有参数的 return 语句，函数将返回 None。

到目前为止，我们在函数中使用了 print() 语句而不是 return 语句。让我们创建一个程序，该程序不是打印而是返回一个变量。

在一个名为 square.py 的新文本文件中，我们将创建一个程序，该程序将参数 x 的平方并返回变量 y。我们发出一个调用以打印 result 变量，该变量是通过运行 square() 函数并传入 3 得到的。

def square(x):
    y = x ** 2
    return y

result = square(3)
print(result)

我们可以运行程序并收到输出：

python square.py

9

整数 9 作为输出返回，这是我们期望 Python 找到 3 的平方的结果。

为了进一步理解 return 语句的工作原理，我们可以注释掉程序中的 return 语句：

def square(x):
    y = x ** 2
    # return y

result = square(3)
print(result)

现在，让我们再次运行程序：

python square.py

None

在这里没有使用 return 语句，程序无法返回一个值，因此该值默认为 None。

另一个例子，在上面的 add_numbers.py 程序中，我们可以将 print() 语句替换为 return 语句。

def add_numbers(x, y, z):
    a = x + y
    b = x + z
    c = y + z
    return a, b, c

sums = add_numbers(1, 2, 3)
print(sums)

在函数之外，我们将变量 sums 设置为函数接受 1、2 和 3 作为参数的结果。然后我们调用了 sums 变量的打印。

现在让我们再次运行程序，因为它有了 return 语句：

python add_numbers.py

(3, 4, 5)

我们收到了与之前使用 print() 语句在函数中收到的相同的数字 3、4 和 5 作为输出，这次它作为一个元组返回，因为 return 语句的表达式列表至少有一个逗号。

函数在遇到 return 语句时立即退出，无论它们是否返回一个值。

def loop_five():
    for x in range(0, 25):
        print(x)
        if x == 5:
            # 在 x == 5 时停止函数
            return
    print("此行将不会执行。")

loop_five()

在 for 循环中使用 return 语句结束了函数，因此在循环之外的行将不会运行。如果我们使用 break 语句，只有循环会在那时退出，并且最后的 print() 行将运行。

return 语句退出函数，并在发出参数时可能返回一个值。## 使用 main() 作为一个函数

虽然在 Python 中，你可以在程序的末尾调用函数并且它会运行（就像我们在上面的例子中所做的那样），但是许多编程语言（比如 C++ 和 Java）要求必须有一个 main 函数才能执行。虽然不是必需的，但是包含一个 main() 函数可以以一种逻辑的方式构建我们的 Python 程序，将程序的最重要的组件放入一个函数中。这也可以使得我们的程序更容易让非 Python 程序员阅读。

我们将从在上面的 hello.py 程序中添加一个 main() 函数开始。我们将保留我们的 hello() 函数，然后定义一个 main() 函数：

def hello():
    print("Hello, World!")

<^>def main():<^>

在 main() 函数中，让我们包含一个 print() 语句来让我们知道我们在 main() 函数中。另外，让我们在 main() 函数中调用 hello() 函数：

def hello():
    print("Hello, World!")


def main():
    <^>print("This is the main function")<^>
    <^>hello()<^>

最后，在程序的末尾我们将调用 main() 函数：

def hello():
    print("Hello, World!")

def main():
    print("This is the main function.")
    hello()

<^>main()<^>

此时，我们可以运行我们的程序：

python hello.py

我们将收到以下输出：

This is the main function.
Hello, World!

因为我们在 main() 中调用了 hello() 函数，然后只调用了 main() 来运行，所以 Hello, World! 文本只打印了一次，在告诉我们我们在主函数中的字符串之后。

接下来，我们将要使用多个函数，因此值得回顾一下全局变量和局部变量的变量作用域。如果你在一个函数块内定义一个变量，你只能在该函数内使用该变量。如果你想要在多个函数之间使用变量，最好声明一个全局变量。

在 Python 中，'__main__' 是顶层代码将执行的作用域的名称。当从标准输入、脚本或交互式提示符中运行程序时，它的 __name__ 被设置为 '__main__'。

因此，有一个约定使用以下结构：

if __name__ == '__main__':
    # 当这是主程序时要运行的代码

这使得程序文件可以被用作：

• 主程序并运行 if 语句后面的内容
• 作为一个模块而不运行 if 语句后面的内容。

任何不包含在此语句中的代码将在运行时执行。如果你将你的程序文件用作模块，那么在运行次要文件时，不在此语句中的代码也将被执行。

让我们扩展上面的 names.py 程序，并创建一个名为 more_names.py 的新文件。在这个程序中，我们将声明一个全局变量，并修改我们原来的 names() 函数，使得指令在两个不同的函数中。

第一个函数 has_vowel() 将检查 name 字符串是否包含元音字母。

第二个函数 print_letters() 将打印 name 字符串的每个字母。

# 声明全局变量 name 以便在所有函数中使用
name = str(input('输入你的名字：'))


# 定义函数来检查名字是否包含元音字母
def has_vowel():
    if set('aeiou').intersection(name.lower()):
        print('你的名字包含元音字母。')
    else:
        print('你的名字不包含元音字母。')


# 遍历名字字符串中的每个字母
def print_letters():
    for letter in name:
        print(letter)

有了这个设置，让我们定义 main() 函数，其中将调用 has_vowel() 和 print_letters() 函数。

# 声明全局变量 name 以便在所有函数中使用
name = str(input('输入你的名字：'))


# 定义函数来检查名字是否包含元音字母
def has_vowel():
    if set('aeiou').intersection(name.lower()):
        print('你的名字包含元音字母。')
    else:
        print('你的名字不包含元音字母。')


# 遍历名字字符串中的每个字母
def print_letters():
    for letter in name:
        print(letter)


# 定义调用其他函数的主方法
<^>def main():<^>
    <^>has_vowel()<^>
    <^>print_letters()<^>

最后，我们将在文件的末尾添加 if __name__ == '__main__': 结构。对于我们的目的，因为我们已经把我们想要在 main() 函数中做的所有函数都放在了 main() 函数中，我们将在这个 if 语句后面调用 main() 函数。

# 声明全局变量 name 以便在所有函数中使用
name = str(input('输入你的名字：'))


# 定义函数来检查名字是否包含元音字母
def has_vowel():
    if set('aeiou').intersection(name.lower()):
        print('你的名字包含元音字母。')
    else:
        print('你的名字不包含元音字母。')


# 遍历名字字符串中的每个字母
def print_letters():
    for letter in name:
        print(letter)


# 定义调用其他函数的主方法
<^>def main():<^>
    <^>has_vowel()<^>
    <^>print_letters()<^>


# 执行 main() 函数
<^>if __name__ == '__main__':<^>
    <^>main()<^>

现在我们可以运行这个程序：

python more_names.py

程序将显示与 names.py 程序相同的输出，但是这里的代码更有组织性，可以以模块化的方式使用而无需修改。

如果你不想声明一个 main() 函数，你也可以像这样结束程序：

...
if __name__ == '__main__':
    has_vowel()
    print_letters()

使用 main() 作为一个函数和 if __name__ == '__main__': 语句可以以一种逻辑的方式组织你的代码，使得它更易读和模块化。

结论

函数是程序中执行操作的代码块，有助于使我们的代码可重用和模块化。

要了解如何使你的代码更模块化，你可以阅读我们的指南《如何在 Python 3 中编写模块》。