第四章案例学习：交互设计

本章会提供一个案例，用于展示如何却设计一些共同工作的函数。

本章介绍了小乌龟这个模块，这允许你用小龟的图形功能来制作一些图形。乌龟模块在大部分的 Python 中都有安装，不过如果你在线使用 PythnAnywhere，你就无法运行这些乌龟样例了（至少我写这本教材的时候还不行）。

（译者注：都学到第四章了，你还不本地安装个 Python 也太说不过去了吧。）

如果你已经安装了 Python 在你的电脑上，你就能运行这些例子了。没安装的话呢，这就是安装的好时机了呗。我已经把相关介绍放到网页上面了，点击访问。

本章代码样例可以点击此链接来下载了。

4.1 乌龟模块

要检查你是不是已经安装了这个乌龟模块，你要打开 Python 解释器来输入如下内容：

>>> import turtle 
>>> bob = turtle.Turtle()

运行上述例子的时候，应该就能新建一个小窗口，还有个小箭头象征小乌龟。如果有的话就对了，把窗口关掉吧先。

建立一个叫做 mypolygon.py 的文件，在里面输入如下内容：

import turtle 
bob = turtle.Turtle() 
print(bob) 
turtle.mainloop()

这个小乌龟模块（记着是小写的 t）提供了一个叫做 Turtle（注意这里是大写的，大小写要去分！）的函数，这个函数会创建一个 Turtle 对象，我们把它赋值给 bob 这个变量。打印一下 bob 就能显示如下内容：

<turtle.Turtle object at 0xb7bfbf4c>

这就意味着 bob 已经指向了模块 turtle 中所定义的 Turtle 类的一个对象。

mainloop 这个函数是告诉窗口等用户来做些事情，当然本次尝试的情况下用户也就是关闭窗口而已了。

一旦你创建了一个 Trutle，你就可以调用一些方法让他在窗口中移动。方法跟函数有点相似，但语法的使用稍微不太一样。比如你可以让小乌龟往前走：

bob.fd(100)

fd 这个方法，是 turtle 类这个叫做 bob 的对象所包含的。调用这个方法就像是做出一个请求一样：你再让 bob 向前移动。fd 这个方法的参数是像素数距离，所以实际的大小依赖于你显示器的情况了。

Turtle 对象中还有一些其他方法，比如 bk 是后退，lt 是左转，rt 是右转。lt 和 rt 用偏转角度做参数。

另外，每个 Turtle 都相当于带着笔，可以落下或者抬起；如果笔落下了，Turtle 移动的时候就会留下轨迹了。抬笔落笔的方法缩写粉笔嗯是 pu 和 pd。

画一个直角，就要把下面这些线加到程序里面（当然要先创建一个 bob 并且在此之前运行 mainloop）：

bob.fd(100) 
bob.lt(90) 
bob.fd(100)

运行这个程序，你就能看到 bob 先向东再往北，后面就留下了两根互相垂直的线段了。

现在修改一下程序，去画一个正方形。这个程序运行不好的话就不要继续后面的章节！

4.2 简单的重复

你估计会写出如下的内容：

bob.fd(100) 
bob.lt(90)  
bob.fd(100) 
bob.lt(90)  
bob.fd(100) 
bob.lt(90)  
bob.fd(100)

上面这个太麻烦了，咱们可以用一个 for 语句来让这个过程更简洁。把下面的代码添加到 mypolygon.py 中然后运行一下：

for i in range(4):     
    print('Hello!')

你将会看到这样的输出：

Hello! 
Hello! 
Hello! 
Hello!

这就是 for 语句的最简单的一种应用；以后我们会看到更多。不过当前这种简单的足够你来重构一下你的正方形绘制程序了。不达目的不罢休，不要跳过困难哈，一定要编写出来这个再进行后面的内容。

这就是一个用 for 语句来画正方形的语句：

for i in range(4):     
    bob.fd(100)     
    bob.lt(90)

for 语句的语法跟函数定义有点相似。有一个头部，头部的结尾要用冒号，然后还有一个缩进的循环体。循环体可以包含任意多的语句。

for 语句也被叫做循环，因为运行流程会重复执行循环体。在本节的例子中，循环进行了四次。

这次的正方形绘制代码实际上和之前的少有不同了，因为在画完了最后一个边之后，多了一次转向。多出来的这部分需要消耗额外的时间，但简化了下次我们来循环进行绘制的过程。这个版本的代码也有一个额外的效果：让小乌龟回到起点，朝着初始方向。

4.3 练习

