Python 函数返回值与文档字符串详解

函数返回值的核心机制

在Python中，函数默认返回值为 None。若函数体内未包含 return 语句，或者 return 后未指定具体值，调用该函数时将得到 None。理解这一默认行为对于调试和逻辑控制至关重要。

return 语句的执行逻辑

return 语句不仅用于返回数据，它还承担着结束函数执行的职责。一旦解释器执行到 return 语句，函数立即终止，后续代码不再运行。这与 print 函数有本质区别：print 仅将内容输出到控制台，不会中断函数的运行流程，也不会将值返回给调用者。

多值返回与解包

虽然每个函数只能有一个返回值，但可以通过返回序列类型（如列表、元组）来实现“多值返回”。调用时，利用Python的序列解包特性，可以将返回的序列元素分别赋值给多个变量。

def testReturn(input1, input2):
    sum = input1 + input2
    # 返回列表，包含和以及两个输入参数
    return [sum, input1, input2]

# 方式一：接收整个列表
calculation = testReturn(1, 2)
print(calculation)  # 输出: [3, 1, 2]

# 方式二：解包赋值给多个变量
x, y, z = testReturn(1, 2)
print(x)  # 输出: 3 (sum)
print(y)  # 输出: 1 (input1)
print(z)  # 输出: 2 (input2)

return 对循环的控制

在循环结构中，return 会立即终止整个函数，而不仅仅是当前循环迭代。以下示例展示了 return 与 print 在循环中的不同表现：

def testReturn(input1):
    for i in range(input1):
        return i  # 第一次迭代即返回并结束函数

def testPrint(input1):
    for i in range(input1):
        print(i)  # 打印所有迭代值，函数继续执行至结束

n = 3
value1 = testReturn(n)
print('testReturn return value = %s' % value1)  # 输出: 0

print('*' * 15)

value2 = testPrint(n)
print('testPrint return value = %s' % value2)  # 输出: None

运行结果分析：
1. testReturn(3)：循环从 i=0 开始，立即执行 return 0，函数结束。因此返回值仅为 0。
2. testPrint(3)：循环完整执行，依次打印 0、1、2。由于无 return 语句，函数返回 None。

函数文档字符串 (Docstring)

良好的代码应包含清晰的说明。Python 支持在函数定义语句的下一行使用三引号（"""）来定义文档字符串。这不仅是注释，更是函数对象的一部分属性。

查看与使用文档

可以通过访问函数的 __doc__ 属性来打印或获取该文档字符串。此外，Python 内置类型的方法也遵循此规范，例如查看数字加法方法的说明：

number = 123
# 查看 int 类型 __add__ 方法的文档字符串
print(number.__add__.__doc__)
# 输出: 'x.__add__(y) <==> x+y'

通过规范使用 __doc__，开发者可以利用 IDE 自动提示或 help() 函数快速获取函数用法，显著提升代码的可维护性和团队协作效率。

以上就是Python函数返回值机制与文档字符串使用的详细内容，更多关于Python基础语法与函数编程的资料请关注本站其它相关文章！