Python 3 | 重构

你经常会遇到这样的情况：代码能够正确地运行，但可做进一步的改进——将代码划分为一系列完成具体工作的函数。这样的过程被称为重构 。重构让代码更清晰、更易于理 解、更容易扩展。

以下remember_me程序：

import json
# 如果以前存储了用户名，就加载它
# 否则，就提示用户输入用户名并存储它
filename = 'username.json'
try:
    with open(filename) as f_obj:
        username = json.load(f_obj)
except FileNotFoundError:
    username = input("What is your name? ")
    with open(filename, 'w') as f_obj:
        json.dump(username, f_obj)
        print("We'll remember you when you come back, " + username + "!")
else:
    print("Welcome back, " + username + "!")

尝试打开文件username.json。如果这个文件存在，就将其中的用户名读取到内存中， 再执行else 代码块，即打印一条欢迎用户回来的消息。用户首次运行这个程序时，文件username.json不存在，将引发FileNotFoundError 异常，因此Python将执 行except 代码块：提示用户输入其用户名，再使用json.dump() 存储该用户名，并打印一句问候语。 无论执行的是except 代码块还是else 代码块，都将显示用户名和合适的问候语。如果这个程序是首次运行，输出将如下：

What is your name? Zina
We'll remember you when you come back, Zina!

否则，输出将如下：

Welcome back, Zina!

要重构remember_me.py，可将其大部分逻辑放到一个或多个函数中。remember_me.py的重点是问候用户，因此我们将其所有代码都放到一个名为greet_user() 的函数中：

remember.py:

import json
def greet_user():
 """问候用户，并指出其名字"""
filename = 'username.json'
try:
    with open(filename) as f_obj:
        username = json.load(f_obj)
except FileNotFoundError:
    username = input("What is your name? ")
    with open(filename, 'w') as f_obj:
        json.dump(username, f_obj)
        print("We'll remember you when you come back, " + username + "!")
else:
    print("Welcome back, " + username + "!")
greet_user()

这个程序更清晰些，但函数greet_user() 所做的不仅仅是问候用 户，还在存储了用户名时获取它，而在没有存储用户名时提示用户输入一个。 下面来重构greet_user() ，让它不执行这么多任务。为此，我们首先将获取存储的用户名的代码移到另一个函数中：

import json
def get_stored_username():
    """如果存储了用户名，就获取它"""
    filename = 'username.json'
    try:
        with open(filename) as f_obj:
            username = json.load(f_obj)
    except FileNotFoundError:
            return None
    else:
        return username

def greet_user():
    """问候用户，并指出其名字"""
    username = get_stored_username()
    if username:
        print("Welcome back, " + username + "!")
    else:
        username = input("What is your name? ")
        filename = 'username.json'
        with open(filename, 'w') as f_obj:
            json.dump(username, f_obj)
            print("We'll remember you when you come back, " + username + "!")

greet_user()

新增的函数get_stored_username() 目标明确，文档字符串指出了这一点。如果存储了用户名，这个函数就获取并返回它；如果文件username.json不存在，这个函数 就返回None 。这是一种不错的做法：函数要么返回预期的值，要么返回None ；这能够使用函数的返回值做简单测试。

如果成功地获取了用户名，就打 印一条欢迎用户回来的消息，否则就提示用户输入用户名。 还需将greet_user() 中的另一个代码块提取出来：将没有存储用户名时提示用户输入的代码放在一个独立的函数中：

import json
def get_stored_username():
    """如果存储了用户名，就获取它"""
    filename = 'username.json'
    try:
        with open(filename) as f_obj:
            username = json.load(f_obj)
    except FileNotFoundError:
            return None
    else:
        return username
def get_new_username():
    """提示用户输入用户名"""
    username = input("What is your name? ")
    filename = 'username.json'
    with open(filename, 'w') as f_obj:
        json.dump(username, f_obj)
        return username
def greet_user():
    """问候用户，并指出其名字"""
    username = get_stored_username()
    if username:
        print("Welcome back, " + username + "!")
    else:
        username = get_new_username()
        print("We'll remember you when you come back, " + username + "!")

greet_user()

在remember_me.py的这个最终版本中，每个函数都执行单一而清晰的任务。

• 调用greet_user() ，它打印一条合适的消息：要么欢迎老用户回来，要么问候新用户。
• 它首先调用get_stored_username() ，这个函数只负责获取存储的用户名（如果存储了的话）。
• 再在必要时调用get_new_username() ，这个函数只负责获取并存储新用户的用户名。

要编写出清晰而易于维护和扩展的代码，这种划分工作必不可少。