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() #调用函数，打印问候语

代码重构的意义在于，简化同一个代码块的任务量，让代码更容易读懂。