Python基础-4

Posted 2020-09-24

目录

1. 迭代器&生成器
2. 装饰器
3. Json & pickle 数据序列化
4. 软件目录结构规范

1.列表生成式，迭代器&生成器

看列表[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]，现在要求把列表里的每个值加1

1 a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2 a = map(lambda x:x+1, a)

又或者

1 a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
2 a = [i+1 for i in a]

这就叫做列表生成

生成器

通过列表生成式，我们可以直接创建一个列表。但是，受到内存限制，列表容量肯定是有限的。而且，创建一个包含100万个元素的列表，不仅占用很大的存储空间，如果我们仅仅需要访问前面几个元素，那后面绝大多数元素占用的空间都白白浪费了。

所以，如果列表元素可以按照某种算法推算出来，那我们是否可以在循环的过程中不断推算出后续的元素呢？这样就不必创建完整的list，从而节省大量的空间。在Python中，这种一边循环一边计算的机制，称为生成器：generator。

要创建一个generator，有很多种方法。第一种方法很简单，只要把一个列表生成式的[]改成()，就创建了一个generator：

1 >>> L = [x * x for x in range(10)]
2 >>> L
3 [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
4 >>> g = (x * x for x in range(10))
5 >>> g
6 <generator object <genexpr> at 0x1022ef630>

创建L和g的区别仅在于最外层的[]和()，L是一个list，而g是一个generator。

我们可以直接打印出list的每一个元素，但我们怎么打印出generator的每一个元素呢？

如果要一个一个打印出来，可以通过next()函数获得generator的下一个返回值：

1 g = (x * x for x in range(10))
2 print(g.__next__())
3 print(g.__next__())
4 print(g.__next__())
5 0
6 1
7 4

最后一个print(g.__next__())会抛出错误：StopIteration

我们讲过，generator保存的是算法，每次调用next(g)，就计算出g的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出StopIteration的错误。

当然，上面这种不断调用next(g)实在是太变态了，正确的方法是使用for循环，因为generator也是可迭代对象：

1  g = (x * x for x in range(10))
2  for n in g:
3        print(n)

所以，我们创建了一个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

仔细观察，可以看出，fib函数实际上是定义了斐波拉契数列的推算规则，可以从第一个元素开始，推算出后续任意的元素，这种逻辑其实非常类似generator。

也就是说，上面的函数和generator仅一步之遥。要把fib函数变成generator，只需要把print(b)改为yield b就可以了：

 1 def fib(max):
 2     n,a,b = 0,0,1
 3 
 4     while n < max:
 5         #print(b)
 6         yield  b
 7         a,b = b,a+b
 8 
 9         n += 1
10 
11     return ‘done‘ 

这就是定义generator的另一种方法。如果一个函数定义中包含yield关键字，那么这个函数就不再是一个普通函数，而是一个generator：

1 >>> f = fib(6)
2 >>> f
3 <generator object fib at 0x104feaaa0>

这里，最难理解的就是generator和函数的执行流程不一样。函数是顺序执行，遇到return语句或者最后一行函数语句就返回。而变成generator的函数，在每次调用next()的时候执行，遇到yield语句返回，再次执行时从上次返回的yield语句处继续执行。

 1 data = fib(10)
 2 print(data)
 3 
 4 print(data.__next__())
 5 print(data.__next__())
 6 print("干点别的事")
 7 print(data.__next__())
 8 print(data.__next__())
 9 print(data.__next__())
10 print(data.__next__())
11 print(data.__next__())
12 
13 #输出
14 <generator object fib at 0x101be02b0>
15 1
16 1
17 干点别的事
18 2
19 3
20 5
21 8
22 13

在上面fib的例子，我们在循环过程中不断调用yield，就会不断中断。当然要给循环设置一个条件来退出循环，不然就会产生一个无限数列出来。

同样的，把函数改成generator后，我们基本上从来不会用next()来获取下一个返回值，而是直接使用for循环来迭代：

1 >>> for n in fib(6):
2 ...     print(n)
3 ...
4 1
5 1
6 2
7 3
8 5
9 8

但是用for循环调用generator时，发现拿不到generator的return语句的返回值。如果想要拿到返回值，必须捕获StopIteration错误，返回值包含在StopIteration的value中：

 1 >>> g = fib(6)
 2 >>> while True:
 3 ...     try:
 4 ...         x = next(g)
 5 ...         print(‘g:‘, x)
 6 ...     except StopIteration as e:
 7 ...         print(‘Generator return value:‘, e.value)
 8 ...         break
 9 ...
10 g: 1
11 g: 1
12 g: 2
13 g: 3
14 g: 5
15 g: 8
16 Generator return value: done

通过生成器实现协程并行运算

 1 import time 
 2 def consumer(name):
 3     print("%s准备吃包子！"%name)
 4     while True:
 5         baozi = yield
 6         print("【%s】号包子来了，分两半，一半被【%s】吃了"%(baozi,name))
 7 
 8 #c = consumer("小明")
 9 #c.__next__()
10 
11 #b1 = "韭菜馅的"
12 #c.send(b1)
13 
14 def producer(name):
15     c = consumer("A")
16     c2 = consumer("B")
17     c.__next__()
18     c2.__next__()
19     print("厨师开始做包子了！")
20     for i in range(3):
21         time.sleep(1)
22         print("做好了1个包子,分两半")
23         c.send(i)
24         c2.send(i)
25 
26 producer("Freeman")
27 
28 
29 
30 A准备吃包子！
31 B准备吃包子！
32 厨师开始做包子了！
33 做好了1个包子,分两半
34 【0】号包子来了，分两半，一半被【A】吃了
35 【0】号包子来了，分两半，一半被【B】吃了
36 做好了1个包子,分两半
37 【1】号包子来了，分两半，一半被【A】吃了
38 【1】号包子来了，分两半，一半被【B】吃了
39 做好了1个包子,分两半
40 【2】号包子来了，分两半，一半被【A】吃了
41 【2】号包子来了，分两半，一半被【B】吃了

迭代器

我们已经知道，可以直接作用于for循环的数据类型有以下几种：

一类是集合数据类型，如list、tuple、dict、set、str等；

一类是generator，包括生成器和带yield的generator function。

这些可以直接作用于for循环的对象统称为可迭代对象：Iterable。

可以使用isinstance()判断一个对象是否是Iterable对象：

 1 >>> from collections import Iterable
 2 >>> isinstance([], Iterable)
 3 True
 4 >>> isinstance({}, Iterable)
 5 True
 6 >>> isinstance(‘abc‘, Iterable)
 7 True
 8 >>> isinstance((x for x in range(10)), Iterable)
 9 True
10 >>> isinstance(100, Iterable)
11 False

而生成器不但可以作用于for循环，还可以被next()函数不断调用并返回下一个值，直到最后抛出StopIteration错误表示无法继续返回下一个值了。

可以被next()函数调用并不断返回下一个值的对象称为迭代器：Iterator。

可以使用isinstance()判断一个对象是否是Iterator对象：

1 >>> from collections import Iterator
2 >>> isinstance((x for x in range(10)), Iterator)
3 True
4 >>> isinstance([], Iterator)
5 False
6 >>> isinstance({}, Iterator)
7 False
8 >>> isinstance(‘abc‘, Iterator)
9 False

生成器都是Iterator对象，但list、dict、str虽然是Iterable，却不是Iterator。

把list、dict、str等Iterable变成Iterator可以使用iter()函数：

1 >>> isinstance(iter([]), Iterator)
2 True
3 >>> 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     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

2.装饰器

一家视频网站的后端开发工程师，你们网站有以下几个版块

 1 def home():
 2     print("---首页----")
 3  
 4 def america():
 5     print("----欧美专区----")
 6  
 7 def japan():
 8     print("----日韩专区----")
 9  
10 def henan():
11     print("----河南专区----")

视频刚上线初期，为了吸引用户，你们采取了免费政策，所有视频免费观看，迅速吸引了一大批用户，免费一段时间后，每天巨大的带宽费用公司承受不了了，所以准备对比较受欢迎的几个版块收费，其中包括“欧美” 和 “河南”专区，你拿到这个需求后，想了想，想收费得先让其进行用户认证，认证通过后，再判定这个用户是否是VIP付费会员就可以了，是VIP就让看，不是VIP就不让看就行了呗。 你觉得这个需求很是简单，因为要对多个版块进行认证，那应该把认证功能提取出来单独写个模块，然后每个版块里调用 就可以了，与是你轻轻的就实现了下面的功能 。

 1 #_*_coding:utf-8_*_
 2  
 3  
 4 user_status = False #用户登录了就把这个改成True
 5  
 6 def login():
 7     _username = "alex" #假装这是DB里存的用户信息
 8     _password = "abc!23" #假装这是DB里存的用户信息
 9     global user_status
10  
11     if user_status == False:
12         username = input("user:")
13         password = input("pasword:")
14  
15         if username == _username and password == _password:
16             print("welcome login....")
17             user_status = True
18         else:
19             print("wrong username or password!")
20     else:
21         print("用户已登录，验证通过...")
22  
23 def home():
24     print("---首页----")
25  
26 def america():
27     login() #执行前加上验证
28     print("----欧美专区----")
29  
30 def japan():
31     print("----日韩专区----")
32  
33 def henan():
34     login() #执行前加上验证
35     print("----河南专区----")
36  
37  
38  
39 home()
40 america()
41 henan()

此时你信心满满的把这个代码提交给你的TEAM LEADER审核，没成想，没过5分钟，代码就被打回来了， TEAM LEADER给你反馈是，我现在有很多模块需要加认证模块，你的代码虽然实现了功能，但是需要更改需要加认证的各个模块的代码，这直接违反了软件开发中的一个原则“开放-封闭”原则，简单来说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

• 封闭：已实现的功能代码块
• 开放：对扩展开发

这个原则你还是第一次听说，我擦，再次感受了自己这个野生程序员与正规军的差距，BUT ANYWAY,老大要求的这个怎么实现呢？如何在不改原有功能代码的情况下加上认证功能呢？你一时想不出思路，只好带着这个问题回家继续憋，媳妇不在家，去隔壁老王家串门了，你正好落的清静，一不小心就想到了解决方案，不改源代码可以呀，

记得学过，高阶函数，就是把一个函数当做一个参数传给另外一个函数，只需要写个认证方法，每次调用 需要验证的功能 时，直接把这个功能的函数名当做一个参数传给我的验证模块不就行了

 1 #_*_coding:utf-8_*_
 2  
 3  
 4 user_status = False #用户登录了就把这个改成True
 5  
 6 def login(func): #把要执行的模块从这里传进来
 7     _username = "alex" #假装这是DB里存的用户信息
 8     _password = "abc!23" #假装这是DB里存的用户信息
 9     global user_status
10  
11     if user_status == False:
12         username = input("user:")
13         password = input("pasword:")
14  
15         if username == _username and password == _password:
16             print("welcome login....")
17             user_status = True
18         else:
19             print("wrong username or password!")
20  
21     if user_status == True:
22         func() # 看这里看这里，只要验证通过了，就调用相应功能
23  
24 def home():
25     print("---首页----")
26  
27 def america():
28     #login() #执行前加上验证
29     print("----欧美专区----")
30  
31 def japan():
32     print("----日韩专区----")
33  
34 def henan():
35     #login() #执行前加上验证
36     print("----河南专区----")
37  
38  
39  
40 home()
41 login(america) #需要验证就调用 login，把需要验证的功能 当做一个参数传给login
42 # home()
43 # america()
44 login(henan)

然而该方法改变了调用方式呀， 想一想，现在没每个需要认证的模块，都必须调用你的login()方法，并把自己的函数名传给你，人家之前可不是这么调用 的， 试想，如果有100个模块需要认证，那这100个模块都得更改调用方式，这么多模块肯定不止是一个人写的，让每个人再去修改调用方式 才能加上认证，你会被骂死的。。。。

之所改变了调用方式，是因为用户每次调用时需要执行login(henan)，类似的。其实稍一改就可以了呀

1 home()
2 america = login(america)
3 henan = login(henan)

这样你，其它人调用henan时，其实相当于调用了login(henan), 通过login里的验证后，就会自动调用henan功能。 

不过， 我这样写了好，那用户调用时，应该是下面这个样子

1 home()
2 america = login(america) #你在这里相当于把america这个函数替换了
3 henan = login(henan)
4  
5 #那用户调用时依然写
6 america()

但问题在于，还不等用户调用 ，你的america = login(america)就会先自己把america执行了呀。。。。，你应该等我用户调用 的时候 再执行才对呀，不信我试给你看。。。

确实有这个问题。想实现一开始你写的america = login(america)不触发你函数的执行，只需要在这个login里面再定义一层函数，第一次调用america = login(america)只调用到外层login，这个login虽然会执行，但不会触发认证了，因为认证的所有代码被封装在login里层的新定义 的函数里了，login只返回里层函数的函数名，这样下次再执行america()时， 就会调用里层函数啦。。。

还是给你看代码吧。。

 1 def login(func): #把要执行的模块从这里传进来
 2  
 3     def inner():#再定义一层函数
 4         _username = "alex" #假装这是DB里存的用户信息
 5         _password = "abc!23" #假装这是DB里存的用户信息
 6         global user_status
 7  
 8         if user_status == False:
 9             username = input("user:")
10             password = input("pasword:")
11  
12             if username == _username and password == _password:
13                 print("welcome login....")
14                 user_status = True
15             else:
16                 print("wrong username or password!")
17  
18         if user_status == True:
19             func() # 看这里看这里，只要验证通过了，就调用相应功能
20  
21     return inner #用户调用login时，只会返回inner的内存地址，下次再调用时加上()才会执行inner函数

这是开发中一个常用的玩法，叫语法糖，官方名称“装饰器”，其实上面的写法，还可以更简单

1 america = login(america) #你在这里相当于把america这个函数替换了

只在你要装饰的函数上面加上下面代码

 1 @login
 2 def america():
 3     #login() #执行前加上验证
 4     print("----欧美专区----")
 5  
 6 def japan():
 7     print("----日韩专区----")
 8  
 9 @login
10 def henan():
11     #login() #执行前加上验证
12     print("----河南专区----")

然而，如果你在  河南专区   版块加了个参数，然后，结果出错了。。。

你调用henan时，其实是相当于调用的login，你的henan第一次调用时henan = login(henan)， login就返回了inner的内存地址，第2次用户自己调用henan("3p"),实际上相当于调用inner,但你的inner定义时并没有设置参数，但你给他传了个参数，所以自然就报错了呀。

如果有多个参数的话：非固定参数。。。*args,**kwargs...

 1 #_*_coding:utf-8_*_
 2  
 3  
 4 user_status = False #用户登录了就把这个改成True
 5  
 6 def login(func): #把要执行的模块从这里传进来
 7  
 8     def inner(*args,**kwargs):#再定义一层函数
 9         _username = "alex" #假装这是DB里存的用户信息
10         _password = "abc!23" #假装这是DB里存的用户信息
11         global user_status
12  
13         if user_status == False:
14             username = input("user:")
15             password = input("pasword:")
16  
17             if username == _username and password == _password:
18                 print("welcome login....")
19                 user_status = True
20             else:
21                 print("wrong username or password!")
22  
23         if user_status == True:
24             func(*args,**kwargs) # 看这里看这里，只要验证通过了，就调用相应功能
25  
26     return inner #用户调用login时，只会返回inner的内存地址，下次再调用时加上()才会执行inner函数
27  
28  
29 def home():
30     print("---首页----")
31  
32 @login
33 def america():
34     #login() #执行前加上验证
35     print("----欧美专区----")
36  
37 def japan():
38     print("----日韩专区----")
39  
40 # @login
41 def henan(style):
42     ‘‘‘
43     :param style: 喜欢看什么类型的，就传进来
44     :return:
45     ‘‘‘
46     #login() #执行前加上验证
47     print("----河南专区----")
48  
49 home()
50 # america = login(america) #你在这里相当于把america这个函数替换了
51 henan = login(henan)
52  
53 # #那用户调用时依然写
54 america()
55  
56 henan("3p")

产品经理又提了新的需求，要允许用户选择用qq\\weibo\\weixin认证，此时的你，已深谙装饰器各种装逼技巧，轻松的就实现了新的需求。

 1 #_*_coding:utf-8_*_
 2 
 3 
 4 user_status = False #用户登录了就把这个改成True
 5 
 6 def login(auth_type): #把要执行的模块从这里传进来
 7     def auth(func):
 8         def inner(*args,**kwargs):#再定义一层函数
 9             if auth_type == "qq":
10                 _username = "alex" #假装这是DB里存的用户信息
11                 _password = "abc!23" #假装这是DB里存的用户信息
12                 global user_status
13 
14                 if user_status == False:
15                     username = input("user:")
16                     password = input("pasword:")
17 
18                     if username == _username and password == _password:
19                         print("welcome login....")
20                         user_status = True
21                     else:
22                         print("wrong username or password!")
23 
24                 if user_status == True:
25                     return func(*args,**kwargs) # 看这里看这里，只要验证通过了，就调用相应功能
26             else:
27                 print("only support qq ")
28         return inner #用户调用login时，只会返回inner的内存地址，下次再调用时加上()才会执行inner函数
29 
30     return auth
31 
32 def home():
33     print("---首页----")
34 
35 @login(‘qq‘)
36 def america():
37     #login() #执行前加上验证
38     print("----欧美专区----")
39 
40 def japan():
41     print("----日韩专区----")
42 
43 @login(‘weibo‘)
44 def henan(style):
45     ‘‘‘
46     :param style: 喜欢看什么类型的，就传进来
47     :return:
48     ‘‘‘
49     #login() #执行前加上验证
50     print("----河南专区----")
51 
52 home()
53 # america = login(america) #你在这里相当于把america这个函数替换了
54 #henan = login(henan)
55 
56 # #那用户调用时依然写
57 america()
58 
59 # henan("3p")

3.Json & pickle 数据序列化

用于序列化的两个模块

• json，用于字符串 和 python数据类型间进行转换
• pickle，用于python特有的类型 和 python的数据类型间进行转换

Json模块提供了四个功能：dumps、dump、loads、load

pickle模块提供了四个功能：dumps、dump、loads、load

 

4.软件目录结构规范

为什么要设计好目录结构?

"设计项目目录结构"，就和"代码编码风格"一样，属于个人风格问题。对于这种风格上的规范，一直都存在两种态度:

1. 一类同学认为，这种个人风格问题"无关紧要"。理由是能让程序work就好，风格问题根本不是问题。
2. 另一类同学认为，规范化能更好的控制程序结构，让程序具有更高的可读性。

我是比较偏向于后者的，因为我是前一类同学思想行为下的直接受害者。我曾经维护过一个非常不好读的项目，其实现的逻辑并不复杂，但是却耗费了我非常长的时间去理解它想表达的意思。从此我个人对于提高项目可读性、可维护性的要求就很高了。"项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点:

1. 可读性高: 不熟悉这个项目的代码的人，一眼就能看懂目录结构，知道程序启动脚本是哪个，测试目录在哪儿，配置文件在哪儿等等。从而非常快速的了解这个项目。
2. 可维护性高: 定义好组织规则后，维护者就能很明确地知道，新增的哪个文件和代码应该放在什么目录之下。这个好处是，随着时间的推移，代码/配置的规模增加，项目结构不会混乱，仍然能够组织良好。

所以，我认为，保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录，其实是一件很简单的事儿。

目录组织方式

关于如何组织一个较好的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

简要解释一下:

1. bin/: 存放项目的一些可执行文件，当然你可以起名script/之类的也行。
2. foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码； (3) 程序的入口最好命名为main.py。
3. docs/: 存放一些文档。
4. setup.py: 安装、部署、打包的脚本。
5. requirements.txt: 存放软件依赖的外部Python包列表。
6. README: 项目说明文件。

除此之外，有一些方案给出了更加多的内容。比如LICENSE.txt,ChangeLog.txt文件等，我没有列在这里，因为这些东西主要是项目开源的时候需要用到。如果你想写一个开源软件，目录该如何组织，可以参考这篇文章。

下面，再简单讲一下我对这些目录的理解和个人要求吧。

关于README的内容

这个我觉得是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。
2. 运行代码的方法: 安装环境、启动命令等。
3. 简要的使用说明。
4. 代码目录结构说明，更详细点可以说明软件的基本原理。
5. 常见问题说明。

我觉得有以上几点是比较好的一个README。在软件开发初期，由于开发过程中以上内容可能不明确或者发生变化，并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候，是需要撰写这样的一个文档的。

可以参考Redis源码中Readme的写法，这里面简洁但是清晰的描述了Redis功能和源码结构。

关于requirements.txt和setup.py

setup.py

一般来说，用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题，而是说，一个项目一定要有一个安装部署工具，能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。

这个我是踩过坑的。

我刚开始接触Python写项目的时候，安装环境、部署代码、运行程序这个过程全是手动完成，遇到过以下问题:

1. 安装环境时经常忘了最近又添加了一个新的Python包，结果一到线上运行，程序就出错了。
2. Python包的版本依赖问题，有时候我们程序中使用的是一个版本的Python包，但是官方的已经是最新的包了，通过手动安装就可能装错了。
3. 如果依赖的包很多的话，一个一个安装这些依赖是很费时的事情。
4. 新同学开始写项目的时候，将程序跑起来非常麻烦，因为可能经常忘了要怎么安装各种依赖。

setup.py可以将这些事情自动化起来，提高效率、减少出错的概率。"复杂的东西自动化，能自动化的东西一定要自动化。"是一个非常好的习惯。

setuptools的文档比较庞大，刚接触的话，可能不太好找到切入点。学习技术的方式就是看他人是怎么用的，可以参考一下Python的一个Web框架，flask是如何写的: setup.py

当然，简单点自己写个安装脚本（deploy.sh）替代setup.py也未尝不可。

requirements.txt

这个文件存在的目的是:

1. 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中，避免在setup.py安装依赖时漏掉软件包。
2. 方便读者明确项目使用了哪些Python包。

这个文件的格式是每一行包含一个包依赖的说明，通常是flask>=0.10这种格式，要求是这个格式能被pip识别，这样就可以简单的通过 pip install -r requirements.txt来把所有Python包依赖都装好了。具体格式说明： 点这里。

 

关于配置文件的使用方法

注意，在上面的目录结构中，没有将conf.py放在源码目录下，而是放在docs/目录下。

很多项目对配置文件的使用做法是:

1. 配置文件写在一个或多个python文件中，比如此处的conf.py。
2. 项目中哪个模块用到这个配置文件就直接通过import conf这种形式来在代码中使用配置。

这种做法我不太赞同:

1. 这让单元测试变得困难（因为模块内部依赖了外部配置）
2. 另一方面配置文件作为用户控制程序的接口，应当可以由用户自由指定该文件的路径。
3. 程序组件可复用性太差，因为这种贯穿所有模块的代码硬编码方式，使得大部分模块都依赖conf.py这个文件。

所以，我认为配置的使用，更好的方式是，

1. 模块的配置都是可以灵活配置的，不受外部配置文件的影响。
2. 程序的配置也是可以灵活控制的。

能够佐证这个思想的是，用过nginx和mysql的同学都知道，nginx、mysql这些程序都可以自由的指定用户配置。

所以，不应当在代码中直接import conf来使用配置文件。上面目录结构中的conf.py，是给出的一个配置样例，不是在写死在程序中直接引用的配置文件。可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。当然，这里的conf.py你可以换个类似的名字，比如settings.py。或者你也可以使用其他格式的内容来编写配置文件，比如settings.yaml之类的。