https://www.shiyanlou.com/courses/596/learning/

1.开启python之旅

实验介绍

本课程基于Python for you and me教程翻译制作,其中参考了Python tutorialThe Python Standard Library,并对原教程的内容进行了改进与补充。

相关链接地址如下:

Python for you and me的法律声明有如下内容:

Permission is granted to copy, distribute, and/or modify this document under the terms of the Open Publication Licence, Version 1.0, or any later version.

知识点

  • 使用交互模式的 Python3 解释器
  • 简单使用 vim 编写 Python3 脚本
  • 执行 Python3 脚本
  • Python3 代码风格建议
  • Python3 中使用注释
  • 认识 Python3 模块

实验环境

  • Python 3.5
  • Xfce 终端
  • Vim

适合人群

本课程属于初级级别课程,不仅适用于那些有其它语言基础的同学,对没有编程经验的同学也非常友好。

解释器

Python 是一个脚本语言,你可以在 Python 解释器中直接写代码或者将代码写到一个文件里,然后执行这个文件(即脚本文件)。

首先,我们从使用解释器开始,打开 Xfce 终端,键入python3并回车。这个时候解释器便工作于交互模式

Python3简明教程--实验楼 - 图2

Python3简明教程--实验楼 - 图3

作为我们第一个 Python 代码,我们将打印经典的 “Hello World!”,输入python3,如下所示:

  1. >>> print("Hello World!")
  2. Hello World!

Python3简明教程--实验楼 - 图4

欣赏完自己的杰作后,按Ctrl + D输入一个 EOF 字符来退出解释器,你也可以键入exit()来退出解释器。

脚本文件

作为正式的程序员,你可能想要将上述的代码写到一个源文件。那么我们来创建一个 helloworld.py 文件,用你喜欢的任何编辑器来创建这个文件,我使用 Vim ,你可以使用基于 GUI 的工具,如实验楼环境桌面上的 gedit。

我们建议使用 Vim,在这里我们简单的使用它,你可以在实验楼的课程Vim编辑器里深入学习或者通过这张vi(vim)键盘图帮助你记忆:

Python3简明教程--实验楼 - 图5

(原图来自:www.viemu.com)

首先,创建的文件会放在/home/shiyanlou目录下,打开 Xfce 终端,键入vim helloworld.py来启动 Vim 并编辑 helloworld.py,启动后不要乱按键。

Python3简明教程--实验楼 - 图6

然后按i键进入插入模式,此时你可以看到左下角有 “插入” 两个字,现在你可以键入下面的代码了。

  1. #!/usr/bin/env python3
  2. print("Hello World!")

其中第一行的前两个字符#!称为Shebang,目的是告诉 shell 使用 Python 解释器执行其下面的代码。
Python3简明教程--实验楼 - 图7

然后按Esc键退出插入模式,再键入:wq回车,Vim 就会保存文件并退出。

要运行脚本文件helloworld.py,还要为文件添加可执行权限(否则会出现权限不足的错误):

  1. $ chmod +x helloworld.py

在这里使用到了linux下的chmod命令来变更文件或目录的权限,+x代表赋予了其可执行的权限。
若想要了解更多,推荐你学习我们的Linux基础入门(新版)
你也可以点击此处快速掌握常用 Unix/Linux 常用命令查看。

然后执行脚本文件:

  1. $ ./helloworld.py

Python3简明教程--实验楼 - 图8

这里需要注意如果程序中没有#!/usr/bin/env python3的话,应该使用python3 helloworld.py来执行,否则使用./helloworld.py程序会被当作 bash 脚本来执行,最终报错。

代码风格建议

在 Python 中,空格很重要,我们使用空格将标识符区分开,行开始处的空格我们称之为缩进,如果你的缩进是错误的,Python 解释器会抛出错误。例如下面情形:

  1. >>> a = 12
  2. >>> a = 12
  3. File "<stdin>", line 1
  4. a = 12
  5. ^
  6. IndentationError: unexpected indent

这是因为第二行开始处出现了多余的空格,所以需要经常检查代码的缩进。
如果你在代码中混用制表符和空格,这种缩进错误会很常见。

所以如果是用空格,就一直用空格缩进,不要使用制表符。

建议遵守以下约定:

  • 使用 4 个空格来缩进
  • 永远不要混用空格和制表符
  • 在函数之间空一行
  • 在类之间空两行
  • 字典,列表,元组以及参数列表中,在,后添加一个空格。对于字典,:后面也添加一个空格
  • 在赋值运算符和比较运算符周围要有空格(参数列表中除外),但是括号里则不加空格:a = f(1, 2) + g(3, 4)

注释

注释是一些文本用来解释此处代码是做什么的,写注释是为了使他人更容易理解代码。

Python 的注释以#字符开始的,在#字符到行尾之间的所有东西都被程序忽略为注释,也就说对程序没有任何影响。

  1. >>> # 这是一个注释
  2. >>> # 下面这一行是求两数之和
  3. >>> a = 12 + 34
  4. >>> print(a) # 这里也是注释 :)

注释主要面向的人群是开发人员和维护代码库的人员,所以如果你写了一些复杂代码,你应该写足够的注释在里面,以便让其他任何人能够通过你的注释读懂代码。你应该总是在#后跟一个空格,然后再写注释。你也可以做一些标准的注释,像下面这样。

  1. # FIXME -- fix these code later
  2. # TODO -- in future you have to do this

模块

模块是包含了我们能复用的代码的文件,包含了不同的函数定义,变量。模块文件通常以 .py 为扩展名。

Python 本身在默认安装时就带有大量的模块。我们之后将会用到其中的一部分。在使用模块前先导入它。

  1. >>> import math # 导入math模块
  2. >>> print(math.e)
  3. 2.71828182846

我们会在模块这个实验里学习更多有关模块的知识。

总结

完成本实验后,应当明白如何使用交互模式的 Python3 解释器,如何简单使用 vim 编写脚本文件并执行这个脚本文件。

要特别注意的是,Python 使用缩进来定义语句块,缩进是 Python 语法的一部分,这与其它大多数语言不同。

代码风格在本课程的实验PEP8 代码风格指南有更为详细的讲述。注释的话,能使用英文建议使用英文。模块同样会在之后的实验里深入学习。

2.变量和数据类型

实验介绍

本节实验内容主要包括 Python 基本的数据类型和变量。

知识点

  • python 关键字
  • 变量的定义与赋值
  • input() 函数
  • 字符串的格式化

关键字和标识符

每一种编程语言都有它们自己的语法规则,就像我们所说的外语。

下列的标识符是 Python3 的关键字,并且不能用于通常的标识符。关键字必须完全按照下面拼写:

  1. False def if raise
  2. None del import return
  3. True elif in try
  4. and else is while
  5. as except lambda with
  6. assert finally nonlocal yield
  7. break for not
  8. class from or
  9. continue global pass

这些内容可以在 Python3 解释器中得到:
Python3简明教程--实验楼 - 图9

在 Python 中 我们不需要为变量指定数据类型。所以你可以直接写出abc = 1,这样变量abc就是整数类型。如果你写出abc = 1.0,那么变量abc就是浮点类型。

  1. >>> a = 13
  2. >>> b = 23
  3. >>> a + b
  4. 36

通过上面的例子你应该理解了如何在 Python 中定义变量,也就是只需要输入变量名和值就行了。Python 也能操作字符串,它们用单引号或双引号括起来,就像下面这样。

  1. >>> 'ShiYanLou'
  2. 'ShiYanLou'
  3. >>> 'ShiYanLou\'s best'
  4. "ShiYanLou's best"
  5. >>> "Hello World!"
  6. 'Hello World!'

从键盘读取输入

通常情况下,Python 的代码中是不需要从键盘读取输入的。不过我们还是可以在 Python 中使用函数input()来做到这一点,input()有一个用于打印在屏幕上的可选字符串参数,返回用户输入的字符串。

我们来写一个程序,它将会从键盘读取一个数字并且检查这个数字是否小于 100。这个程序名称是/home/shiyanlou/testhundred.py。还记得如何使用 Vim 吗?忘了的话可以看看下面的动图,打开 Xfce 终端,使用 Vim 开始编写代码:

Python3简明教程--实验楼 - 图10

在终端中输入:

  1. $ vim testhundred.py

输入i后,编写以下代码:

  1. #!/usr/bin/env python3
  2. number = int(input("Enter an integer: "))
  3. if number <= 100:
  4. print("Your number is less than or equal to 100")
  5. else:
  6. print("Your number is greater than 100")

接着按ESC键并输入:wq退出Vim。
该段代码的含义如下:

如果number小于等于 100,输出 “Your number is less than or equal to 100”,如果大于 100,输出 “Your number is greater than 100”。

在执行程序前,别忘了为文件添加可执行权限:

  1. $ chmod +x testhundred.py

程序运行起来就像这样:

  1. $ ./testhundred.py
  2. Enter an integer: 13
  3. Your number is less than or equal to 100
  4. $ ./testhundred.py
  5. Enter an integer: 123
  6. Your number is greater than 100

后续程序中将会用到之后实验将学到的 while 循环语句,这里先简单介绍下。
while 是使用一个表达式作为判断的条件,如果条件不能够达成则停止循环:

  1. w = 20
  2. while w > 1:
  3. print(w)
  4. w -= 1

这个循环中判断条件为w > 1,当条件不满足的时候就停止循环。当 w 的值小于等于 1 的时候,循环退出。这里要注意w -= 1,等同于w = w - 1
下一个程序我们写入/home/shiyanlou/investment.py,来计算投资,使用 Vim 输入以下代码:

  1. #!/usr/bin/env python3
  2. amount = float(input("Enter amount: ")) # 输入数额
  3. inrate = float(input("Enter Interest rate: ")) # 输入利率
  4. period = int(input("Enter period: ")) # 输入期限
  5. value = 0
  6. year = 1
  7. while year <= period:
  8. value = amount + (inrate * amount)
  9. print("Year {} Rs. {:.2f}".format(year, value))
  10. amount = value
  11. year = year + 1

运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x investment.py
  3. $ ./investment.py
  4. Enter amount: 10000
  5. Enter Interest rate: 0.14
  6. Enter period: 5
  7. Year 1 Rs. 11400.00
  8. Year 2 Rs. 12996.00
  9. Year 3 Rs. 14815.44
  10. Year 4 Rs. 16889.60
  11. Year 5 Rs. 19254.15

while year <= period:的意思是,当year的值小于等于period的值时,下面的语句将会一直循环执行下去,直到year大于period时停止循环。
Year {} Rs. {:.2f}".format(year, value)称为字符串格式化,大括号和其中的字符会被替换成传入str.format()的参数,也即yearvalue。其中{:.2f}的意思是替换为 2 位精度的浮点数。

代码示例

一些关于变量和数据类型的代码实例。下面的例子程序请都写在/home/shiyanlou目录下。

本部分包括下面的几个实例:

  1. 求 N 个数字的平均值
  2. 华氏温度到摄氏温度转换程序

请按照指定目录完成每个程序,并理解每个程序中每行代码的含义。

求N个数字的平均值

下面的程序用来求 N 个数字的平均值。请将程序代码写入到文件/home/shiyanlou/averagen.py中,程序中将需要输入 10 个数字,最后计算 10 个 数字的平均值。

代码内容,请理解每一行代码含义:

  1. #!/usr/bin/env python3
  2. N = 10
  3. sum = 0
  4. count = 0
  5. print("please input 10 numbers:")
  6. while count < N:
  7. number = float(input())
  8. sum = sum + number
  9. count = count + 1
  10. average = sum / N
  11. print("N = {}, Sum = {}".format(N, sum))
  12. print("Average = {:.2f}".format(average))

运行程序过程,需要输入 10 个数字:

  1. $ cd /home/shiyanlou
  2. $ chmod +x averagen.py
  3. $ ./averagen.py
  4. 1.2
  5. 3.4
  6. 3.5
  7. 33.2
  8. 2
  9. 4
  10. 6
  11. 2.4
  12. 4
  13. 5.5
  14. N = 10, Sum = 65.2
  15. Average = 6.52

温度转换

在下面的程序里,我们使用公式 C = (F - 32) / 1.8 将华氏温度转为摄氏温度。

  1. #!/usr/bin/env python3
  2. fahrenheit = 0
  3. print("Fahrenheit Celsius")
  4. while fahrenheit <= 250:
  5. celsius = (fahrenheit - 32) / 1.8 # 转换为摄氏度
  6. print("{:5d} {:7.2f}".format(fahrenheit , celsius))
  7. fahrenheit = fahrenheit + 25

{:5d}的意思是替换为 5 个字符宽度的整数,宽度不足则使用空格填充。{:7.2f}的意思是替换为为7个字符宽度的保留两位的小数,小数点也算一个宽度,宽度不足则使用空格填充。其中7指宽度为7,.2f指保留两位小数。
运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x temperature.py
  3. $ ./temperature.py
  4. Fahrenheit Celsius
  5. 0 -17.78
  6. 25 -3.89
  7. 50 10.00
  8. 75 23.89
  9. 100 37.78
  10. 125 51.67
  11. 150 65.56
  12. 175 79.44
  13. 200 93.33
  14. 225 107.22
  15. 250 121.11

单行定义多个变量或复制

你甚至可以在一行内将多个值赋值给多个变量。

在终端中输入:

  1. $ python3

进入到 python3 交互式界面:

  1. >>> a , b = 45, 54
  2. >>> a
  3. 45
  4. >>> b
  5. 54

这个技巧用来交换两个数的值非常方便。

  1. >>> a, b = b , a
  2. >>> a
  3. 54
  4. >>> b
  5. 45

要明白这是怎么工作的,你需要学习元组(tuple)这个数据类型。我们是用逗号创建元组。在赋值语句的右边我们创建了一个元组,我们称这为元组封装(tuple packing),赋值语句的左边我们则做的是元组拆封 (tuple unpacking)。
下面是另一个元组拆封的例子:

  1. >>> data = ("shiyanlou", "China", "Python")
  2. >>> name, country, language = data
  3. >>> name
  4. 'shiyanlou'
  5. >>> country
  6. 'China'
  7. >>> language
  8. 'Python'

总结

完成这个实验我们应该了解到以下的内容:

  1. Python3 关键字有哪些(在这里不要求全部记住)
  2. 变量如何赋值变量
  3. Python3 怎样从键盘读取输入
  4. Python3 字符串的格式化
  5. 元组封装和拆封

在这里可以了解更多有关字符串格式化的信息:https://docs.python.org/3/library/string.html#formatstrings

3.运算符和表达式

实验介绍

在 Python 中你会写大量的表达式。

表达式由运算符和操作数组成,像2+3就是一个表达式,其中 2 和 3 是操作数,加号是运算符。

本节实验中我们将学习运算符和表达式的基本用法。

知识点

  • 关系/逻辑运算
  • 表达式
  • 类型转换

运算符

运算符是一些符号,它告诉 Python 解释器去做一些数学或逻辑操作。一些基本的数学操作符如下所示:

  1. >>> 2 + 3
  2. 5
  3. >>> 23.0 - 3
  4. 20.0
  5. >>> 22 / 12
  6. 1.8333333333333333

只要有任意一个操作数是浮点数,结果就会是浮点数。
进行除法运算时若是除不尽,结果将会是小数,这很自然,如果要进行整除,使用//运算符,它将返回商的整数部分。

%是求余运算符:

  1. >>> 14 % 3
  2. 2

整数运算示例

整数运算符比较容易理解,代码如下:

  1. #!/usr/bin/env python3
  2. days = int(input("Enter days: "))
  3. months = days // 30
  4. days = days % 30
  5. print("Months = {} Days = {}".format(months, days))

在终端里使用Vim输入上述代码后,用chmod命令赋予可执行权限,最后运行程序:
Python3简明教程--实验楼 - 图11

Enter days:后获得用户输入的天数,然后获得月份数和天数,最后把这些数打印出来。你可以使用更容易的办法:

  1. #!/usr/bin/env python3
  2. days = int(input("Enter days: "))
  3. print("Months = {} Days = {}".format(*divmod(days, 30)))

divmod(num1, num2)返回一个元组,这个元组包含两个值,第一个是 num1 和 num2 相整除得到的值,第二个是 num1 和 num2 求余得到的值,然后我们用*运算符拆封这个元组,得到这两个值。

关系运算符

你可以使用下面的运算符实现关系运算。

关系运算符

Operator Meaning
< Is less than
<= Is less than or equal to
> Is greater than
>= Is greater than or equal to
== Is equal to
!= Is not equal to

在终端里输入python3进入交互页面,试一试以下一些例子:

  1. >>> 1 < 2
  2. True
  3. >>> 3 > 34
  4. False
  5. >>> 23 == 45
  6. False
  7. >>> 34 != 323
  8. True

逻辑运算符

对于逻辑 与,或,非,我们使用andornot这几个关键字。

逻辑运算符andor也称作短路运算符:它们的参数从左向右解析,一旦结果可以确定就停止。例如,如果AC为真而B为假,A and B and C不会解析C。作用于一个普通的非逻辑值时,短路运算符的返回值通常是能够最先确定结果的那个操作数。

关系运算可以通过逻辑运算符andor组合,比较的结果可以用not来取反意。逻辑运算符的优先级又低于关系运算符,在它们之中,not具有最高的优先级,or优先级最低,所以A and not B or C等于(A and (notB)) or C。当然,括号也可以用于比较表达式。

下面是一些例子:

  1. >>> 5 and 4 # 首先判断5,肯定为true,那么最终的结果就取决于 and 后面那个的布尔值,4 的布尔值为 true,这样就可以确定整个表达式的值为 true 了,所以返回 4
  2. 4
  3. >>> 0 and 4 # 首先判断0,因为 0 的布尔值为 false,那么不管 and 后面那个的布尔值是什么,整个表达式的布尔值都应该为 false 了,这个时候就不需要判断 4 了,直接返回最先确定结果的那个数也就是0
  4. 0
  5. >>> False or 3 or 0
  6. 3
  7. >>> 2 > 1 and not 3 > 5 or 4
  8. True

简写运算符

x op= expression为简写运算的语法形式。其等价于x = x op expression,举例如下:

  1. >>> a = 12
  2. >>> a += 13
  3. >>> a
  4. 25
  5. >>> a /= 3
  6. >>> a
  7. 8.333333333333334
  8. >>> a += (26 * 32)
  9. >>> a
  10. 840.3333333333334

/home/shiyanlou/shorthand.py示例,输入quit()退出python交互页面,用Vim写入以下代码:

  1. #!/usr/bin/env python3
  2. N = 100
  3. a = 2
  4. while a < N:
  5. print(str(a))
  6. a *= a

运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x shorthand.py
  3. $ ./shorthand.py
  4. 2
  5. 4
  6. 16

表达式

通常我们书写表达式的时候,会在每一个运算符左右都放一个空格,这样使代码更可读,如:

  1. a = 234 * (45 - 56 / 34)

一个用于展示表达式的例子,注意其中运算符的优先级。

  1. #!/usr/bin/env python3
  2. a = 9
  3. b = 12
  4. c = 3
  5. x = a - b / 3 + c * 2 - 1
  6. y = a - b / (3 + c) * (2 - 1)
  7. z = a - (b / (3 + c) * 2) - 1
  8. print("X = ", x)
  9. print("Y = ", y)
  10. print("Z = ", z)

运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x evaluationexp.py
  3. $ ./evaluationexp.py
  4. X = 10.0
  5. Y = 7.0
  6. Z = 4.0

第一个计算的是x,步骤如下:

  1. 9 - 12 / 3 + 3 * 2 -1
  2. 9 - 4 + 3 * 2 - 1
  3. 9 - 4 + 6 - 1
  4. 5 + 6 - 1
  5. 11 - 1
  6. 10

由于括号的存在,yz的计算方式不同,你可以自己去验证它们。

类型转换

我们可以手动的执行类型转换。

类型转换函数 转换路径
float(string) 字符串 -> 浮点值
int(string) 字符串 -> 整数值
str(integer) 整数值 -> 字符串
str(float) 浮点值 -> 字符串
  1. >>> a = 8.126768
  2. >>> str(a)
  3. '8.126768'

可以分别尝试下前面的四个类型转换函数。

程序示例

2.7.1. evaluateequ.py

这个程序计算数列1/x+1/(x+1)+1/(x+2)+ … +1/n,我们设 x = 1,n = 10。

使用Vim写入以下代码:

  1. #!/usr/bin/env python3
  2. sum = 0
  3. for i in range(1, 11):
  4. sum += 1.0 / i
  5. print("{:2d} {:6.4f}".format(i , sum))

运行程序:
Python3简明教程--实验楼 - 图12

2.7.2. quadraticequation.py

这个程序的名称为quadratic equation组合,是二次方程的英文词组。

这个程序用来求解二次方程式:

  1. #!/usr/bin/env python3
  2. import math
  3. a = int(input("Enter value of a: "))
  4. b = int(input("Enter value of b: "))
  5. c = int(input("Enter value of c: "))
  6. d = b * b - 4 * a * c
  7. if d < 0:
  8. print("ROOTS are imaginary")
  9. else:
  10. root1 = (-b + math.sqrt(d)) / (2 * a)
  11. root2 = (-b - math.sqrt(d)) / (2 * a)
  12. print("Root 1 = ", root1)
  13. print("Root 2 = ", root2)

运行程序:
Python3简明教程--实验楼 - 图13

2.7.3. salesmansalary.py

这个程序计算一位数码相机销售人员的工资。他的基本工资是 1500,每售出一台相机他可以得到 200 并且获得 2% 的抽成。程序要求输入相机数量及单价。

  1. #!/usr/bin/env python3
  2. basic_salary = 1500
  3. bonus_rate = 200
  4. commission_rate = 0.02
  5. numberofcamera = int(input("Enter the number of inputs sold: "))
  6. price = float(input("Enter the price of camera: "))
  7. bonus = (bonus_rate * numberofcamera)
  8. commission = (commission_rate * price * numberofcamera)
  9. print("Bonus = {:6.2f}".format(bonus))
  10. print("Commission = {:6.2f}".format(commission))
  11. print("Gross salary = {:6.2f}".format(basic_salary + bonus + commission))

运行程序:

  1. shiyanlou:~/ $ ./salesmansalary.py
  2. Enter the number of inputs sold: 5
  3. Enter the price of camera: 2000
  4. Bonus = 1000.00
  5. Commission = 200.00
  6. Gross salary = 2700.00

总结

本节实验知识点回顾:

  • 关系/逻辑运算
  • 表达式
  • 类型转换

除了数值运算,关系和逻辑运算也是程序的重要组成部分。另外 Python 是强类型语言,所以必要的时候需要手动进行类型转换。

程序挑战:圆的面积

挑战:圆的面积

介绍

我们通过实验已经学习了基本的 Python 3 语法。现在我们就来用一个挑战来巩固一下我们的实验效果。

本挑战中,我们将实现一个程序用来计算半径为 2 的圆的面积并打印输出。

目标

/home/shiyanlou/Code创建一个 Python 脚本CircleArea.py

  1. $ cd /home/shiyanlou/Code
  2. $ touch CircleArea.py

CircleArea.py 能够计算出一个半径为2的圆的面积,并且把面积打印出来,保留小数点后10位。
不要使用 input 等方法获得输入,程序不需要输入任何参数,程序执行如下,直接输出半径为 2 的圆的面积:

  1. $ python3 /home/shiyanlou/Code/CircleArea.py

