本节内容
1.列表生成式
2.迭代器&生成器
3.装饰器
4.软件目录结构规范
1.列表生成式
1 a = [i**2 for i in range(10)] 2 3 print(a) 4 # [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
这就叫列表生成式。
2.迭代器&生成器
生成器
生成器是一次生成一个值的特殊类型函数。可以将其视为可恢复函数。
生成器也是一种迭代器,但是你只能对其迭代一次 。这是因为它们并没有把所有的值存在内存中,而是在运行时生成值。你通过遍历来使用它们,要么用一个“for”循环,要么将它们传递给任意可以进行迭代的函数和结构。大多数时候生成器是以函数来实现的。然而,它们并不返回一个值,而是yield(暂且译作“生出”)一个值。
通过列表生成式,我们可以直接创建一个列表。但是,受到内存限制,列表容量肯定是有限的。而且,创建一个包含100万个元素的列表,不仅占用很大的存储空间,如果我们仅仅需要访问前面几个元素,那后面绝大多数元素占用的空间都白白浪费了。
所以,如果列表元素可以按照某种算法推算出来,那我们是否可以在循环的过程中不断推算出后续的元素呢?这样就不必创建完整的list,从而节省大量的空间。在Python中,这种一边循环一边计算的机制,称为生成器:generator。
要创建一个generator,有很多种方法。第一种方法很简单,只要把一个列表生成式的[]
改成()
,就创建了一个generator:
1 L = [x*x for x in range(10)] 2 print(L) 3 # [0, 1, 4, 9, 16, 25, 36, 49, 64, 81] 4 g = (x*x for x in range(10)) 5 print(g) 6 # <generator object <genexpr> at 0x0000023B6E345A98>
创建L
和g
的区别仅在于最外层的[]
和()
,L
是一个list,而g
是一个generator。
我们可以直接打印出list的每一个元素,但我们怎么打印出generator的每一个元素呢?
如果要一个一个打印出来,可以通过next()
函数获得generator的下一个返回值:
1 g = (x*x for x in range(10)) 2 print(g) 3 # <generator object <genexpr> at 0x0000023B6E345A98> 4 5 print(next(g)) #0 6 print(next(g)) #1 7 print(next(g)) #4 8 print(next(g)) #9 9 print(next(g)) #16 10 print(next(g)) #25 11 print(next(g)) #36 12 print(next(g)) #49
我们讲过,generator保存的是算法,每次调用next(g)
,就计算出g
的下一个元素的值,直到计算到最后一个元素,没有更多的元素时,抛出StopIteration
的错误。
当然,上面这种不断调用next(g)
实在是太变态了,正确的方法是使用for
循环,因为generator也是可迭代对象:
1 g = (x*x for x in range(10)) 2 print(g) 3 # <generator object <genexpr> at 0x0000023B6E345A98> 4 for n in g: 5 print(n) 6 #输出 7 # 0 8 # 1 9 # 4 10 # 9 11 # 16 12 # 25 13 # 36 14 # 49 15 # 64 16 # 81
所以,我们创建了一个generator后,基本上永远不会调用next()
,而是通过for
循环来迭代它,并且不需要关心StopIteration
的错误。
generator非常强大。如果推算的算法比较复杂,用类似列表生成式的for
循环无法实现的时候,还可以用函数来实现。
比如,著名的斐波拉契数列(Fibonacci),除第一个和第二个数外,任意一个数都可由前两个数相加得到:
1, 1, 2, 3, 5, 8, 13, 21, 34, ...
斐波拉契数列用列表生成式写不出来,但是,用函数把它打印出来却很容易:
1 def fib(max): 2 n, a, b = 0, 0, 1 3 while n < max: 4 print(b) 5 a, b = b, a + b 6 n = n + 1 7 return 'done' 8 9 print(fib(8)) 10 # 输出 11 # 1 12 # 1 13 # 2 14 # 3 15 # 5 16 # 8 17 # 13 18 # 21 19 # done
仔细观察,可以看出,fib
函数实际上是定义了斐波拉契数列的推算规则,可以从第一个元素开始,推算出后续任意的元素,这种逻辑其实非常类似generator。
也就是说,上面的函数和generator仅一步之遥。要把fib
函数变成generator,只需要把print(b)
改为yield b
就可以了:
1 def feibo(max): 2 n,before,after=0,0,1 3 while n < max: 4 yield before 5 before,after=after,before+after 6 n += 1
这就是定义generator的另一种方法。如果一个函数定义中包含yield
关键字,那么这个函数就不再是一个普通函数,而是一个generator:
这里,最难理解的就是generator和函数的执行流程不一样。函数是顺序执行,遇到return
语句或者最后一行函数语句就返回。而变成generator的函数,在每次调用next()
的时候执行,遇到yield
语句返回,再次执行时从上次返回的yield
语句处继续执行。
迭代器
迭代器(iterator)是一种对象,它能够用来遍历标准模板库容器中的部分或全部元素,每个迭代器对象代表容器中的确定的地址。迭代器修改了常规指针的接口,所谓迭代器是一种概念上的抽象:那些行为上像迭代器的东西都可以叫做迭代器。然而迭代器有很多不同的能力,它可以把抽象容器和通用算法有机的统一起来。
我们已经知道,可以直接作用于for
循环的数据类型有以下几种:
一类是集合数据类型,如list
、tuple
、dict
、set
、str
等;
一类是generator
,包括生成器和带yield
的generator function。
这些可以直接作用于for
循环的对象统称为可迭代对象:Iterable
。
可以使用isinstance()
判断一个对象是否是Iterable
对象:
1 from collections import Iterable 2 print(isinstance([],Iterable)) 3 # True 4 print(isinstance({},Iterable)) 5 # True 6 print(isinstance('abc',Iterable)) 7 # True 8 print(isinstance((x for x in range(10)),Iterable)) 9 # True 10 print(isinstance(100,Iterable)) 11 # False
而生成器不但可以作用于for
循环,还可以被next()
函数不断调用并返回下一个值,直到最后抛出StopIteration
错误表示无法继续返回下一个值了。
可以被next()
函数调用并不断返回下一个值的对象称为迭代器:Iterator
。
可以使用isinstance()
判断一个对象是否是Iterator
对象:
1 from collections import Iterator 2 print(isinstance([],Iterator)) 3 # False 4 print(isinstance({},Iterator)) 5 # False 6 print(isinstance('abc',Iterator)) 7 # False 8 print(isinstance((x for x in range(10)),Iterator)) 9 # True
生成器都是Iterator
对象,但list
、dict
、str
虽然是Iterable
,却不是Iterator
。
把list
、dict
、str
等Iterable
变成Iterator
可以使用iter()
函数:
1 print(isinstance(iter([]),Iterator)) 2 # True 3 print(isinstance(iter('abc'),Iterator)) 4 # True
你可能会问,为什么list
、dict
、str
等数据类型不是Iterator
?
这是因为Python的Iterator
对象表示的是一个数据流,Iterator对象可以被next()
函数调用并不断返回下一个数据,直到没有数据时抛出StopIteration
错误。可以把这个数据流看做是一个有序序列,但我们却不能提前知道序列的长度,只能不断通过next()
函数实现按需计算下一个数据,所以Iterator
的计算是惰性的,只有在需要返回下一个数据时它才会计算。
Iterator
甚至可以表示一个无限大的数据流,例如全体自然数。而使用list是永远不可能存储全体自然数的。
小结
凡是可作用于for
循环的对象都是Iterable
类型;
凡是可作用于next()
函数的对象都是Iterator
类型,它们表示一个惰性计算的序列;
集合数据类型如list
、dict
、str
等是Iterable
但不是Iterator
,不过可以通过iter()
函数获得一个Iterator
对象。
Python的for
循环本质上就是通过不断调用next()
函数实现的,例如:
1 for x in [1, 2, 3, 4, 5]: 2 3 pass
实际上完全等价于:
1 # 首先获得Iterator对象: 2 it = iter([1, 2, 3, 4, 5]) 3 # 循环: 4 while True: 5 try: 6 # 获得下一个值: 7 x = next(it) 8 except StopIteration: 9 # 遇到StopIteration就退出循环 10 break
3.装饰器
装饰器之闭包
1 def outer(): 2 x=10 3 def inner(): 4 print(x) 5 return 'boom' 6 return inner 7 8 print(outer()()) 9 # 10 10 # boom
闭包=内部函数+定义函数时的环境
outer()()执行时分两步,按理说第一步执行后外层函数会清掉内存(包括里面的函数),然而并没有。
这就是闭包函数。
装饰器
装饰器是一个函数,是为其他函数增添功能的函数。
1 import time 2 3 def show_time(f): 4 def inner(): 5 start=time.time() 6 f() 7 end=time.time() 8 print("执行时间:%s"%(end-start)) 9 return inner 10 11 @show_time #foo=show_time(foo) 12 def foo(): 13 print("foo.......") 14 time.sleep(2) 15 16 foo() 17 #输出 18 # foo....... 19 # 执行时间:2.00065016746521 20 21 @show_time #bar=show_time(bar) 22 def bar(): 23 print("bar.......") 24 time.sleep(3) 25 26 bar() 27 #输出 28 # bar....... 29 # 执行时间:3.000929832458496 30 31 # 功能函数想加参数,则装饰器函数一起加 32 # 装饰器函数想加参数,则外层多嵌一层函数
4.软件目录结构规范(搬照https://www.cnblogs.com/alex3714/articles/5765046.html)
为什么要设计好目录结构?
"设计项目目录结构",就和"代码编码风格"一样,属于个人风格问题。对于这种风格上的规范,一直都存在两种态度:
- 一类同学认为,这种个人风格问题"无关紧要"。理由是能让程序work就好,风格问题根本不是问题。
- 另一类同学认为,规范化能更好的控制程序结构,让程序具有更高的可读性。
我是比较偏向于后者的,因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目,其实现的逻辑并不复杂,但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴,我们设计一个层次清晰的目录结构,就是为了达到以下两点:
- 可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。
- 可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。
所以,我认为,保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录,其实是一件很简单的事儿。
目录组织方式
关于如何组织一个较好的Python工程目录结构,已经有一些得到了共识的目录结构。在Stackoverflow的这个问题上,能看到大家对Python目录结构的讨论。
这里面说的已经很好了,我也不打算重新造轮子列举各种不同的方式,这里面我说一下我的理解和体会。
假设你的项目名为foo, 我比较建议的最方便快捷目录结构这样就足够了:
Foo/
|-- bin/
| |-- foo
|
|-- foo/
| |-- tests/
| | |-- __init__.py
| | |-- test_main.py
| |
| |-- __init__.py
| |-- main.py
|
|-- docs/
| |-- conf.py
| |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README
简要解释一下:
bin/
: 存放项目的一些可执行文件,当然你可以起名script/
之类的也行。foo/
: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/
存放单元测试代码; (3) 程序的入口最好命名为main.py
。docs/
: 存放一些文档。setup.py
: 安装、部署、打包的脚本。requirements.txt
: 存放软件依赖的外部Python包列表。README
: 项目说明文件。
除此之外,有一些方案给出了更加多的内容。比如LICENSE.txt
,ChangeLog.txt
文件等,我没有列在这里,因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件,目录该如何组织,可以参考这篇文章。
下面,再简单讲一下我对这些目录的理解和个人要求吧。
关于README的内容
这个我觉得是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。
它需要说明以下几个事项:
- 软件定位,软件的基本功能。
- 运行代码的方法: 安装环境、启动命令等。
- 简要的使用说明。
- 代码目录结构说明,更详细点可以说明软件的基本原理。
- 常见问题说明。
我觉得有以上几点是比较好的一个README
。在软件开发初期,由于开发过程中以上内容可能不明确或者发生变化,并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候,是需要撰写这样的一个文档的。
可以参考Redis源码中Readme的写法,这里面简洁但是清晰的描述了Redis功能和源码结构。
关于requirements.txt和setup.py
setup.py
一般来说,用setup.py
来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。
这个我是踩过坑的。
我刚开始接触Python写项目的时候,安装环境、部署代码、运行程序这个过程全是手动完成,遇到过以下问题:
- 安装环境时经常忘了最近又添加了一个新的Python包,结果一到线上运行,程序就出错了。
- Python包的版本依赖问题,有时候我们程序中使用的是一个版本的Python包,但是官方的已经是最新的包了,通过手动安装就可能装错了。
- 如果依赖的包很多的话,一个一个安装这些依赖是很费时的事情。
- 新同学开始写项目的时候,将程序跑起来非常麻烦,因为可能经常忘了要怎么安装各种依赖。
setup.py
可以将这些事情自动化起来,提高效率、减少出错的概率。"复杂的东西自动化,能自动化的东西一定要自动化。"是一个非常好的习惯。
setuptools的文档比较庞大,刚接触的话,可能不太好找到切入点。学习技术的方式就是看他人是怎么用的,可以参考一下Python的一个Web框架,flask是如何写的: setup.py
当然,简单点自己写个安装脚本(deploy.sh
)替代setup.py
也未尝不可。
requirements.txt
这个文件存在的目的是:
- 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在
setup.py
安装依赖时漏掉软件包。 - 方便读者明确项目使用了哪些Python包。
这个文件的格式是每一行包含一个包依赖的说明,通常是flask>=0.10
这种格式,要求是这个格式能被pip
识别,这样就可以简单的通过 pip install -r requirements.txt
来把所有Python包依赖都装好了。具体格式说明: 点这里。
关于配置文件的使用方法
注意,在上面的目录结构中,没有将conf.py
放在源码目录下,而是放在docs/
目录下。
很多项目对配置文件的使用做法是:
- 配置文件写在一个或多个python文件中,比如此处的conf.py。
- 项目中哪个模块用到这个配置文件就直接通过
import conf
这种形式来在代码中使用配置。
这种做法我不太赞同:
- 这让单元测试变得困难(因为模块内部依赖了外部配置)
- 另一方面配置文件作为用户控制程序的接口,应当可以由用户自由指定该文件的路径。
- 程序组件可复用性太差,因为这种贯穿所有模块的代码硬编码方式,使得大部分模块都依赖
conf.py
这个文件。
所以,我认为配置的使用,更好的方式是,
- 模块的配置都是可以灵活配置的,不受外部配置文件的影响。
- 程序的配置也是可以灵活控制的。
能够佐证这个思想的是,用过nginx和mysql的同学都知道,nginx、mysql这些程序都可以自由的指定用户配置。
所以,不应当在代码中直接import conf
来使用配置文件。上面目录结构中的conf.py
,是给出的一个配置样例,不是在写死在程序中直接引用的配置文件。可以通过给main.py
启动参数指定配置路径的方式来让程序读取配置内容。当然,这里的conf.py
你可以换个类似的名字,比如settings.py
。或者你也可以使用其他格式的内容来编写配置文件,比如settings.yaml
之类的。
装饰器应用之登录
1 # a={'username':'yyy','passwd':'123'} 2 # b={'username':'rrr','passwd':'321'} 3 # with open('weixin','w') as f_weixin,open('jingdong','w') as f_jingdong: 4 # f_weixin.write(str(a)) 5 # f_jingdong.write(str(b)) 6 7 8 def logger(flag=" "): 9 def login(f): 10 def inner(): 11 if flag == 'a': 12 print('请用京东账号登录。') 13 username=input('username:') 14 passwd=input('passwd:') 15 with open('jingdong','r') as f_jingdong: 16 f_j=eval(f_jingdong.read()) 17 if username == f_j['username'] and passwd == f_j['passwd'] : 18 print("欢迎光临--------") 19 f() 20 status='b' 21 else: 22 print('输入错误!') 23 24 elif flag == 'b': 25 print('请用微信账号登录。') 26 username = input('username:') 27 passwd = input('passwd:') 28 with open('weixin', 'r') as f_weixin: 29 f_w = eval(f_weixin.read()) 30 if username == f_w['username'] and passwd == f_w['passwd']: 31 print('欢迎光临--------') 32 f() 33 status = 'a' 34 35 elif flag == 'a': 36 print('请用京东账号登录。') 37 username = input('username:') 38 passwd = input('passwd:') 39 with open('jingdong', 'r') as f_jingdong: 40 f_j = eval(f_jingdong.read()) 41 if username == f_j['username'] and passwd == f_j['passwd']: 42 print('欢迎光临--------') 43 f() 44 status = 'b' 45 return inner 46 return login 47 48 @logger('a') 49 def home(): 50 print('welcome the home.....') 51 52 @logger('b') 53 def finance(): 54 print('welcome the finance.....') 55 56 @logger('a') 57 def book(): 58 print('welcome the book.....') 59 60 u_exit = 1 61 while u_exit !=0 : 62 print('''选择要进入的页面:\t 63 1.home\t 64 2.finance\t 65 3.book\t 66 退出请输入0 67 ''') 68 user_input = input('>>:') 69 70 if user_input == '1': 71 home() 72 break 73 elif user_input == '2': 74 finance() 75 break 76 elif user_input == '3': 77 book() 78 break 79 elif user_input == '0': 80 print('下次再来玩~~') 81 u_exit=0