Python 函數實戰

模塊化程序設計是指在進行程序設計時將一個大程序按照功能劃分為若干小程序模塊，每個小程序模塊完成一個確定的功能，并在這些模塊之間建立必要的聯系，通過模塊的互相協作完成整個功能的程序設計方法。

在設計較復雜的程序時，一般采用自頂向下的方法，將問題劃分為幾個部分，各個部分再進行細化，直到分解為較好解決問題為止。

采用模塊化設計編寫程序時，不是一開始就逐條編寫程序代碼，而是首先用主程序、子程序等框架把軟件的主要結構和流程描述出來。以功能塊為單位進行程序設計，實現其求解算法的方法稱為模塊化。

利用函數，不僅可以實現程序的模塊化，使得程序設計更加簡單和直觀，從而提高了程序的易讀性和可維護性，而且還可以把程序中經常用到的一些計算或操作編寫成通用函數，以供隨時調用。

本小節實現一個通訊錄管理程序。在前面章節中，程序的各項功能代碼全部集中在一個代碼段中，程序的結構不清晰。本小節使用函數來實現程序，采用模塊化的程序設計方法：

• 劃分通訊錄程序的功能模塊，使用函數實現相應的功能
• 首先實現整體框架，然后再細化每個功能細節
• 最終的程序由多個函數構成，每個函數實現一個單一的功能，整個程序的結構清晰

1. 通訊錄功能簡介

編寫程序 addr-manage.py 實現通訊錄管理系統，通訊錄包含若干聯系人，每個聯系人包括：姓名、地址、電話 3 項內容。程序提供 4 項基本功能：

• 增加聯系人: 用戶輸入姓名、地址、電話等信息，將信息保存在一個列表中
• 列出聯系人: 打印輸出所有聯系人的信息
• 查詢聯系人: 用戶輸入聯系人姓名，打印輸出該聯系人的信息
• 刪除聯系人: 用戶輸入聯系人姓名，從通訊錄中刪除該聯系人

通過命令行界面實現以上功能，程序 addr-manage.py 運行時首先打印一個菜單，如下所示：

C:\> python addr-manage.py
1. create person
2. list all persons
3. query person
4. delete person
5. quit
Enter a number(1-5): 

總共有 5 個選項，用戶輸入對應的數字選擇相應的功能，如下表所示：

2. 程序框架

2.1 數據結構

程序使用字典描述一個聯系人，假設某個聯系人的信息如下：

使用字典描述該聯系人如下：

>>> person = {'name': '張三', 'address': '南京', 'phone': '12306'}

• 字典有三個鍵：name、address、phone
• 對應的值分別為：張三、南京、12306

程序將所有聯系人信息存儲在列表中，即通訊錄是一個列表、列表的元素是字典。假設通訊錄中有兩個人，它們的信息如下所示：

使用列表描述通訊錄如下：

>>> zhangSan = {'name': '張三', 'address': '南京', 'phone': '12306'}
>>> liSi = {'name': '李四', 'address': '北京', 'phone': '10086'}
>>> persons = [zhangSan, liSi]

• 在第 1 行，變量 zhangSan 的類型是一個字典，描述了張三的信息
• 在第 2 行，變量 liSi 的類型是一個字典，描述了李四的信息
• 在第 3 行，persons 是一個列表，存儲了 zhangSan 和 liSi 兩個聯系人

上面的代碼為了易于理解，使用了 3 行代碼描述了通訊錄。也可以使用 1 行代碼描述該通訊錄，代碼如下：

>>> persons = [{'name': '張三', 'address': '南京', 'phone': '12306'}, {'name': '李四', 'address': '北京', 'phone': '10086'}]

2.2 劃分功能模塊

分析通訊錄的功能需求，初步將程序劃分為 5 個功能模塊，如下表所示：

編寫對應的函數，這里先寫出函數的定義，暫時忽略實現，代碼如下：

persons = []

def create_person():
    pass

def list_person():
    pass

def query_person():
    pass

def delete_person():
    pass

def main():
    pass

main()    

• 在第 1 行，定義全局變量 persons，persons 是一個列表，保存了所有聯系人的信息
• 在第 3 行，定義函數 create_person，該函數實現 “增加聯系人” 的功能
• 在第 6 行，定義函數 list_person，該函數實現 “列出聯系人” 的功能
• 在第 9 行，定義函數 query_person，該函數實現 “查詢聯系人” 的功能
• 在第 12 行，定義函數 delete_person，該函數實現 “刪除聯系人” 的功能
• 在第 15 行，定義函數 main，該函數控制程序的流程，被稱為主控函數，他讀取用戶的選擇，調用相應的功能，實現對通訊錄的增、刪、查的操作
• 在第 18 行，程序啟動后，首先執行主函數 main

2.3 主功能模塊

本節完成程序的主功能模塊 main，函數 main 的功能邏輯如下：

1. 獲取用戶輸入的選擇
2. 根據用戶的選擇執行對應的功能
3. 重復執行第 1 步的操作

函數 main 的實現代碼如下：

persons = []

def get_choice():
    pass

def main():
    while True:
        choice = get_choice()

        if choice == '1':
            create_person()
        elif choice == '2':
            list_person()
        elif choice == '3':
            query_person()
        elif choice == '4':
            delete_person()
        elif choice == '5':
            break
        else:
            print('Invalid choice')  

