python之代碼重構

在擼碼過程中，總有很多代碼需要重構，碼一個問候用戶的小例子，加深對代碼重構的印象。

原始代碼：

import json

filename = 'username.json' #定義文件名

try:
    with open(filename) as file_object:
        username = json.load(file_object) #加載存儲的用戶名，如果有的話

except FileNotFoundError: 
    username = input("what is your name: ")
    with open(filename,'w') as file_object: #以寫入的方式打開文件filename
        json.dump(username,file_object) #將username寫入到文件對象中
        print("We will remember you when you back " +username + "!") #打印問候語

else:
    print("Welcome back, " + username + "!") #打印問候語

代碼重構1，將代碼全部封裝到一個函數里面：

import json

'''定義函數，用於代碼封裝'''
def greet_user():
    filename = 'username.json'
    try:
        with open(filename) as file_object:
            username = json.load(file_object)

    except FileNotFoundError:
        username = input("What is your name: ")
        with open(filename,'w') as file_object:
            json.dump(username,file_object)
            print("We will remember you when you back, " + username + "!")

    else:
        print("Welcome back, " + username + "!")

greet_user() #調用函數問候

代碼重構2，將代碼重構1的函數進一步拆分，讓函數greet_user()不執行那么多任務，我們將獲取存儲的用戶名的代碼寫到另一個get_stored_user()函數中。

import json


def get_stored_user():
    filename = 'username.json'
    try:
        with open(filename) as file_object:
            username = json.load(file_object)

    except FileNotFoundError:
        return None

    else:
        return username


def greet_user():
    username = get_stored_user()
    if username:
        print("Welcome back " + username + "!")
    else:
        username = input("What is your name: ")
        filename = 'username.json'
        with open(filename,'w') as file_object:
            json.dump(username,file_object)
            print("We will remember you when you back, " + username + "!")
 
greet_user() #調用函數問候

代碼重構3，由於最終的目的是問候用戶，我們可以將重構2里的代碼進一步拆分，將沒有用戶名的時候提示輸入用戶名的代碼存儲在另外一個函數中。

import json

def get_stored_user():
    '''定義函數以獲取存儲了的用戶名'''
    filename = 'username.json'
    try:
        with open(filename) as file_object:
            username = json.load(file_object)
    except FileNotFoundError:
        return None
    else:
        return username #返回用戶名

def get_new_user():
    '''定義函數以獲取用戶輸入'''
    username = input("What is your name: ")
    filename = 'username.json'
    with open(filename,'w') as file_object:
        json.dump(username,file_object)

    return username #返回用戶名

def greet_user():
    '''定義函數問候用戶'''
    username = get_stored_user()
    if username:
        print("Welcome back, " + username + "!")
    else:
        username = get_new_user()
        print("We will remember you when you back, " + username + "!")

greet_user() #調用函數，打印問候語

代碼重構的意義在於，簡化同一個代碼塊的任務量，讓代碼更容易讀懂。