摘要：系列文章工匠善用變量改善代碼質(zhì)量序言編寫條件分支代碼是編碼過(guò)程中不可或缺的一部分。而進(jìn)行條件分支判斷時(shí)用到的也是這個(gè)值重點(diǎn)來(lái)了，雖然所有用戶類實(shí)例的布爾值都是真。

歡迎大家前往騰訊云+社區(qū)，獲取更多騰訊海量技術(shù)實(shí)踐干貨哦~

本文由鵝廠優(yōu)文發(fā)表于云+社區(qū)專欄

作者：朱雷 | 騰訊IEG高級(jí)工程師

我一直覺(jué)得編程某種意義是一門『手藝』，因?yàn)閮?yōu)雅而高效的代碼，就如同完美的手工藝品一樣讓人賞心悅目。

在雕琢代碼的過(guò)程中，有大工程：比如應(yīng)該用什么架構(gòu)、哪種設(shè)計(jì)模式。也有更多的小細(xì)節(jié)，比如何時(shí)使用異常（Exceptions）、或怎么給變量起名。那些真正優(yōu)秀的代碼，正是由無(wú)數(shù)優(yōu)秀的細(xì)節(jié)造就的。

『Python 工匠』這個(gè)系列文章，是我的一次小小嘗試。它專注于分享 Python 編程中的一些偏『小』的東西。希望能夠幫到每一位編程路上的匠人。

系列文章：

Python 工匠：善用變量改善代碼質(zhì)量

編寫條件分支代碼是編碼過(guò)程中不可或缺的一部分。

如果用道路來(lái)做比喻，現(xiàn)實(shí)世界中的代碼從來(lái)都不是一條筆直的高速公路，而更像是由無(wú)數(shù)個(gè)岔路口組成的某個(gè)市區(qū)地圖。我們編碼者就像是駕駛員，需要告訴我們的程序，下個(gè)路口需要往左還是往右。

編寫優(yōu)秀的條件分支代碼非常重要，因?yàn)樵愀?、?fù)雜的分支處理非常容易讓人困惑，從而降低代碼質(zhì)量。所以，這篇文章將會(huì)種重點(diǎn)談?wù)勗?Python 中編寫分支代碼應(yīng)該注意的地方。

Python 支持最為常見(jiàn)的 if/else 條件分支語(yǔ)句，不過(guò)它缺少在其他編程語(yǔ)言中常見(jiàn)的 switch/case 語(yǔ)句。

除此之外，Python 還為 for/while 循環(huán)以及 try/except 語(yǔ)句提供了 else 分支，在一些特殊的場(chǎng)景下，它們可以大顯身手。

下面我會(huì)從 最佳實(shí)踐、常見(jiàn)技巧、常見(jiàn)陷阱 三個(gè)方面講一下如果編寫優(yōu)秀的條件分支代碼。

如果這篇文章只能刪減成一句話就結(jié)束，那么那句話一定是“要竭盡所能的避免分支嵌套”。

過(guò)深的分支嵌套是很多編程新手最容易犯的錯(cuò)誤之一。假如有一位新手 JavaScript 程序員寫了很多層分支嵌套，那么你可能會(huì)看到一層又一層的大括號(hào)：if { if { if { ... }}}。俗稱“嵌套 if 地獄（Nested If Statement Hell）”。

但是因?yàn)?Python 使用了縮進(jìn)來(lái)代替 {}，所以過(guò)深的嵌套分支會(huì)產(chǎn)生比其他語(yǔ)言下更為嚴(yán)重的后果。比如過(guò)多的縮進(jìn)層次很容易就會(huì)讓代碼超過(guò) PEP8 中規(guī)定的每行字?jǐn)?shù)限制。讓我們看看這段代碼：

