Python之路,Day4 - Python基礎4 (new版)

本節內容

1. 迭代器&生成器
2. 裝飾器
3. Json & pickle 數據序列化
4. 軟件目錄結構規范
5. 作業:ATM項目開發

 

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

列表生成式

孩子，我現在有個需求，看列表[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],我要求你把列表里的每個值加1，你怎么實現？你可能會想到2種方式 

>>> a
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> b = []
>>> for i in a:b.append(i+1)
... 
>>> b
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> a = b
>>> a
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

a = [1,3,4,6,7,7,8,9,11]

for index,i in enumerate(a):
    a[index] +=1
print(a)

原值修改

>>> a
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> a = map(lambda x:x+1, a)
>>> a
<map object at 0x101d2c630>
>>> for i in a:print(i)
... 
2
3
4
5
6
7
8
9
10
11

其實還有一種寫法，如下 

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

這就叫做列表生成

 

生成器

通過列表生成式，我們可以直接創建一個列表。但是，受到內存限制，列表容量肯定是有限的。而且，創建一個包含100萬個元素的列表，不僅占用很大的存儲空間，如果我們僅僅需要訪問前面幾個元素，那后面絕大多數元素占用的空間都白白浪費了。

所以，如果列表元素可以按照某種算法推算出來，那我們是否可以在循環的過程中不斷推算出后續的元素呢？這樣就不必創建完整的list，從而節省大量的空間。在Python中，這種一邊循環一邊計算的機制，稱為生成器：generator。

要創建一個generator，有很多種方法。第一種方法很簡單，只要把一個列表生成式的[]改成()，就創建了一個generator：

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

創建L和g的區別僅在於最外層的[]和()，L是一個list，而g是一個generator。

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

如果要一個一個打印出來，可以通過next()函數獲得generator的下一個返回值：

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

我們講過，generator保存的是算法，每次調用next(g)，就計算出g的下一個元素的值，直到計算到最后一個元素，沒有更多的元素時，拋出StopIteration的錯誤。

當然，上面這種不斷調用next(g)實在是太變態了，正確的方法是使用for循環，因為generator也是可迭代對象：

>>> g = (x * x for x in range(10))
>>> for n in g:
...     print(n)
... 
0
1
4
9
16
25
36
49
64
81

 

所以，我們創建了一個generator后，基本上永遠不會調用next()，而是通過for循環來迭代它，並且不需要關心StopIteration的錯誤。

generator非常強大。如果推算的算法比較復雜，用類似列表生成式的for循環無法實現的時候，還可以用函數來實現。

比如，著名的斐波拉契數列（Fibonacci），除第一個和第二個數外，任意一個數都可由前兩個數相加得到：

1, 1, 2, 3, 5, 8, 13, 21, 34, ...

斐波拉契數列用列表生成式寫不出來，但是，用函數把它打印出來卻很容易：

def fib(max):
    n, a, b = 0, 0, 1
    while n < max:
        print(b)
        a, b = b, a + b
        n = n + 1
    return 'done'

注意，賦值語句：

a, b = b, a + b

相當於：

t = (b, a + b) # t是一個tuple
a = t[0]
b = t[1]

但不必顯式寫出臨時變量t就可以賦值。

上面的函數可以輸出斐波那契數列的前N個數：

>>> fib(10)
1
1
2
3
5
8
13
21
34
55
done

仔細觀察，可以看出，fib函數實際上是定義了斐波拉契數列的推算規則，可以從第一個元素開始，推算出后續任意的元素，這種邏輯其實非常類似generator。

也就是說，上面的函數和generator僅一步之遙。要把fib函數變成generator，只需要把print(b)改為yield b就可以了：

def fib(max):
    n,a,b = 0,0,1

    while n < max:
        #print(b)
        yield  b
        a,b = b,a+b

        n += 1

    return 'done' 

這就是定義generator的另一種方法。如果一個函數定義中包含yield關鍵字，那么這個函數就不再是一個普通函數，而是一個generator：

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

這里，最難理解的就是generator和函數的執行流程不一樣。函數是順序執行，遇到return語句或者最后一行函數語句就返回。而變成generator的函數，在每次調用next()的時候執行，遇到yield語句返回，再次執行時從上次返回的yield語句處繼續執行。

data = fib(10)
print(data)

print(data.__next__())
print(data.__next__())
print("干點別的事")
print(data.__next__())
print(data.__next__())
print(data.__next__())
print(data.__next__())
print(data.__next__())

#輸出
<generator object fib at 0x101be02b0>
1
1
干點別的事
2
3
5
8
13