提示语

  • import math
  • 使用format可以控制输出的小数位数,可以使用'{:.10f}'.format()来进行格式化输出保留 10 位小数
  • 注意代码文件的路径必须是/home/shiyanlou/Code/CircleArea.py
  • 请不要使用 input 获取输入,程序执行不需要任何输入的参数

知识点

  • 导入模块
  • 打印输出
  • 运算符和表达式

参考代码

注意:请务必先独立思考获得 PASS 之后再查看参考代码,直接拷贝代码收获不大

/home/shiyanlou/Code/CircleArea.py参考代码:

  1. import math
  2. # 计算圆的面积
  3. area = 2 * 2 * math.pi
  4. # 格式化输出圆的面积,保留10位小数
  5. print("{:.10f}".format(area))

4.控制流if-else

实验介绍

我们处理现实生活中的问题时会做出决定,就像决定买哪种相机或者怎样更好的打篮球。

同样我们写计算机程序的时候也要做相同的事情。

我们通过if-else语句来做决定,我们使用它来改变程序运行的流程。

知识点

  • if 语句
  • else 语句
  • 真值检测

if语句

语法如下:

  1. if expression:
  2. do this

如果表达式expression的值为真(不为零的任何值都为真),程序将执行缩进后的内容。务必要使用正确的缩进,在表达式为真的情况将会执行缩进的所有行。
一个简单的例子,使用vim写入文件/home/shiyanlou/number100.py,程序接受用户输入的一个数并且检查这个数是否小于 100。

  1. #!/usr/bin/env python3
  2. number = int(input("Enter a number: "))
  3. if number < 100:
  4. print("The number is less than 100")

然后我们运行它:

  1. $ cd /home/shiyanlou
  2. $ chmod +x number100.py
  3. $ ./number100.py

操作截图:
Python3简明教程--实验楼 - 图14

else语句

在上面的例子中,我们想要这样做:如果输入数大于 100 则打印 “Greater than”。我们使用else语句来做到这一点,它将在if语句未满足的情况时工作。

  1. #!/usr/bin/env python3
  2. number = int(input("Enter a number: "))
  3. if number < 100:
  4. print("The number is less than 100")
  5. else:
  6. print("The number is greater than 100")

运行它:
Python3简明教程--实验楼 - 图15

另一个非常基础的例子:

  1. >>> x = int(input("Please enter an integer: "))
  2. >>> if x < 0:
  3. ... x = 0
  4. ... print('Negative changed to zero')
  5. ... elif x == 0:
  6. ... print('Zero')
  7. ... elif x == 1:
  8. ... print('Single')
  9. ... else:
  10. ... print('More')

在上面的例子中,elifelse if的缩写。

真值检验

检测真值的优雅方式是这样的:

  1. if x:
  2. pass

不要像下面这样做:

  1. if x == True:
  2. pass

总结

这个实验非常简单,这里只是提一句,Python 中的很多值是具有布尔意义的,所以有时候我们可以写的更优雅一点。

同时也要注意下if``elif``else的基本语法结构。

5.循环

在以前的例子里,有些时候我们需要多次执行相同的任务,我们使用一个计数器来检查代码需要执行的次数。这个技术被称为循环。

实验知识点

  • while 循环
  • print() 函数的 end 参数
  • 列表

    • 索引
    • 切片
  • for 循环
  • range() 函数
  • continue 关键字
  • for 循环中的 else 关键字

while循环

while语句的语法如下:

  1. while condition:
  2. statement1
  3. statement2

想要多次执行的代码必须以正确的缩进放在while语句下面。在表达式condition为真的时候它们才会执行。同if-else一样,非零值为真。启动python3交互页面,让我们写一个简单的代码,它按顺序打印 0 到 10 的数字:

  1. >>> n = 0
  2. >>> while n < 11:
  3. ... print(n)
  4. ... n += 1
  5. ...
  6. 0
  7. 1
  8. 2
  9. 3
  10. 4
  11. 5
  12. 6
  13. 7
  14. 8
  15. 9
  16. 10

在第一行我们使n = 0,然后在while语句中把条件设置为n < 11,这意味着在while语句下面缩进的所有行将会被执行,直到n的值大于等于11。在循环里我们只是打印 n 的值然后令它增一。
想想如果没有循环语句,你想要打印 0 到 10 的所有数字,那你得手动打印 11 次!

斐波那契(Fibonacci)数列

让我们来试试打印斐波那契数列。这个数列前两项为 1,之后的每一个项都是前两项之和。所以这个数列看起来就像这样:1,1,2,3,5,8,13 ……

  1. #!/usr/bin/env python3
  2. a, b = 0, 1
  3. while b < 100:
  4. print(b)
  5. a, b = b, a + b

运行程序:
Python3简明教程--实验楼 - 图16

第一行代码中我们初始化ab。当b的值小于 100 的时候,循环执行代码。循环里我们首先打印b的值,然后在下一行将a + b的值赋值给bb的值赋值给a

学习其他语言的同学在这里可能有些困惑,你可以这样理解,Python 中赋值语句执行时会先对赋值运算符右边的表达式求值,然后将这个值赋值给左边的变量。

默认情况下,print()除了打印你提供的字符串之外,还会打印一个换行符,所以每调用一次print()就会换一次行,如同上面一样。

你可以通过print()的另一个参数end来替换这个换行符,就像下面这样,下面的程序写入/home/shiyanlou/fibonacci2.py

  1. #!/usr/bin/env python3
  2. a, b = 0, 1
  3. while b < 100:
  4. print(b, end=' ')
  5. a, b = b, a + b
  6. print()

运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x fibonacci2.py
  3. $ ./fibonacci2.py

Python3简明教程--实验楼 - 图17

幂级数

我们来写一个程序计算幂级数:e^x = 1 + x + x^2 / 2! + x^3 / 3! + … + x^n / n!(0 < x < 1)。

该程序写入代码文件/home/shiyanlou/powerseries.py

  1. #!/usr/bin/env python3
  2. x = float(input("Enter the value of x: "))
  3. n = term = num = 1
  4. result = 1.0
  5. while n <= 100:
  6. term *= x / n
  7. result += term
  8. n += 1
  9. if term < 0.0001:
  10. break
  11. print("No of Times= {} and Sum= {}".format(n, result))

运行程序:
Python3简明教程--实验楼 - 图18

在这个程序里我们介绍一个新的关键字break,它可以终止最里面的循环。这个例子里我们在if语句里使用break

  1. if term < 0.0001:
  2. break

这意味着如果term的值小于0.0001,那么终止循环。

乘法表

这个例子里我们打印 10 以内的乘法表。写入代码文件/home/shiyanlou/multiplication.py

  1. #!/usr/bin/env python3
  2. i = 1
  3. print("-" * 50)
  4. while i < 11:
  5. n = 1
  6. while n <= 10:
  7. print("{:5d}".format(i * n), end=' ')
  8. n += 1
  9. print()
  10. i += 1
  11. print("-" * 50)

运行如下:
Python3简明教程--实验楼 - 图19

这里我们在while循环里使用了另一个while循环,这被称为嵌套循环。你应该已经看到一条有趣的语句:

  1. print("-" * 50)

字符串若是乘上整数 n,将返回由 n 个此字符串拼接起来的新字符串。
下面是一些例子:

  1. >>> 's' * 10
  2. 'ssssssssss'
  3. >>> print("*" * 10)
  4. **********
  5. >>> print("#" * 20)
  6. ####################
  7. >>> print("--" * 20)
  8. ----------------------------------------
  9. >>> print("-" * 40)
  10. ----------------------------------------

一些打印星号的例子

这里是一些你可以在大学的实验报告里经常看到的例子。

2.4.1. 设计 1

  1. #!/usr/bin/env python3
  2. row = int(input("Enter the number of rows: "))
  3. n = row
  4. while n >= 0:
  5. x = "*" * n
  6. print(x)
  7. n -= 1

运行这个程序:
Python3简明教程--实验楼 - 图20

2.4.2. 设计 2

  1. #!/usr/bin/env python3
  2. n = int(input("Enter the number of rows: "))
  3. i = 1
  4. while i <= n:
  5. print("*" * i)
  6. i += 1

运行这个程序:
Python3简明教程--实验楼 - 图21

2.4.3 设计 3

  1. #!/usr/bin/env python3
  2. row = int(input("Enter the number of rows: "))
  3. n = row
  4. while n >= 0:
  5. x = "*" * n
  6. y = " " * (row - n)
  7. print(y + x)
  8. n -= 1

运行这个程序:
Python3简明教程--实验楼 - 图22

列表

在继续学习循环之前,我们先学习一个叫做列表的数据结构。它可以写作中括号之间的一列逗号分隔的值。列表的元素不必是同一类型:

  1. >>> a = [ 1, 342, 223, 'India', 'Fedora']
  2. >>> a
  3. [1, 342, 223, 'India', 'Fedora']

你可以将上面的列表想象为一堆有序的盒子,盒子包含有上面提到的值,每个盒子都有自己的编号(红色的数字),编号从零开始,你可以通过编号访问每一个盒子里面的值。对于列表,这里的编号称为索引。
Python3简明教程--实验楼 - 图23

我们像下面这样通过索引来访问列表中的每一个值:

  1. >>> a[0]
  2. 1
  3. >>> a[4]
  4. 'Fedora'

如果我们使用负数的索引,那将会从列表的末尾开始计数,像下面这样:

  1. >>> a[-1]
  2. 'Fedora'

你甚至可以把它切成不同的部分,这个操作称为切片,例子在下面给出:

  1. >>> a[0:-1]
  2. [1, 342, 223, 'India']
  3. >>> a[2:-2]
  4. [223]

切片并不会改变正在操作的列表,切片操作返回其子列表,这意味着下面的切片操作返回列表一个新的(栈)拷贝副本:

  1. >>> a[:]
  2. [1, 342, 223, 'India', 'Fedora']

切片的索引有非常有用的默认值;省略的第一个索引默认为零,省略的第二个索引默认为切片的字符串的大小:

  1. >>> a[:-2]
  2. [1, 342, 223]
  3. >>> a[-2:]
  4. ['India', 'Fedora']

有个办法可以很容易地记住切片的工作方式:切片时的索引是在两个元素之间 。左边第一个元素的索引为 0,而长度为 n 的列表其最后一个元素的右界索引为 n。例如:

  1. +---+-----+-----+---------+----------+
  2. | 1 | 342 | 223 | 'India' | 'Fedora' |
  3. +---+-----+-----+---------+----------+
  4. 0 1 2 3 4 5
  5. -5 -4 -3 -2 -1

上面的第一行数字给出列表中的索引点 0…5。第二行给出相应的负索引。切片是从 i 到 j 两个数值表示的边界之间的所有元素。
对于非负索引,如果上下都在边界内,切片长度就是两个索引之差。例如a[2:4]是 2。

Python 中有关下标的集合都满足左闭右开原则,切片中也是如此,也就是说集合左边界值能取到,右边界值不能取到。

对上面的列表,a[0:5]用数学表达式可以写为[0,5),其索引取值为0,1,2,3,4,所以能将a中所有值获取到。 你也可以用a[:5], 效果是一样的。

a[-5:-1],因为左闭右开原则,其取值为-5,-4,-3,-2是不包含-1的。

为了取到最后一个值,你可以使用a[-5:],它代表了取该列表最后5个值。

试图使用太大的索引会导致错误:

  1. >>> a[32]
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. IndexError: list index out of range
  5. >>> a[-10]
  6. Traceback (most recent call last):
  7. File "<stdin>", line 1, in <module>
  8. IndexError: list index out of range

Python 能够优雅地处理那些没有意义的切片索引:一个过大的索引值(即大于列表实际长度)将被列表实际长度所代替,当上边界比下边界大时(即切片左值大于右值)就返回空列表:

  1. >>> a[2:32]
  2. [223, 'India', 'Fedora']
  3. >>> a[32:]
  4. []

切片操作还可以设置步长,就像下面这样:

  1. >>> a[1::2]
  2. [342, 'India']

它的意思是,从切片索引 1 到列表末尾,每隔两个元素取值。
列表也支持连接这样的操作,它返回一个新的列表:

  1. >>> a + [36, 49, 64, 81, 100]
  2. [1, 342, 223, 'India', 'Fedora', 36, 49, 64, 81, 100]

列表允许修改元素:

  1. >>> cubes = [1, 8, 27, 65, 125]
  2. >>> cubes[3] = 64
  3. >>> cubes
  4. [1, 8, 27, 64, 125]

也可以对切片赋值,此操作可以改变列表的尺寸,或清空它:

  1. >>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
  2. >>> letters
  3. ['a', 'b', 'c', 'd', 'e', 'f', 'g']
  4. >>> # 替换某些值
  5. >>> letters[2:5] = ['C', 'D', 'E']
  6. >>> letters
  7. ['a', 'b', 'C', 'D', 'E', 'f', 'g']
  8. >>> # 现在移除他们
  9. >>> letters[2:5] = []
  10. >>> letters
  11. ['a', 'b', 'f', 'g']
  12. >>> # 通过替换所有元素为空列表来清空这个列表
  13. >>> letters[:] = []
  14. >>> letters
  15. []

细心的同学可能发问了,前面不是说过切片操作不改变列表么?严格来说,这里并不算真正的切片操作,只是上面代码中赋值运算符左边的这种操作与切片操作形式一样而已。
要检查某个值是否存在于列表中,你可以这样做:

  1. >>> a = ['ShiYanLou', 'is', 'cool']
  2. >>> 'cool' in a
  3. True
  4. >>> 'Linux' in a
  5. False

这意味着我们可以将上面的语句使用在if子句中的表达式。通过内建函数len()我们可以获得列表的长度:

  1. >>> len(a)
  2. 3

如果你想要检查列表是否为空,请这样做:

  1. if list_name: # 列表不为空
  2. pass
  3. else: # 列表为空
  4. pass

列表是允许嵌套的(创建一个包含其它列表的列表),例如:

  1. >>> a = ['a', 'b', 'c']
  2. >>> n = [1, 2, 3]
  3. >>> x = [a, n]
  4. >>> x
  5. [['a', 'b', 'c'], [1, 2, 3]]
  6. >>> x[0]
  7. ['a', 'b', 'c']
  8. >>> x[0][1]
  9. 'b'

for循环

通过for语句我们可以使用 for 循环。Python 里的 for 循环与 C 语言中的不同。这里的 for 循环遍历任何序列(比如列表和字符串)中的每一个元素。下面给出示例:

  1. >>> a = ['ShiYanLou', 'is', 'powerful']
  2. >>> for x in a:
  3. ... print(x)
  4. ...
  5. ShiYanLou
  6. is
  7. powerful

我们也能这样做:

  1. >>> a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
  2. >>> for x in a[::2]:
  3. ... print(x)
  4. 1
  5. 3
  6. 5
  7. 7
  8. 9

range() 函数

如果你需要一个数值序列,内置函数range()会很方便,它生成一个等差数列(并不是列表):

  1. >>> for i in range(5):
  2. ... print(i)
  3. ...
  4. 0
  5. 1
  6. 2
  7. 3
  8. 4
  9. >>> range(1, 5)
  10. range(1, 5)
  11. >>> list(range(1, 5))
  12. [1, 2, 3, 4]
  13. >>> list(range(1, 15, 3))
  14. [1, 4, 7, 10, 13]
  15. >>> list(range(4, 15, 2))
  16. [4, 6, 8, 10, 12, 14]

comtinue语句

如同break,我们可以在循环中使用另一个语句continue。它会跳过其后的代码回到循环开始处执行。这意味着它可以帮助你跳过部分循环。在下面的例子中,我们要求用户输入一个整数,如果输入的是负数,那么我们会再次要求输入,如果输入的是整数,我们计算这个数的平方。用户输入 0 来跳出这个无限循环。

  1. #!/usr/bin/env python3
  2. while True:
  3. n = int(input("Please enter an Integer: "))
  4. if n < 0:
  5. continue # 这会返回到循环开始处执行
  6. elif n == 0:
  7. break
  8. print("Square is ", n ** 2)
  9. print("Goodbye")

运行程序:
Python3简明教程--实验楼 - 图24

循环的else语句

我们可以在循环后面使用可选的else语句。它将会在循环完毕后执行,除非有break语句终止了循环。

  1. >>> for i in range(0, 5):
  2. ... print(i)
  3. ... else:
  4. ... print("Bye bye")
  5. ...
  6. 0
  7. 1
  8. 2
  9. 3
  10. 4
  11. Bye bye

在本课程的后续内容中,我们会看到更多有关breakcontinue的例子。

棍子游戏

这是一个非常简单的游戏。这里有 21 根棍子,首先用户选 1 到 4 根棍子,然后电脑选 1到 4 根棍子。谁选到最后一根棍子谁就输。判断一下用户有赢的机会吗?如果没有的话,如何修改游戏规则可以使用户有赢的机会呢?

特别说明:用户和电脑一次选的棍子总数只能是5。

  1. #!/usr/bin/env python3
  2. sticks = 21
  3. print("There are 21 sticks, you can take 1-4 number of sticks at a time.")
  4. print("Whoever will take the last stick will loose")
  5. while True:
  6. print("Sticks left: " , sticks)
  7. if sticks == 1:
  8. print("You took the last stick, you loose")
  9. break
  10. sticks_taken = int(input("Take sticks(1-4):"))
  11. if sticks_taken >= 5 or sticks_taken <= 0:
  12. print("Wrong choice")
  13. continue
  14. print("Computer took: " , (5 - sticks_taken) , "\n")
  15. sticks -= 5

总结

这个实验中我们了解了两种循环:whilefor循环,其中的for循环我们通常与range()函数配合使用,要特别注意的是,range()函数返回的并不是列表而是一种可迭代对象:

Python3简明教程--实验楼 - 图25

python 中for循环的else子句给我们提供了检测循环是否顺利执行完毕的一种优雅方法。

6.数据结构

实验介绍

Python 有许多内建的数据结构。如果你困惑于什么是数据结构,那么可以参考一下Wikipedia

简单的来说,数据结构(data structure)是计算机中存储、组织数据的方式。比如我们之前的课程中使用过的列表就是一种数据结构,在这里我们还会深入学习它。

知识点

  • 列表的方法与列表元素的删除
  • 将列表用作栈和队列
  • 列表推导式
  • 元组、集合、字典的创建与操作
  • enumerate()zip()函数

列表

  1. >>> a = [23, 45, 1, -3434, 43624356, 234]
  2. >>> a.append(45)
  3. >>> a
  4. [23, 45, 1, -3434, 43624356, 234, 45]

首先我们建立了一个列表a。然后调用列表的方法a.append(45)添加元素45到列表末尾。你可以看到元素 45 已经添加到列表的末端了。有些时候我们需要将数据插入到列表的任何位置,这时我们可以使用列表的insert()方法。

  1. >>> a.insert(0, 1) # 在列表索引 0 位置添加元素 1
  2. >>> a
  3. [1, 23, 45, 1, -3434, 43624356, 234, 45]
  4. >>> a.insert(0, 111) # 在列表索引 0 位置添加元素 111
  5. >>> a
  6. [111, 1, 23, 45, 1, -3434, 43624356, 234, 45]

列表方法count(s)会返回列表元素中s的数量。我们来检查一下45这个元素在列表中出现了多少次。

  1. >>> a.count(45)
  2. 2

如果你想要在列表中移除任意指定值,你需要使用remove()方法。

  1. >>> a.remove(234)
  2. >>> a
  3. [111, 1, 23, 45, 1, -3434, 43624356, 45]

现在我们反转整个列表。

  1. >>> a.reverse()
  2. >>> a
  3. [45, 43624356, -3434, 1, 45, 23, 1, 111]

怎样将一个列表的所有元素添加到另一个列表的末尾呢,可以使用列表的extend()方法。

  1. >>> b = [45, 56, 90]
  2. >>> a.extend(b) # 添加 b 的元素而不是 b 本身
  3. >>> a
  4. [45, 43624356, -3434, 1, 45, 23, 1, 111, 45, 56, 90]

给列表排序,我们使用列表的sort()方法,排序的前提是列表的元素是可比较的。

  1. >>> a.sort()
  2. >>> a
  3. [-3434, 1, 1, 23, 45, 45, 45, 56, 90, 111, 43624356]

你也能使用del关键字删除指定位置的列表元素。

  1. >>> del a[-1]
  2. >>> a
  3. [-3434, 1, 1, 23, 45, 45, 45, 56, 90, 111]

将列表用作栈和队列

栈是我们通常所说的一种LIFO(Last In First Out 后进先出)数据结构。它的意思是最后进入的数据第一个出来。一个最简单的例子往一端封闭的管道放入一些弹珠然后取出来,如果你想把弹珠取出来,你必须从你最后放入弹珠的位置挨个拿出来。用代码实现此原理:

  1. >>> a = [1, 2, 3, 4, 5, 6]
  2. >>> a
  3. [1, 2, 3, 4, 5, 6]
  4. >>> a.pop()
  5. 6
  6. >>> a.pop()
  7. 5
  8. >>> a.pop()
  9. 4
  10. >>> a.pop()
  11. 3
  12. >>> a
  13. [1, 2]
  14. >>> a.append(34)
  15. >>> a
  16. [1, 2, 34]

上面的代码中我们使用了一个新方法pop()。传入一个参数 i 即pop(i)会将第 i 个元素弹出。
在我们的日常生活中会经常遇到队列,比如售票窗口、图书馆、超市的结账出口。队列是一种在末尾追加数据以及在开始弹出数据的数据结构。与栈不同,它是FIFO(First In First Out 先进先出)的数据结构。

  1. >>> a = [1, 2, 3, 4, 5]
  2. >>> a.append(1)
  3. >>> a
  4. [1, 2, 3, 4, 5, 1]
  5. >>> a.pop(0)
  6. 1
  7. >>> a.pop(0)
  8. 2
  9. >>> a
  10. [3, 4, 5, 1]

我们使用a.pop(0)弹出列表中第一个元素。

列表推导式

列表推导式为从序列中创建列表提供了一个简单的方法。如果没有列表推导式,一般都是这样创建列表的:通过将一些操作应用于序列的每个成员并通过返回的元素创建列表,或者通过满足特定条件的元素创建子序列。

假设我们创建一个 squares 列表,可以像下面这样创建。

  1. >>> squares = []
  2. >>> for x in range(10):
  3. ... squares.append(x**2)
  4. ...
  5. >>> squares
  6. [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

注意这个 for 循环中的被创建(或被重写)的名为x的变量在循环完毕后依然存在。使用如下方法,我们可以计算 squares 的值而不会产生任何的副作用:。

  1. squares = list(map(lambda x: x**2, range(10)))

等价于下面的列表推导式。

  1. squares = [x**2 for x in range(10)]

上面这个方法更加简明且易读。
列表推导式由包含一个表达式的中括号组成,表达式后面跟随一个 for 子句,之后可以有零或多个 for 或 if 子句。结果是一个列表,由表达式依据其后面的 for 和 if 子句上下文计算而来的结果构成。

例如,如下的列表推导式结合两个列表的元素,如果元素之间不相等的话:

  1. >>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y]
  2. [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]

等同于:

  1. >>> combs = []
  2. >>> for x in [1,2,3]:
  3. ... for y in [3,1,4]:
  4. ... if x != y:
  5. ... combs.append((x, y))
  6. ...
  7. >>> combs
  8. [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]

