Python基礎 day4 迭代器&生成器裝飾器 Json & pickle 數據序列化軟件目錄結構規範做業:ATM項目開發

時間 2019-11-13

標籤 python 基礎 day4 day 迭代成器裝飾 json pickle 數據序列軟件目錄結構規範 atm 項目開發欄目 Python 简体版

原文原文鏈接

本節內容html

迭代器&生成器
裝飾器
Json & pickle 數據序列化
軟件目錄結構規範
做業:ATM項目開發

列表生成器python

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

列表生成式

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

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

原值修改

[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萬個元素的列表，不只佔用很大的存儲空間，若是咱們僅僅須要訪問前面幾個元素，那後面絕大多數元素佔用的空間都白白浪費了。git

因此，若是列表元素能夠按照某種算法推算出來，那咱們是否能夠在循環的過程當中不斷推算出後續的元素呢？這樣就沒必要建立完整的list，從而節省大量的空間。在Python中，這種一邊循環一邊計算的機制，稱爲生成器：generator。程序員

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

>>> 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。redis

咱們能夠直接打印出list的每個元素，但咱們怎麼打印出generator的每個元素呢？算法

若是要一個一個打印出來，能夠經過next()函數得到generator的下一個返回值：sql

>>> 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語句處繼續執行。

ata = 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.軟件目錄結構規範

爲何要設計好目錄結構?

"設計項目目錄結構"，就和"代碼編碼風格"同樣，屬於我的風格問題。對於這種風格上的規範，一直都存在兩種態度:

一類同窗認爲，這種我的風格問題"可有可無"。理由是能讓程序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之類的。