在上面fib的例子，我們在循環過程中不斷調用yield，就會不斷中斷。當然要給循環設置一個條件來退出循環，不然就會產生一個無限數列出來。

同樣的，把函數改成generator后，我們基本上從來不會用next()來獲取下一個返回值，而是直接使用for循環來迭代：

 

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

但是用for循環調用generator時，發現拿不到generator的return語句的返回值。如果想要拿到返回值，必須捕獲StopIteration錯誤，返回值包含在StopIteration的value中：

>>> g = fib(6)
>>> while True:
...     try:
...         x = next(g)
...         print('g:', x)
...     except StopIteration as e:
...         print('Generator return value:', e.value)
...         break
...
g: 1
g: 1
g: 2
g: 3
g: 5
g: 8
Generator return value: done

關於如何捕獲錯誤，后面的錯誤處理還會詳細講解。

還可通過yield實現在單線程的情況下實現並發運算的效果　　

#_*_coding:utf-8_*_
__author__ = 'Alex Li'

import time
def consumer(name):
    print("%s 准備吃包子啦!" %name)
    while True:
       baozi = yield

       print("包子[%s]來了,被[%s]吃了!" %(baozi,name))


def producer(name):
    c = consumer('A')
    c2 = consumer('B')
    c.__next__()
    c2.__next__()
    print("老子開始准備做包子啦!")
    for i in range(10):
        time.sleep(1)
        print("做了2個包子!")
        c.send(i)
        c2.send(i)

producer("alex")

 

迭代器

我們已經知道，可以直接作用於for循環的數據類型有以下幾種：

一類是集合數據類型，如list、tuple、dict、set、str等；

一類是generator，包括生成器和帶yield的generator function。

這些可以直接作用於for循環的對象統稱為可迭代對象：Iterable。

可以使用isinstance()判斷一個對象是否是Iterable對象：

 

>>> from collections import Iterable
>>> isinstance([], Iterable)
True
>>> isinstance({}, Iterable)
True
>>> isinstance('abc', Iterable)
True
>>> isinstance((x for x in range(10)), Iterable)
True
>>> isinstance(100, Iterable)
False

而生成器不但可以作用於for循環，還可以被next()函數不斷調用並返回下一個值，直到最后拋出StopIteration錯誤表示無法繼續返回下一個值了。

*可以被next()函數調用並不斷返回下一個值的對象稱為迭代器：Iterator。

可以使用isinstance()判斷一個對象是否是Iterator對象：

>>> from collections import Iterator
>>> isinstance((x for x in range(10)), Iterator)
True
>>> isinstance([], Iterator)
False
>>> isinstance({}, Iterator)
False
>>> isinstance('abc', Iterator)
False

生成器都是Iterator對象，但list、dict、str雖然是Iterable，卻不是Iterator。

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

>>> isinstance(iter([]), Iterator)
True
>>> isinstance(iter('abc'), Iterator)
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()函數實現的，例如：

for x in [1, 2, 3, 4, 5]:
    pass

實際上完全等價於：

# 首先獲得Iterator對象:
it = iter([1, 2, 3, 4, 5])
# 循環:
while True:
    try:
        # 獲得下一個值:
        x = next(it)
    except StopIteration:
        # 遇到StopIteration就退出循環
        break

 

　　

2.裝飾器

你是一家視頻網站的后端開發工程師，你們網站有以下幾個版塊

def home():
    print("---首頁----")

def america():
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

def henan():
    print("----河南專區----")

視頻剛上線初期，為了吸引用戶，你們采取了免費政策，所有視頻免費觀看，迅速吸引了一大批用戶，免費一段時間后，每天巨大的帶寬費用公司承受不了了，所以准備對比較受歡迎的幾個版塊收費，其中包括“歐美” 和 “河南”專區，你拿到這個需求后，想了想，想收費得先讓其進行用戶認證，認證通過后，再判定這個用戶是否是VIP付費會員就可以了，是VIP就讓看，不是VIP就不讓看就行了唄。 你覺得這個需求很是簡單，因為要對多個版塊進行認證，那應該把認證功能提取出來單獨寫個模塊，然后每個版塊里調用 就可以了，與是你輕輕的就實現了下面的功能 。

#_*_coding:utf-8_*_


user_status = False #用戶登錄了就把這個改成True

def login():
    _username = "alex" #假裝這是DB里存的用戶信息
    _password = "abc!23" #假裝這是DB里存的用戶信息
    global user_status

    if user_status == False:
        username = input("user:")
        password = input("pasword:")

        if username == _username and password == _password:
            print("welcome login....")
            user_status = True
        else:
            print("wrong username or password!")
    else:
        print("用戶已登錄，驗證通過...")