值得注意的是在上面两个方法中的 for 和 if 语句的顺序。
列表推导式也可以嵌套。

  1. >>> a=[1,2,3]
  2. >>> z = [x + 1 for x in [x ** 2 for x in a]]
  3. >>> z
  4. [2, 5, 10]

元组

元组是由数个逗号分割的值组成。

  1. >>> a = 'Fedora', 'ShiYanLou', 'Kubuntu', 'Pardus'
  2. >>> a
  3. ('Fedora', 'ShiYanLou', 'Kubuntu', 'Pardus')
  4. >>> a[1]
  5. 'ShiYanLou'
  6. >>> for x in a:
  7. ... print(x, end=' ')
  8. ...
  9. Fedora ShiYanLou Kubuntu Pardus

你可以对任何一个元组执行拆封操作并赋值给多个变量,就像下面这样:

  1. >>> divmod(15,2)
  2. (7, 1)
  3. >>> x, y = divmod(15,2)
  4. >>> x
  5. 7
  6. >>> y
  7. 1

元组是不可变类型,这意味着你不能在元组内删除或添加或编辑任何值。如果你尝试这些操作,将会出错:

  1. >>> a = (1, 2, 3, 4)
  2. >>> del a[0]
  3. Traceback (most recent call last):
  4. File "<stdin>", line 1, in <module>
  5. TypeError: 'tuple' object doesn't support item deletion

要创建只含有一个元素的元组,在值后面跟一个逗号。

  1. >>> a = (123)
  2. >>> a
  3. 123
  4. >>> type(a)
  5. <class 'int'>
  6. >>> a = (123, )
  7. >>> b = 321,
  8. >>> a
  9. (123,)
  10. >>> b
  11. (321,)
  12. >>> type(a)
  13. <class 'tuple'>
  14. >>> type(b)
  15. <class 'tuple'>

通过内建函数type()你可以知道任意变量的数据类型。还记得我们使用len()函数来查询任意序列类型数据的长度吗?

  1. >>> type(len)
  2. <class 'builtin_function_or_method'>

集合

集合是一个无序不重复元素的集。基本功能包括关系测试和消除重复元素。集合对象还支持 union(联合),intersection(交),difference(差)和 symmetric difference(对称差集)等数学运算。

大括号或 set() 函数可以用来创建集合。注意:想要创建空集合,你必须使用 set() 而不是 {}。后者用于创建空字典,我们在下一节中介绍的一种数据结构。

下面是集合的常见操作:

  1. >>> basket = {'apple', 'orange', 'apple', 'pear', 'orange', 'banana'}
  2. >>> print(basket) # 你可以看到重复的元素被去除
  3. {'orange', 'banana', 'pear', 'apple'}
  4. >>> 'orange' in basket
  5. True
  6. >>> 'crabgrass' in basket
  7. False
  8. >>> # 演示对两个单词中的字母进行集合操作
  9. ...
  10. >>> a = set('abracadabra')
  11. >>> b = set('alacazam')
  12. >>> a # a 去重后的字母
  13. {'a', 'r', 'b', 'c', 'd'}
  14. >>> a - b # a 有而 b 没有的字母
  15. {'r', 'd', 'b'}
  16. >>> a | b # 存在于 a 或 b 的字母
  17. {'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'}
  18. >>> a & b # a 和 b 都有的字母
  19. {'a', 'c'}
  20. >>> a ^ b # 存在于 a 或 b 但不同时存在的字母
  21. {'r', 'd', 'b', 'm', 'z', 'l'}

从集合中添加或弹出元素:

  1. >>> a = {'a','e','h','g'}
  2. >>> a.pop() # pop 方法随机删除一个元素并打印
  3. 'h'
  4. >>> a.add('c')
  5. >>> a
  6. {'c', 'e', 'g', 'a'}

字典

字典是是无序的键值对(key:value)集合,同一个字典内的键必须是互不相同的。一对大括号{}创建一个空字典。初始化字典时,在大括号内放置一组逗号分隔的键:值对,这也是字典输出的方式。我们使用键来检索存储在字典中的数据。

  1. >>> data = {'kushal':'Fedora', 'kart_':'Debian', 'Jace':'Mac'}
  2. >>> data
  3. {'kushal': 'Fedora', 'Jace': 'Mac', 'kart_': 'Debian'}
  4. >>> data['kart_']
  5. 'Debian'

创建新的键值对很简单:

  1. >>> data['parthan'] = 'Ubuntu'
  2. >>> data
  3. {'kushal': 'Fedora', 'Jace': 'Mac', 'kart_': 'Debian', 'parthan': 'Ubuntu'}

使用del关键字删除任意指定的键值对:

  1. >>> del data['kushal']
  2. >>> data
  3. {'Jace': 'Mac', 'kart_': 'Debian', 'parthan': 'Ubuntu'

使用in关键字查询指定的键是否存在于字典中。

  1. >>> 'ShiYanLou' in data
  2. False

必须知道的是,字典中的键必须是不可变类型,比如你不能使用列表作为键。
dict()可以从包含键值对的元组中创建字典。

  1. >>> dict((('Indian','Delhi'),('Bangladesh','Dhaka')))
  2. {'Indian': 'Delhi', 'Bangladesh': 'Dhaka'}

如果你想要遍历一个字典,使用字典的items()方法。

  1. >>> data
  2. {'Kushal': 'Fedora', 'Jace': 'Mac', 'kart_': 'Debian', 'parthan': 'Ubuntu'}
  3. >>> for x, y in data.items():
  4. ... print("{} uses {}".format(x, y))
  5. ...
  6. Kushal uses Fedora
  7. Jace uses Mac
  8. kart_ uses Debian
  9. parthan uses Ubuntu

许多时候我们需要往字典中的元素添加数据,我们首先要判断这个元素是否存在,不存在则创建一个默认值。如果在循环里执行这个操作,每次迭代都需要判断一次,降低程序性能。
我们可以使用dict.setdefault(key, default)更有效率的完成这个事情。

  1. >>> data = {}
  2. >>> data.setdefault('names', []).append('Ruby')
  3. >>> data
  4. {'names': ['Ruby']}
  5. >>> data.setdefault('names', []).append('Python')
  6. >>> data
  7. {'names': ['Ruby', 'Python']}
  8. >>> data.setdefault('names', []).append('C')
  9. >>> data
  10. {'names': ['Ruby', 'Python', 'C']}

试图索引一个不存在的键将会抛出一个keyError错误。我们可以使用dict.get(key, default)来索引键,如果键不存在,那么返回指定的 default 值。

  1. >>> data['foo']
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. KeyError: 'foo'
  5. >>> data.get('foo', 0)
  6. 0

如果你想要在遍历列表(或任何序列类型)的同时获得元素索引值,你可以使用enumerate()

  1. >>> for i, j in enumerate(['a', 'b', 'c']):
  2. ... print(i, j)
  3. ...
  4. 0 a
  5. 1 b
  6. 2 c

你也许需要同时遍历两个序列类型,你可以使用zip()函数。

  1. >>> a = ['Pradeepto', 'Kushal']
  2. >>> b = ['OpenSUSE', 'Fedora']
  3. >>> for x, y in zip(a, b):
  4. ... print("{} uses {}".format(x, y))
  5. ...
  6. Pradeepto uses OpenSUSE
  7. Kushal uses Fedora

程序示例

本节实验将会通过两个实例程序来熟悉 Python3 的基本数据结构:

  1. 判断学生成绩是否达标的程序
  2. 计算两个矩阵的 Hadamard 乘积

students.py

这是一个判断学生成绩是否达标的程序,要求输入学生数量,以及各个学生物理、数学、历史三科的成绩,如果总成绩小于 120,程序打印 “failed”,否则打印 “passed”。

代码写入/home/shiyanlou/students.py文件:

  1. #!/usr/bin/env python3
  2. n = int(input("Enter the number of students: "))
  3. data = {} # 用来存储数据的字典变量
  4. Subjects = ('Physics', 'Maths', 'History') # 所有科目
  5. for i in range(0, n):
  6. name = input('Enter the name of the student {}: '.format(i + 1)) # 获得学生名称
  7. marks = []
  8. for x in Subjects:
  9. marks.append(int(input('Enter marks of {}: '.format(x)))) # 获得每一科的分数
  10. data[name] = marks
  11. for x, y in data.items():
  12. total = sum(y)
  13. print("{}'s total marks {}".format(x, total))
  14. if total < 120:
  15. print(x, "failed :(")
  16. else:
  17. print(x, "passed :)")

name 和 marks 是变量,name 用来存储学生的名称,marks 是个列表,用来存储输入的学生的成绩数据。
data 是个字典,字典的键值对中,键指的是 name 的值,值指的是 marks 的值。因此会使用data[name] = marks将学生数据存入到 data 字典。

最后通过 for 循环遍历字典,x 为学生的 name,y 为学生成绩列表 marks,sum()函数会将传入的列表进行加和。

运行如下:

Python3简明教程--实验楼 - 图26

matrixmul.py

这个例子里我们计算两个矩阵的 Hadamard 乘积。要求输入矩阵的行/列数(在这里假设我们使用的是 n × n 的矩阵)。

代码写入/home/shiyanlou/matrixmul.py文件:

  1. #!/usr/bin/env python3
  2. n = int(input("Enter the value of n: "))
  3. print("Enter values for the Matrix A")
  4. a = []
  5. for i in range(n):
  6. a.append([int(x) for x in input().split()])
  7. print("Enter values for the Matrix B")
  8. b = []
  9. for i in range(n):
  10. b.append([int(x) for x in input().split()])
  11. c = []
  12. for i in range(n):
  13. c.append([a[i][j] * b[i][j] for j in range(n)])
  14. print("After matrix multiplication")
  15. print("-" * 7 * n)
  16. for x in c:
  17. for y in x:
  18. print(str(y).rjust(5), end=' ')
  19. print()
  20. print("-" * 7 * n)

运行如下:
Python3简明教程--实验楼 - 图27

这里我们使用了几次列表推导式。[int(x) for x in input().split()]首先通过input()获得用户输入的字符串,再使用split()分割字符串得到一系列的数字字符串,然后用int()从每个数字字符串创建对应的整数值。我们也使用了[a[i][j] * b[i][j] for j in range(n)]来得到矩阵乘积的每一行数据。

总结

本实验了解了 Python 内置的几种常用数据结构,在写程序的过程中,不同的场景应当选取合适的数据结构。

一般来说,目前我们见到的数据结构已经够用了,不过 Python 中还有一些其它有用的数据结构,可以在这里了解:https://docs.python.org/3/library/datatypes.html

7.字符串

实验介绍

字符串是 Python 中最常用的数据类型。本节实验将会学习如何对 Python3 的字符串进行处理操作。

知识点

  • 字符串的3种表示
  • 字符串的分割、连接、大小写转换、搜索等常用操作

字符串的表示

可以通过几种不同的方式表示字符串。如单引号('...')或双引号("...")。下面的例子能帮助你更好的理解字符串。

  1. >>> s = "I am Chinese"
  2. >>> s
  3. 'I am Chinese'
  4. >>> s = 'I am Chinese'
  5. >>> s = "Here is a line \
  6. ... split in two lines"
  7. >>> s
  8. 'Here is a line split in two lines'
  9. >>> s = "Here is a line \n split in two lines"
  10. >>> s
  11. 'Here is a line \n split in two lines'
  12. >>> print(s)
  13. Here is a line
  14. split in two lines

如果你想要分几行输入字符串,并且希望行尾的换行符自动包含到字符串当中,可以使用三对引号:"""..."""'''...'''

  1. >>> print("""\
  2. ... Usage: thingy [OPTIONS]
  3. ... -h Display this usage message
  4. ... -H hostname Hostname to connect to
  5. ... """)
  6. Usage: thingy [OPTIONS]
  7. -h Display this usage message
  8. -H hostname Hostname to connect to

字符串的方法

每一个字符串对象都有几个可用的内建方法,我们已经使用过一些了,比如s.split()

  1. >>> s = "shi yan lou"
  2. >>> s.title()
  3. 'Shi Yan Lou'

方法title()返回字符串的标题版本,即单词首字母大写其余字母小写。

  1. >>> z = s.upper()
  2. >>> z
  3. 'SHI YAN LOU'
  4. >>> z.lower()
  5. 'shi yan lou'

方法upper()返回字符串全部大写的版本,反之lower()返回字符串的全部小写版本。

  1. >>> s = "I am A pRoGraMMer"
  2. >> s.swapcase()
  3. 'i AM a PrOgRAmmER'

方法swapcase()返回字符串大小写交换后的版本 :)

  1. >>> s = "jdwb 2323bjb"
  2. >>> s.isalnum()
  3. False
  4. >>> s = "jdwb2323bjb"
  5. >>> s.isalnum()
  6. True

方法isalnum()检查所有字符是否只有字母和数字,上面的代码中第一行的字符串s中包含空格字符,所以返回False

  1. >>> s = "SankarshanSir"
  2. >>> s.isalpha()
  3. True
  4. >>> s = "Sankarshan Sir"
  5. >>> s.isalpha()
  6. False

方法isalpha()检查字符串之中是否只有字母。

  1. >>> s = "1234"
  2. >>> s.isdigit() # 检查字符串是否所有字符为数字
  3. True
  4. >>> s = "ShiYanLou is coming"
  5. >>> s.islower() # 检查字符串是否所有字符为小写
  6. False
  7. >>> s = "Shiyanlou Is Coming"
  8. >>> s.istitle() # To 检查字符串是否为标题样式
  9. True
  10. >>> s = "CHINA"
  11. >>> s.isupper() # 检查字符串是否所有字符为大写
  12. True

我们可以使用split()分割任意字符串,split()允许有一个参数,用来指定字符串以什么字符分隔(默认为" "),它返回一个包含所有分割后的字符串的列表。

  1. >>> s = "We all love Python"
  2. >>> s.split()
  3. ['We', 'all', 'love', 'Python']
  4. >>> x = "shiyanlou:is:waiting"
  5. >>> x.split(':')
  6. ['shiyanlou', 'is', 'waiting']

相反的,方法join()使用指定字符连接多个字符串,它需要一个包含字符串元素的列表作为输入然后连接列表内的字符串元素。

  1. >>> "-".join("GNU/Linux is great".split())
  2. 'GNU/Linux-is-great'

在上面的例子中,我们基于空格" "分割字符串"GNU/Linux is great",然后用"-"连接它们。

字符串剥离

字符串有几个进行剥离操作的方法。最简单的一个是strip(chars),用来剥离字符串首尾中指定的字符,它允许有一个字符串参数,这个参数为剥离哪些字符提供依据。不指定参数则默认剥离掉首尾的空格和换行符,代码如下:

  1. >>> s = " a bc\n "
  2. >>> s.strip()
  3. 'a bc'

你可以使用lstrip(chars)rstrip(chars)只对字符串左或右剥离。

  1. >>> s = "www.foss.in"
  2. >>> s.lstrip("cwsd.") #删除在字符串左边出现的'c','w','s','d','.'字符
  3. 'foss.in'
  4. >>> s.rstrip("cnwdi.") #删除在字符串右边出现的'c','n','w','d','i','.'字符
  5. 'www.foss'

文本搜索

字符串有一些方法能够帮助你搜索字符串里的文本或子字符串。下面给出示例:

  1. >>> s = "faulty for a reason"
  2. >>> s.find("for")
  3. 7
  4. >>> s.find("fora")
  5. -1
  6. >>> s.startswith("fa") # 检查字符串是否以 fa 开头
  7. True
  8. >>> s.endswith("reason") # 检查字符串是否以 reason 结尾
  9. True

find()能帮助你找到第一个匹配的子字符串,没有找到则返回 -1。

回文检查

回文是一种无论从左还是从右读都一样的字符序列。比如 “madam”。在这个例子中,我们检查用户输入的字符串是否是回文,并输出结果。

代码写入文件/home/shiyanlou/palindrome.py

  1. #!/usr/bin/env python3
  2. s = input("Please enter a string: ")
  3. z = s[::-1] #把输入的字符串s 进行倒序处理形成新的字符串z
  4. if s == z:
  5. print("The string is a palindrome")
  6. else:
  7. print("The string is not a palindrome")

运行程序:
Python3简明教程--实验楼 - 图28

单词计数

在讲解单词计数之前我们先了解一个概念:格式化操作符(%)。

我们先看下面的这个例子:

  1. print("my name is %s.I am %d years old" % ('Shixiaolou',4))

Python3简明教程--实验楼 - 图29

在这个例子中,%s为第一个格式符,表示一个字符串;%d为第二个格式符,表示一个整数。格式符为真实值预留位置,并控制显示的格式。常用的有:

%s 字符串(用 str() 函数进行字符串转换)
%r 字符串(用 repr() 函数进行字符串转换)
%d 十进制整数
%f 浮点数
%% 字符“%”

那么接下来我们对用户输入的一行文本进行单词计数。

代码写入文件/home/shiyanlou/countwords.py

  1. #!/usr/bin/env python3
  2. s = input("Enter a line: ")
  3. print("The number of words in the line are %d" % (len(s.split(" "))))

运行程序:
Python3简明教程--实验楼 - 图30

总结

回顾本节实验的知识点:

  • 字符串的3种表示
  • 字符串的分割、连接、大小写转换、搜索等常用操作

本实验学习了字符串的几种表示方法(3种引号)以及对字符串的各种常用操作(分割、连接、大小写转换、搜索…),应当熟练掌握它们。

单词计数的实例需要仔细理解,字符串的更多用法在实验楼的项目实验中也都会涉及到。

8.函数

实验介绍

我们经常需要在同一个程序里多次复用代码。函数可以很好的帮助我们完成这一点。我们在函数里写我们要重复做的事,然后我们在任何需要的时候调用它。我们已经看到一些内建的函数,比如len()divmod()

知识点

  • 函数的定义
  • 局部/全局变量的概念
  • 默认参数,关键字参数及强制关键字参数
  • 文档字符串的使用
  • 高阶函数,map() 函数

定义一个函数

我们使用关键字def来定义一个函数,语法描述如下所示:

  1. def 函数名(参数):
  2. 语句1
  3. 语句2

让我们编写一个函数,它将接受两个整数作为输入,然后返回总和。

  1. >>> def sum(a, b):
  2. ... return a + b

第二行有个return关键字,我们把a + b的值返回给调用者。
你必须像下面这样调用这个函数。

  1. >>> res = sum(234234, 34453546464)
  2. >>> res
  3. 34453780698L

还记得我们上一个实验讲过的回文检查程序么,让我们编写一个函数来检查给出的字符串是否为回文,然后返回True或者False

  1. #!/usr/bin/env python3
  2. def palindrome(s):
  3. return s == s[::-1]
  4. if __name__ == '__main__':
  5. s = input("Enter a string: ")
  6. if palindrome(s):
  7. print("Yay a palindrome")
  8. else:
  9. print("Oh no, not a palindrome")

将上述代码写入到 testpalindrome.py 文件,执行如下:

  1. $ python3 testpalindrome.py
  2. Enter a string: test111
  3. Oh no, not a palindrome
  4. $ python3 testpalindrome.py
  5. Enter a string: 1234321
  6. Yay a palindrome

局域或全部变量

我们通过几个例子来弄明白局域或全局变量,首先我们在函数内部和函数调用的代码中都使用同一个变量 a,将下方代码写入/home/shiyanlou/local.py

  1. #!/usr/bin/env python3
  2. def change():
  3. a = 90
  4. print(a)
  5. a = 9
  6. print("Before the function call ", a)
  7. print("inside change function", end=' ')
  8. change()
  9. print("After the function call ", a)

运行程序:
Python3简明教程--实验楼 - 图31

首先我们对a赋值 9,然后调用更改函数,这个函数里我们对a赋值 90,然后打印a的值。调用函数后我们再次打印a的值。

当我们在函数里写a = 90时,它实际上创建了一个新的名为a的局部变量,这个变量只在函数里可用,并且会在函数完成时销毁。所以即使这两个变量的名字都相同,但事实上他们并不是同一个变量。

那么如果我们先定义a,在函数中是否可以直接使用呢?

例如下面这段代码:

  1. #!/usr/bin/env python3
  2. a = 9
  3. def change():
  4. print(a)
  5. change()

这段代码是没有问题的,可以直接打印输出 9。稍微改动一下:

  1. #!/usr/bin/env python3
  2. a = 9
  3. def change():
  4. print(a)
  5. a = 100
  6. change()

现在就会报错了:“UnboundLocalError: local variable ‘a’ referenced before assignment”,原因是当函数中只要用到了变量 a,并且 a 出现在表达式等于号的前面,就会被当作局部变量。当执行到print(a)的时候会报错,因为 a 作为函数局部变量是在print(a)之后才定义的。
现在我们使用global关键字,对函数中的a标志为全局变量,让函数内部使用全局变量的 a,那么整个程序中出现的a都将是这个:

  1. #!/usr/bin/env python3
  2. a = 9
  3. def change():
  4. global a
  5. print(a)
  6. a = 100
  7. print("Before the function call ", a)
  8. print("inside change function", end=' ')
  9. change()
  10. print("After the function call ", a)

程序中的end=' '参数表示,print 打印后的结尾不用换行,而用空格。默认情况下 print 打印后会在结尾换行。
程序执行的结果,不会报错了,因为函数体内可以访问全局的变量a

  1. Before the function call 9
  2. inside change function 9
  3. After the function call 100

在函数内使用global会有什么作用呢?尝试下面的代码:

  1. #!/usr/bin/env python3
  2. def change():
  3. global a
  4. a = 90
  5. print(a)
  6. a = 9
  7. print("Before the function call ", a)
  8. print("inside change function", end=' ')
  9. change()
  10. print("After the function call ", a)

程序执行的结果:

  1. Before the function call 9
  2. inside change function 90
  3. After the function call 90

这里通过关键字global来告诉 a 的定义是全局的,因此在函数内部更改了a的值,函数外a的值也实际上更改了。
运行程序:

Python3简明教程--实验楼 - 图32

默认参数值

函数的参数变量可以有默认值,也就是说如果我们对指定的参数变量没有给出任何值则会赋其默认值。

  1. >>> def test(a , b=-99):
  2. ... if a > b:
  3. ... return True
  4. ... else:
  5. ... return False

在上面的例子里,我们在函数的参数列表写出b = -99。这表示如果调用者未给出b的值,那么b的值默认为-99。这是一个关于默认参数的非常简单的例子。
你可以通过调用函数测试代码。

  1. >>> test(12, 23)
  2. False
  3. >>> test(12)
  4. True

有两个非常重要的地方,第一个是具有默认值的参数后面不能再有普通参数,比如f(a,b=90,c)就是错误的。
第二个是默认值只被赋值一次,因此如果默认值是任何可变对象时会有所不同,比如列表、字典或大多数类的实例。例如,下面的函数在后续调用过程中会累积(前面)传给它的参数:

  1. >>> def f(a, data=[]):
  2. ... data.append(a)
  3. ... return data
  4. ...
  5. >>> print(f(1))
  6. [1]
  7. >>> print(f(2))
  8. [1, 2]
  9. >>> print(f(3))
  10. [1, 2, 3]

要避免这个问题,你可以像下面这样:

  1. >>> def f(a, data=None):
  2. ... if data is None:
  3. ... data = []
  4. ... data.append(a)
  5. ... return data
  6. ...
  7. >>> print(f(1))
  8. [1]
  9. >>> print(f(2))
  10. [2]

