掌握設(shè)計(jì)優(yōu)雅返回結(jié)果的函數(shù)的藝術(shù)

在開發(fā)解決方案時(shí)，我們傾向于將復(fù)雜的實(shí)際問題提煉為更小、更易于管理的子問題，然后使用函數(shù)來解決這些問題。函數(shù)是冗余代碼的克星，也是我們抵御代碼復(fù)雜性的最強(qiáng)防線。

大多數(shù)函數(shù)在編寫過程中，關(guān)鍵是其返回值。函數(shù)產(chǎn)生結(jié)果的方式會(huì)極大地影響用戶調(diào)用函數(shù)時(shí)的體驗(yàn)。掌握設(shè)計(jì)優(yōu)雅返回結(jié)果的函數(shù)的藝術(shù)是制作高質(zhì)量函數(shù)的基礎(chǔ)。

不要返回多種類型

Python 是如此的靈活，以至于我們可以很容易地做到在其他語言中很難做到的事情。例如：讓函數(shù)同時(shí)返回不同類型的結(jié)果。就像下面這樣：

def get_users(user_id=None):
    if user_id is not None:
        return User.get(user_id)
    else:
        return User.filter(is_active=True)
# Return single user
get_users(user_id=1)
# Return all users
get_users()

在上面的代碼片段中，當(dāng)我們需要獲取單個(gè)用戶時(shí)，我們傳遞一個(gè) "user_id " 參數(shù)，否則，如果我們傳遞一個(gè) None 值，它將返回所有活躍用戶的列表。乍一看，這種設(shè)計(jì)似乎很合理。

但是，編寫類似功能強(qiáng)大的函數(shù)并不是一件好事。這是因?yàn)閮?yōu)秀的函數(shù)必須具有 單一職責(zé)。所謂 "單一職責(zé)"，是指一個(gè)函數(shù)只做好一件事，而且目的明確。這樣的函數(shù)將來也不太可能隨著需求的變化而修改，同時(shí)也非常方便編寫單元測(cè)試。

返回多種類型的函數(shù)違反了 "單一職責(zé) "原則。一個(gè)好的函數(shù)應(yīng)始終提供一個(gè)穩(wěn)定的返回值，以盡量減少調(diào)用者的處理成本。就像上面的例子，我們應(yīng)該編寫兩個(gè)獨(dú)立的函數(shù) get_active_users() 和 get_user_by_id(user_id)。

使用類型提示定義返回類型

使用類型提示定義返回類型和顯式參數(shù)聲明。這樣，集成開發(fā)環(huán)境就能幫助您進(jìn)行自動(dòng)補(bǔ)全和類型檢查，從而在編輯的時(shí)候就發(fā)現(xiàn)錯(cuò)誤。

例如：

def say_hello(name: str) -> str:
    return "Hello, " + name

-> 語法表示 say_hello() 函數(shù)將返回一個(gè)字符串。

使用部分函數(shù)構(gòu)造新函數(shù)

假設(shè)在這種情況下，您的代碼中有一個(gè)帶有很多參數(shù)的函數(shù) A，它非常適用。另一個(gè)函數(shù) B 調(diào)用 A 做一些工作，就像下面這樣：

def add(x, y):
    return x + y


def sum(value):
    # Calling add
    return add(100, value)

在上述示例中，我們可以使用 functools 模塊中的 partial() 函數(shù)來簡(jiǎn)化它。

import functools

sum = functools.partial(add, 100)
sum(200)  # Output is 300

partial(func,*args,**kwargs) 以傳入的函數(shù)為基礎(chǔ)，使用變量參數(shù)構(gòu)造一個(gè)新函數(shù)。在合并當(dāng)前調(diào)用參數(shù)和構(gòu)造參數(shù)后，對(duì)新函數(shù)的所有調(diào)用都將委托給原始函數(shù)。

因此，在使用部分函數(shù)時(shí)，可以將上面的求和函數(shù)定義修改為單行表達(dá)式，這樣會(huì)更加簡(jiǎn)潔和直接。

拋出異常而不是返回錯(cuò)誤

有時(shí)，您可能需要編寫同時(shí)返回結(jié)果和錯(cuò)誤信息的函數(shù)：

def create_user(name):
    if len(name) > MAX_LENGTH_OF_NAME:
        return None, 'name of user is too long'
    if len(CURRENT_USERS) > MAX_USERS_QUOTA:
        return None, 'too many users'
    return User(name=name), ''def create_from_input():
    name = input()
    user, err_msg = create_user(name)
    if err_msg:
        print(f'create user failed: {err_msg}')
    else:
        print(f'user<{name}> created')