def home():
    print("---首頁----")

def america():
    login() #執行前加上驗證
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

def henan():
    login() #執行前加上驗證
    print("----河南專區----")



home()
america()
henan()

此時你信心滿滿的把這個代碼提交給你的TEAM LEADER審核，沒成想，沒過5分鍾，代碼就被打回來了， TEAM LEADER給你反饋是，我現在有很多模塊需要加認證模塊，你的代碼雖然實現了功能，但是需要更改需要加認證的各個模塊的代碼，這直接違反了軟件開發中的一個原則“開放-封閉”原則，簡單來說，它規定已經實現的功能代碼不允許被修改，但可以被擴展，即：

• 封閉：已實現的功能代碼塊不應該被修改
• 開放：對現有功能的擴展開放

這個原則你還是第一次聽說，我擦，再次感受了自己這個野生程序員與正規軍的差距，BUT ANYWAY,老大要求的這個怎么實現呢？如何在不改原有功能代碼的情況下加上認證功能呢？你一時想不出思路，只好帶着這個問題回家繼續憋，媳婦不在家，去隔壁老王家串門了，你正好落的清靜，一不小心就想到了解決方案，不改源代碼可以呀，

你師從沙河金角大王時，記得他教過你，高階函數，就是把一個函數當做一個參數傳給另外一個函數，當時大王說，有一天，你會用到它的，沒想到這時這個知識點突然從腦子 里蹦出來了，我只需要寫個認證方法，每次調用 需要驗證的功能 時，直接 把這個功能 的函數名當做一個參數 傳給 我的驗證模塊不就行了么，哈哈，機智如我，如是你啪啪啪改寫了之前的代碼

#_*_coding:utf-8_*_


user_status = False #用戶登錄了就把這個改成True

def login(func): #把要執行的模塊從這里傳進來
    _username = "alex" #假裝這是DB里存的用戶信息
    _password = "abc!23" #假裝這是DB里存的用戶信息
    global user_status

    if user_status == False:
        username = input("user:")
        password = input("pasword:")

        if username == _username and password == _password:
            print("welcome login....")
            user_status = True
        else:
            print("wrong username or password!")

    if user_status == True: 
        func() # 看這里看這里，只要驗證通過了，就調用相應功能

def home():
    print("---首頁----")

def america():
    #login() #執行前加上驗證
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

def henan():
    #login() #執行前加上驗證
    print("----河南專區----")



home()
login(america) #需要驗證就調用 login，把需要驗證的功能 當做一個參數傳給login
# home()
# america()
login(henan)

你很開心，終於實現了老板的要求，不改變原功能代碼的前提下，給功能加上了驗證，此時，媳婦回來了，后面還跟着老王，你兩家關系 非常 好，老王經常來串門，老王也是碼農，你跟他分享了你寫的代碼，興奮的等他看完 誇獎你NB,沒成想，老王看后，並沒有誇你，抱起你的兒子，笑笑說，你這個代碼還是改改吧， 要不然會被開除的，WHAT? 會開除，明明實現了功能 呀， 老王講，沒錯，你功能 是實現了，但是你又犯了一個大忌，什么大忌？ 

你改變了調用方式呀， 想一想，現在沒每個需要認證的模塊，都必須調用你的login()方法，並把自己的函數名傳給你，人家之前可不是這么調用 的， 試想，如果 有100個模塊需要認證，那這100個模塊都得更改調用方式，這么多模塊肯定不止是一個人寫的，讓每個人再去修改調用方式 才能加上認證，你會被罵死的。。。。

你覺得老王說的對，但問題是，如何即不改變原功能代碼，又不改變原有調用方式，還能加上認證呢？ 你苦思了一會，還是想不出，老王在逗你的兒子玩，你說，老王呀，快給我點思路 ，實在想不出來，老王背對着你問，

老王：學過匿名函數沒有？

你：學過學過，就是lambda嘛

老王：那lambda與正常函數的區別是什么？

你：最直接的區別是，正常函數定義時需要寫名字，但lambda不需要

老王：沒錯，那lambda定好后，為了多次調用 ，可否也給它命個名？

你：可以呀，可以寫成plus = lambda x:x+1類似這樣，以后再調用plus就可以了，但這樣不就失去了lambda的意義了，明明人家叫匿名函數呀，你起了名字有什么用呢？

老王：我不是要跟你討論它的意義 ，我想通過這個讓你明白一個事實

說着，老王拿起你兒子的畫板，在上面寫了以下代碼：

def plus(n):
    return n+1

plus2 = lambda x:x+1

老王： 上面這兩種寫法是不是代表 同樣的意思？

你：是的

