《think in python》学习-4

think in python -4

接口设计：

本章引入了一个实例 来讲解接口方面的知识。

准备工作：
下载swampy模块，从地址下载，并安装，安装信息可以从网页上查看。

swampy模块 提供各种函数，来让一只乌龟在频幕是爬行，并且画出它的爬行路线。

开始使用别人的接口：

from  swampy.TurtleWorld import *  #导入模块

world = TurtleWorld() #使用该模块定义的一个方法
bob = Turtle()  #定义一个实例 
fb(bob,100)   #前进100
lt(bob)       #左拐
fd(bob,100)   #再前进100

wait_for_user()

以上，我们成功调用了该模块定义的一些方法来使用，并且成功让乌龟来运动。

接下来，我们让乌龟画一个正方形出来。

from  swampy.TurtleWorld import *  #导入模块

world = TurtleWorld() #使用该模块定义的一个方法
bob = Turtle()  #定义一个实例 

for i in range(4):
    fb(bob,100)
    lt(bob)

wait_for_user()

通过使用for循环，让程序正确的画出了一个正方形。

封装

通过一些练习，来封装几个函数 ，让乌龟可以画出更多的形状。

练习一：写一个函数 square，接受形参t,用来表示一只乌龟，并完成画正方形的功能。

def square(t):
    for i in range(4):
        fd(t,100)
        lt(t)
        
#调用
square(bob)

for循环缩进了一层，表示它在定义的方法里面， 而fd lt缩进2层，表示他们在for语句里面。

泛化

给函数添加参数的过程 称之为 泛化，因为它让函数更通用

练习二：更新square，再加一个参数length，让画出的正方形长度是length

def square(t,length):
    for i in range(4):
        fd(t,length)
        lt(t)
        
#调用
square(bob,120)

练习三：函数lt和rt默认会进行90度转角度，但我们也可以指定第二个参数 让乌龟转任意角度，定义一个polygon 再加一个参数，让其可以绘制正N边形。

def polygon(t,n,length):
    angle = 360.0/n
    for i in range(n):
        fd(t,length)
        lt(t,angle)
        
#调用
polygon(bob,7,120)  #绘制一个7边形
#你也可以这样
polygon(bob,n=7,length=120)  #这样调用函数时加上参数名，是合法的。并且在参数很多的情况下，有助于正确执行函数

接口设计

函数的接口能表达出一些信息，它有哪些参数？这个函数能做什么，他的返回值有什么，设计一个接口，尽可能简洁。

练习四：写一个circle接收代表乌龟的t,以及半径r，并使用合适的长度和边数调用polygon来画一个近似圆。

这里。我们发现，边的数量不固定，在之前我们都是给出固定的边数来进行画图的，所以呢 我们需要根据周长 来进行计算边数 以及长度。

def circle(t,r):
    circumference = 2 * math.pi *r #通过半径计算出 周长
    n = int(circumference/3)+1     #为了从视觉上接近圆，每条边的长度定为3，从而算出 有多少条边
    length= circumference /n #再计算下真正长度
    polygon(t,n,length)
    

重构

重新组织程序，提高代码复用率，改善函数接口。

练习五：给circle写个更通用的版本arc，增加一个形参angle，用来表示画的圆弧的大小，她是度数，当ang;e=360时，它会绘制一个圆。

#查看了需求以后，发现可以将一个arc所需要的东西 ，细化成几个小函数，其中 这个函数就是为了 画多多边线，给定角度的线，因为它可能不是一个闭合的形状，而只是几条线。
   def polyline(t,n,length,angle):
       for i in range(n):
           fd(t,length)
           lt(t,angle)
#紧接着依据 上面的函数，可以重构 polygon 来完成一个多边形的绘制
   def polygon(t,n,length):
       angle = 360.0/n
       polyline(t,n,length,angle)
#有了上面2个基础函数，我们可以开发 arc函数了
   def arc(t,r,angle):
       arc_length = 2 * math.pi * r *range/360 
       n = int(arc_length/3)+1
       step_length = arc_length/n   
       step_angle = float(angle)/n
       polyline(t,n,step_length,step_angle)
       
#重构circle
   def circle(t,r):
       arc(t,r,360)

一个开发计划

开发计划 是指写程序的过程。

以上的例子的过程大概是：

1. 最开始写些小程序，而不需要函数定义。
2. 一旦程序成功运行，将它封装到一个函数中，并加以命名
3. 泛化这个函数 添加合适的形参
4. 重复步骤 1到3 直到你得到一组可行的函数
5. 寻找可以使用重构来改善程序的机会

文档字符串

docstring 是指函数开头用来解释接口的字符串

    def some():
        """docstring 
        """

文档字符串是一个使用 三个引号括起来的字符串，允许跨行

好的文档字符串 能简洁扼要的表述清楚程序接口。

术语(新手建议阅读并尝试理解)

• 实例(instance):一个集合中的一员。
• 循环(loop):程序中的一个片段，可以重复执行。
• 封装(encapsulation):将一组语句转换成函数定义的过程。
• 泛化(generalization):将一些不必要的具体值(如一个数字)替换为合适的通用参数或者变量的过程
• 关键词参数(keyword argument):调用函数时 附带了参数名称
• 接口(interface):描述函数如何使用的说明，包括函数的名称，以及形参与返回值的说明
• 重构(refactoring):修改代码并改善函数的接口以及代码质量的过程
• 开发计划(development plan):写程序的过程
• 文档字符串(docstring):在函数定义开始处出现的用于说明函数接口的字符串
• 前置条件(precondition):在函数调用开始前应当满足的条件
• 后置条件(postcondition):在函数调用结束后应当满足的条件