def buy_fruit(nerd, store):
    """去水果店買蘋果
    
    - 先得看看店是不是在營(yíng)業(yè)
    - 如果有蘋果的話，就買 1 個(gè)
    - 如果錢不夠，就回家取錢再來(lái)
    """
    if store.is_open():
        if store.has_stocks("apple"):
            if nerd.can_afford(store.price("apple", amount=1)):
                nerd.buy(store, "apple", amount=1)
                return
            else:
                nerd.go_home_and_get_money()
                return buy_fruit(nerd, store)
        else:
            raise MadAtNoFruit("no apple in store!")
    else:
        raise MadAtNoFruit("store is closed!")

上面這段代碼最大的問(wèn)題，就是過(guò)于直接翻譯了原始的條件分支要求，導(dǎo)致短短十幾行代碼包含了有三層嵌套分支。

這樣的代碼可讀性和維護(hù)性都很差。不過(guò)我們可以用一個(gè)很簡(jiǎn)單的技巧：“提前結(jié)束” 來(lái)優(yōu)化這段代碼：

def buy_fruit(nerd, store):
    if not store.is_open():
        raise MadAtNoFruit("store is closed!")

    if not store.has_stocks("apple"):
        raise MadAtNoFruit("no apple in store!")

    if nerd.can_afford(store.price("apple", amount=1)):
        nerd.buy(store, "apple", amount=1)
        return
    else:
        nerd.go_home_and_get_money()
        return buy_fruit(nerd, store)

“提前結(jié)束”指：在函數(shù)內(nèi)使用 return 或 raise 等語(yǔ)句提前在分支內(nèi)結(jié)束函數(shù)。比如，在新的 buy_fruit 函數(shù)里，當(dāng)分支條件不滿足時(shí)，我們直接拋出異常，結(jié)束這段這代碼分支。這樣的代碼沒(méi)有嵌套分支，更直接也更易讀。

如果條件分支里的表達(dá)式過(guò)于復(fù)雜，出現(xiàn)了太多的 not/and/or，那么這段代碼的可讀性就會(huì)大打折扣，比如下面這段代碼：

# 如果活動(dòng)還在開(kāi)放，并且活動(dòng)剩余名額大于 10，為所有性別為女性，或者級(jí)別大于 3
# 的活躍用戶發(fā)放 10000 個(gè)金幣
if activity.is_active and activity.remaining > 10 and 
        user.is_active and (user.sex == "female" or user.level > 3):
    user.add_coins(10000)
    return

對(duì)于這樣的代碼，我們可以考慮將具體的分支邏輯封裝成函數(shù)或者方法，來(lái)達(dá)到簡(jiǎn)化代碼的目的：

if activity.allow_new_user() and user.match_activity_condition():
    user.add_coins(10000)
    return

事實(shí)上，將代碼改寫后，之前的注釋文字其實(shí)也可以去掉了。因?yàn)楹竺孢@段代碼已經(jīng)達(dá)到了自說(shuō)明的目的。至于具體的 什么樣的用戶滿足活動(dòng)條件？ 這種問(wèn)題，就應(yīng)由具體的 match_activity_condition() 方法來(lái)回答了。

Hint: 恰當(dāng)?shù)姆庋b不光直接改善了代碼的可讀性，事實(shí)上，如果上面的活動(dòng)判斷邏輯在代碼中出現(xiàn)了不止一次的話，封裝更是必須的。不然重復(fù)代碼會(huì)極大的破壞這段邏輯的可維護(hù)性。

重復(fù)代碼是代碼質(zhì)量的天敵，而條件分支語(yǔ)句又非常容易成為重復(fù)代碼的重災(zāi)區(qū)。所以，當(dāng)我們編寫條件分支語(yǔ)句時(shí)，需要特別留意，不要生產(chǎn)不必要的重復(fù)代碼。

讓我們看下這個(gè)例子：

# 對(duì)于新用戶，創(chuàng)建新的用戶資料，否則更新舊資料
if user.no_profile_exists:
    create_user_profile(
        username=user.username,
        email=user.email,
        age=user.age,
        address=user.address,
        # 對(duì)于新建用戶，將用戶的積分置為 0
        points=0,
        created=now(),
    )