老王：我給lambda x:x+1 起了個名字叫plus2，是不是相當於def plus2(x) ?

你：我擦，你別說，還真是，但老王呀，你想說明什么呢？

老王： 沒啥，只想告訴你，給函數賦值變量名就像def func_name　是一樣的效果，如下面的plus(n)函數，你調用時可以用plus名，還可以再起個其它名字，如

calc = plus

calc(n)

你明白我想傳達什么意思了么？

你：。。。。。。。。。。。這。。。。。。嗯 。。。。。不太。。。。明白 。。

老王：。。。。這。。。。。呵呵。。。。。。好吧。。。。，那我在給你點一下，你之前寫的下面這段調用 認證的代碼 

home()
login(america) #需要驗證就調用 login，把需要驗證的功能 當做一個參數傳給login
# home()
# america()
login(henan)

你之所改變了調用方式，是因為用戶每次調用時需要執行login(henan)，類似的。其實稍一改就可以了呀

home()
america = login(america) 
henan = login(henan)

這樣你，其它人調用henan時，其實相當於調用了login(henan), 通過login里的驗證后，就會自動調用henan功能。 

你：我擦，還真是唉。。。，老王，還是你nb。。。不過，等等， 我這樣寫了好，那用戶調用時，應該是下面這個樣子

home()
america = login(america) #你在這里相當於把america這個函數替換了
henan = login(henan)

#那用戶調用時依然寫
america()

但問題在於，還不等用戶調用 ，你的america = login(america)就會先自己把america執行了呀。。。。，你應該等我用戶調用 的時候 再執行才對呀，不信我試給你看。。。

老王：哈哈，你說的沒錯，這樣搞會出現這個問題？ 但你想想有沒有解決辦法 呢？

你：我擦，你指的思路呀，大哥。。。我哪知道 下一步怎么走。。。

 

老王：算了，估計你也想不出來。。。 學過嵌套函數沒有？

你：yes,然后呢？

老王：想實現一開始你寫的america = login(america)不觸發你函數的執行，只需要在這個login里面再定義一層函數，第一次調用america = login(america)只調用到外層login，這個login雖然會執行，但不會觸發認證了，因為認證的所有代碼被封裝在login里層的新定義 的函數里了，login只返回 里層函數的函數名，這樣下次再執行america()時， 就會調用里層函數啦。。。

你：。。。。。。什么？ 什么個意思，我蒙逼了。。。

老王：還是給你看代碼吧。。

def login(func): #把要執行的模塊從這里傳進來

    def inner():#再定義一層函數
        _username = "alex" #假裝這是DB里存的用戶信息
        _password = "abc!23" #假裝這是DB里存的用戶信息
        global user_status

        if user_status == False:
            username = input("user:")
            password = input("pasword:")

            if username == _username and password == _password:
                print("welcome login....")
                user_status = True
            else:
                print("wrong username or password!")

        if user_status == True:
            func() # 看這里看這里，只要驗證通過了，就調用相應功能

    return inner #用戶調用login時，只會返回inner的內存地址，下次再調用時加上()才會執行inner函數

此時你仔細着了老王寫的代碼　，感覺老王真不是一般人呀，連這種奇淫巧技都能想出來。。。，心中默默感謝上天賜你一個大牛鄰居。

你: 老王呀，你這個姿勢很nb呀，你獨創的？

此時你媳婦噗嗤的笑出聲來，你也不知道 她笑個球。。。

老王：呵呵， 這不是我獨創的呀當然 ，這是開發中一個常用的玩法，叫語法糖，官方名稱“裝飾器”，其實上面的寫法，還可以更簡單

可以把下面代碼去掉

america = login(america) #你在這里相當於把america這個函數替換了

只在你要裝飾的函數上面加上下面代碼

@login
def america():
    #login() #執行前加上驗證
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

@login
def henan():
    #login() #執行前加上驗證
    print("----河南專區----")

效果是一樣的。

你開心的玩着老王教你的新姿勢 ，玩着玩着就手賤給你的“河南專區”版塊 加了個參數，然后，結果 出錯了。。。

你：老王，老王，怎么傳個參數就不行了呢？

老王：那必然呀，你調用henan時，其實是相當於調用的login，你的henan第一次調用時henan = login(henan)， login就返回了inner的內存地址，第2次用戶自己調用henan("3p"),實際上相當於調用的時inner,但你的inner定義時並沒有設置參數，但你給他傳了個參數，所以自然就報錯了呀

你：但是我的 版塊需要傳參數呀，你不讓我傳不行呀。。。

老王：沒說不讓你傳，稍做改動便可。。

老王：你再試試就好了 。 

