重构 Python 代码系列之一

前言

对自己写的冗长代码，想重构但又无思路？这里整理了系列介绍python代码重构优化的方法，助你一臂之力。这是 Python 重构系列的第一部分，系列文章会陆续推出。

---

1.将for循环转换为list/dictionary/set 表达式

我们在时经常遇到的一个情况是，创建一个值的集合。

比如我们创建一个列表，然后迭代地用值填充它，这里我们想创建一个立方数字的列表。大多数语言的标准方法如下：

cubes = []
for i in range(20):
    cubes.append(i ** 3)

在Python中，我们可以使用列表表达式，生成需要的数据。就可以将代码简化为一行，省去定义列表，然后再去填充列表的略显繁琐的操作。

cubes = [i ** 3 for i in range(20)]

看，我们已经将三行代码转换成一行，这无疑是不错的选择——你的眼睛不用上下左右的检查代码。

把代码压缩到一行会使阅读变得更加困难，但对于推导表达式来说，情况并非如此。您需要的所有元素都被很好地呈现出来，一旦您习惯了语法，它实际上比for循环版本更具可读性。

另一点是赋值现在更像是一个原子操作——我们声明什么是cubes，而不是给出如何构建它的指令。这使得代码读起来更舒适，因为我们关心变量cubes是什么，而不是它的构造细节。

最后，表达式通常比在循环中构建集合更快，如果考虑性能，这也是重要因素。

2.用增量赋值替换赋值

增量赋值是一种快速而简单的Python语法。
只要有这样的代码：

count = count + other_value

都可以替换成下面的代码：

count += other_value

代码是简短和清晰的-我们不需要考虑计数变量两次。其他可以使用的运算符包括-=，*=，/=和**=。

不过有件事需要稍微小心一点，你要分配给的类型必须定义适当的运算符。例如，numpy数组不支持/=操作。

3.只使用一次的内联变量

我们在人们的代码中经常看到的一种情况是将结果赋给临时变量，然后立即返回它。

def state_attributes(self):
    """Return the state attributes."""
    state_attr = {
        ATTR_CODE_FORMAT: self.code_format,
        ATTR_CHANGED_BY: self.changed_by,
    }
    return state_attr

其实更好的方法是直接返回结果，而不是再用一个临时变量存放结果

def state_attributes(self):
    """Return the state attributes."""
    return {
        ATTR_CODE_FORMAT: self.code_format,
        ATTR_CHANGED_BY: self.changed_by,
    }

这样可以缩短代码并删除不必要的变量，从而减少阅读代码的脑力消耗。

临时变量可能有用的地方是，如果它们被用作参数或条件，并且名称可以代表内容。在上面的例子中，返回的是state属性，并且state_attr没有提供任何额外的信息。因此不必将结果赋给临时变量。

4.用if表达式替换if语句

经常会遇到的一种情况是，您经常希望将一个变量设置为两个不同值中的一个。

if condition:
    x = 1
else:
    x = 2

这可以使用Python的条件表达式语法（python的三元运算符版本）在一行上编写：

x = 1 if condition else 2

这肯定更简洁，但它是一个更有争议的重构（就像列表表达式）。一些程序员不喜欢这样的表达式，因为觉得它们比完全写出if条件更难解析。

我们的观点是，只要条件表达式很短并且适合合并，那就是一种改进，提升效率。与列表表达式的示例类似，当我们阅读代码时，通常不需要知道x是如何分配的，只需看到它被赋值，然后继续向前。

5.用生成器代替不需要的表达式

一个技巧是像any、all和sum这样的函数允许传入generator而不是collection。这意味着，与其这样做：

hat_found = any([is_hat(item) for item in wardrobe])

可以将代码改成：

hat_found = any(is_hat(item) for item in wardrobe)

这将删除一对括号，使代码稍微清晰一些。如果any函数找到结果，会立即返回，而不必构建整个列表。这可以导致性能提升。

请注意，我们实际上是将生成器传递到any（）中，严格地说，代码应该如下所示：

hat_found = any((is_hat(item) for item in wardrobe))

但是Python允许您省略这对括号。下面是接受generator的标准库函数：

'all', 'any', 'enumerate', 'frozenset', 'list', 'max', 'min', 'set', 'sum', 'tuple'

6.将条件简化为return语句

最后介绍的重构技巧是，函数需要返回结果是True或False的情况。一种常见的方法是：

def function():
    if isinstance(a, b) or issubclass(b, a):
        return True
    return False

但是，直接返回结果会更简洁，如下所示：

def function():
    return isinstance(a, b) or issubclass(b, a)

只有当表达式的计算结果为布尔值时，才能这样操作。例如

def any_hats():
    hats = [item for item in wardrobe if is_hat(item)]
    if hats or self.wearing_hat():
        return True
    return False

这个示例，可以通过bool()将hat和self.wearing_hat()合成bool列表，就可以消除if条件，达到简化程序的目的。

def any_hats():
    hats = [item for item in wardrobe if is_hat(item)]
    return bool(hats or self.wearing_hat())

真诚邀请您关注「数学与程序」，您的关注是我不断创作的源泉！