下面是一系列使用 TurtleWorld 的练习。主要就是比较有意思，不过也有一些训练的作用。你做这些练习的时候，一定要注意考虑这些训练的作用。

练习后面是有一些样例的解决方案的，所以你要做完了再往后看，至少你得试试，不会做了看看答案也行哈。

1.写一个函数叫做 square（译者注：就是正方形的意思），有一个名叫 t 的参数，这个 t 是一个 turtle。用这个 turtle 来画一个正方形。写一个函数调用，把 bob 作为参数传递给 square，然后再运行这个程序。

2.给这个 square 函数再加一个参数，叫做 length（译者注：长度）。把函数体修改一下，让长度 length 赋值给各个边的长度，然后修改一下调用函数的代码，再提供一个这个对应长度的参数。再次运行一下，用一系列不同的长度值来测试一下你的程序。

3.复制一下 square 这个函数，把名字改成 polygon（译者注：意思为多边形）。另外添加一个参数叫做 n，然后修改函数体，让函数实现画一个正 n 边的多边形。提示：正 n 多边形的外角为 360/n 度。

4.在写一个叫做 circle（译者注：圆）的函数，也用一个 turtle 类的对象 t，以及一个半径 r，作为参数，画一个近似的圆，通过调用 polygon 函数来近似实现，用适当的边长和边数。用不同的半径值来测试一下你的函数。

提示：算出圆的周长，确保边长乘以边数的值（近似）等于圆周长。

5.在 circle 基础上做一个叫做 arc 的函数，在 circle 的基础上添加一个 angle（译者注：角度）变量，用这个角度值来确定画多大的一个圆弧。用度做单位，当 angle 等于 360 度的时候，arc 函数就应当画出一个整团了。

4.4 封装

第一个练习让你把正方形绘制的代码定义到一个函数里面，然后调用这个函数，传入一个 turtle 对象作为参数。下面就是个例子了：

def square(t):     
    for i in range(4):         
        t.fd(100)         
        t.lt(90)  
square(bob)

在最内部的语句里面，fd 和 lt 缩进了两次，这个意思是他们是 for 循环的循环体内部成员，而 for 循环本身缩进了一次，说明 for 语句被包含在函数的定义当中。接下来的那行 square(bob)，紧靠左侧，没有缩进，这说明 for 循环和函数定义都结束了。

在函数体内部，t 所指代的就是小乌龟 bob，因此让 t 来左转九十度的效果完全等同于让 bob 来左转九十度。本文中没有把形式参数的名字设置成 bob，这是为啥呢？是因为用 t 可以指代任意一个小乌龟，不仅仅是 bob，所以你就能再创建另一个小乌龟，把它传递给 square 这个函数作为实际参数：

alice = Turtle() 
square(alice)

用函数的形式把一段代码包装起来，叫做封装。这样有一个好处，就是给代码起了个名字，有类似文档说明的功能，更好理解了。另外一个好处是下次重复使用这段代码的时候，再次调用函数就可以了，这比复制粘贴函数体可方便多了。

4.5 泛化

下一步就是给 square 函数添加一个长度参数了。下面是样例：

def square(t, length):     
    for i in range(4):         
        t.fd(length)         
        t.lt(90)  
square(bob, 100)

给函数添加参数，就叫做泛化，因为者可以让函数的功能更广泛：在之前的版本中，square 这个函数画出来的正方形总是一个尺寸的；在这个新版本里面，可以自定义边长了。

下一步也还是泛化。这次就是不光要画正方形了，要画一个多边形，可以指定边数的。下面是样例：

def polygon(t, n, length):    
    angle = 360 / n     
    for i in range(n):         
        t.fd(length)         
        t.lt(angle)  
polygon(bob, 7, 70)

这个例子画了一个每个边长度都为 70 像素的七边形。

如果你用 Python2 的话，角度可能因为整除而导致的偏差。简单的解决方法就是用 360.0 来除以 n 而不是用 360，这就是用浮点数替代了原来的整形，结果就是一个浮点数了。

当一个函数有超过一个数据参数的时候，很容易忘掉这些参数都是什么，或者忘掉他们的顺序。为了避免这个情况，可以把形式参数的名字包含在一个实际参数列表中：

polygon(bob, n=7, length=70)

这些列表叫做关键参数列表，因为他们把形式参数的名字作为关键词包含了进来。（注意区别这里的关键词可不是 Python 语言的关键词哈！这里就是字面意思，很关键的词。）

这种语法结构让程序更容易被人读懂。也能提醒实际参数和形式参数的使用过程：调用一个函数的时候，把实际参数的值赋给了形式参数。