关键字参数

函数可以通过关键字参数的形式来调用,形如keyword = value。如下:

  1. >>> def func(a, b=5, c=10):
  2. ... print('a is', a, 'and b is', b, 'and c is', c)
  3. ...
  4. >>> func(12, 24)
  5. a is 12 and b is 24 and c is 10
  6. >>> func(12, c = 24)
  7. a is 12 and b is 5 and c is 24
  8. >>> func(b=12, c = 24, a = -1)
  9. a is -1 and b is 12 and c is 24

在上面的例子中你能看见调用函数时使用了变量名,比如func(12,c = 24),这样我们将24赋给cb具有默认值。

强制关键字参数

我们也能将函数的参数标记为只允许使用关键字参数。用户调用函数时将只能对每一个参数使用相应的关键字参数。

  1. >>> def hello(*, name='User'):
  2. ... print("Hello", name)
  3. ...
  4. >>> hello('shiyanlou')
  5. Traceback (most recent call last):
  6. File "<stdin>", line 1, in <module>
  7. TypeError: hello() takes 0 positional arguments but 1 was given
  8. >>> hello(name='shiyanlou')
  9. Hello shiyanlou

了解更多,请阅读PEP-3102

文档字符串

在 Python 里我们使用文档字符串(docstrings)来说明如何使用代码,这在交互模式非常有用,也能用于自动创建文档。下面我们来看看使用文档字符串的例子。

  1. #!/usr/bin/env python3
  2. import math
  3. def longest_side(a, b):
  4. """
  5. Function to find the length of the longest side of a right triangle.
  6. :arg a: Side a of the triangle
  7. :arg b: Side b of the triangle
  8. :return: Length of the longest side c as float
  9. """
  10. return math.sqrt(a*a + b*b)
  11. if __name__ == '__main__':
  12. print(longest_side.__doc__)
  13. print(longest_side(4,5))

运行程序:
Python3简明教程--实验楼 - 图33

高阶函数

高阶函数(Higher-order function)或仿函数(functor)是可以接受函数作为参数的函数:

  • 使用一个或多个函数作为参数
  • 返回另一个函数作为输出

Python 里的任何函数都可以作为高阶函数,下面举一个简单的例子:

  1. # 创建一个函数,将参数列表中每个元素都变成全大写
  2. >>> def high(l):
  3. ... return [i.upper() for i in l]
  4. ...
  5. # 创建高阶函数,接受一个函数和一个列表作为参数
  6. >>> def test(h, l):
  7. ... return h(l)
  8. ...
  9. >>> l = ['python', 'Linux', 'Git']
  10. # 运行高阶函数,返回预期的结果
  11. >>> test(high, l)
  12. ['PYTHON', 'LINUX', 'GIT']

阅读官方文档了解更多。

map 函数

map是一个在 Python 里非常有用的高阶函数。它接受一个函数和一个序列(迭代器)作为输入,然后对序列(迭代器)的每一个值应用这个函数,返回一个序列(迭代器),其包含应用函数后的结果。

举例:

  1. >>> lst = [1, 2, 3, 4, 5]
  2. >>> def square(num):
  3. ... "返回所给数字的平方."
  4. ... return num * num
  5. ...
  6. >>> print(list(map(square, lst)))
  7. [1, 4, 9, 16, 25]

总结

经过本实验应当知道如何定义函数,局域变量和全局变量一定要弄清楚,参数默认值、关键字参数也需要掌握。

另外,其它高级语言常见的函数重载,Python 是没有的,这是因为 Python 有默认参数这个功能,函数重载的功能大都可以使用默认参数达到。

在后面我们还介绍了高阶函数的概念并使用了map()函数。在 Python 中还有其它的高阶函数,如sorted()filter()以及functools模块中的函数,大家可以了解一下。

9.文件处理

实验介绍

文件是保存在计算机存储设备上的一些信息或数据。你已经知道了一些不同的文件类型,比如你的音乐文件,视频文件,文本文件。Python 给了你一些简单的方式操纵文件。通常我们把文件分为两类,文本文件和二进制文件。文本文件是简单的文本,二进制文件包含了只有计算机可读的二进制数据。

知识点

  • 文件打开模式
  • 文件读取与写入
  • with语句

文件操作

本部分实验内容会实践学习以下的知识:

  1. 文件打开与关闭
  2. 文件读取与写入

所有的实例程序都需要你在实验环境中完整的输入并执行。

文件打开

我们使用open()函数打开文件。它需要两个参数,第一个参数是文件路径或文件名,第二个是文件的打开模式。模式通常是下面这样的:

  • "r",以只读模式打开,你只能读取文件但不能编辑/删除文件的任何内容
  • "w",以写入模式打开,如果文件存在将会删除里面的所有内容,然后打开这个文件进行写入
  • "a",以追加模式打开,写入到文件中的任何数据将自动添加到末尾

默认的模式为只读模式,也就是说如果你不提供任何模式,open()函数将会以只读模式打开文件。我们将实验打开一个文件,不过要准备实验材料:

  1. $ wget http://labfile.oss.aliyuncs.com/courses/596/sample.txt

Python3简明教程--实验楼 - 图34

然后进入 Python3 打开这个文件。

  1. >>> fobj = open("sample.txt")
  2. >>> fobj
  3. <_io.TextIOWrapper name='sample.txt' mode='r' encoding='UTF-8'>

文件关闭

打开文件后我们应该总是关闭文件。我们使用方法close()完成这个操作。

  1. >>> fobj.close()

始终确保你显式关闭每个打开的文件,一旦它的工作完成你没有任何理由保持打开文件。因为程序能打开的文件数量是有上限的。如果你超出了这个限制,没有任何可靠的方法恢复,因此程序可能会崩溃。每个打开的文件关联的数据结构(文件描述符/句柄/文件锁…)都要消耗一些主存资源。因此如果许多打开的文件没用了你可以结束大量的内存浪费,并且文件打开时始终存在数据损坏或丢失的可能性。

文件读取

使用read()方法一次性读取整个文件。

  1. >>> fobj = open("sample.txt")
  2. >>> fobj.read()
  3. 'I love Python\nI love shiyanlou\n'
  4. >>> fobj.close()

如果你再一次调用read(),它会返回空字符串因为它已经读取完整个文件。
read(size)有一个可选的参数size,用于指定字符串长度。如果没有指定size或者指定为负数,就会读取并返回整个文件。当文件大小为当前机器内存两倍时,就会产生问题。反之,会尽可能按比较大的size读取和返回数据。

readline()能帮助你每次读取文件的一行。

  1. >>> fobj = open("sample.txt")
  2. >>> fobj.readline()
  3. 'I love Python\n'
  4. >>> fobj.readline()
  5. 'I love shiyanlou\n'
  6. >>> fobj.close()

使用readlines()方法读取所有行到一个列表中。

  1. >>> fobj = open('sample.txt')
  2. >>> fobj.readlines()
  3. ['I love Python\n', 'I love shiyanlou\n']
  4. >>> fobj.close()

你可以循环遍历文件对象来读取文件中的每一行。

  1. >>> fobj = open('sample.txt')
  2. >>> for x in fobj:
  3. ... print(x, end = '')
  4. ...
  5. I love Python
  6. I love shiyanlou
  7. >>> fobj.close()

让我们写一个程序,这个程序接受用户输入的字符串作为将要读取的文件的文件名,并且在屏幕上打印文件内容。

  1. #!/usr/bin/env python3
  2. name = input("Enter the file name: ")
  3. fobj = open(name)
  4. print(fobj.read())
  5. fobj.close()

运行程序:

  1. $ cd /home/shiyanlou
  2. $ chmod +x test.py
  3. $ ./test.py
  4. Enter the file name: sample.txt
  5. I love Python
  6. I love shiyanlou

文件写入

让我们通过write()方法打开一个文件然后我们随便写入一些文本。

  1. >>> fobj = open("ircnicks.txt", 'w')
  2. >>> fobj.write('powerpork\n')
  3. >>> fobj.write('indrag\n')
  4. >>> fobj.write('mishti\n')
  5. >>> fobj.write('sankarshan')
  6. >>> fobj.close()

现在读取我们刚刚创建的文件。

  1. >>> fobj = open('ircnicks.txt')
  2. >>> s = fobj.read()
  3. >>> fobj.close()
  4. >>> print(s)
  5. powerpork
  6. indrag
  7. mishti
  8. sankarshan

文件操作示例程序

本部分实验将通过两个实例程序来实践之前学习的文件操作方法:

  1. 拷贝文件程序
  2. 文本文件信息统计程序

所有的实例程序都需要你在实验环境中完整的输入并执行。

拷贝文件

在这个例子里我们拷贝给定的文本文件到另一个给定的文本文件。

  1. #!/usr/bin/env python3
  2. import sys
  3. if len(sys.argv) < 3:
  4. print("Wrong parameter")
  5. print("./copyfile.py file1 file2")
  6. sys.exit(1)
  7. f1 = open(sys.argv[1])
  8. s = f1.read()
  9. f1.close()
  10. f2 = open(sys.argv[2], 'w')
  11. f2.write(s)
  12. f2.close()

运行程序:
Python3简明教程--实验楼 - 图35

你可以看到我们在这里使用了一个新模块syssys.argv包含所有命令行参数。这个程序的功能完全可以使用 shell 的cp命令替代:在cp后首先输入被拷贝的文件的文件名,然后输入新文件名。

sys.argv的第一个值是命令自身的名字,下面这个程序打印命令行参数。

  1. #!/usr/bin/env python3
  2. import sys
  3. print("First value", sys.argv[0])
  4. print("All values")
  5. for i, x in enumerate(sys.argv):
  6. print(i, x)

运行程序:

  1. $ ./argvtest.py Hi there
  2. First value ./argvtest.py
  3. All values
  4. 0 ./argvtest.py
  5. 1 Hi
  6. 2 there

这里我们用到了一个新函数enumerate(iterableobject),在序列中循环时,索引位置和对应值可以使用它同时得到。

文本文件现关信息统计

让我们试着编写一个程序,对任意给定文本文件中的制表符、行、空格进行计数。

代码写入文件/home/shiyanlou/parsefile.py

  1. #!/usr/bin/env python3
  2. import os
  3. import sys
  4. def parse_file(path):
  5. """
  6. 分析给定文本文件,返回其空格、制表符、行的相关信息
  7. :arg path: 要分析的文本文件的路径
  8. :return: 包含空格数、制表符数、行数的元组
  9. """
  10. fd = open(path)
  11. i = 0
  12. spaces = 0
  13. tabs = 0
  14. for i,line in enumerate(fd):
  15. spaces += line.count(' ')
  16. tabs += line.count('\t')
  17. # 现在关闭打开的文件
  18. fd.close()
  19. # 以元组形式返回结果
  20. return spaces, tabs, i + 1
  21. def main(path):
  22. """
  23. 函数用于打印文件分析结果
  24. :arg path: 要分析的文本文件的路径
  25. :return: 若文件存在则为 True,否则 False
  26. """
  27. if os.path.exists(path):
  28. spaces, tabs, lines = parse_file(path)
  29. print("Spaces {}. tabs {}. lines {}".format(spaces, tabs, lines))
  30. return True
  31. else:
  32. return False
  33. if __name__ == '__main__':
  34. if len(sys.argv) > 1:
  35. main(sys.argv[1])
  36. else:
  37. sys.exit(-1)
  38. sys.exit(0)

运行程序:
Python3简明教程--实验楼 - 图36

你可以看到程序有两个函数,main()parse_file()parse_file函数真正的分析文件并返回结果,然后在main()函数里打印结果。通过分割代码到一些更小的单元(函数)里,能帮助我们组织代码库并且也更容易为函数编写测试用例。

使用with语句

在实际情况中,我们应该尝试使用with语句处理文件对象,它会在文件用完后会自动关闭,就算发生异常也没关系。它是 try-finally 块的简写:

  1. >>> with open('sample.txt') as fobj:
  2. ... for line in fobj:
  3. ... print(line, end = '')
  4. ...
  5. I love Python
  6. I love shiyanlou

实现lscpu命令

在 Linux 下你可以使用lscpu命令来查看当前电脑的 CPU 相关信息,如下图:

Python3简明教程--实验楼 - 图37

实际上lscpu命令是读取/proc/cpuinfo这个文件的信息并美化输出,现在你可以自己写一个 Python 程序以只读模式读取/proc/cpuinfo这个文件,然后打印出来,这样你就有自己的一个 Python 版本的lscpu命令了 :)

记得一行一行的读取文本文件,不要一次性读取整个文件,因为有时候你读取的文件可能比可用内存还大。

总结

回顾本节实验知识点:

  • 文件打开模式
  • 文件读取与写入
  • with语句

本实验我们学习了文件的打开与读写,在读写完毕后一定要记得关闭文件,或者使用 with 语句也是极好的。在 Linux 中你还需要注意你操作的文件的权限。Linux 有一个思想是“一切皆文件”,这在实验最后的lscpu的实现中得到了体现。

挑战:字符串操作

介绍

我们需要实现一个程序用来提取文件中的字符串中的数字,然后打印输出。

目标

首先,打开 Xfce 终端,下载所需的测试文件:

  1. $ cd /tmp
  2. $ wget http://labfile.oss.aliyuncs.com/courses/790/String.txt

这个文件/tmp/String.txt中存储了一个很长的字符串,需要读取并进行处理。
然后,我们在/home/shiyanlou/Code创建FindDigits.pyPython 脚本:

  1. $ cd /home/shiyanlou/Code
  2. $ touch FindDigits.py

FindDigits.py中,我们需要完成以下任务:

  1. 使用 open 打开文件/tmp/String.txt并读取其中的字符串
  2. 提取字符串中的所有数字,并组合成一个新的字符串,然后打印输出

程序执行过程如下:

  1. $ python3 /home/shiyanlou/Code/FindDigits.py

提示语

  • 可以使用循环来访问字符串中的单个字符
  • 可以使用isdigit()来判断字符是否为数字
  • 使用print()把新的数字组成的字符串输出
  • 代码文件必须保存在/home/shiyanlou/Code/FindDigits.py

知识点

  • 文件读取
  • for 循环
  • 字符串操作

参考代码

注意:请务必先独立思考获得 PASS 之后再查看参考代码,直接拷贝代码收获不大

/home/shiyanlou/Code/FindDigits.py参考代码:

  1. # 打开并读取文件里的字符串
  2. with open('/tmp/String.txt') as f:
  3. s = f.read()
  4. res = ""
  5. # 循环字符串里的每个字符,判断是否为数字
  6. for char in s:
  7. if char.isdigit():
  8. res += char
  9. print(res)

10. 异常

实验介绍

在这个实验我们学习 Python 的异常以及如何在你的代码中处理它们。

知识点

  • NameError
  • TypeError
  • 异常处理(try..except)
  • 异常抛出(raise)
  • finally 子句

异常

在程序执行过程中发生的任何错误都是异常。每个异常显示一些相关的错误信息,比如你在 Python3 中使用 Python2 独有的语法就会发生SyntaxError

Python3简明教程--实验楼 - 图38不小心在行首多打了一个空格就会产生IndentationError

Python3简明教程--实验楼 - 图39

NameError

当访问一个未定义的变量则会发生 NameError。

  1. >>> print(kushal)
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. NameError: name 'kushal' is not defined

最后一行包含了错误的详细信息,其余行显示它是如何发生(或什么引起该异常)的详细信息。

TypeError

TypeError 也是一种经常出现的异常。当操作或函数应用于不适当类型的对象时引发,一个常见的例子是对整数和字符串做加法。

  1. >>> print(1 + "kushal")
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. TypeError: unsupported operand type(s) for +: 'int' and 'str'

处理异常

我们使用try...except块来处理任意异常。基本的语法像这样:

  1. try:
  2. statements to be inside try clause
  3. statement2
  4. statement3
  5. ...
  6. except ExceptionName:
  7. statements to evaluated in case of ExceptionName happens

它以如下方式工作:

  • 首先,执行try子句 (在tryexcept关键字之间的部分)。
  • 如果没有异常发生,except子句 在try语句执行完毕后就被忽略了。

如果在try子句执行过程中发生了异常,那么该子句其余的部分就会被忽略。

  • 如果异常匹配于except关键字后面指定的异常类型,就执行对应的except子句。然后继续执行try语句之后的代码。

如果发生了一个异常,在except子句中没有与之匹配的分支,它就会传递到上一级try语句中。

  • 如果最终仍找不到对应的处理语句,它就成为一个未处理异常,终止程序运行,显示提示信息。

下面的例子展示了这些情况:

  1. >>> def get_number():
  2. ... "Returns a float number"
  3. ... number = float(input("Enter a float number: "))
  4. ... return number
  5. ...
  6. >>>
  7. >>> while True:
  8. ... try:
  9. ... print(get_number())
  10. ... except ValueError:
  11. ... print("You entered a wrong value.")
  12. ...
  13. Enter a float number: 45.0
  14. 45.0
  15. Enter a float number: 24,0
  16. You entered a wrong value.
  17. Enter a float number: Traceback (most recent call last):
  18. File "<stdin>", line 3, in <module>
  19. File "<stdin>", line 3, in get_number
  20. KeyboardInterrupt

首先我输入了一个合适的浮点值,解释器返回输出这个值。
然后我输入以逗号分隔的值,抛出ValueError异常,except子句捕获之,并且打印出错误信息。

第三次我按下Ctrl + C,导致了KeyboardInterrupt异常发生,这个异常并未在except块中捕获,因此程序执行被中止。

一个空的except语句能捕获任何异常。阅读下面的代码:

  1. >>> try:
  2. ... input() # 输入的时候按下 Ctrl + C 产生 KeyboardInterrupt
  3. ... except:
  4. ... print("Unknown Exception")
  5. ...
  6. Unknown Exception

抛出异常

使用raise语句抛出一个异常。

  1. >>> raise ValueError("A value error happened.")
  2. Traceback (most recent call last):
  3. File "<stdin>", line 1, in <module>
  4. ValueError: A value error happened.

我们可以捕获任何其它普通异常一样,来捕获这些异常。

  1. >>> try:
  2. ... raise ValueError("A value error happened.")
  3. ... except ValueError:
  4. ... print("ValueError in our code.")
  5. ...
  6. ValueError in our code.

定义清理行为

try语句还有另一个可选的finally子句,目的在于定义在任何情况下都一定要执行的功能。例如:

  1. >>> try:
  2. ... raise KeyboardInterrupt
  3. ... finally:
  4. ... print('Goodbye, world!')
  5. ...
  6. Goodbye, world!
  7. KeyboardInterrupt
  8. Traceback (most recent call last):
  9. File "<stdin>", line 2, in ?

不管有没有发生异常,finally子句 在程序离开try后都一定会被执行。当try语句中发生了未被except捕获的异常(或者它发生在exceptelse子句中),在finally子句执行完后它会被重新抛出。
在真实场景的应用程序中,finally子句用于释放外部资源(文件或网络连接之类的),无论它们的使用过程中是否出错。

总结

本实验我们知道了异常是什么,然后怎样处理异常以及抛出异常。记得在前面说过的with语句吧,它是try-finally块的简写,使用with语句能保证文件始终被关闭。

异常是什么?其实异常是一种,而类将会在下一个实验介绍。

挑战:玩转函数

介绍

本次挑战中我们将实现一个程序,将分钟转为小时和分钟。

注意:代码中不要使用input()函数,否则挑战测试会卡住,出现Timeout的报错。

目标

请在/home/shiyanlou/Code创建代码文件MinutesToHours.py

  1. $ cd /home/shiyanlou/Code
  2. $ touch MinutesToHours.py

在 MinutesToHours.py 文件中实现一个函数Hours(),将用户输入的分钟数转化为小时数和分钟数,并要求小时数尽量大。将结果以XX H, XX M的形式打印出来。
要求:

  1. 用户能够通过命令行参数输入分钟数,不要使用input,命令行参数可以使用sys.argv来提取。例如程序执行为python3 MinutesToHours.py 80,传入的参数 80 就是分钟数,程序需要打印出相应的小时数和分钟数,输出为1 H, 20 M
  2. 如果用户输入的是一个负值,程序需要 raise 来抛出ValueError异常。
  3. Hours()函数调用的时候,需要使用try...except处理异常。获取异常后,在屏幕上打印出Parameter Error提示用户输入的值有误。

操作实例:

  1. $ python3 /home/shiyanlou/Code/MinutesToHours.py 80
  2. 1 H, 20 M
  3. $ python3 /home/shiyanlou/Code/MinutesToHours.py 95
  4. 1 H, 35 M
  5. $ python3 /home/shiyanlou/Code/MinutesToHours.py -10
  6. Parameter Error
  7. $ python3 /home/shiyanlou/Code/MinutesToHours.py abcd
  8. Parameter Error

提示语

  • sys.argv获取命令行参数,注意获取的参数为字符串,可以使用int()将字符串转为整数,此处也可能会出现异常情况,例如输入为 “abcd” 是无法转为整数的
  • raise语句
  • try...except语句

知识点

  • 异常
  • 文件处理
  • if-else

参考代码

注意:请务必先独立思考获得 PASS 之后再查看参考代码,直接拷贝代码收获不大

/home/shiyanlou/Code/MinutesToHours.py参考代码:

  1. import sys
  2. # 转换函数
  3. def Hours(minute):
  4. # 如果为负数则 raise 异常
  5. if minute < 0:
  6. raise ValueError("Input number cannot be negative")
  7. else:
  8. print("{} H, {} M".format(int(minute / 60), minute % 60))
  9. # 函数调用及异常处理逻辑
  10. try:
  11. Hours(int(sys.argv[1]))
  12. except:
  13. print("Parameter Error")

11.类

实验介绍

在Python中,所有数据类型都可以视为对象,当然也可以自定义对象。自定义的对象数据类型就是面向对象中的类(Class)的概念。

知识点

  • 类的定义
  • 对象初始化

实验步骤

本部分实验中将通过定义一些简单的 Python 类,来学习 Python 面向对象编程的基本概念。

实验安排如下:

  1. 定义简单的类
  2. init 方法
  3. Python 中的继承
  4. 多继承
  5. 删除对象
  6. 属性读取方法
  7. @property装饰器

定义类

在写你的第一个类之前,你应该知道它的语法。我们以下面这种方式定义类:

  1. class nameoftheclass(parent_class):
  2. statement1
  3. statement2
  4. statement3

在类的声明中你可以写任何 Python 语句,包括定义函数(在类中我们称为方法)。

  1. >>> class MyClass(object):
  2. ... """A simple example class"""
  3. ... i = 12345
  4. ... def f(self):
  5. ... return 'hello world'

\init_方法

类的实例化使用函数符号。只要将类对象看作是一个返回新的类实例的无参数函数即可。例如(假设沿用前面的类):

  1. x = MyClass()

以上创建了一个新的类实例并将该对象赋给局部变量x
这个实例化操作创建一个空的对象。很多类都倾向于将对象创建为有初始状态的。因此类可能会定义一个名为__init__()的特殊方法,像下面这样:

  1. def __init__(self):
  2. self.data = []

类定义了__init__()方法的话,类的实例化操作会自动为新创建的类实例调用__init__()方法。所以在下例中,可以这样创建一个新的实例:

  1. x = MyClass()