main()                  

• 在第 1 行，創建一個空列表 persons，persons 記錄所有聯系人的信息
• 在第 3 行，定義了函數 get_choice，該函數打印功能菜單并讀取用戶的選擇
• 在第 6 行，定義了函數 main，該函數讀取用戶選擇，并執行相應功能
• 在第 7 行，創建一個 while 死循環
  • 在第 8 行，使用 get_choice() 函數獲取用戶輸入的選擇
  • 在第 10 行至第 21 行，根據 choice 選擇執行相應的功能
  • 在第 19 行，如果 choice == ‘5’，則執行 break 退出程序

2.4 獲取用戶輸入

編寫函數 get_choice 獲取用戶的選擇，代碼如下：

def get_choice():
    print('1. create person')
    print('2. list all persons')
    print('3. query person')
    print('4. delete person')
    print('5. quit')
    choice = input('Enter a number(1-5):')  
    return choice

• 在第 2 行到第 6 行，打印功能菜單
• 在第 7 行，使用 input() 函數獲取用戶輸入的選擇
• 在第 8 行，返回用戶的選擇 choice

3. 增加聯系人

本小節實現增加聯系人的功能，如下所示：

def create_person():
    name = input('name: ')
    address = input('address: ')
    phone = input('phone: ')
    person = {'name': name,  'address': address, 'phone': phone}
    persons.append(person)

• 在第 1 行，定義函數 create_person，該函數實現增加聯系人的功能
• 在第 2 行，獲取用戶輸入的 name
• 在第 3 行，獲取用戶輸入的 address
• 在第 4 行，獲取用戶輸入的 phone
• 在第 5 行，根據用戶輸入的 name、address、phone 創建一個字典，用于描述該聯系人
• 在第 6 行，將聯系人加入到 persons 中

4. 列出聯系人

本小節實現列出所有聯系人的功能，如下所示：

def list_person():
    for person in persons:
        print('%s,%s,%s' % (person['name'], person['address'], person['phone']))

• 在第 1 行，定義函數 list_person，實現列出所有聯系人的功能
• 在第 2 行，遍歷列表 persons，循環變量 person 是一個字典
• 在第 3 行，打印變量 person 的內容

對每個聯系人打印輸出一行，假設通訊錄中已經存儲了張三和李四兩個聯系人，輸出如下：

C:\> python addr-manage.py
1. create person
2. list all persons
3. query person
4. delete person
5. quit
Enter a number(1-5): 2
張三,南京,12306
李四,北京,10086

• 在第 7 行，用戶選擇執行功能 2
• 在第 8 行，打印聯系人張三的信息
• 在第 9 行，打印聯系人李四的信息

5. 查詢聯系人

本小節實現查詢聯系人的功能，如下所示：

def query_person():
    name = input('name: ')
    for person in persons:
        if person['name'] == name:
            print('%s,%s,%s' % (person['name'], person['address'], person['phone']))

• 在第 1 行，定義函數 query_person，實現查詢聯系人的功能
• 在第 2 行，獲取用戶輸入的 name
• 在第 3 行，遍歷列表 persons，循環變量 person 是一個字典
• 在第 4 行，如果用戶輸入的 name 和循環訪問 person 的 name 相同，則表示找到指定的 person
• 在第 5 行，打印變量 person 的內容

6. 刪除聯系人

本小節實現刪除聯系人的功能，如下所示：

def delete_person():
    name = input('name: ')
    for person in persons:
        if person['name'] == name:
            persons.remove(person)
            break

• 在第 1 行，定義函數 delete_person，實現刪除聯系人的功能
• 在第 2 行，獲取用戶輸入的 name
• 在第 3 行，遍歷列表 persons，循環變量 person 是一個字典
• 在第 4 行，如果用戶輸入的 name 和循環訪問 person 的 name 相同，則表示找到指定的 person
• 在第 5 行，使用方法 persons.remove(person)， 從 persons 中刪除元素 person
• 在第 6 行，退出 for 循環

7. 完整的程序

persons = []

def create_person():
    name = input('name: ')
    address = input('address: ')
    phone = input('phone: ')
    person = {'name': name,  'address': address, 'phone': phone}
    persons.append(person)

def list_person():
    for person in persons:
        print('%s,%s,%s' % (person['name'], person['address'], person['phone']))

def query_person():
    name = input('name: ')
    for person in persons:
        if person['name'] == name:
            print('%s,%s,%s' % (person['name'], person['address'], person['phone']))

def delete_person():
    name = input('name: ')
    for person in persons:
        if person['name'] == name:
            persons.remove(person)
            break                    

def get_choice():
    print('1. create person')
    print('2. list all persons')
    print('3. query person')
    print('4. delete person')
    print('5. quit')
    choice = input('Enter a number(1-5):')  
    return choice

def main():
    while True:
        choice = get_choice()

        if choice == '1':
            create_person()
        elif choice == '2':
            list_person()
        elif choice == '3':
            query_person()
        elif choice == '4':
            delete_person()
        elif choice == '5':
            break
        else:
            print('Invalid choice')  

main()       

8. 小結

這節課我們通過使用函數的方式來改寫了我們之前所設計的通訊錄功能，可以把這一小節的代碼和之的代碼做一下比對，看一下函數式編程與普通編程范式有何不同。