4.6 接口设计

下一步就是写 circle 这个函数了，需要半径 r 作为一个参数。下面是一个简单的样例，使用 polygon 函数来画一个 50 边形，来接近一个圆：

import math  
def circle(t, r):     
    circumference = 2 * math.pi * r    
    n = 50     
    length = circumference / n     
    polygon(t, n, length)

第一行计算了圆的周长，使用 2 乘以圆周率再乘以半径 r。这个计算用到了圆周率，所以要导入 math 模块。通常都要把导入语句放到整个脚本的开头。

n 是我们用来逼近一个圆所用的线段数量，所以 length 就是每一个线段的长度了。polygon 画一个 50 边的多边形，来近似做一个半径为 r 的圆。

这种方案的一个局限性就是 n 是常数，就意味着对于一些大尺寸的圆，线段数目就太多了，而对小的圆，又浪费了很多小线段。解决的方法就是进一步扩展函数，让函数把 n 也作为一个参数。这就亏让用户（调用 circle 函数的任何人）有更多决定权，可以控制所用的线段数量，当然，接口就不那么简洁了。

函数的接口就是关于它如何工作的一个概述：都有什么变量？函数实现什么功能？以及返回值是什么？允许调用者随意操作而不用处理一些无关紧要的细节，这种函数接口就是简洁的。

在本节的例子中，r 包含于接口内，因为要用它来确定所画圆的大小。n 就不那么合适了，因为它是用来处理如何具体绘制一个圆的。

与其让接口复杂冗余，更好的思路是让 n 根据周长来自适应一个合适的值：

def circle(t, r):     
    circumference = 2 * math.pi * r     
    n = int(circumference / 3) + 1     
    length = circumference / n     
    polygon(t, n, length)

现在线段个数就是周长的三分之一了，因此每段线段的长度近似为 3，这个大小可以让圆看着不错，也对任意大小的圆都适用了。

4.7 重构

当我写 circle 这个函数的时候，我能利用多边形函数 polygon 是因为一个足够多边的多边形和圆很接近。但圆弧就不太适合这个思路了；我们不能用多边形或者圆来画一个圆弧。

一个替代的方法就是把 polygon 修改一下，转换成圆弧。结果大概如下所示：

def arc(t, r, angle):     
    arc_length = 2 * math.pi * r * angle / 360     
    n = int(arc_length / 3) + 1     
    step_length = arc_length / n     
    step_angle = angle / n          
    for i in range(n):        
        t.fd(step_length)         
        t.lt(step_angle)

这个函数的后半段看着和多边形那个还挺像的，但必须修改一下接口才能重利用多边形的代码。我们在多边形函数上增加 angle（角度）作为第三个参数，但继续叫多边形就不太合适了，因为不闭合啊！所以就改名叫它多段线 polyline：

def polyline(t, n, length, angle):     
    for i in range(n):         
    t.fd(length)         
    t.lt(angle)

现在就可以用多段线 polyline 来重写多边形 polygon 和圆弧 arc：

def polygon(t, n, length):     
    angle = 360.0 / n     
    polyline(t, n, length, angle)  
def arc(t, r, angle):     
    arc_length = 2 * math.pi * r * angle / 360     
    n = int(arc_length / 3) + 1     
    step_length = arc_length / n     
    step_angle = float(angle) / n     
    polyline(t, n, step_length, step_angle)

最终，咱们就可以用圆弧 arc 来重写 circle 的实现了：

def circle(t, r):     
    arc(t, r, 360)

这个过程中，改进了接口设计，增强了代码再利用，这就叫做重构。在本节的这个例子中，我们先是注意到圆弧 arc 和多边形 polygon 有相似的代码，所以我们把他们都用多段线 polyline 来实现。

如果我们事先进行了计划，估计就会先写出多段线函数 polyline，然后就不用重构了，但大家在开始一个项目之前往往不一定了解的那么清楚。一旦开始编码了，你就逐渐更理解其中的问题了。有时候重构就意味着你已经学到了新的内容了。

4.8 开发计划

开发计划是写程序的一系列过程。我们本章所用的就是『封装-泛化』的模式。这一过程的步骤如下：

开始写一个特别小的程序，没有函数定义。
一旦有你的程序能用了，确定一下实现功能的这部分有练习的语句，封装成函数，并命名一下。
通过逐步给这个函数增加参数的方式来泛化。
重复 1-3 步骤，一直到你有了一系列能工作的函数为止。把函数复制粘贴出来，避免重复输入或者修改了。
看看是不是有通过重构来改进函数的可能。比如，假设你在一些地方看到了相似的代码，就可以把这部分代码做成一个函数。