else:
    update_user_profile(
        username=user.username,
        email=user.email,
        age=user.age,
        address=user.address,
        updated=now(),
    )

在上面的代碼中，我們可以一眼看出，在不同的分支下，程序調(diào)用了不同的函數(shù)，做了不一樣的事情。但是，因?yàn)槟切┲貜?fù)代碼的存在，我們卻很難簡(jiǎn)單的區(qū)分出，二者的不同點(diǎn)到底在哪。

其實(shí)，得益于 Python 的動(dòng)態(tài)特性，我們可以簡(jiǎn)單的改寫一下上面的代碼，讓可讀性可以得到顯著的提升：

if user.no_profile_exists:
    profile_func = create_user_profile
    extra_args = {"points": 0, "created": now()}
else:
    profile_func = update_user_profile
    extra_args = {"updated": now()}

profile_func(
    username=user.username,
    email=user.email,
    age=user.age,
    address=user.address,
    **extra_args
)

當(dāng)你編寫分支代碼時(shí)，請(qǐng)額外關(guān)注由分支產(chǎn)生的重復(fù)代碼塊，如果可以簡(jiǎn)單的消滅它們，那就不要遲疑。

三元表達(dá)式是 Python 2.5 版本后才支持的語(yǔ)法。在那之前，Python 社區(qū)一度認(rèn)為三元表達(dá)式?jīng)]有必要，我們需要使用 x and a or b 的方式來(lái)模擬它。

事實(shí)是，在很多情況下，使用普通的 if/else 語(yǔ)句的代碼可讀性確實(shí)更好。盲目追求三元表達(dá)式很容易誘惑你寫出復(fù)雜、可讀性差的代碼。

所以，請(qǐng)記得只用三元表達(dá)式處理簡(jiǎn)單的邏輯分支。

language = "python" if you.favor("dynamic") else "golang"

對(duì)于絕大多數(shù)情況，還是使用普通的 if/else 語(yǔ)句吧。

在做分支判斷時(shí)，我們有時(shí)候會(huì)寫成這樣的代碼：

# 如果用戶沒(méi)有登錄或者用戶沒(méi)有使用 chrome，拒絕提供服務(wù)
if not user.has_logged_in or not user.is_from_chrome:
    return "our service is only available for chrome logged in user"

第一眼看到代碼時(shí)，是不是需要思考一會(huì)才能理解它想干嘛？這是因?yàn)樯厦娴倪壿嫳磉_(dá)式里面出現(xiàn)了 2 個(gè) not 和 1 個(gè) or。而我們?nèi)祟惽『貌簧瞄L(zhǎng)處理過(guò)多的“否定”以及“或”這種邏輯關(guān)系。

這個(gè)時(shí)候，就該 德摩根定律 出場(chǎng)了。通俗的說(shuō)，德摩根定律就是 not A or not B 等價(jià)于 not (A and B)。通過(guò)這樣的轉(zhuǎn)換，上面的代碼可以改寫成這樣：

if not (user.has_logged_in and user.is_from_chrome):
    return "our service is only open for chrome logged in user"

怎么樣，代碼是不是易讀了很多？記住德摩根定律，很多時(shí)候它對(duì)于簡(jiǎn)化條件分支里的代碼邏輯非常有用。

我們常說(shuō)，在 Python 里，“萬(wàn)物皆對(duì)象”。其實(shí)，不光“萬(wàn)物皆對(duì)象”，我們還可以利用很多魔法方法（文檔中稱為：user-defined method），來(lái)自定義對(duì)象的各種行為。我們可以用很多在別的語(yǔ)言里面無(wú)法做到、有些魔法的方式來(lái)影響代碼的執(zhí)行。

比如，Python 的所有對(duì)象都有自己的“布爾真假”：

布爾值為假的對(duì)象：None, 0, False, [], (), {}, set(), frozenset(), ... ...

布爾值為真的對(duì)象：非 0 的數(shù)值、True，非空的序列、元組，普通的用戶類實(shí)例，... ...

