1.4 实践指南：函数的艺术

来源：1.4 Practical Guidance: The Art of the Function

译者：飞龙

协议：CC BY-NC-SA 4.0

函数是所有程序的要素，无论规模大小，并且在编程语言中作为我们表达计算过程的主要媒介。目前为止，我们讨论了函数的形式特性，以及它们如何使用。我们现在跳转到如何编写良好的函数这一话题。

  • 每个函数都应该只做一个任务。这个任务可以使用短小的名称来定义，使用一行文本来标识。顺序执行多个任务的函数应该拆分在多个函数中。
  • 不要重复劳动（DRY）是软件工程的中心法则。所谓的DRY原则规定多个代码段不应该描述重复的逻辑。反之，逻辑应该只实现一次，指定一个名称，并且多次使用。如果你发现自己在复制粘贴一段代码，你可能发现了一个使用函数抽象的机会。
  • 函数应该定义得通常一些，准确来说，平方并不是在 Python 库中，因为它是pow函数的一个特例，这个函数计算任何数的任何次方。

这些准则提升代码的可读性，减少错误数量，并且通常使编写的代码总数最小。将复杂的任务拆分为简洁的函数是一个技巧，它需要一些经验来掌握。幸运的是，Python 提供了一些特性来支持你的努力。

1.4.1 文档字符串

函数定义通常包含描述这个函数的文档，叫做文档字符串，它必须在函数体中缩进。文档字符串通常使用三个引号。第一行描述函数的任务。随后的一些行描述参数，并且澄清函数的行为：

  1. >>> def pressure(v, t, n):
  2.         """Compute the pressure in pascals of an ideal gas.
  4.         Applies the ideal gas law: http://en.wikipedia.org/wiki/Ideal_gas_law
  6.         v -- volume of gas, in cubic meters
  7.         t -- absolute temperature in degrees kelvin
  8.         n -- particles of gas
  9.         """
  10.         k = 1.38e-23  # Boltzmann's constant
  11.         return n * k * t / v

当你以函数名称作为参数来调用help时，你会看到它的文档字符串（按下q来退出 Python 帮助）。

  1. >>> help(pressure)

编写 Python 程序时，除了最简单的函数之外，都要包含文档字符串。要记住，代码只编写一次，但是会阅读多次。Python 文档包含了文档字符串准则，它在不同的 Python 项目中保持一致。

1.4.2 参数默认值

定义普通函数的结果之一就是额外参数的引入。具有许多参数的函数调用起来非常麻烦，也难以阅读。

在 Python 中，我们可以为函数的参数提供默认值。调用这个函数时，带有默认值的参数是可选的。如果它们没有提供，默认值就会绑定到形式参数的名称上。例如，如果某个应用通常用来计算一摩尔粒子的压强，这个值就可以设为默认：

  1. >>> k_b=1.38e-23  # Boltzmann's constant
  2. >>> def pressure(v, t, n=6.022e23):
  3.         """Compute the pressure in pascals of an ideal gas.
  5.         v -- volume of gas, in cubic meters
  6.         t -- absolute temperature in degrees kelvin
  7.         n -- particles of gas (default: one mole)
  8.         """
  9.         return n * k_b * t / v
  10. >>> pressure(1, 273.15)
  11. 2269.974834

这里，pressure的定义接受三个参数，但是在调用表达式中只提供了两个。这种情况下，n的值通过def语句的默认值获得（它看起来像对n的赋值，虽然就像这个讨论暗示的那样，更大程度上它是条件赋值）。

作为准则，用于函数体的大多数数据值应该表示为具名参数的默认值，这样便于查看，以及被函数调用者修改。一些值永远不会改变，就像基本常数k_b，应该定义在全局帧中。