这个模式有一些缺点，我们后续会看到一些替代的方式，但这个模式是很有用的，尤其对耐饿实现不值得怎么去把程序分成多个函数的情况。

4.9 文档字符串

文档字符串是指：在函数开头部位，解释函数的交互接口的字符串，doc 是文档 documentation 的缩写。下面是一个例子：

def polyline(t, n, length, angle):     
"""
Draws n line segments with the given length and     angle (in degrees) between them. 
t is a turtle.     """         
    for i in range(n):         
        t.fd(length)         
        t.lt(angle)

一般情况下，所有文档字符串都是三重引用字符串，也被叫做多行字符串，因为三重的单引号表示允许这个字符串是多行的。

这些文字很简洁，但都包含了一些关键的信息，这些信息对于函数使用者来说至关重要。这些信息简要解释了函数的用途（不会说细节，也不会说如何实现）。文档解释了每个参数对函数行为的影响，以及各自的类型（一般在不是显而易见的情况下就给解释了）。

写这种文档，对交互接口的设计来说，是至关重要的。设计良好的交互接口应该很容易解释明白；如果你的函数有一个特别不好解释了，估计这个函数的交互设计还存在需要改进的地方。

4.10 调试

一个交互接口，就像是函数和调用者的一个中间人。调用者提供特定的参数，函数完成特定的任务。

例如，polyline 这个多段线函数，需要四个实际参数：t 必须是一个 Turtle 小乌龟；n（边数）必须是一个整形；length（长度）应该是一个正数；angle（角度）必须是一个以度为单位的角度值。

这些要求叫做『前置条件』，因为要在函数开始运行之前就要实现才行。相应的在函数的结尾那里的条件叫『后置条件』。后置条件包含函数的预期效果（如画线段）和其他作用（如移动海龟或进行其他改动）。

前置条件是准备给函数调用者的。如果调用者违背了（妥当标注的）前置条件，然后函数不能正常工作，这个 bug 就会反馈在函数调用者上，而不是函数本身。

如果前置条件得到了满足，而后置条件未能满足，这个 bug 就是函数的了。所以如果你的前后置条件都弄清晰，对调试很有帮助。

4.11 Glossary 术语列表

method: A function that is associated with an object and called using dot notation.

方法：某个类中一个对象所具有的函数，用点连接来进行调用。

loop: A part of a program that can run repeatedly.

循环：程序中重复运行的一部分。

encapsulation: The process of transforming a sequence of statements into a function definition.

封装：把一系列相关的语句整理定义成一个函数的过程。

generalization: The process of replacing something unnecessarily specific (like a number) with something appropriately general (like a variable or parameter).

泛化：把一些不必要的内容用更广泛通用的内容来替换掉的过程，比如把一个数字替换成了一个变量或者参数。

keyword argument: An argument that includes the name of the parameter as a “keyword”.

关键词参数：一种特殊的实际参数，把形式参数的名字作为关键词包含在内。

interface: A description of how to use a function, including the name and descriptions of the arguments and return value.

交互接口：对如何使用一个函数的描述，包括了函数名，以及对实际参数和返回值的描述。

refactoring: The process of modifying a working program to improve function interfaces and other qualities of the code.

重构：对一份能工作的程序进行修改，改进函数交互接口以及提高代码其他方面质量的过程。

development plan: A process for writing programs.

开发计划：写程序的过程。

docstring: A string that appears at the top of a function definition to document the function’s interface.

文档字符串：一个在函数定义的顶部的字符串，讲解函数的交互接口。

precondition: A requirement that should be satisfied by the caller before a function starts.

前置条件：函数开始之前，调用者应当满足的要求。

postcondition: A requirement that should be satisfied by the function before it ends.

后置条件：函数结束之前应该满足的一些要求。

4.12 练习

练习 1

点击下面这个链接下载代码。

画一个栈图，表明运行函数 circle(bob,radius)时候程序的状态。你可以手算一下，或者把输出语句加到代码上。
4.7 小节中的那个版本的 arc 函数并不太精确，因为对圆进行线性逼近总会超过真实情况。结果就是小乌龟总会距离正确位置偏离一些像素。我的样例给出了一种降低这种误差程度的方法。阅读一下代码，看你能不能理解。如果你画一个图标，也许就能明白代码是怎么工作的了。

Figure 4.1: Turtle flowers.