通過(guò)內(nèi)建函數(shù) bool()，你可以很方便的查看某個(gè)對(duì)象的布爾真假。而 Python 進(jìn)行條件分支判斷時(shí)用到的也是這個(gè)值：

>>> bool(object())
True

重點(diǎn)來(lái)了，雖然所有用戶類實(shí)例的布爾值都是真。但是 Python 提供了改變這個(gè)行為的辦法：自定義類的__bool__ 魔法方法 （在 Python 2.X 版本中為 __nonzero__）。當(dāng)類定義了 bool 方法后，它的返回值將會(huì)被當(dāng)作類實(shí)例的布爾值。

另外，__bool__ 不是影響實(shí)例布爾真假的唯一方法。如果類沒(méi)有定義 bool 方法，Python 還會(huì)嘗試調(diào)用 len 方法（也就是對(duì)任何序列對(duì)象調(diào)用 len 函數(shù)），通過(guò)結(jié)果是否為 0 判斷實(shí)例真假。

那么這個(gè)特性有什么用呢？看看下面這段代碼：

class UserCollection(object):

    def __init__(self, users):
        self._users = users


users = UserCollection([piglei, raymond])

if len(users._users) > 0:
    print("There"s some users in collection!")

上面的代碼里，判斷 UserCollection 是否有內(nèi)容時(shí)用到了 users._users 的長(zhǎng)度。其實(shí)，通過(guò)為 UserCollection 添加 len 魔法方法，上面的分支可以變得更簡(jiǎn)單：

class UserCollection:

    def __init__(self, users):
        self._users = users

    def __len__(self):
        return len(self._users)


users = UserCollection([piglei, raymond])

# 定義了 __len__ 方法后，UserCollection 對(duì)象本身就可以被用于布爾判斷了
if users:
    print("There"s some users in collection!")

通過(guò)定義魔法方法 len 和 bool ，我們可以讓類自己控制想要表現(xiàn)出的布爾真假值，讓代碼變得更 pythonic。

all() 和 any() 兩個(gè)函數(shù)非常適合在條件判斷中使用。這兩個(gè)函數(shù)接受一個(gè)可迭代對(duì)象，返回一個(gè)布爾值，其中：

all(seq)：僅當(dāng) seq 中所有對(duì)象都為布爾真時(shí)返回 True，否則返回 False

any(seq)：只要 seq 中任何一個(gè)對(duì)象為布爾真就返回 True，否則返回 False

假如我們有下面這段代碼：

def all_numbers_gt_10(numbers):
    """僅當(dāng)序列中所有數(shù)字大于 10 時(shí)，返回 True
    """
    if not numbers:
        return False

    for n in numbers:
        if n <= 10:
            return False
    return True

如果使用 all() 內(nèi)建函數(shù)，再配合一個(gè)簡(jiǎn)單的生成器表達(dá)式，上面的代碼可以寫成這樣：

def all_numbers_gt_10_2(numbers):
    return bool(numbers) and all(n > 10 for n in numbers)

簡(jiǎn)單、高效，同時(shí)也沒(méi)有損失可用性。

讓我們看看這個(gè)函數(shù)：

def do_stuff():
    first_thing_successed = False
    try:
        do_the_first_thing()
        first_thing_successed = True
    except Exception as e:
        print("Error while calling do_some_thing")
        return

    # 僅當(dāng) first_thing 成功完成時(shí)，做第二件事
    if first_thing_successed:
        return do_the_second_thing()

在函數(shù) do_stuff 中，我們希望只有當(dāng) do_the_first_thing() 成功調(diào)用后（也就是不拋出任何異常），才繼續(xù)做第二個(gè)函數(shù)調(diào)用。為了做到這一點(diǎn)，我們需要定義一個(gè)額外的變量 first_thing_successed 來(lái)作為標(biāo)記。

其實(shí)，我們可以用更簡(jiǎn)單的方法達(dá)到同樣的效果：

def do_stuff():
    try:
        do_the_first_thing()
    except Exception as e:
        print("Error while calling do_some_thing")
        return
    else:
        return do_the_second_thing()

在 try 語(yǔ)句塊最后追加上 else 分支后，分支下的do_the_second_thing() 便只會(huì)在 try 下面的所有語(yǔ)句正常執(zhí)行（也就是沒(méi)有異常，沒(méi)有 return、break 等）完成后執(zhí)行。

類似的，Python 里的 for/while 循環(huán)也支持添加 else 分支，它們表示：當(dāng)循環(huán)使用的迭代對(duì)象被正常耗盡、或 while 循環(huán)使用的條件變量變?yōu)?False 后才執(zhí)行 else 分支下的代碼。

在 Python 中，有兩種比較變量的方法：== 和 is，二者在含義上有著根本的區(qū)別：

==：表示二者所指向的的值是否一致

is：表示二者是否指向內(nèi)存中的同一份內(nèi)容，也就是 id(x) 是否等于 id(y)

None 在 Python 語(yǔ)言中是一個(gè)單例對(duì)象，如果你要判斷某個(gè)變量是否為 None 時(shí)，記得使用 is 而不是 ==，因?yàn)橹挥?is 才能在嚴(yán)格意義上表示某個(gè)變量是否是 None。