当然,出于弹性的需要,__init__()方法可以有参数。事实上,参数通过__init__()传递到类的实例化操作上。例如:

  1. >>> class Complex:
  2. ... def __init__(self, realpart, imagpart):
  3. ... self.r = realpart
  4. ... self.i = imagpart
  5. ...
  6. >>> x = Complex(3.0, -4.5)
  7. >>> x.r, x.i
  8. (3.0, -4.5)

继承

当一个类继承另一个类时,它将继承父类的所有功能(如变量和方法)。这有助于重用代码。

在下一个例子中我们首先创建一个叫做Person的类,然后创建两个派生类StudentTeacher。当两个类都从Person类继承时,它们的类除了会有Person类的所有方法还会有自身用途的新方法和新变量。

2.3.1 student_teacher.py

代码写入文件/home/shiyanlou/student_teacher.py

  1. #!/usr/bin/env python3
  2. class Person(object):
  3. """
  4. 返回具有给定名称的 Person 对象
  5. """
  6. def __init__(self, name):
  7. self.name = name
  8. def get_details(self):
  9. """
  10. 返回包含人名的字符串
  11. """
  12. return self.name
  13. class Student(Person):
  14. """
  15. 返回 Student 对象,采用 name, branch, year 3 个参数
  16. """
  17. def __init__(self, name, branch, year):
  18. Person.__init__(self, name)
  19. self.branch = branch
  20. self.year = year
  21. def get_details(self):
  22. """
  23. 返回包含学生具体信息的字符串
  24. """
  25. return "{} studies {} and is in {} year.".format(self.name, self.branch, self.year)
  26. class Teacher(Person):
  27. """
  28. 返回 Teacher 对象,采用字符串列表作为参数
  29. """
  30. def __init__(self, name, papers):
  31. Person.__init__(self, name)
  32. self.papers = papers
  33. def get_details(self):
  34. return "{} teaches {}".format(self.name, ','.join(self.papers))
  35. person1 = Person('Sachin')
  36. student1 = Student('Kushal', 'CSE', 2005)
  37. teacher1 = Teacher('Prashad', ['C', 'C++'])
  38. print(person1.get_details())
  39. print(student1.get_details())
  40. print(teacher1.get_details())

运行程序
Python3简明教程--实验楼 - 图40

在这个例子中你能看到我们是怎样在Student类和Teacher类中调用Person类的__init__方法。

我们也在Student类和Teacher类中重写了Person类的get_details()方法。

因此,当我们调用student1teacher1get_details()方法时,使用的是各自类(StudentTeacher)中定义的方法。

多继承

一个类可以继承自多个类,具有父类的所有变量和方法,语法如下:

  1. class MyClass(Parentclass1, Parentclass2,...):
  2. def __init__(self):
  3. Parentclass1.__init__(self)
  4. Parentclass2.__init__(self)
  5. ...
  6. ...

这里没有提供额外的实例,将会在其他实验楼的项目实战中用到。

删除对象

现在我们已经知道怎样创建对象,现在我们来看看怎样删除一个对象。我们使用关键字del来做到这个。

  1. >>> s = "I love you"
  2. >>> del s
  3. >>> s
  4. Traceback (most recent call last):
  5. File "<stdin>", line 1, in <module>
  6. NameError: name 's' is not defined

del实际上使对象的引用计数减少一,当对象的引用计数变成零的时候,垃圾回收器会删除这个对象。

属性(attributes)读取方法

在 Python 里请不要使用属性(attributes)读取方法(getterssetters)。如果你之前学过其它语言(比如 Java),你可能会想要在你的类里面定义属性读取方法。请不要这样做,直接使用属性就可以了,就像下面这样:

  1. >>> class Student(object):
  2. ... def __init__(self, name):
  3. ... self.name = name
  4. ...
  5. >>> std = Student("Kushal Das")
  6. >>> print(std.name)
  7. Kushal Das
  8. >>> std.name = "Python"
  9. >>> print(std.name)
  10. Python

装饰器

你可能想要更精确的调整控制属性访问权限,你可以使用@property装饰器,@property装饰器就是负责把一个方法变成属性调用的。

下面有个银行账号的例子,我们要确保没人能设置金额为负,并且有个只读属性 cny 返回换算人民币后的金额。

代码写入文件/home/shiyanlou/property.py

  1. #!/usr/bin/env python3
  2. class Account(object):
  3. """账号类,
  4. amount 是美元金额.
  5. """
  6. def __init__(self, rate):
  7. self.__amt = 0
  8. self.rate = rate
  9. @property
  10. def amount(self):
  11. """账号余额(美元)"""
  12. return self.__amt
  13. @property
  14. def cny(self):
  15. """账号余额(人民币)"""
  16. return self.__amt * self.rate
  17. @amount.setter
  18. def amount(self, value):
  19. if value < 0:
  20. print("Sorry, no negative amount in the account.")
  21. return
  22. self.__amt = value
  23. if __name__ == '__main__':
  24. acc = Account(rate=6.6) # 基于课程编写时的汇率
  25. acc.amount = 20
  26. print("Dollar amount:", acc.amount)
  27. print("In CNY:", acc.cny)
  28. acc.amount = -100
  29. print("Dollar amount:", acc.amount)

运行程序:
Python3简明教程--实验楼 - 图41

总结

实验知识点回顾:

  • 类的定义
  • 对象初始化

本实验我们了解了类的定义,类的继承以及多继承,并且最后我们还接触了装饰器这个概念,本质上,装饰器也是一种高阶函数。

12.模块

实验介绍

在这个实验我们将要学习 Python 模块相关知识。包括模块的概念和导入方法,包的概念和使用,第三方模块的介绍,命令行参数的使用等。

知识点

  • 模块的导入
  • 默认/第三方模块介绍
  • 命令行参数

模块

到目前为止,我们在 Python 解释器中写的所有代码都在我们退出解释器的时候丢失了。但是当人们编写大型程序的时候他们会倾向于将代码分为多个不同的文件以便使用,调试以及拥有更好的可读性。在 Python 中我们使用模块来到达这些目的。模块是包括 Python 定义和声明的文件。文件名就是模块名加上.py后缀。

你可以由全局变量__name__得到模块的模块名(一个字符串)。

现在我们来看看模块是怎样工作的。创建一个bars.py文件。文件内容如下:

  1. """
  2. Bars Module
  3. ============
  4. 这是一个打印不同分割线的示例模块
  5. """
  6. def starbar(num):
  7. """打印 * 分割线
  8. :arg num: 线长
  9. """
  10. print('*' * num)
  11. def hashbar(num):
  12. """打印 # 分割线
  13. :arg num: 线长
  14. """
  15. print('#' * num)
  16. def simplebar(num):
  17. """打印 - 分割线
  18. :arg num: 线长
  19. """
  20. print('-' * num)

现在我们启动解释器然后导入我们的模块。

  1. >>> import bars
  2. >>>

我们必须使用模块名来访问模块内的函数。

  1. >>> bars.hashbar(10)
  2. ##########
  3. >>> bars.simplebar(10)
  4. ----------
  5. >>> bars.starbar(10)
  6. **********

导入模块

有不同的方式导入模块。我们已经看到过一种了。你甚至可以从模块中导入指定的函数。这样做:

  1. >>> from bars import simplebar, starbar
  2. >>> simplebar(20)
  3. --------------------

你也可以使用from module import *导入模块中的所有定义,然而这并不是推荐的做法。

含有__init__.py文件的目录可以用来作为一个包,目录里的所有.py文件都是这个包的子模块。

本节实验将创建下面的 mymodule 目录,目录结构如下:

Python3简明教程--实验楼 - 图42

在这个例子中,mymodule是一个包名并且barsutils是里面的两个子模块。

首先创建 mymodule 目录:

  1. $ cd /home/shiyanlou
  2. $ mkdir mymodule

然后将上一节编写的bars.py拷贝到 mymodule 目录下,然后可以使用touch创建一个utils.py文件。
使用touch命令创建一个空的__init__.py文件。

  1. $ touch mymodule/__init__.py

如果__init__.py文件内有一个名为__all__的列表,那么只有在列表内列出的名字将会被公开。
因此如果mymodule内的__init__.py文件含有以下内容:

  1. from mymodule.bars import simplebar
  2. __all__ = [simplebar, ]

那么导入时将只有simplebar可用。如果你在 python3 解释器中进行测试,需要确定是在 mymodule 目录同级的目录下执行的python3,类似下面的操作,否则会出现ImportError: No module named 'mymodule'的报错。

  1. $ cd /home/shiyanlou
  2. $ python3
  3. >>>

from mymodule import *只能工作在模块级别的对象上,试图导入函数或类将导致 syntax error。
参考资料

默认模块

现在你安装 Python 的时候会附带安装不同的模块,你可以按需使用它们,也可以为其它特殊用途安装新模块。在下面的几个例子中,我们将要看到同样例子很多。

Python3简明教程--实验楼 - 图43

上面的例子展示了怎样获得你系统中安装的所有模块的列表。在这里就不粘贴它们了,因为这是一个很大的列表。

你也能在解释器里使用help()函数查找任何模块/类的文档。如果你想要知道字符串所有可用的方法,你可以像下面这样做:

  1. >>> help(str)

os模块

os模块提供了与操作系统相关的功能。你可以使用如下语句导入它:

  1. >>> import os

getuid()函数返回当前进程的有效用户 id。

  1. >>> os.getuid()
  2. 500

getpid()函数返回当前进程的 id。getppid()返回父进程的 id。

  1. >>> os.getpid()
  2. 16150
  3. >>> os.getppid()
  4. 14847

uname()函数返回识别操作系统的不同信息,在 Linux 中它返回的详细信息可以从uname -a命令得到。uname()返回的对象是一个元组,(sysname, nodename, release, version, machine)

  1. >>> os.uname()
  2. ('Linux', 'd80', '2.6.34.7-56.fc13.i686.PAE', '#1 SMP Wed Sep 15 03:27:15 UTC 2010', 'i686')

getcwd() 函数返回当前工作目录。chdir(path)则是更改当前目录到 path。在例子中我们首先看到当前工作目录是/home/shiyanlou,然后我们更改当前工作目录到/Code并再一次查看当前工作目录。

  1. >>> os.getcwd()
  2. '/home/shiyanlou'
  3. >>> os.chdir('Code')
  4. >>> os.getcwd()
  5. '/home/shiyanlou/Code'

所以现在让我们使用 os 模块提供的另一个函数来创建一个自己的函数,它将列出给定目录下的所有文件和目录。

  1. def view_dir(path='.'):
  2. """
  3. 这个函数打印给定目录中的所有文件和目录
  4. :args path: 指定目录,默认为当前目录
  5. """
  6. names = os.listdir(path)
  7. names.sort()
  8. for name in names:
  9. print(name, end =' ')
  10. print()

使用例子中的view_dir()函数。

  1. >>> view_dir('/')
  2. .bashrc .dockerenv .profile bin boot dev etc home lib lib64 media mnt opt proc root run sbin srv sys tmp usr var

os 模块还有许多非常有用的函数,你可以在这里阅读相关内容。

Requests模块

Requests是一个第三方 Python 模块,其官网的介绍如下:

Requests 唯一的一个非转基因的 Python HTTP 库,人类可以安全享用。
警告:非专业使用其他 HTTP 库会导致危险的副作用,包括:安全缺陷症、冗余代码症、重新发明轮子症、啃文档症、抑郁、头疼、甚至死亡。

第三方模块并不是默认的模块,意味着你需要安装它,我们使用pip3安装它。

首先要安装pip3

  1. $ sudo apt-get update
  2. $ sudo apt-get install python3-pip

然后用pip3安装requests

  1. $ sudo pip3 install requests

上面的命令会在你的系统中安装 Python3 版本的 Requests 模块。

4.2.1 获得一个简单的网页

你可以使用get()方法获取任意一个网页。

  1. >>> import requests
  2. >>> req = requests.get('https://github.com')
  3. >>> req.status_code
  4. 200

reqtext属性存有服务器返回的 HTML 网页,由于 HTML 文本太长就不在这里贴出来了。
使用这个知识,让我们写一个能够从指定的 URL 中下载文件的程序。

代码写入文件/home/shiyanlou/download.py

  1. #!/usr/bin/env python3
  2. import requests
  3. def download(url):
  4. '''
  5. 从指定的 URL 中下载文件并存储到当前目录
  6. url: 要下载页面内容的网址
  7. '''
  8. # 检查 URL 是否存在
  9. try:
  10. req = requests.get(url)
  11. except requests.exceptions.MissingSchema:
  12. print('Invalid URL "{}"'.format(url))
  13. return
  14. # 检查是否成功访问了该网站
  15. if req.status_code == 403:
  16. print('You do not have the authority to access this page.')
  17. return
  18. filename = url.split('/')[-1]
  19. with open(filename, 'w') as fobj:
  20. fobj.write(req.content.decode('utf-8'))
  21. print("Download over.")
  22. if __name__ == '__main__':
  23. url = input('Enter a URL: ')
  24. download(url)

测试一下程序:
Python3简明教程--实验楼 - 图44

可以看到目录下已经多了一个 sample.txt 文件。

你可能已经注意到了if __name__ == '__main__':这条语句,它的作用是,只有在当前模块名为__main__的时候(即作为脚本执行的时候)才会执行此if块内的语句。换句话说,当此文件以模块的形式导入到其它文件中时,if块内的语句并不会执行。

你可以将上面的程序修改的更友好些。举个例子,你可以检查当前目录是否已存在相同的文件名。os.path模块可以帮助你完成这个。

argparse 命令行参数处理模块

你还记得ls命令吗,你可以传递不同的选项作为命令行参数。

这里是用到的模块是sys,命令行传入的所有参数都可以使用sys.argv获取。如果希望对参数进行处理可以使用argparse模块,阅读这篇文档学习。

TAB补全

首先创建一个文件:~/.pythonrc,文件内写入如下内容:

  1. import rlcompleter, readline
  2. readline.parse_and_bind('tab: complete')
  3. history_file = os.path.expanduser('~/.python_history')
  4. readline.read_history_file(history_file)
  5. import atexit
  6. atexit.register(readline.write_history_file, history_file)

下一步在~/.bashrc文件中设置 PYTHONSTARTUP 环境变量指向这个文件:

  1. $ export PYTHONSTARTUP=~/.pythonrc

现在,从今以后每当你打开 bash shell,你将会有 TAB 补全和 Python 解释器中代码输入的历史记录。
要在当前 shell 中使用,source 这个 bashrc 文件。

  1. $ source ~/.bashrc

总结

本实验了解了什么是模块,模块怎样导入,举例了 os 和 Requests 模块的使用。Python 吸引人的一点是其有众多的模块可以使用,对于自带模块,可以看看 Python3 的官方文档,对于第三方模块,可以在PyPI上找找。很多时候你都能找到合适的包帮你优雅的完成部分工作。比如argparse模块帮你非常容易的编写用户友好的命令行接口。

13.Collections 模块

实验介绍

collections 是 Python 内建的一个集合模块,提供了许多有用的集合类。

知识点

  • Counter 类
  • defaultdict 类
  • namedtuple 类

Counter

在这个实验我们会学习Collections模块。这个模块实现了一些很好的数据结构,它们能帮助你解决各种实际问题。

  1. >>> import collections

这是如何导入这个模块,现在我们来看看其中的一些类。
Counter是一个有助于hashable对象计数的 dict 子类。它是一个无序的集合,其中hashable对象的元素存储为字典的键,它们的计数存储为字典的值,计数可以为任意整数,包括零和负数。

我们可以这样查看Counter的帮助信息,事实上这些信息来源于 Counter 的文档字符串(collections.Counter.__doc__)。

Python3简明教程--实验楼 - 图45

Python3简明教程--实验楼 - 图46

下面我们来看一个例子,例子中我们查看 Python 的 LICENSE 文件中某些单词出现的次数。

Counter 示例

  1. >>> from collections import Counter
  2. >>> import re
  3. >>> path = '/usr/lib/python3.5/LICENSE.txt'
  4. >>> words = re.findall('\w+', open(path).read().lower())
  5. >>> Counter(words).most_common(10)
  6. [('the', 80), ('or', 78), ('1', 66), ('of', 61), ('to', 50), ('and', 48), ('python', 46), ('in', 38), ('license', 37), ('any', 37)]

Counter 对象有一个叫做elements()的方法,其返回的序列中,依照计数重复元素相同次数,元素顺序是无序的。

  1. >>> c = Counter(a=4, b=2, c=0, d=-2)
  2. >>> list(c.elements())
  3. ['b','b','a', 'a', 'a', 'a']

most_common()方法返回最常见的元素及其计数,顺序为最常见到最少。

  1. >>> Counter('abracadabra').most_common(3)
  2. [('a', 5), ('r', 2), ('b', 2)]

defaultdict

defaultdict是内建dict类的子类,它覆写了一个方法并添加了一个可写的实例变量。其余功能与字典相同。

defaultdict()第一个参数提供了default_factory属性的初始值,默认值为Nonedefault_factory属性值将作为字典的默认数据类型。所有剩余的参数与字典的构造方法相同,包括关键字参数。

同样的功能使用defaultdict比使用dict.setdefault方法快。

