06 Python 類實戰

阿新 • • 發佈：2020-06-25

還是以我們之前做過的，通訊錄功能為例，這節課我們繼續對通訊錄功能使用類進行改造：

1. 通訊錄功能簡介

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

增加聯絡人: 使用者輸入姓名、地址、電話等資訊，將資訊儲存在一個列表中
列出聯絡人: 列印輸出所有聯絡人的資訊
查詢聯絡人: 使用者輸入聯絡人姓名，列印輸出該聯絡人的資訊
刪除聯絡人: 使用者輸入聯絡人姓名，從通訊錄中刪除該聯絡人

通過命令列介面實現以上功能，程式 addressBook.py 執行時首先列印一個選單，如下所示：

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

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

數字選項	功能描述
1. create person	增加聯絡人
2. list all persons	列出聯絡人
3. query person	查詢聯絡人
4. delete person	刪除聯絡人
5. quit	退出通訊錄程式

2. 程式框架

2.1 描述單個聯絡人的資料結構

程式使用字典描述一個聯絡人，假設某個聯絡人的資訊如下：

姓名	地址	電話
張三	南京	12306

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

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

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

2.2 描述所有聯絡人的資料結構

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

姓名	地址	電話
張三	南京	12306
李四	王五	10086

本節使用面向物件的上設計方法實現通訊錄，使用一個類 AddressBook 描述通訊錄，類 AddressBook 的核心成員是一個列表，該列表儲存了所有聯絡人, 程式碼如下：

class AddressBook:
    def __init__(self):
        self.persons = []

    def addPerson(person):
        self.person.append(person)

addressBook = AddressBook()
zhangSan = {'name': '張三', 'address': '南京', 'phone': '12306'}
liSi = {'name': '李四', 'address': '北京', 'phone': '10086'}
addressBook.addPerson(zhangSan)
addressBook.addPerson(lisi)

在第 1 行，定義了類 AddressBook 描述通訊錄
- 在第 3 行，定義了成員變數 persons，它是一個列表，記錄了所有的聯絡人
- 在第 5 行，定義了成員方法 addPerson，它將單個聯絡人加入到聯絡人列表中
在第 8 行，使用類 AdressBook 建立一個物件
建立兩個聯絡人
- 在第 9 行，變數 zhangSan 的型別是一個字典，描述了張三的資訊
- 在第 10 行，變數 liSi 的型別是一個字典，描述了李四的資訊
將聯絡人新增到通訊錄中
- 在第 11 行，將聯絡人 zhangSan 新增到通訊錄中
- 在第 12 行，將聯絡人 liSi 新增到通訊錄中

2.3 類 AddressBook 的主要成員方法

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

功能模組	成員方法
增加聯絡人	create_person
列出聯絡人	list_person
查詢聯絡人	query_person
刪除聯絡人	delete_person

使用 4 個成員方法實現相應的功能，這裡先寫出成員方法的定義，暫時忽略實現，程式碼如下：

class AddressBook:
    def __init__(self):
        self.persons = []

    def create_person(self):
        pass

    def list_person(self):
        pass

    def query_person(self):
        pass

    def delete_person(self):
        pass

2.4 主控模組

本節完成程式的主功能模組 main，函式 main 的功能邏輯如下：

獲取使用者輸入的選擇
根據使用者的選擇執行對應的功能
重複執行第 1 步的操作

函式 main 的實現程式碼如下：

def get_choice():
    pass

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

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

main()

在第 1 行，定義了函式 get_choice，該函式列印功能選單並讀取使用者的選擇
在第 4 行，定義了函式 main，該函式讀取使用者選擇，並執行相應功能
在第 5 行，使用類 AdressBook 建立一個物件 addressBook
在第 6 行，建立一個 while 死迴圈
- 在第 7 行，使用 get_choice() 函式獲取使用者輸入的選擇
- 在第 9 行至第 20 行，根據 choice 執行物件 addressBook 相應的成員方法
- 在第 18 行，如果 choice == ‘5’，則執行 break 退出程式

2.5 獲取使用者輸入

編寫函式 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(self):
        name = input('name: ')
        address = input('address: ')
        phone = input('phone: ')
        person = {'name': name,  'address': address, 'phone': phone}
        self.persons.append(person)

在第 1 行，定義函式 create_person，該函式實現增加聯絡人的功能
在第 2 行，獲取使用者輸入的 name
在第 3 行，獲取使用者輸入的 address
在第 4 行，獲取使用者輸入的 phone
在第 5 行，根據使用者輸入的 name、address、phone 建立一個字典，用於描述該聯絡人
在第 6 行，將聯絡人加入到 self.persons 中

4. 列出聯絡人

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

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

在第 1 行，定義函式 list_person，實現列出所有聯絡人的功能
在第 2 行，遍歷列表 self.persons，迴圈變數 self.persons 是一個字典
在第 3 行，列印變數 person 的內容

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

C:\> python addressBook.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(self):
        name = input('name: ')
        for person in self.persons:
            if person['name'] == name:
                print('%s,%s,%s' % (person['name'], person['address'], person['phone']))

在第 1 行，定義函式 query_person，實現查詢聯絡人的功能
在第 2 行，獲取使用者輸入的 name
在第 3 行，遍歷列表 self.persons，迴圈變數 self.persons 是一個字典
在第 4 行，如果使用者輸入的 name 和迴圈訪問 person 的 name 相同，則表示找到指定的 person
在第 5 行，列印變數 person 的內容

6. 刪除聯絡人

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

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

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

7. 完整的程式

案例演示預覽複製複製成功！

class AddressBook:
    def __init__(self):
        self.persons = []

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

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

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

    def delete_person(self):
        name = input('name: ')
        for person in self.persons:
            if person['name'] == name:
                self.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():
    addressBook = AddressBook()
    while True:
        choice = get_choice()

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

main()