否則，可能出現(xiàn)下面這樣的情況：

>>> class Foo(object):
...     def __eq__(self, other):
...         return True
...
>>> foo = Foo()
>>> foo == None
True

在上面代碼中，F(xiàn)oo 這個(gè)類通過(guò)自定義 eq 魔法方法的方式，很容易就滿足了 == None 這個(gè)條件。

所以，當(dāng)你要判斷某個(gè)變量是否為 None 時(shí)，請(qǐng)使用 is 而不是 ==。

看看下面這兩個(gè)表達(dá)式，猜猜它們的值一樣嗎？

>>> (True or False) and False
>>> True or False and False

答案是：不一樣，它們的值分別是 False 和 True，你猜對(duì)了嗎？

問(wèn)題的關(guān)鍵在于：and 運(yùn)算符的優(yōu)先級(jí)大于 or。因此上面的第二個(gè)表達(dá)式在 Python 看來(lái)實(shí)際上是 True or (False and False)。所以結(jié)果是 True 而不是 False。

在編寫包含多個(gè) and 和 or 的表達(dá)式時(shí)，請(qǐng)額外注意 and 和 or 的運(yùn)算優(yōu)先級(jí)。即使執(zhí)行優(yōu)先級(jí)正好是你需要的那樣，你也可以加上額外的括號(hào)來(lái)讓代碼更清晰。

以上就是『Python 工匠』系列文章的第二篇。不知道文章的內(nèi)容是否對(duì)你的胃口。

代碼內(nèi)的分支語(yǔ)句不可避免，我們?cè)诰帉懘a時(shí)，需要尤其注意它的可讀性，避免對(duì)其他看到代碼的人造成困擾。

看完文章的你，有沒(méi)有什么想吐槽的？請(qǐng)留言告訴我吧。

問(wèn)答
初學(xué)Python代碼問(wèn)題
相關(guān)閱讀
Python | 四種運(yùn)行其他程序的黑科技
Python | 21行輕松搞定拼寫檢查器
Python | 自動(dòng)生成表情包，從此斗圖無(wú)敵手！ 
【每日課程推薦】機(jī)器學(xué)習(xí)實(shí)戰(zhàn)！快速入門在線廣告業(yè)務(wù)及CTR相應(yīng)知識(shí)

此文已由作者授權(quán)騰訊云+社區(qū)發(fā)布，更多原文請(qǐng)點(diǎn)擊

搜索關(guān)注公眾號(hào)「云加社區(qū)」，第一時(shí)間獲取技術(shù)干貨，關(guān)注后回復(fù)1024 送你一份技術(shù)課程大禮包！

海量技術(shù)實(shí)踐經(jīng)驗(yàn)，盡在云加社區(qū)！