defaultdict 用例

  1. >>> from collections import defaultdict
  2. >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
  3. >>> d = defaultdict(list)
  4. >>> for k, v in s:
  5. ... d[k].append(v)
  6. ...
  7. >>> d.items()
  8. dict_items([('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])])

在例子中你可以看到,即使defaultdict对象不存在某个,它会自动创建一个空列表。

namedtuple

命名元组有助于对元组每个位置赋予意义,并且让我们的代码有更好的可读性和自文档性。你可以在任何使用元组地方使用命名元组。在例子中我们会创建一个命名元组以展示为元组每个位置保存信息。

  1. >>> from collections import namedtuple
  2. >>> Point = namedtuple('Point', ['x', 'y']) # 定义命名元组
  3. >>> p = Point(10, y=20) # 创建一个对象
  4. >>> p
  5. Point(x=10, y=20)
  6. >>> p.x + p.y
  7. 30
  8. >>> p[0] + p[1] # 像普通元组那样访问元素
  9. 30
  10. >>> x, y = p # 元组拆封
  11. >>> x
  12. 10
  13. >>> y
  14. 20

总结

本节知识点回顾:

  • Counter 类
  • defaultdict 类
  • namedtuple 类

这个实验我们使用了 Collections 中的一些数据结构,可能你目前并用不上他,但希望你以后需要的时候会想起它们。

挑战:类和Collection

介绍

本次挑战中我们将通过改写之前实验中的student_teacher.py程序实现更加丰富的功能。

目标

改写 我们在这个实验中继承部分的student_teacher.py脚本,实现以下功能:

  1. Person()类中增添函数get_grade()
  2. 对于教师类,get_grade()函数可以自动统计出老师班上学生的得分情况并按照频率的高低以A: X, B: X, C: X, D: X的形式打印出来
  3. 对于学生类,get_grade()函数则可以以Pass: X, Fail: X来统计自己的成绩情况(A,B,C 为 Pass, 如果得了 D 就认为是 Fail)。

student_teacher.py文件可以通过在 Xfce 终端中输入如下代码来获取

  1. $ cd /home/shiyanlou/Code
  2. $ wget http://labfile.oss.aliyuncs.com/courses/790/student_teacher.py

要求:

  1. 请把最终的student_teacher.py代码文件放在/home/shiyanlou/Code/路径下
  2. 根据命令行中的第一个参数teacher或者student来判断最终输出的格式。
  3. 命令行中第二个输入的参数是需要统计的字符串

执行实例:

Python3简明教程--实验楼 - 图47

提示语

  • Teacher 及 Student 类的__init__()也要增加 grade 参数
  • import sys
  • collections中的Counter子类
  • format()以及join

知识点

  • Collection 模块
  • 注意最终的打印形式

参考代码

注意:请务必先独立思考获得 PASS 之后再查看参考代码,直接拷贝代码收获不大

/home/shiyanlou/Code/student_teacher.py参考代码:

  1. #!/usr/bin/env python3
  2. import sys
  3. from collections import Counter
  4. class Person(object):
  5. """
  6. 返回具有给定名称的 Person 对象
  7. """
  8. def __init__(self, name):
  9. self.name = name
  10. def get_details(self):
  11. """
  12. 返回包含人名的字符串
  13. """
  14. return self.name
  15. def get_grade(self):
  16. return 0
  17. class Student(Person):
  18. """
  19. 返回 Student 对象,采用 name, branch, year 3 个参数
  20. """
  21. def __init__(self, name, branch, year,grade):
  22. Person.__init__(self, name)
  23. self.branch = branch
  24. self.year = year
  25. self.grade = grade
  26. def get_details(self):
  27. """
  28. 返回包含学生具体信息的字符串
  29. """
  30. return "{} studies {} and is in {} year.".format(self.name, self.branch, self.year)
  31. def get_grade(self):
  32. common = Counter(self.grade).most_common(4)
  33. n1 = 0
  34. n2 = 0
  35. for item in common:
  36. if item[0] != 'D':
  37. n1 += item[1]
  38. else:
  39. n2 += item[1]
  40. print("Pass: {}, Fail: {}".format(n1,n2))
  41. class Teacher(Person):
  42. """
  43. 返回 Teacher 对象,采用字符串列表作为参数
  44. """
  45. def __init__(self, name, papers, grade):
  46. Person.__init__(self, name)
  47. self.papers = papers
  48. self.grade = grade
  49. def get_details(self):
  50. return "{} teaches {}".format(self.name, ','.join(self.papers))
  51. def get_grade(self):
  52. s = []
  53. common = Counter(self.grade).most_common(4)
  54. for i,j in common:
  55. s.append("{}: {}".format(i,j))
  56. print(', '.join(s))
  57. person1 = Person('Sachin')
  58. if sys.argv[1] == "student":
  59. student1 = Student('Kushal', 'CSE', 2005, sys.argv[2])
  60. student1.get_grade()
  61. else:
  62. teacher1 = Teacher('Prashad', ['C', 'C++'], sys.argv[2])
  63. teacher1.get_grade()

14.PEP8 代码风格指南

实验介绍

编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的。 这篇文章原文实际上来自于这里:https://www.python.org/dev/peps/pep-0008/

知识点

  • 代码排版
  • 字符串引号
  • 表达式和语句中的空格
  • 注释
  • 版本注记
  • 命名约定
  • 公共和内部接口
  • 程序编写建议

实验步骤

建议在实验楼中打开 Python 解释器或者 vim 自己照着做一下,或者看看以前自己写的代码

Python3简明教程--实验楼 - 图48

Python3简明教程--实验楼 - 图49

介绍

这份文档给出的代码约定适用于主要的 Python 发行版所有标准库中的 Python 代码。请参阅相似的 PEP 信息,其用于描述实现 Python 的 C 代码规范[1]。

这份文档和PEP 257(文档字符串约定) 改编自 Guido 的 Python 风格指南原文,从 Barry 的风格指南里添加了一些东西[2]。

随着时间的推移,这份额外约定的风格指南已经被认可了,过去的约定由于语言自身的发展被淘汰了。

许多项目有它们自己的编码风格指南。如果有冲突,优先考虑项目规定的编码指南。

愚蠢的一致性就像没脑子的妖怪

Guido 的一个主要见解是读代码多过写代码。这里提供指南的意图是强调代码可读性的重要性,并且使大多数 Python 代码保持一致性。如PEP 20所述,“Readability counts”。

风格指南是关于一致性的。风格一致对于本指南来说是重要的,对一个项目来说是更重要的,对于一个模块或者方法来说是最重要的。

但是最最重要的是:知道什么时候应该破例–有时候这份风格指南就是不适用。有疑问时,用你最好的判断力,对比其它的例子来确定这是不是最好的情况,并且不耻下问。

特别说明:不要为了遵守这份风格指南而破坏代码的向后兼容性。

这里有一些好的理由去忽略某个风格指南:

  1. 当应用风格指南的时候使代码更难读了,对于严格依循风格指南的约定去读代码的人也是不应该的。
  2. 为了保持和风格指南的一致性同时也打破了现有代码的一致性(可能是历史原因)–虽然这也是一个整理混乱代码的机会(现实中的 XP 风格)。
  3. 因为问题代码的历史比较久远,修改代码就没有必要性了。
  4. 当代码需要与旧版本的 Python 保持兼容,而旧版 Python 又不支持风格指南中提到的特性的时候。

代码排版

2.3.1 缩进

每层缩进使用4个空格。

续行要么与圆括号、中括号、花括号这样的被包裹元素保持垂直对齐,要么放在 Python 的隐线(注:应该是相对于def的内部块)内部,或者使用悬挂缩进。使用悬挂缩进的注意事项:第一行不能有参数,用进一步的缩进来把其他行区分开。

好的:

  1. # Aligned with opening delimiter.
  2. foo = long_function_name(var_one, var_two,
  3. var_three, var_four)
  4. # More indentation included to distinguish this from the rest.
  5. def long_function_name(
  6. var_one, var_two, var_three,
  7. var_four):
  8. print(var_one)
  9. # Hanging indents should add a level.
  10. foo = long_function_name(
  11. var_one, var_two,
  12. var_three, var_four)

不好的:

  1. # Arguments on first line forbidden when not using vertical alignment.
  2. foo = long_function_name(var_one, var_two,
  3. var_three, var_four)
  4. # Further indentation required as indentation is not distinguishable.
  5. def long_function_name(
  6. var_one, var_two, var_three,
  7. var_four):
  8. print(var_one)

4空格规则是可选的:

  1. # Hanging indents *may* be indented to other than 4 spaces.
  2. foo = long_function_name(
  3. var_one, var_two,
  4. var_three, var_four)

当 if 语句的条件部分足够长,需要将它写入到多个行,值得注意的是两个连在一起的关键字(i.e. if),添加一个空格,给后续的多行条件添加一个左括号形成自然地4空格缩进。如果和嵌套在 if 语句内的缩进代码块产生了视觉冲突,也应该被自然缩进4个空格。这份增强建议书对于怎样(或是否)把条件行和 if 语句的缩进块在视觉上区分开来是没有明确规定的。可接受的情况包括,但不限于:

  1. # No extra indentation.
  2. if (this_is_one_thing and
  3. that_is_another_thing):
  4. do_something()
  5. # Add a comment, which will provide some distinction in editors
  6. # supporting syntax highlighting.
  7. if (this_is_one_thing and
  8. that_is_another_thing):
  9. # Since both conditions are true, we can frobnicate.
  10. do_something()
  11. # Add some extra indentation on the conditional continuation line.
  12. if (this_is_one_thing
  13. and that_is_another_thing):
  14. do_something()

在多行结构中的右圆括号、右中括号、右大括号应该放在最后一行的第一个非空白字符的正下方,如下所示:

  1. my_list = [
  2. 1, 2, 3,
  3. 4, 5, 6,
  4. ]
  5. result = some_function_that_takes_arguments(
  6. 'a', 'b', 'c',
  7. 'd', 'e', 'f',
  8. )

或者放在多行结构的起始行的第一个字符正下方,如下:

  1. my_list = [
  2. 1, 2, 3,
  3. 4, 5, 6,
  4. ]
  5. result = some_function_that_takes_arguments(
  6. 'a', 'b', 'c',
  7. 'd', 'e', 'f',
  8. )

2.3.2 制表符还是空格?

空格是首选的缩进方法。

制表符(Tab)应该被用在那些以前就使用了制表符缩进的地方。

Python 3 不允许混合使用制表符和空格来缩进代码。

混合使用制表符和空格缩进的 Python 2 代码应该改为只使用空格。

当使用-t选项来调用 Python 2 的命令行解释器的时候,会对混合使用制表符和空格的代码发出警告。当使用-tt选项的时候,这些警告会变成错误。这些选项是强烈推荐的!

2.3.3 每行最大长度

限制每行的最大长度为79个字符。

对于那些约束很少的文本结构(文档字符串或注释)的长块,应该限制每行长度为72个字符。

限制编辑窗口的宽度使并排打开两个窗口成为可能,使用通过代码审查工具时,也能很好的通过相邻列展现不同代码版本。

一些工具的默认换行设置打乱了代码的可视结构,使其更难理解。限制编辑器窗口宽为80来避免自动换行,即使有些编辑工具在换行的时候会在最后一列放一个标识符。一些基于 Web 的工具可能根本就不提供动态换行。

一些团队更倾向于长的代码行。对于达成了一致意见来统一代码的团队而言,把行提升到80~100的长度是可接受的(实际最大长度为99个字符),注释和文档字符串的长度还是建议在72个字符内。

Python 标准库是非常专业的,限制最大代码长度为79个字符(注释和文档字符串最大长度为72个字符)。

首选的换行方式是在括号(小中大)内隐式换行(非续行符\)。长行应该在括号表达式的包裹下换行。这比反斜杠作为续行符更好。

反斜杠有时仍然适用。例如,多个很长的with语句不能使用隐式续行,因此反斜杠是可接受的。

  1. with open('/path/to/some/file/you/want/to/read') as file_1, \
  2. open('/path/to/some/file/being/written', 'w') as file_2:
  3. file_2.write(file_1.read())

(见前面关于多行if语句的讨论来进一步思考这种多行with语句该如何缩进)
另一种使用反斜杠续行的案例是assert语句。

确保续行的缩进是恰到好处的。遇到二元操作符,首选的断行位置是操作符的后面而不是前面。这有一些例子:

  1. class Rectangle(Blob):
  2. def __init__(self, width, height,
  3. color='black', emphasis=None, highlight=0):
  4. if (width == 0 and height == 0 and
  5. color == 'red' and emphasis == 'strong' or
  6. highlight > 100):
  7. raise ValueError("sorry, you lose")
  8. if width == 0 and height == 0 and (color == 'red' or
  9. emphasis is None):
  10. raise ValueError("I don't think so -- values are %s, %s" %
  11. (width, height))
  12. Blob.__init__(self, width, height,
  13. color, emphasis, highlight)

2.3.4 空行

顶级函数和类定义上下使用两个空行分隔。

类内的方法定义使用一个空行分隔。

可以使用额外的空行(有节制的)来分隔相关联的函数组。在一系列相关联的单行代码中空行可以省略(e.g. 一组虚拟的实现)。

在函数中使用空白行(有节制的)来表明逻辑部分。

Python 接受使用换页符(i.e.Ctrl+L)作为空格;许多工具都把Ctrl+L作为分页符,因此你可以用它们把你的文件中相似的章节分页。注意,一些编辑器和基于 Web 的代码查看工具可能不把Ctrl+L看做分页符,而是在这个位置放一个其它的符号。

2.3.5 源文件编码

在核心 Python 发布版中的代码应该总是使用UTF-8编码(或者在 Python 2 中使用ASCII)。

使用ASCII(Python 2)或UTF-8(Python 3)的文件不需要有编码声明(注:它们是默认的)。

在标准库中,非缺省的编码应该仅仅用于测试目的,或者注释或文档字符串中的作者名包含非ASCII码字符;否则,优先使用\x\u\U或者\N来转义字符串中的非ASCII数据。

对于 Python 3.0 和之后的版本,以下是有关标准库的政策(见PEP 3131):所有 Python 标准库中的标识符必须使用只含ASCII的标识,并且应该使用英语单词只要可行(在多数情况下,缩略语和技术术语哪个不是英语)。此外,字符串和注释也必须是ASCII。仅有的例外是:(a)测试用例测试非ASCII特性时,(b)作者名。作者的名字不是基于拉丁字母的必须提供他们名字的拉丁字母音译。

面向全球用户的开源项目,鼓励采取相似的政策。

2.3.6. 导入包

import不同的模块应该独立一行,如:

  • 好的:
  1. import os
  2. import sys

不好的:

  1. import sys, os

这样也是可行的:

  1. from subprocess import Popen, PIPE

import语句应该总是放在文件的顶部,在模块注释和文档字符串之下,在模块全局变量和常量之前。
import语句分组顺序如下:

  1. * 导入标准库模块
  2. * 导入相关第三方库模块
  3. * 导入当前应用程序/库模块

每组之间应该用空行分开。

  • 然后用__all__声明本文件内的模块。
  • 绝对导入是推荐的,它们通常是更可读的,并且在错误的包系统配置(如一个目录包含一个以os.path结尾的包)下有良好的行为倾向(至少有更清晰的错误消息):
  1. import mypkg.sibling
  2. from mypkg import sibling
  3. from mypkg.sibling import example

当然,相对于绝对导入,相对导入是个可选替代,特别是处理复杂的包结构时,绝对导入会有不必要的冗余:

  1. from . import sibling
  2. from .sibling import example

标准库代码应该避免复杂的包结构,并且永远使用绝对导入。
应该从不使用隐式的相对导入,而且在 Python 3 中已经被移除。

  • 从一个包含类的模块导入类时,这样写通常是可行的:
  1. from myclass import MyClass
  2. from foo.bar.yourclass import YourClass

如果上面的方式会本地导致命名冲突,则这样写:

  1. import myclass
  2. import foo.bar.yourclass

myclass.MyClassfoo.bar.yourclass.YourClass这样的方式使用。
应该避免通配符导入(from import *),这会使名称空间里存在的名称变得不清晰,迷惑读者和自动化工具。这里有一个可辩护的通配符导入用例,,重新发布一个内部接口作为公共 API 的一部分(例如,使用纯 Python 实现一个可选的加速器模块的接口,但并不能预知这些定义会被覆盖)。

  • 当以这种方式重新发布名称时,下面关于公共和内部接口的指南仍然适用。

字符串引号

在 Python 里面,单引号字符串和双引号字符串是相同的。这份指南对这个不会有所建议。选择一种方式并坚持使用。一个字符串同时包含单引号和双引号字符时,用另外一种来包裹字符串,而不是使用反斜杠来转义,以提高可读性。

对于三引号字符串,总是使用双引号字符来保持与文档字符串约定的一致性(PEP 257)。

表达式和语句中的空格

2.5.1 不能忍受的情况

避免在下列情况中使用多余的空格:

  • 与括号保持紧凑(小括号、中括号、大括号):
  1. Yes: spam(ham[1], {eggs: 2})
  2. No: spam( ham[ 1 ], { eggs: 2 } )
  • 与后面的逗号、分号或冒号保持紧凑:
  1. Yes: if x == 4: print x, y; x, y = y, x
  2. No: if x == 4 : print x , y ; x , y = y , x

切片内的冒号就像二元操作符一样,任意一侧应该被等同对待(把它当做一个极低优先级的操作)。在一个可扩展的切片中,冒号两侧必须有相同的空格数量。例外:切片参数省略时,空格也省略。

  • 好的:
  1. ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
  2. ham[lower:upper], ham[lower:upper:], ham[lower::step]
  3. ham[lower+offset : upper+offset]
  4. ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
  5. ham[lower + offset : upper + offset]

不好的:

  1. ham[lower + offset:upper + offset]
  2. ham[1: 9], ham[1 :9], ham[1:9 :3]
  3. ham[lower : : upper]
  4. ham[ : upper]
  • 函数名与其后参数列表的左括号应该保持紧凑:
  1. Yes: spam(1)
  2. No: spam (1)
  • 与切片或索引的左括号保持紧凑:
  1. Yes: dct['key'] = lst[index]
  2. No: dct ['key'] = lst [index]

在赋值操作符(或其它)的两侧保持多余一个的空格:

  • 好的:
  1. x = 1
  2. y = 2
  3. long_variable = 3

不好的:

  1. x = 1
  2. y = 2
  3. long_variable = 3

2.5.2 其他建议

  • 总是在这些二元操作符的两侧加入一个空格:赋值(=),增量赋值(+=, -= etc.),比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not),布尔运算(and, or, not)。

在不同优先级之间,考虑在更低优先级的操作符两侧插入空格。用你自己的判断力;但不要使用超过一个空格,并且在二元操作符的两侧有相同的空格数。

  • 好的:
  1. i = i + 1
  2. submitted += 1
  3. x = x*2 - 1
  4. hypot2 = x*x + y*y
  5. c = (a+b) * (a-b)

不好的:

  1. i=i+1
  2. submitted +=1
  3. x = x * 2 - 1
  4. hypot2 = x * x + y * y
  5. c = (a + b) * (a - b)

不要在关键值参数或默认值参数的等号两边加入空格。

  • 好的:
  1. def complex(real, imag=0.0):
  2. return magic(r=real, i=imag)

不好的:

  1. def complex(real, imag = 0.0):
  2. return magic(r = real, i = imag)

【注:Python 3】带注释的函数定义中的等号两侧要各插入空格。此外,在冒号后用一个单独的空格,也要在表明函数返回值类型的->左右各插入一个空格。

  • 好的:
  1. def munge(input: AnyStr):
  2. def munge(sep: AnyStr = None):
  3. def munge() -> AnyStr:
  4. def munge(input: AnyStr, sep: AnyStr = None, limit=1000):

不好的:

  1. def munge(input: AnyStr=None):
  2. def munge(input:AnyStr):
  3. def munge(input: AnyStr)->PosInt:

打消使用复合语句(多条语句在同一行)的念头。

  • 好的:
  1. if foo == 'blah':
  2. do_blah_thing()
  3. do_one()
  4. do_two()
  5. do_three()

宁可不:

  1. if foo == 'blah': do_blah_thing()
  2. do_one(); do_two(); do_three()

有时候把if/for/while和一个小的主体放在同一行也是可行的,千万不要在有多条语句的情况下这样做。此外,还要避免折叠,例如长行。

  • 宁可不:
  1. if foo == 'blah': do_blah_thing()
  2. for x in lst: total += x
  3. while t < 10: t = delay()

绝对不:

  1. if foo == 'blah': do_blah_thing()
  2. else: do_non_blah_thing()
  3. try: something()
  4. finally: cleanup()
  5. do_one(); do_two(); do_three(long, argument,
  6. list, like, this)
  7. if foo == 'blah': one(); two(); three()

注释

与代码相矛盾的注释不如没有。注释总是随着代码的变更而更新。

注释应该是完整的句子。如果注释是一个短语或语句,第一个单词应该大写,除非是一个开头是小写的标识符(从不改变标识符的大小写)。

如果注释很短,末尾的句点可以省略。块注释通常由一个或多个有完整句子的段落组成,并且每个句子应该由句点结束。

你应该在一个句子的句点后面用两个空格。

写英语时,遵循《Strunk and White》(注:《英文写作指南》,参考维基百科)。

来自非英语国家的程序员:请用英语写注释,除非你120%确定你的代码永远不会被那些不说你的语言的人阅读。

2.6.1 块注释

块注释通常用来说明跟随在其后的代码,应该与那些代码有相同的缩进层次。块注释每一行以#起头,并且#后要跟一个空格(除非是注释内的缩进文本)。

2.6.2 行内注释

有节制的使用行内注释。

一个行内注释与语句在同一行。行内注释应该至少与语句相隔两个空格。以#打头,#后接一个空格。

无谓的行内注释如果状态明显,会转移注意力。不要这样做:

  1. x = x + 1 # Increment x

但有的时候,这样是有用的:

  1. x = x + 1 # Compensate for border

2.6.3 文档字符串

编写良好的文档字符串(a.k.a “docstring”)的约定常驻在PEP 257

  • 为所有的公共模块、函数、类和方法编写文档字符串。对于非公共的方法,文档字符串是不必要的,但是也应该有注释来说明代码是干什么的。这个注释应该放在方法声明的下面。
  • PEP 257描述了良好的文档字符串的约定。注意,文档字符串的结尾"""应该放在单独的一行,例如:
  1. """Return a foobang
  2. Optional plotz says to frobnicate the bizbaz first.
  3. """
  • 对于单行的文档字符串,把结尾"""放在同一行。

版本注记

如果必须要 Subversion,CVS 或 RCS 标记在你的源文件里,像这样做:

  1. __version__ = "$Revision$"
  2. # $Source$

这几行应该在模块的文档字符串后面,其它代码的前面,上下由一个空行分隔。

命名约定

Python 库的命名规则有点混乱,因此我们永远也不会使其完全一致的 – 不过,这里有一些当前推荐的命名标准。新的模块和包(包括第三方框架)应该按照这些标准来命名,但是已存在库有不同的风格,内部一致性是首选。

2.8.1 覆盖原则

API 里对用户可见的公共部分应该遵循约定,反映的是使用而不是实现。

2.8.2 规定:命名约定

有许多不同的命名风格。这有助于识别正在使用的命名风格,独立于它们的用途。

下面的命名风格通常是有区别的:

  • b (一个小写字母)
  • B (一个大写字母)
  • lowercase
  • lower_case_with_underscores
  • UPPERCASE
  • UPPER_CASE_WITH_UNDERSCORES
  • CapitalizedWords (又叫 CapWords,或者 CamelCase(骆驼命名法) – 如此命名因为字母看起来崎岖不平[3]。有时候也叫 StudlyCaps。

注意:在 CapWords 使用缩略语时,所有缩略语的首字母都要大写。因此HTTPServerErrorHttpServerError要好。

  • mixedCase (和上面不同的是首字母小写)
  • Capitalized_Words_With_Underscores (丑陋无比!)

也有种风格用独一无二的短前缀来将相似的命名分组。在 Python 里用的不是很多,但是为了完整性被提及。例如,os.stat()函数返回一个元组,通常有像st_modest_sizest_mtime等名字。(强调与 POSIX 系统调用的字段结构一致,有助于程序员对此更熟悉)

X11 库的所有公共函数都用 X 打头。在 Python 中这种风格被认为是不重要的,因为属性和方法名的前缀是一个对象,函数名的前缀为一个模块名。

此外,下面的特许形式用一个前导或尾随的下划线进行识别(这些通常可以和任何形式的命名约定组合):

  • _single_leading_underscore :仅内部使用的标识,如from M import *不会导入像这样一下划线开头的对象。
  • singletrailing_underscore : 通常是为了避免与 Python 规定的关键字冲突,如Tkinter.Toplevel(master, class_='ClassName')
  • double_leading_underscore : 命名一个类属性,调用的时候名字会改变(在类FooBar中,boo变成了_FooBar__boo;见下)。
  • doubleleadingandtrailingunderscore :”魔术”对象或属性,活在用户控制的命名空间里。例如,__init__,`__import__file`。永远不要像这种方式命名;只把它们作为记录。

2.8.3 规定:命名约定

2.8.3.1 应该避免的名字

永远不要使用单个字符l(小写字母 el),O(大写字母 oh),或I(大写字母 eye)作为变量名。

在一些字体中,这些字符是无法和数字10区分开的。试图使用l时用L代替。

2.8.3.2 包和模块名

模块名应该短,且全小写。如果能改善可读性,可以使用下划线。Python 的包名也应该短,全部小写,但是不推荐使用下划线。

因为模块名就是文件名,而一些文件系统是大小写不敏感的,并且自动截断长文件名,所以给模块名取一个短小的名字是非常重要的 – 在 Unix 上这不是问题,但是把代码放到老版本的 Mac, Windows,或者 DOS 上就可能变成一个问题了。

用 C/C++ 给 Python 写一个高性能的扩展(e.g. more object oriented)接口的时候,C/C++ 模块名应该有一个前导下划线。

2.8.3.3 类名

类名通常使用 CapWords 约定。

The naming convention for functions may be used instead in cases where the interface is documented and used primarily as a callable.

注意和内建名称的区分开:大多数内建名称是一个单独的单词(或两个单词一起),CapWords 约定只被用在异常名和内建常量上。

2.8.3.4 异常名

因为异常应该是类,所以类名约定在这里适用。但是,你应该用Error作为你的异常名的后缀(异常实际上是一个错误)。

2.8.3.5 全局变量名

(我们希望这些变量仅仅在一个模块内部使用)这个约定有关诸如此类的变量。

若被设计的模块可以通过from M import *来使用,它应该使用__all__机制来表明那些可以可导出的全局变量,或者使用下划线前缀的全局变量表明其是模块私有的。

2.8.3.6 函数名

函数名应该是小写的,有必要的话用下划线来分隔单词提高可读性。

混合大小写仅仅在上下文都是这种风格的情况下允许存在(如thread.py),这是为了维持向后兼容性。

2.8.3.7 函数和方法参数

总是使用self作为实例方法的第一个参数。

总是使用cls作为类方法的第一个参数。

如果函数参数与保留关键字冲突,通常最好在参数后面添加一个尾随的下划线,而不是使用缩写或胡乱拆减。因此class_clss要好。(或许避免冲突更好的方式是使用近义词)

2.8.3.8 方法名和实例变量

用函数名的命名规则:全部小写,用下划线分隔单词提高可读性。

用一个且有一个前导的下划线来表明非公有的方法和实例变量。

为了避免与子类变量或方法的命名冲突,用两个前导下划线来调用 Python 的命名改编规则。

Python 命名改编通过添加一个类名:如果类Foo有一个属性叫__a,它不能被这样Foo.__a访问(执着的人可以通过这样Foo._Foo__a来访问)通常,双前导的下划线应该仅仅用来避免与其子类属性的命名冲突。

注意:这里有一些争议有关__names的使用(见下文)。

2.8.3.9 常量

常量通常是模块级的定义,全部大写,单词之间以下划线分隔。例如MAX_OVERFLOWTOTAL

2.8.3.10 继承的设计

总是决定一个类的方法和变量(属性)是应该公有还是非公有。如果有疑问,选择非公有;相比把共有属性变非公有,非公有属性变公有会容易得多。

公有属性是你期望给那些与你的类无关的客户端使用的,你应该保证不会出现不向后兼容的改变。非公有的属性是你不打算给其它第三方使用的;你不需要保证非公有的属性不会改变甚至被移除也是可以的。

我们这里不适用“私有”这个术语,因为在 Python 里没有真正的私有属性(一般没有不必要的工作量)。

另一种属性的分类是“子类 API”的一部分(通常在其它语言里叫做“Protected”)。一些类被设计成被继承的,要么扩展要么修改类的某方面行为。设计这样一个类的时候,务必做出明确的决定,哪些是公有的,其将会成为子类 API 的一部分,哪些仅仅是用于你的基类的。

处于这种考虑,给出 Pythonic 的指南:

  • 共有属性不应该有前导下划线。
  • 如果你的公有属性与保留关键字发生冲突,在你的属性名后面添加一个尾随的下划线。这比使用缩写或胡乱拆减要好。(尽管这条规则,已知某个变量或参数可能是一个类情况下,cls是首选的命名,特别是作为类方法的第一个参数)

注意一:见上面推荐的类方法参数命名方式。

  • 对于简单的公有数据属性,最好的方式是暴露属性名,不要使用复杂的访问属性/修改属性的方法。记住,Python 提供了捷径去提升特性,如果你发现简单的数据属性需要增加功能行为。在这种情况下,使用properties把功能实现隐藏在简单的数据属性访问语法下面。

注意一:properties仅仅在新式类下工作。 注意二:尽量保持功能行为无边际效应,然而如缓存有边际效应也是好的。 注意三:避免为计算开销大的操作使用properties;属性标记使调用者相信这样来访问(相对来说)是开销很低的。

  • 如果你的类是为了被继承,你有不想让子类使用的属性,给属性命名时考虑给它们加上双前导下划线,不要加尾随下划线。这会调用 Python 的名称重整算法,把类名加在属性名前面。避免了命名冲突,当子类不小心命名了和父类属性相同名称的时候。

注意一:注意只是用了简单的类名来重整名字,因此如果子类和父类同名的时候,你仍然有能力避免冲突。

注意二:命名重整有确定的用途,例如调试和__getattr__(),就不太方便。命名重整算法是有据可查的,易于手动执行。

注意三:不是每个人都喜欢命名重整。尽量平衡名称的命名冲突与面向高级调用者的潜在用途。

公共和内部接口

保证所有公有接口的向后兼容性。用户能清晰的区分公有和内部接口是重要的。

文档化的接口考虑公有,除非文档明确的说明它们是暂时的,或者内部接口不保证其的向后兼容性。所有的非文档化的应该被假设为非公开的。

为了更好的支持内省,模块应该用__all__属性来明确规定公有 API 的名字。设置__all__为空list表明模块没有公有 API。

甚至与__all__设置相当,内部接口(包、模块、类、函数、属性或者其它的名字)应该有一个前导的下划线前缀。

被认为是内部的接口,其包含的任何名称空间(包、模块或类)也被认为是内部的。

导入的名称应始终视作一个实现细节。其它模块不能依赖间接访问这些导入的名字,除非它们是包含模块的 API 明确记载的一部分,例如os.path或一个包的__init__模块暴露了来自子模块的功能。

编写程序的建议

代码的编写方式不能对其它 Python 的实现(PyPy、Jython、IronPython、Cython、Psyco,诸如此类的)不利。

  • 例如,不要依赖于 CPython 在字符串拼接时的优化实现,像这种语句形式a += ba = a + b。即使是 CPython(仅对某些类型起作用) 这种优化也是脆弱的,不是在所有的实现中都不使用引用计数。在库中性能敏感的部分,用''.join形式来代替。这会确保在所有不同的实现中字符串拼接是线性时间的。

比较单例,像None应该用isis not,从不使用==操作符。

  • 当你的真正用意是if x is not None的时候,当心if x这样的写法 – 例如,测试一个默认值为None的变量或参数是否设置成了其它值,其它值可能是那些布尔值为 false 的类型(如空容器)。

is not操作符而不是not ... is。虽然这两个表达式是功能相同的,前一个是更可读的,是首选。

  • 好的:
  1. if foo is not None:

不好的:

  1. if not foo is None:

用富比较实现排序操作的时候,实现所有六个比较操作符(__eq____ne____lt__,__le__,__gt__,__ge__)是更好的,而不是依赖其它仅仅运用一个特定比较的代码
为了最大限度的减少工作量,functools.total_ordering()装饰器提供了一个工具去生成缺少的比较方法。

  • PEP 207说明了 Python 假定的所有反射规则。因此,解释器可能交换y > xx < yy >= xx <= y,也可能交换x == yx != ysort()min()操作肯定会使用<操作符,max()函数肯定会使用>操作符。当然,最好是六个操作符都实现,以便不会在其它上下文中有疑惑。

始终使用def语句来代替直接绑定了一个lambda表达式的赋值语句。

  • 好的:
  1. def f(x): return 2*x

不好的:

  1. f = lambda x: 2*x

第一种形式意味着函数对象的__name__属性值是'f'而不是'<lambda>'。通常这对异常追踪和字符串表述是更有用的。使用赋值语句消除的唯一好处,lambda表达式可以提供一个显示的def语句不能提供的,如,lambda能镶嵌在一个很长的表达式里。
异常类应派生自Exception而不是BaseException。直接继承自BaseException是为Exception保留的,如果从BaseException继承,捕获到的错误总是错的。

设计异常结构层次,应基于那些可能出现异常的代码,而不是在出现异常后的。编码的时候,以回答“出了什么问题?”为目标,而不是仅仅指出“这里出现了问题”(见PEP 3151一个内建异常结构层次的例子)。

  • 类的命名约定适用于异常,如果异常类是一个错误,你应该给异常类加一个后缀Error。用于非本地流程控制或者其他形式的信号的非错误异常不需要一个特殊的后缀。

适当的使用异常链。在 Python 3 里,raise X from Y用于表明明确的替代者,不丢失原有的回溯信息。

  • 有意替换一个内部的异常时(在 Python 2 用raise X,Python 3.3+ 用raise X from None),确保相关的细节全部转移给了新异常(例如,把KeyError变成AttributeError时保留属性名,或者把原始异常的错误信息嵌在新异常里)。

在 Python 2 里抛出异常时,用raise ValueError('message')代替旧式的raise ValueError, 'message'

在 Python 3 之后的语法里,旧式的异常抛出方式是非法的。

  • 使用括号形式的异常意味着,当你传给异常的参数过长或者包含字符串格式化时,你就不需要使用续行符了,这要感谢括号!

捕获异常时,尽可能使用明确的异常,而不是用一个空的except:语句。

  • 例如,用:
  1. try:
  2. import platform_specific_module
  3. except ImportError:
  4. platform_specific_module = None

一个空的except:语句将会捕获到SystemExitKeyboardInterrupt异常,很难区分程序的中断到底是Ctrl+C还是其他问题引起的。如果你想捕获程序的所有错误,使用except Exception:(空except:等同于except BaseException)。
一个好的经验是限制使用空except语句,除了这两种情况:

  1. 如果异常处理程序会打印出或者记录回溯信息;至少用户意识到错误的存在。
  2. 如果代码需要做一些清理工作,但后面用raise向上抛出异常。try .. finally是处理这种情况更好的方式。
  • 绑定异常给一个名字时,最好使用 Python 2.6 里添加的明确的名字绑定语法:
  1. try:
  2. process_data()
  3. except Exception as exc:
  4. raise DataProcessingFailedError(str(exc))

Python 3 只支持这种语法,避免与基于逗号的旧式语法产生二义性。

  • 捕获操作系统错误时,最好使用 Python 3.3 里引进的明确的异常结构层次,而不是自省的errno值。

此外,对于所有的try/except语句来说,限制try里面有且仅有绝对必要的代码。在强调一次,这能避免屏蔽错误。

  • 好的:
  1. try:
  2. value = collection[key]
  3. except KeyError:
  4. return key_not_found(key)
  5. else:
  6. return handle_value(value)

不好的:

  1. try:
  2. # Too broad!
  3. return handle_value(collection[key])
  4. except KeyError:
  5. # Will also catch KeyError raised by handle_value()
  6. return key_not_found(key)
  • 当资源是本地的特定代码段,用with语句确保其在使用后被立即干净的清除了,try/finally也是也接受的。

当它们做一些除了获取和释放资源之外的事的时候,上下文管理器应该通过单独的函数或方法调用。例如:

  • 好的:
  1. with conn.begin_transaction():
  2. do_stuff_in_transaction(conn)

不好的:

  1. with conn:
  2. do_stuff_in_transaction(conn)

第二个例子没有提供任何信息来表明__enter____exit__方法在完成一个事务后做了一些除了关闭连接以外的其它事。在这种情况下明确是很重要的。
坚持使用return语句。函数内的return语句都应该返回一个表达式,或者None。如果一个return语句返回一个表达式,另一个没有返回值的应该用return None清晰的说明,并且在一个函数的结尾应该明确使用一个return语句(如果有返回值的话)。

  • 好的:
  1. def foo(x):
  2. if x >= 0:
  3. return math.sqrt(x)
  4. else:
  5. return None
  6. def bar(x):
  7. if x < 0:
  8. return None
  9. return math.sqrt(x)

不好的:

  1. def foo(x):
  2. if x >= 0:
  3. return math.sqrt(x)
  4. def bar(x):
  5. if x < 0:
  6. return
  7. return math.sqrt(x)

用字符串方法代替字符串模块。

  • 字符串方法总是更快,与 unicode 字符串共享 API。如果需要向后兼容性覆盖这个规则,需要 Python 2.0 以上的版本。

''.startswith()''.endswith()代替字符串切片来检查前缀和后缀。

  • startswith()endswith()是更简洁的,不容易出错的。例如:
  1. Yes: if foo.startswith('bar'):
  2. No: if foo[:3] == 'bar':
  • 对象类型的比较应该始终使用isinstance()而不是直接比较。
  1. Yes: if isinstance(obj, int):
  2. No: if type(obj) is type(1):

当比较一个对象是不是字符串时,记住它有可能也是一个 unicode 字符串!在 Python 2 里面,strunicode有一个公共的基类叫basestring,因此你可以这样做:

  1. if isinstance(obj, basestring):

注意,在 Python 3 里面,unicodebasestring已经不存在了(只有str),byte对象不再是字符串的一种(被一个整数序列替代)。
对于序列(字符串、列表、元组)来说,空的序列为False

  • 好的:
  1. if not seq:
  2. if seq:

不好的:

  1. if len(seq):
  2. if not len(seq):
  • 不要让字符串对尾随的空格有依赖。这样的尾随空格是视觉上无法区分的,一些编辑器(or more recently, reindent.py)会将其裁剪掉。
  • 不要用==比较TrueFalse
  1. Yes: if greeting:
  2. No: if greeting == True:
  3. Worse: if greeting is True:

Python 标准库将不再使用函数标注,以至于给特殊的标注风格给一个过早的承若。代替的,这些标注是留给用户去发现和体验的有用的标注风格。
建议第三方实验的标注用相关的修饰符指示标注应该如何被解释。

  • 早期的核心开发者尝试用函数标注显示不一致、特别的标注风格。例如:

    • [str]是很含糊的,它可能代表一个包含字符串的列表,也可能代表一个为字符串或为空的值。
    • open(file:(str,bytes))可能用来表示file的值可以是一个str或者bytes,也可能用来表示file的值是一个包含strbytes的二元组。
    • 标注seek(whence:int)体现了一个过于明确又不够明确的混合体:int太严格了(有__index__的应该被允许),又不够严格(只有0,1,2是被允许的)。同样的,标注write(b: byte)太严格了(任何支持缓存协议的都应该被允许)。
    • read1(n: int=None)这样的标注自我矛盾,因为None不是int。像source_path(self, fullname:str) -> object标注是迷惑人的,返回值到底是应该什么类型?
    • 除了上面之外,在具体类型和抽象类型的使用上是不一致的:intintegral(整数),set/fronzensetMutableSet/Set
    • 不正确的抽象基类标注规格。例如,集合之间的操作需要另一个对象是集合的实例,而不只是一个可迭代序列。
    • 另一个问题是,标注成为了规范的一部分,但却没有经受过考验。
    • 在大多数情况下,文档字符串已经包括了类型规范,比函数标注更清晰。在其余的情况下,一旦标注被移除,文档字符串应该被完善。
    • 观察到的函数标注太标新立异了,相关的系统不能一致的处理自动类型检查和参数验证。离开这些标注的代码以后很难做出更改,使自动化工具可以支持。

总结

即使内容有点多,但每一个 Python 开发者都应该尽量遵守 PEP8 规范。

参考文献

[1]:PEP 7 , Style Guide for C Code, van Rossum

[2]:Barry’s GNU Mailman style guidehttp://barry.warsaw.us/software/STYLEGUIDE.txt

[3]:http://www.wikipedia.com/wiki/CamelCase

版权说明

This document has been placed in the public domain.

Source:https://hg.python.org/peps/file/tip/pep-0008.txt

15.迭代器、生成器、装饰器

实验介绍

在这个实验里我们学习迭代器、生成器、装饰器有关知识。

这几个概念是 Python 中不容易理解透彻的概念,务必把所有的实验代码都完整的输入并理解清楚其中每一行的意思。

知识点

  • 迭代器
  • 生成器
  • 生成器表达式
  • 闭包
  • 装饰器

迭代器

Python 迭代器(Iterators)对象在遵守迭代器协议时需要支持如下两种方法。

__iter__(),返回迭代器对象自身。这用在forin语句中。

__next__(),返回迭代器的下一个值。如果没有下一个值可以返回,那么应该抛出StopIteration异常。

  1. class Counter(object):
  2. def __init__(self, low, high):
  3. self.current = low
  4. self.high = high
  5. def __iter__(self):
  6. return self
  7. def __next__(self):
  8. #返回下一个值直到当前值大于 high
  9. if self.current > self.high:
  10. raise StopIteration
  11. else:
  12. self.current += 1
  13. return self.current - 1

现在我们能把这个迭代器用在我们的代码里。

  1. >>> c = Counter(5,10)
  2. >>> for i in c:
  3. ... print(i, end=' ')
  4. ...
  5. 5 6 7 8 9 10

请记住迭代器只能被使用一次。这意味着迭代器一旦抛出StopIteration,它会持续抛出相同的异常。

  1. >>> c = Counter(5,6)
  2. >>> next(c)
  3. 5
  4. >>> next(c)
  5. 6
  6. >>> next(c)
  7. Traceback (most recent call last):
  8. File "<stdin>", line 1, in <module>
  9. File "<stdin>", line 11, in next
  10. StopIteration
  11. >>> next(c)
  12. Traceback (most recent call last):
  13. File "<stdin>", line 1, in <module>
  14. File "<stdin>", line 11, in next
  15. StopIteration

我们已经看过在for循环中使用迭代器的例子了,下面的例子试图展示迭代器被隐藏的细节:

  1. >>> iterator = iter(c)
  2. >>> while True:
  3. ... try:
  4. ... x = iterator.__next__()
  5. ... print(x, end=' ')
  6. ... except StopIteration as e:
  7. ... break
  8. ...
  9. 5 6 7 8 9 10

生成器

在这一节我们学习有关 Python 生成器(Generators)的知识。生成器是更简单的创建迭代器的方法,这通过在函数中使用yield关键字完成:

  1. >>> def my_generator():
  2. ... print("Inside my generator")
  3. ... yield 'a'
  4. ... yield 'b'
  5. ... yield 'c'
  6. ...
  7. >>> my_generator()
  8. <generator object my_generator at 0x7fbcfa0a6aa0>

在上面的例子中我们使用yield语句创建了一个简单的生成器。我们能在for循环中使用它,就像我们使用任何其它迭代器一样。

  1. >>> for char in my_generator():
  2. ... print(char)
  3. ...
  4. Inside my generator
  5. a
  6. b
  7. c

在下一个例子里,我们会使用一个生成器函数完成与 Counter 类相同的功能,并且把它用在 for 循环中。

  1. >>> def counter_generator(low, high):
  2. ... while low <= high:
  3. ... yield low
  4. ... low += 1
  5. ...
  6. >>> for i in counter_generator(5,10):
  7. ... print(i, end=' ')
  8. ...
  9. 5 6 7 8 9 10

在 While 循环中,每当执行到yield语句时,返回变量low的值并且生成器状态转为挂起。在下一次调用生成器时,生成器从之前冻结的地方恢复执行然后变量low的值增一。生成器继续while循环并且再次来到yield语句…
当你调用生成器函数时它返回一个生成器对象。如果你把这个对象传入dir()函数,你会在返回的结果中找到__iter____next__两个方法名。

Python3简明教程--实验楼 - 图50

我们通常使用生成器进行惰性求值。这样使用生成器是处理大数据的好方法。如果你不想在内存中加载所有数据,你可以使用生成器,一次只传递给你一部分数据。

os.path.walk()函数是最典型的这样的例子,它使用一个回调函数和当前的os.walk生成器。使用生成器实现节约内存。

我们可以使用生成器产生无限多的值。以下是一个这样的例子。

  1. >>> def infinite_generator(start=0):
  2. ... while True:
  3. ... yield start
  4. ... start += 1
  5. ...
  6. >>> for num in infinite_generator(4):
  7. ... print(num, end=' ')
  8. ... if num > 20:
  9. ... break
  10. ...
  11. 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

如果我们回到my_generator()这个例子,我们会发现生成器的一个特点:它们是不可重复使用的。

  1. >>> g = my_generator()
  2. >>> for c in g:
  3. ... print(c)
  4. ...
  5. Inside my generator
  6. a
  7. b
  8. c
  9. >>> for c in g:
  10. ... print(c)
  11. ...

我们无法创建一个可重复使用的生成器,但可以创建一个对象,将它的__iter__方法调用得到一个生成器,举例如下:

  1. >>> class Counter(object):
  2. ... def __init__(self, low, high):
  3. ... self.low = low
  4. ... self.high = high
  5. ... def __iter__(self):
  6. ... counter = self.low
  7. ... while self.high >= counter:
  8. ... yield counter
  9. ... counter += 1
  10. ...
  11. >>> gobj = Counter(5, 10)
  12. >>> for num in gobj:
  13. ... print(num, end=' ')
  14. ...
  15. 5 6 7 8 9 10
  16. >>> for num in gobj:
  17. ... print(num, end=' ')
  18. ...
  19. 5 6 7 8 9 10

上面的gobj并不是生成器或迭代器,因为它不具有__next__方法,只是一个可迭代对象,生成器是一定不能重复循环的。而gobj.__iter__()是一个生成器,因为它是一个带有 yield 关键字的函数。
如果想要使类的实例变成迭代器,可以用__iter__+__next__方法实现:

  1. >>> from collections import Iterator
  2. >>> class Test():
  3. ...: def __init__(self, a, b):
  4. ...: self.a = a
  5. ...: self.b = b
  6. ...: def __iter__(self):
  7. ...: return self
  8. ...: def __next__(self):
  9. ...: self.a += 1
  10. ...: if self.a > self.b:
  11. ...: raise StopIteration()
  12. ...: return self.a
  13. ...:
  14. >>> test = Test(5, 10)
  15. >>> isinstance(test, Iterator)
  16. True

生成器表达式

在这一节我们学习生成器表达式(Generator expressions),生成器表达式是列表推导式和生成器的一个高性能,内存使用效率高的推广。

举个例子,我们尝试对 1 到 9 的所有数字进行平方求和。

  1. >>> sum([x*x for x in range(1,10)])

这个例子实际上首先在内存中创建了一个平方数值的列表,然后遍历这个列表,最终求和后释放内存。你能理解一个大列表的内存占用情况是怎样的。
我们可以通过使用生成器表达式来节省内存使用。

  1. >>> sum(x*x for x in range(1,10))

生成器表达式的语法要求其总是直接在在一对括号内,并且不能在两边有逗号。这基本上意味着下面这些例子都是有效的生成器表达式用法示例:

  1. >>> sum(x*x for x in range(1,10))
  2. 285
  3. >>> g = (x*x for x in range(1,10))
  4. >>> g
  5. <generator object <genexpr> at 0x7fc559516b90>

我们可以把生成器和生成器表达式联系起来,在下面的例子中我们会读取文件'/var/log/cron'并且查看任意指定任务(例中我们搜索'anacron')是否成功运行。
我们可以用 shell 命令tail -f /etc/crontab |grep anacron完成同样的事(按 Ctrl + C 终止命令执行)。

Python3简明教程--实验楼 - 图51

  1. >>> jobtext = 'anacron'
  2. >>> all = (line for line in open('/etc/crontab', 'r') )
  3. >>> job = ( line for line in all if line.find(jobtext) != -1)
  4. >>> text = next(job)
  5. >>> text
  6. '25 6\t* * *\troot\ttest -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.daily )\n'
  7. >>> text = next(job)
  8. >>> text
  9. '47 6\t* * 7\troot\ttest -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.weekly )\n'
  10. >>> text = next(job)
  11. >>> text
  12. '52 6\t1 * *\troot\ttest -x /usr/sbin/anacron || ( cd / && run-parts --report /etc/cron.monthly )\n'

你可以写一个for循环遍历所有行。

闭包

闭包(Closures)是由另外一个函数返回的函数。我们使用闭包去除重复代码。在下面的例子中我们创建了一个简单的闭包来对数字求和。

  1. >>> def add_number(num):
  2. ... def adder(number):
  3. ... #adder 是一个闭包
  4. ... return num + number
  5. ... return adder
  6. ...
  7. >>> a_10 = add_number(10)
  8. >>> a_10(21)
  9. 31
  10. >>> a_10(34)
  11. 44
  12. >>> a_5 = add_number(5)
  13. >>> a_5(3)
  14. 8

装饰器

装饰器(Decorators)用来给一些对象动态的添加一些新的行为,我们使用过的闭包也是这样的。

我们会创建一个简单的示例,将在函数执行前后打印一些语句。

  1. >>> def my_decorator(func):
  2. ... def wrapper(*args, **kwargs):
  3. ... print("Before call")
  4. ... result = func(*args, **kwargs)
  5. ... print("After call")
  6. ... return result
  7. ... return wrapper
  8. ...
  9. >>> @my_decorator
  10. ... def add(a, b):
  11. ... #我们的求和函数
  12. ... return a + b
  13. ...
  14. >>> add(1, 3)
  15. Before call
  16. After call
  17. 4

总结

知识点回顾:

  • 迭代器
  • 生成器
  • 生成器表达式
  • 闭包
  • 装饰器

本实验我们学习了迭代器和生成器以及装饰器这几个高级特性的定义方法和用法,也了解了怎样使用生成器表达式和怎样定义闭包。

16.Virtualenv

实验介绍

虚拟的 Python 环境(简称 venv) 是一个能帮助你在本地目录安装不同版本的 Python 模块的 Python 环境,你可以不再需要在你系统中安装所有东西就能开发并测试你的代码。

实验知识点

  • virtualenv 的安装
  • 创建虚拟环境
  • 激活虚拟环境
  • 使用多个虚拟环境
  • 关闭虚拟环境

安装 virtualenv

首先安装 pip3,打开 xfce 终端输入下面的命令:

  1. $ sudo apt-get update
  2. $ sudo apt-get install python3-pip

用如下命令安装 virtualenv:

  1. $ sudo pip3 install virtualenv

Python3简明教程--实验楼 - 图52

用法

我们会创建一个叫做virtual的目录,在里面我们会有两个不同的虚拟环境。

  1. $ cd /home/shiyanlou
  2. $ mkdir virtual

下面的命令创建一个叫做 virt1 的环境。

  1. $ cd virtual
  2. $ virtualenv virt1

Python3简明教程--实验楼 - 图53

现在我们激活这个 virt1 环境。

  1. $ source virt1/bin/activate
  2. (virt1)shiyanlou:~/$

提示符的第一部分是当前虚拟环境的名字,当你有多个环境的时候它会帮助你识别你在哪个环境里面。
现在我们将安装redis这个 Python 模块。

  1. (virt1)$ sudo pip3 install redis

Python3简明教程--实验楼 - 图54

使用deactivate命令关闭虚拟环境。

  1. (virt1)$ deactivate
  2. $

现在我们将创建另一个虚拟环境 virt2,我们会在里面同样安装redis模块,但版本是 2.8 的旧版本。

  1. $ virtualenv virt2
  2. $ source virt2/bin/activate
  3. (virt2)$ sudo pip3 install redis==2.8

Python3简明教程--实验楼 - 图55

这样可以为你的所有开发需求拥有许多不同的环境。

总结

本节知识点回顾:

  • virtualenv 的安装
  • 创建虚拟环境
  • 激活虚拟环境
  • 使用多个虚拟环境
  • 关闭虚拟环境

永远记住当开发新应用时创建虚拟环境,这会帮助你的系统模块保持干净。

17.测试

实验介绍

编写测试检验应用程序所有不同的功能。每一个测试集中在一个关注点上验证结果是不是期望的。定期执行测试确保应用程序按预期的工作。当测试覆盖很大的时候,通过运行测试你就有自信确保修改点和新增点不会影响应用程序。

知识点

  • 单元测试概念
  • 使用 unittest 模块
  • 测试用例的编写
  • 异常测试
  • 测试覆盖率概念
  • 使用 coverage 模块

测试范围

如果可能的话,代码库中的所有代码都要测试。但这取决于开发者,如果写一个健壮性测试是不切实际的,你可以跳过它。就像Nick Coghlan(Python 核心开发成员) 在访谈里面说的:有一个坚实可靠的测试套件,你可以做出大的改动,并确信外部可见行为保持不变。

单元测试

这里引用维基百科的介绍:

在计算机编程中,单元测试(英语:Unit Testing)又称为模块测试, 是针对程序模块(软件设计的最小单位)来进行正确性检验的测试工作。程序单元是应用的最小可测试部件。在过程化编程中,一个单元就是单个程序、函数、过程等;对于面向对象编程,最小单元就是方法,包括基类(超类)、抽象类、或者派生类(子类)中的方法。

单元测试模块

在 Python 里我们有 unittest 这个模块来帮助我们进行单元测试。

阶乘计算程序

在这个例子中我们将写一个计算阶乘的程序/home/shiyanlou/factorial.py

  1. import sys
  2. def fact(n):
  3. """
  4. 阶乘函数
  5. :arg n: 数字
  6. :returns: n 的阶乘
  7. """
  8. if n == 0:
  9. return 1
  10. return n * fact(n -1)
  11. def div(n):
  12. """
  13. 只是做除法
  14. """
  15. res = 10 / n
  16. return res
  17. def main(n):
  18. res = fact(n)
  19. print(res)
  20. if __name__ == '__main__':
  21. if len(sys.argv) > 1:
  22. main(int(sys.argv[1]))

运行程序:

  1. $ python3 factorial.py 5

第一个测试用例

测试哪个函数?

正如你所看到的,fact(n)这个函数执行所有的计算,所以我们至少应该测试这个函数。

编辑/home/shiyanlou/factorial_test.py文件,代码如下:

  1. import unittest
  2. from factorial import fact
  3. class TestFactorial(unittest.TestCase):
  4. """
  5. 我们的基本测试类
  6. """
  7. def test_fact(self):
  8. """
  9. 实际测试
  10. 任何以 `test_` 开头的方法都被视作测试用例
  11. """
  12. res = fact(5)
  13. self.assertEqual(res, 120)
  14. if __name__ == '__main__':
  15. unittest.main()

运行测试:

  1. $ python3 factorial_test.py
  2. .
  3. ----------------------------------------------------------------------
  4. Ran 1 test in 0.000s
  5. OK

说明
我们首先导入了 unittest 模块,然后测试我们需要测试的函数。

测试用例是通过子类化unittest.TestCase创建的。

现在我们打开测试文件并且把 120 更改为 121,然后看看会发生什么?

各类 assert 语句

Method Checks that New in
assertEqual(a, b) a == b
assertNotEqual(a, b) a != b
assertTrue(x) bool(x) is True
assertFalse(x) bool(x) is False
assertIs(a, b) a is b 2.7
assertIsNot(a, b) a is not b 2.7
assertIsNone(x) x is None 2.7
assertIsNotNone(x) x is not None 2.7
assertIn(a, b) a in b 2.7
assertNotIn(a, b) a not in b 2.7
assertIsInstance(a, b) isinstance(a, b) 2.7
assertNotIsInstance(a, b) not isinstance(a, b)

2.7异常测试

如果我们在factorial.py中调用div(0),我们能看到异常被抛出。

我们也能测试这些异常,就像这样:

  1. self.assertRaises(ZeroDivisionError, div, 0)

完整代码:

  1. import unittest
  2. from factorial import fact, div
  3. class TestFactorial(unittest.TestCase):
  4. """
  5. 我们的基本测试类
  6. """
  7. def test_fact(self):
  8. """
  9. 实际测试
  10. 任何以 `test_` 开头的方法都被视作测试用例
  11. """
  12. res = fact(5)
  13. self.assertEqual(res, 120)
  14. def test_error(self):
  15. """
  16. 测试由运行时错误引发的异常
  17. """
  18. self.assertRaises(ZeroDivisionError, div, 0)
  19. if __name__ == '__main__':
  20. unittest.main()

mounttab.py

mounttab.py 中只有一个mount_details()函数,函数分析并打印挂载详细信息。

  1. import os
  2. def mount_details():
  3. """
  4. 打印挂载详细信息
  5. """
  6. if os.path.exists('/proc/mounts'):
  7. fd = open('/proc/mounts')
  8. for line in fd:
  9. line = line.strip()
  10. words = line.split()
  11. print('{} on {} type {}'.format(words[0],words[1],words[2]), end=' ')
  12. if len(words) > 5:
  13. print('({})'.format(' '.join(words[3:-2])))
  14. else:
  15. print()
  16. fd.close()
  17. if __name__ == '__main__':
  18. mount_details()

重构 mounttab.py
现在我们在 mounttab2.py 中重构了上面的代码并且有一个我们能容易的测试的新函数parse_mounts()

  1. import os
  2. def parse_mounts():
  3. """
  4. 分析 /proc/mounts 并 返回元祖的列表
  5. """
  6. result = []
  7. if os.path.exists('/proc/mounts'):
  8. fd = open('/proc/mounts')
  9. for line in fd:
  10. line = line.strip()
  11. words = line.split()
  12. if len(words) > 5:
  13. res = (words[0],words[1],words[2],'({})'.format(' '.join(words[3:-2])))
  14. else:
  15. res = (words[0],words[1],words[2])
  16. result.append(res)
  17. fd.close()
  18. return result
  19. def mount_details():
  20. """
  21. 打印挂载详细信息
  22. """
  23. result = parse_mounts()
  24. for line in result:
  25. if len(line) == 4:
  26. print('{} on {} type {} {}'.format(*line))
  27. else:
  28. print('{} on {} type {}'.format(*line))
  29. if __name__ == '__main__':
  30. mount_details()

同样我们测试代码,编写 mounttest.py 文件:

  1. #!/usr/bin/env python
  2. import unittest
  3. from mounttab2 import parse_mounts
  4. class TestMount(unittest.TestCase):
  5. """
  6. 我们的基本测试类
  7. """
  8. def test_parsemount(self):
  9. """
  10. 实际测试
  11. 任何以 `test_` 开头的方法都被视作测试用例
  12. """
  13. result = parse_mounts()
  14. self.assertIsInstance(result, list)
  15. self.assertIsInstance(result[0], tuple)
  16. def test_rootext4(self):
  17. """
  18. 测试找出根文件系统
  19. """
  20. result = parse_mounts()
  21. for line in result:
  22. if line[1] == '/' and line[2] != 'rootfs':
  23. self.assertEqual(line[2], 'ext4')
  24. if __name__ == '__main__':
  25. unittest.main()

运行程序

  1. $ python3 mounttest.py
  2. ..
  3. ----------------------------------------------------------------------
  4. Ran 2 tests in 0.001s
  5. OK

测试覆盖率

测试覆盖率是找到代码库未经测试的部分的简单方法。它并不会告诉你的测试好不好。

在 Python 中我们已经有了一个不错的覆盖率工具来帮助我们。你可以在实验楼环境中安装它:

  1. $ sudo pip3 install coverage

覆盖率示例

  1. $ coverage3 run mounttest.py
  2. ..
  3. ----------------------------------------------------------------------
  4. Ran 2 tests in 0.013s
  5. OK
  6. $ coverage3 report -m
  7. Name Stmts Miss Cover Missing
  8. --------------------------------------------
  9. mounttab2.py 22 7 68% 16, 25-30, 34
  10. mounttest.py 14 0 100%
  11. --------------------------------------------
  12. TOTAL 36 7 81%

我们还可以使用下面的命令以 HTML 文件的形式输出覆盖率结果,然后在浏览器中查看它。

  1. $ coverage3 html

Python3简明教程--实验楼 - 图56

Python3简明教程--实验楼 - 图57

总结

知识点回顾:

  • 单元测试概念
  • 使用 unittest 模块
  • 测试用例的编写
  • 异常测试
  • 测试覆盖率概念
  • 使用 coverage 模块

本实验了解了什么是单元测试,unittest 模块怎么用,测试用例怎么写。以及最后我们使用第三方模块 coverage 进行了覆盖率测试。

在实际生产环境中,测试环节是非常重要的的一环,即便志不在测试工程师,但以后的趋势就是 DevOps,所以掌握良好的测试技能也是很有用的。

18.项目结构

实验介绍

本实验阐述了一个完整的 Python 项目结构,你可以使用什么样的目录布局以及怎样发布软件到网络上。

知识点

  • 创建项目,编写__init__文件
  • 使用 setuptools 模块,编写 setup.py 和 MANIFEST.in 文件
  • 创建源文件的发布版本
  • 项目注册&上传到 PyPI

创建Python项目

我们的实验项目名为factorial,放到/home/shiyanlou/factorial目录:

  1. $ cd /home/shiyanlou
  2. $ mkdir factorial
  3. $ cd factorial/

我们给将要创建的 Python 模块取名为myfact,因此我们下一步创建myfact目录。

  1. $ mkdir myfact
  2. $ cd myfact/

主代码将在fact.py文件里面。

  1. "myfact module"
  2. def factorial(num):
  3. """
  4. 返回给定数字的阶乘值
  5. :arg num: 我们将计算其阶乘的整数值
  6. :return: 阶乘值,若传递的参数为负数,则为 -1
  7. """
  8. if num >= 0:
  9. if num == 0:
  10. return 1
  11. return num * factorial(num -1)
  12. else:
  13. return -1

我们还有模块的__init__.py文件,内容如下:

  1. from fact import factorial
  2. __all__ = [factorial, ]

我们还在factorial目录下添加了一个README.rst文件。因此,目录结构看起来像下面这样:
Python3简明教程--实验楼 - 图58

MANIFEST.in

现在我们要写一个/home/shiyanlou/factorial/MANIFEST.in文件,它用来在使用sdist命令的时候找出将成为项目源代码压缩包一部分的所有文件。

  1. include *.py
  2. include README.rst

如果你想要排除某些文件,你可以在这个文件中使用exclude语句。

安装 python-setuptools 包

我们使用virtualenv(这里不示范步骤)。

  1. $ sudo pip3 install setuptools

setup.py

最终我们需要写一个/home/shiyanlou/factorial/setup.py,用来创建源代码压缩包或安装软件。

  1. #!/usr/bin/env python3
  2. """Factorial project"""
  3. from setuptools import find_packages, setup
  4. setup(name = 'factorial', # 注意这里的name不要使用factorial相关的名字,因为会重复,需要另外取一个不会与其他人重复的名字
  5. version = '0.1',
  6. description = "Factorial module.",
  7. long_description = "A test module for our book.",
  8. platforms = ["Linux"],
  9. author="ShiYanLou",
  10. author_email="support@shiyanlou.com",
  11. url="https://www.shiyanlou.com/courses/596",
  12. license = "MIT",
  13. packages=find_packages()
  14. )

name是项目名称,version是发布版本,descriptionlong_description分别是项目介绍,项目长描述。platforms是此模块的支持平台列表。find_packages()是一个能在你源目录下找到所有模块的特殊函数,packaging docs

2.3.1. setup.py 用例

要创建一个源文件发布版本,执行以下命令。

  1. $ python3 setup.py sdist

执行完毕会返回类似下面的信息:

  1. running sdist
  2. running egg_info
  3. creating factorial.egg-info
  4. writing factorial.egg-info/PKG-INFO
  5. writing top-level names to factorial.egg-info/top_level.txt
  6. writing dependency_links to factorial.egg-info/dependency_links.txt
  7. writing manifest file 'factorial.egg-info/SOURCES.txt'
  8. reading manifest file 'factorial.egg-info/SOURCES.txt'
  9. reading manifest template 'MANIFEST.in'
  10. writing manifest file 'factorial.egg-info/SOURCES.txt'
  11. running check
  12. creating factorial-0.1
  13. creating factorial-0.1/factorial.egg-info
  14. creating factorial-0.1/myfact
  15. making hard links in factorial-0.1...
  16. hard linking MANIFEST.in -> factorial-0.1
  17. hard linking README.rst -> factorial-0.1
  18. hard linking setup.py -> factorial-0.1
  19. hard linking factorial.egg-info/PKG-INFO -> factorial-0.1/factorial.egg-info
  20. hard linking factorial.egg-info/SOURCES.txt -> factorial-0.1/factorial.egg-info
  21. hard linking factorial.egg-info/dependency_links.txt -> factorial-0.1/factorial.egg-info
  22. hard linking factorial.egg-info/top_level.txt -> factorial-0.1/factorial.egg-info
  23. hard linking myfact/__init__.py -> factorial-0.1/myfact
  24. hard linking myfact/fact.py -> factorial-0.1/myfact
  25. Writing factorial-0.1/setup.cfg
  26. creating dist
  27. Creating tar archive
  28. removing 'factorial-0.1' (and everything under it)

我们能在dist目录下看到一个 tar 压缩包。

  1. $ ls dist/
  2. factorial-0.1.tar.gz

记住尝试安装代码时使用 virtualenv。
执行下面的命令从源代码安装。

  1. $ sudo python3 setup.py install

学习更多可前往packaging.python.org

Python Package Index(PyPI)

你还记得我们经常使用的pip命令吗?有没有想过这些包是从哪里来的?答案是PyPI。这是 Python 的软件包管理系统。

为了实验,我们会使用PyPI的测试服务器https://testpypi.python.org/pypi

2.4.1 创建账号

首先在这个链接注册账号。你会收到带有链接的邮件,点击这个链接确认你的注册。

创建 ~/.pypirc 文件,存放你的账号详细信息,其内容格式如下:

  1. [distutils]
  2. index-servers = pypi
  3. testpypi
  4. [pypi]
  5. repository: https://upload.pypi.org/legacy/
  6. username: <username>
  7. password: <password>
  8. [testpypi]
  9. repository:https://test.pypi.org/legacy/
  10. username: <username>
  11. password: <password>

替换<username><password>为您新创建的帐户的详细信息。在这里,由于我们是到testpypi的网页上去注册账号,即将相应的服务上传到testpypi,所以在这里,你只需修改[testpypi]的用户名和密码
记得在setup.py中更改项目的名称为其它的名字来测试下面的指令,在接下来的命令中我将项目名称修改为factorial2,为了不重复,大家需要自行修改至其它名称(不要使用 factorial 和 factorial2,因为已经被使用了)。

2.4.2 上传到 TestPyPI 服务

下一步我们会将我们的项目到 TestPyPI 服务。这通过twine命令完成。

我们也会使用-r把它指向测试服务器。

  1. $ sudo pip3 install twine
  2. $ twine upload dist/* -r testpypi

执行完毕会返回类似下面的信息:

  1. Uploading distributions to https://test.pypi.org/legacy/
  2. Uploading factorial2-0.1.tar.gz

现在如果你浏览这个页面,你会发现你的项目已经准备好被别人使用了。
Python3简明教程--实验楼 - 图59

在这里你也可以使用下面的命令上传到 PyPI 服务上,但这里需要注意,在~/.pypirc里面,你需要到https://pypi.python.org页面,按照上面的步骤去注册一个账号,然后到~/.pypirc[pypi]下填写相应的用户名和密码。testpypipypi的账号密码并不通用。

  1. $ twine upload dist/* -r pypi

总结

实验知识点回顾:

  • 创建项目,编写__init__文件
  • 使用 setuptools 模块,编写 setup.py 和 MANIFEST.in 文件
  • 创建源文件的发布版本
  • 项目注册&上传到 PyPI

本实验使用了 setuptools 包,并完成了较为完整的项目创建&发布流程,最后还将项目发布到了网络 (PyPI)上。

19.Flask介绍

实验介绍

本节实验通过一些简单的示例,学习 Flask 框架的基本使用。

知识点

  • 微框架、WSGI、模板引擎概念
  • 使用 Flask 做 web 应用
  • 模板的使用
  • 根据 URL 返回特定网页

基本概念

什么是 Flask?

Flask 是一个 web 框架。也就是说 Flask 为你提供工具,库和技术来允许你构建一个 web 应用程序。这个 web 应用程序可以是一些 web 页面、博客、wiki、基于 web 的日历应用或商业网站。

Flask 属于微框架(micro-framework)这一类别,微架构通常是很小的不依赖于外部库的框架。这既有优点也有缺点,优点是框架很轻量,更新时依赖少,并且专注安全方面的 bug,缺点是,你不得不自己做更多的工作,或通过添加插件增加自己的依赖列表。Flask 的依赖如下:

维基百科 WSGI 的介绍:

Web服务器网关接口(Python Web Server Gateway Interface,缩写为WSGI)是为Python语言定义的Web服务器Web应用程序框架之间的一种简单而通用的接口)。自从WSGI被开发出来以后,许多其它语言中也出现了类似接口。

什么是模板引擎?

你搭建过一个网站吗?你面对过保持网站风格一致的问题吗,你不得不写多次相同的文本吗?你有没有试图改变这种网站的风格?

如果你的网站只包含几个网页,改变网站风格会花费你一些时间,这确实可行。尽管如此,如果你有许多页面(比如在你商店里的售卖物品列表),这个任务便很艰巨。

使用模板你可以设置你的页面的基本布局,并提及哪个元素将发生变化。这种方式可以定义您的网页头部并在您的网站的所有页面使它保持一致,如果你需要改变网页头部,你只需要更新一个地方。

使用模板引擎创建/更新/维护你的应用会节约你很多时间。

“Hello World”应用

我们将使用 flask 完成一个非常基础的应用。

  • 安装 flask
  1. $ sudo pip3 install flask
  • 创建项目结构
  1. $ cd /home/shiyanlou
  2. $ mkdir -p hello_flask/{templates,static}

这是你的 web 应用的基本结构:

  1. $ tree hello_flask/
  2. hello_flask
  3. |-- static
  4. `-- templates
  5. 2 directories, 0 files

templates文件夹是存放模板的地方,static文件夹存放 web 应用所需的静态文件(images, css, javascript)。

  • 创建应用文件
  1. $ cd hello_flask
  2. $ vim hello_flask.py

hello_flask.py 文件里编写如下代码:

  1. #!/usr/bin/env python3
  2. import flask
  3. # Create the application.
  4. APP = flask.Flask(__name__)
  5. @APP.route('/')
  6. def index():
  7. """ 显示可在 '/' 访问的 index 页面
  8. """
  9. return flask.render_template('index.html')
  10. if __name__ == '__main__':
  11. APP.debug=True
  12. APP.run()
  • 创建模板文件index.html
  1. $ vim templates/index.html

index.html 文件内容如下:

  1. <!DOCTYPE html>
  2. <html lang='en'>
  3. <head>
  4. <meta charset="utf-8" />
  5. <title>Hello world!</title>
  6. <link type="text/css" rel="stylesheet"
  7. href="{{ url_for('static',
  8. filename='hello.css')}}" />
  9. </head>
  10. <body>
  11. It works!
  12. </body>
  13. </html>
  • 运行 flask 应用程序
  1. $ python3 hello_flask.py

访问http://127.0.0.1:5000/,这应该只是显示黑字白底的 “It works!” 文本,如下图:
Python3简明教程--实验楼 - 图60

Flask中使用参数

在本节中我们将要看到如何根据用户使用的 URL 返回网页。

为此我们更新 hello_flask.py 文件。

  • 在 hello_flask.py 文件中添加以下条目
  1. @APP.route('/hello/<name>/')
  2. def hello(name):
  3. """ Displays the page greats who ever comes to visit it.
  4. """
  5. return flask.render_template('hello.html', name=name)
  • 创建下面这个模板 hello.html
  1. <!DOCTYPE html>
  2. <html lang='en'>
  3. <head>
  4. <meta charset="utf-8" />
  5. <title>Hello</title>
  6. <link type="text/css" rel="stylesheet"
  7. href="{{ url_for('static',
  8. filename='hello.css')}}" />
  9. </head>
  10. <body>
  11. Hello {{name}}
  12. </body>
  13. </html>
  • 运行 flask 应用
  1. $ python3 hello_flask.py

访问http://127.0.0.1:5000/,这应该只是显示黑字白底的 “It works!” 文本。
访问http://127.0.0.1:5000/hello/you,这应该返回文本 “Hello you”,见下图:

Python3简明教程--实验楼 - 图61

无论你在 URL 中/hello/后填写的什么,都会出现在返回的网页中。

这是你第一次使用模板,我们在 hello_flask.py 中建立了name变量(参见 hello 函数的 return 行)。通过语法{{name}},name 变量之后在页面中显示其自身。

额外工作

目前,对于每一个页面我们都创建了一个模板,其实这是不好的做法,我们应该做的是创建一个主模板并且在每个页面使用它。

  • 创建模板文件 master.html。
  1. <!DOCTYPE html>
  2. <html lang='en'>
  3. <head>
  4. <meta charset="utf-8" />
  5. <title>{% block title %}{% endblock %} - Hello Flask!</title>
  6. <link type="text/css" rel="stylesheet"
  7. href="{{ url_for('static',
  8. filename='hello.css')}}" />
  9. </head>
  10. <body>
  11. {% block body %}{% endblock %}
  12. </body>
  13. </html>
  • 调整模板 index.html。
  1. {% extends "master.html" %}
  2. {% block title %}Home{% endblock %}
  3. {% block body %}
  4. It works!
  5. {% endblock %}

正如你所看到的,在 master.html 模板中我们定义了两部分,名为titlebodyblocks
在模板 index.html 中,我们声明这个模板扩展自 master.html 模板,然后我们定义了内容来放在这两个部分中(blocks)。在第一个 blocktitle中,我们放置了Home单词,在第二个 blockbody中我们定义了我们想要在页面的 body 中有的东西。

  • 作为练习,更改其他模板 hello.html,同样要使用 master.html。
  • 在 hello 页面添加首页链接。

调整模板 hello.html,添加到首页的链接。

  1. <a href="{{ url_for('index') }}"><button>Home</button></a>
  • 作为你的任务,在首页添加到 hello 页面的链接。

总结

实验知识点回顾:

  • 微框架、WSGI、模板引擎概念
  • 使用 Flask 做 web 应用
  • 模板的使用
  • 根据 URL 返回特定网页

本实验中我们了解了微框架、WSGI、模板引擎等概念,学习使用 Flask 做一个 web 应用,在这个 web 应用中,我们使用了模板。而用户以正确的不同 URL访问服务器时,服务器返回不同的网页。最后还给大家留了一个小任务,希望大家能完成。

想要深入学习Flask,你还可以学习实验楼的Python Flask Web框架课程。

当然,在学习过程中有任何不懂的地方或者对Flsak非常感兴趣,推荐学习Flask官方文档