在上例中，create_user 函數(shù)的作用是創(chuàng)建一個(gè)新的用戶對(duì)象。同時(shí)，為了在發(fā)生錯(cuò)誤時(shí)向調(diào)用者提供錯(cuò)誤詳細(xì)信息，它利用了多返回值特性，將錯(cuò)誤信息作為第二個(gè)結(jié)果返回。

但在 Python 中，這并不是解決此類問題的最佳方法。因?yàn)檫@種做法會(huì)增加調(diào)用者處理錯(cuò)誤的成本，尤其是當(dāng)許多函數(shù)都遵循這種規(guī)范，并且存在多層調(diào)用時(shí)。

在這種情況下，使用異常來處理錯(cuò)誤過程是更習(xí)以為常的做法。因此，上述代碼可以重寫為：

class CreateUserError(Exception):
    """Exception for user creation failure"""
    pass

def create_user(name):
    """Create new user

    :raises: CreateUserError
    """
    if len(name) > MAX_LENGTH_OF_NAME:
        raise CreateUserError('name of user is too long')
    if len(CURRENT_USERS) > MAX_USERS_QUOTA:
        raise CreateUserError('Too many users')
    return User(name=name)


def create_for_input():
    name = input()
    try:
        user = create_user(name)
    except CreateUserError as e:
        print(f'create user failed: {e}')
    else:
        print(f'user<{name}> created')

在使用拋出異常而不是返回結(jié)果、錯(cuò)誤信息后，整個(gè)錯(cuò)誤處理過程乍一看變化不大，但實(shí)際上在一些細(xì)節(jié)上有很大不同：

• 新版函數(shù)的返回值類型更加穩(wěn)定，它將始終只返回用戶類型或拋出異常。

• 異常與返回值的不同之處在于，異常在被捕獲之前會(huì)不斷向調(diào)用棧的上層報(bào)告。因此，create_user 的一級(jí)調(diào)用者可以完全省略異常處理，將其留給上層處理。

盡量少返回 None

None 常被用來表示應(yīng)該存在但缺少的東西，在 Python 中是獨(dú)一無二的。由于 None 獨(dú)特的虛無主義特質(zhì)，它經(jīng)常被用作函數(shù)返回值。

當(dāng)我們使用 None 作為函數(shù)的返回值時(shí)，通常有以下三種情況。

• 作為操作類函數(shù)的默認(rèn)返回值：當(dāng)操作類函數(shù)不需要任何返回值時(shí)，通常會(huì)返回 None。此外，對(duì)于沒有任何返回語句的函數(shù)，None 也是默認(rèn)返回值。例如，list.append()。

• 作為某個(gè)可能不存在的預(yù)期值：在 Python 標(biāo)準(zhǔn)庫(kù)中，正則表達(dá)式模塊下的函數(shù) re 就屬于這一類。例如，re.search 和 re.match。

• 作為代表錯(cuò)誤結(jié)果的值：有時(shí)，當(dāng)函數(shù)調(diào)用失敗時(shí)，我們經(jīng)常使用 None 作為默認(rèn)返回值。如果是這種情況，請(qǐng)確保您的函數(shù)名稱更有意義，例如 create_user_or_none()。

限制遞歸的使用

當(dāng)函數(shù)返回調(diào)用自身時(shí)，這就是遞歸。遞歸在某些情況下是非常有用的編程技巧，但 Python 對(duì)遞歸的支持非常有限。

Python 語言不支持尾部遞歸優(yōu)化。此外，Python 對(duì)遞歸級(jí)別的最大數(shù)量也有嚴(yán)格限制。所以要盡可能少寫遞歸。如果您想用遞歸來解決問題，首先要考慮是否可以用循環(huán)來輕松替代遞歸。如果答案是肯定的，那就用循環(huán)重寫。如果絕對(duì)必須使用遞歸，請(qǐng)考慮以下幾點(diǎn)：

• 確保遞歸層小于 sys.getrecursionlimit()。

• 盡可能使用緩存，例如 functools.lru_cache。

以上就是抵御代碼復(fù)雜性使python函數(shù)更加Pythonic技巧示例詳解的詳細(xì)內(nèi)容，更多關(guān)于python函數(shù)Pythonic的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論