你： 果然好使，大神就是大神呀。 。。 不過，如果有多個參數呢？

老王：。。。。老弟，你不要什么都讓我教你吧，非固定參數你沒學過么？ *args,**kwargs...

你：噢 。。。還能這么搞?,nb,我再試試。

 

你身陷這種新玩法中無法自拔，竟沒注意到老王已經離開，你媳婦告訴你說為了不打擾你加班，今晚帶孩子去跟她姐妹住 ，你覺得媳婦真體貼，最終，你終於搞定了所有需求，完全遵循開放-封閉原則，最終代碼如下 。

#_*_coding:utf-8_*_


user_status = False #用戶登錄了就把這個改成True

def login(func): #把要執行的模塊從這里傳進來

    def inner(*args,**kwargs):#再定義一層函數
        _username = "alex" #假裝這是DB里存的用戶信息
        _password = "abc!23" #假裝這是DB里存的用戶信息
        global user_status

        if user_status == False:
            username = input("user:")
            password = input("pasword:")

            if username == _username and password == _password:
                print("welcome login....")
                user_status = True
            else:
                print("wrong username or password!")

        if user_status == True:
            func(*args,**kwargs) # 看這里看這里，只要驗證通過了，就調用相應功能

    return inner #用戶調用login時，只會返回inner的內存地址，下次再調用時加上()才會執行inner函數


def home():
    print("---首頁----")

@login
def america():
    #login() #執行前加上驗證
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

# @login
def henan(style):
    '''
    :param style: 喜歡看什么類型的，就傳進來
    :return:
    '''
    #login() #執行前加上驗證
    print("----河南專區----")

home()
# america = login(america) #你在這里相當於把america這個函數替換了
henan = login(henan)

# #那用戶調用時依然寫
america()

henan("3p")

此時，你已累的不行了，洗洗就抓緊睡了，半夜，上廁所，隱隱聽到隔壁老王家有微弱的女人的聲音傳來，你會心一笑，老王這家伙，不聲不響找了女朋友也不帶給我看看，改天一定要見下真人。。。。

 

 第二2天早上，產品經理又提了新的需求，要允許用戶選擇用qq\weibo\weixin認證，此時的你，已深諳裝飾器各種裝逼技巧，輕松的就實現了新的需求。

#_*_coding:utf-8_*_


user_status = False #用戶登錄了就把這個改成True

def login(auth_type): #把要執行的模塊從這里傳進來
    def auth(func):
        def inner(*args,**kwargs):#再定義一層函數
            if auth_type == "qq":
                _username = "alex" #假裝這是DB里存的用戶信息
                _password = "abc!23" #假裝這是DB里存的用戶信息
                global user_status

                if user_status == False:
                    username = input("user:")
                    password = input("pasword:")

                    if username == _username and password == _password:
                        print("welcome login....")
                        user_status = True
                    else:
                        print("wrong username or password!")

                if user_status == True:
                    return func(*args,**kwargs) # 看這里看這里，只要驗證通過了，就調用相應功能
            else:
                print("only support qq ")
        return inner #用戶調用login時，只會返回inner的內存地址，下次再調用時加上()才會執行inner函數

    return auth

def home():
    print("---首頁----")

@login('qq')
def america():
    #login() #執行前加上驗證
    print("----歐美專區----")

def japan():
    print("----日韓專區----")

@login('weibo')
def henan(style):
    '''
    :param style: 喜歡看什么類型的，就傳進來
    :return:
    '''
    #login() #執行前加上驗證
    print("----河南專區----")

home()
# america = login(america) #你在這里相當於把america這個函數替換了
#henan = login(henan)

# #那用戶調用時依然寫
america()

# henan("3p")

 

 

　　

　

 

 

3.Json & pickle 數據序列化

參考 http://www.cnblogs.com/alex3714/articles/5161349.html

 

　　

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之類的。

 

5.本節作業

作業需求：

模擬實現一個ATM + 購物商城程序

1. 額度 15000或自定義
2. 實現購物商城，買東西加入 購物車，調用信用卡接口結賬
3. 可以提現，手續費5%
4. 每月22號出賬單，每月10號為還款日，過期未還，按欠款總額 萬分之5 每日計息
5. 支持多賬戶登錄
6. 支持賬戶間轉賬
7. 記錄每月日常消費流水
8. 提供還款接口
9. ATM記錄操作日志 
10. 提供管理接口，包括添加賬戶、用戶額度，凍結賬戶等。。。
11. 用戶認證用裝飾器

示例代碼 https://github.com/triaquae/py3_training/tree/master/atm　

簡易流程圖：https://www.processon.com/view/link/589eb841e4b0999184934329