[Python] 使用一等函数实现设计模式

《流畅的Python》卢西亚诺·拉马略 第6章 使用一等函数实现设计模式  读书笔记

6.1 案例分析：重构“策略”模式

如果合理利用作为一等对象的函数，某些设计模式可以简化，“策略”模式就是其中一个例子。

6.1.1 经典的“策略”模式

《设计模式：可复用面向对象软件的基础》一书是这样概述“策略”模式的：
定义一系列算法，把它们一一封装起来，并且使它们可以相互替换。本模式使得算法可以独立于使用它的客户而变化。电商领域有个功能明显可以使用“策略”模式，即根据客户的属性或订单中的商品计算折扣。

上下文
把一些计算委托给实现不同算法的可互换组件，它提供服务。在这个电商示例中，上下文是 Order，它会根据不同的算法计算促销折扣。
策略
实现不同算法的组件共同的接口。在这个示例中，名为 Promotion的抽象类扮演这个角色。
具体策略
策略的具体子类。fidelityPromo、BulkPromo 和LargeOrderPromo 是这里实现的三个具体策略。

假如一个网店制定了下述折扣规则，假定一个订单一次只能享用一个折扣
有 1000 或以上积分的顾客，每个订单享 5% 折扣。
同一订单中，单个商品的数量达到 20 个或以上，享 10% 折扣。
订单中的不同商品达到 10 个或以上，享 7% 折扣。

【改进步骤】

示例 6-1 每个策略都是一个类，且只定义了一个方法 discount
示例 6-3 把具体策略换成了简单的函数，而且去掉了 Promo 抽象类
示例 6-6 best_promo 迭代一个函数列表，并找出折扣额度最大的
         缺点：若想添加新的促销策略，要定义相应的函数，还要记得把它添加到 promos 列表中
示例 6-7 使用 globals 函数帮助 best_promo 自动找到其他可用的*_promo 函数
示例 6-8 内省单独的 promotions 模块，构建 promos 列表
示例 7-3 promos 列表中的值使用 promotion 装饰器填充 。传送门 -> 函数装饰器和闭包_wy_hhxx-----------------------------------------------------------------------------

示例 6-1 实现 Order 类，支持插入式折扣策略

order.py

from abc import ABC, abstractmethod
from collections import namedtuple
Customer = namedtuple('Customer', 'name fidelity')
class LineItem:
    def __init__(self, product, quantity, price):
        self.product = product
        self.quantity = quantity
        self.price = price
    def total(self):
        return self.price * self.quantity

class Order: # 上下文
    def __init__(self, customer, cart, promotion=None):
        self.customer = customer
        self.cart = list(cart)
        self.promotion = promotion
    def total(self):
        if not hasattr(self, '__total'):
            self.__total = sum(item.total() for item in self.cart)
            return self.__total
    def due(self):
        if self.promotion is None:
            discount = 0
        else:
            discount = self.promotion.discount(self)
        return self.total() - discount
    def __repr__(self):
        fmt = '<Order total: {:.2f} due: {:.2f}>'
        return fmt.format(self.total(), self.due())
class Promotion(ABC) : # 策略：抽象基类
    @abstractmethod
    def discount(self, order):
        """返回折扣金额（正值）"""
class FidelityPromo(Promotion): # 第一个具体策略
    """为积分为1000或以上的顾客提供5%折扣"""
    def discount(self, order):
        return order.total() * .05 if order.customer.fidelity >= 1000 else 0
class BulkItemPromo(Promotion): # 第二个具体策略
    """单个商品为20个或以上时提供10%折扣"""
    def discount(self, order):
        discount = 0
        for item in order.cart:
            if item.quantity >= 20:
                discount += item.total() * .1
        return discount
class LargeOrderPromo(Promotion): # 第三个具体策略
    """订单中的不同商品达到10个或以上时提供7%折扣"""
    def discount(self, order):
        distinct_items = {item.product for item in order.cart}
        if len(distinct_items) >= 10:
            return order.total() * .07
        return 0

注意，line30-33 把 Promotion 定义为抽象基类（Abstract Base Class，ABC），这么做是为了使用 @abstractmethod 装饰器，从而明确表明所用的模式。

@abstractmethod：抽象方法，含abstractmethod方法的类不能实例化，继承了含abstractmethod方法的子类必须复写所有abstractmethod装饰的方法，未被装饰的可以不重写

示例 6-2 使用不同促销折扣的 Order 类示例

>>> from order import *
>>> joe = Customer('John Doe', 0)     #1
>>> ann = Customer('Ann Smith', 1100)
>>> cart = [LineItem('banana', 4, .5),     #2
... LineItem('apple', 10, 1.5),
... LineItem('watermellon', 5, 5.0)]
>>>
>>> Order(joe, cart, FidelityPromo())     #3
<Order total: 42.00 due: 42.00>
>>> Order(ann, cart, FidelityPromo())     #4
<Order total: 42.00 due: 39.90>
>>>
>>> banana_cart = [LineItem('banana', 30, .5),     #5
... LineItem('apple', 10, 1.5)]
>>> Order(joe, banana_cart, BulkItemPromo())     #6
<Order total: 30.00 due: 28.50>
>>> long_order = [LineItem(str(item_code), 1, 1.0)     #7
... for item_code in range(10)]
>>> Order(joe, long_order, LargeOrderPromo())     #8
<Order total: 10.00 due: 9.30>
>>> Order(joe, cart, LargeOrderPromo())
<Order total: 42.00 due: 42.00>
>>>

说明：

#1 两个顾客：joe 的积分是 0，ann 的积分是 1100。
#2 有三个商品的购物车。
#3 fidelityPromo 没给joe提供折扣（积分<1000）。
#4 fidelityPromo 给ann提供了5%折扣（积分>1000）。
#5 banana_cart 中有30把香蕉和10个苹果。
#6 BulkItemPromo 给joe购买的香蕉优惠了1.50美元（香蕉>20）。
#7 long_order 中有10个不同的商品，每个商品的价格为1.00美元。
#8 LargerOrderPromo 给joe的整个订单提供了 7% 折扣（不同商品个数=10）。

6.1.2 使用函数实现“策略”模式

在示例 6-1 中，每个具体策略都是一个类，而且都只定义了一个方法，即 discount。此外，策略实例没有状态（没有实例属性）。
示例 6-3 是对示例 6-1的重构，把具体策略换成了简单的函数，而且去掉了 Promo 抽象类。

示例 6-3 Order 类和使用函数实现的折扣策略

……
class Order: # 上下文
……
    def due(self):
        if self.promotion is None:
            discount = 0
        else:
            discount = self.promotion(self)     #计算折扣只需调用 self.promotion() 函数
        return self.total() - discount
……

def fidelity_promo(order):     #没有抽象类，各个策略都是函数
    """为积分为1000或以上的顾客提供5%折扣"""
    return order.total() * .05 if order.customer.fidelity >= 1000 else 0
def bulk_item_promo(order):
    """单个商品为20个或以上时提供10%折扣"""
    discount = 0
    for item in order.cart:
        if item.quantity >= 20:
            discount += item.total() * .1
    return discount
def large_order_promo(order):
    """订单中的不同商品达到10个或以上时提供7%折扣"""
    distinct_items = {item.product for item in order.cart}
    if len(distinct_items) >= 10:
        return order.total() * .07
    return 0

示例 6-4 使用函数实现的促销折扣的 Order 类示例

>>> from order2 import *
>>> joe = Customer('John Doe', 0)
>>> ann = Customer('Ann Smith', 1100)
>>> cart = [LineItem('banana', 4, .5),
... LineItem('apple', 10, 1.5),
... LineItem('watermellon', 5, 5.0)]
>>> Order(joe, cart, fidelity_promo)      #为了把折扣策略应用到 Order 实例上，只需把促销函数作为参数传入
<Order total: 42.00 due: 42.00>
>>> Order(ann, cart, fidelity_promo)
<Order total: 42.00 due: 39.90>
>>> banana_cart = [LineItem('banana', 30, .5),
... LineItem('apple', 10, 1.5)]
>>> Order(joe, banana_cart, bulk_item_promo)
<Order total: 30.00 due: 28.50>
>>> long_order = [LineItem(str(item_code), 1, 1.0)
... for item_code in range(10)]
>>> Order(joe, long_order, large_order_promo)
<Order total: 10.00 due: 9.30>
>>> Order(joe, cart, large_order_promo)
<Order total: 42.00 due: 42.00>
>>>

没必要在新建订单时实例化新的促销对象，函数拿来即用。
共享是推荐的做法，这样不必在每个新的上下文（这里是Order 实例）中使用相同的策略时不断新建具体策略对象，从而减少消耗。

示例 6-6 best_promo 迭代一个函数列表，并找出折扣额度最大的

promos = [fidelity_promo, bulk_item_promo, large_order_promo]    # promos 列出以函数实现的各个策略
def best_promo(order):
    """选择可用的最佳折扣"""
    return max(promo(order) for promo in promos)     # 使用生成器表达式把 order 传给 promos 列表中的各个函数，返回折扣额度最大的那个函数

测试如下，

>>> from order3 import *
>>>
>>> joe = Customer('John Doe', 0)
>>> 
>>> banana_cart = [LineItem('banana', 30, .5),
... LineItem('apple', 10, 1.5)]
>>> long_order = [LineItem(str(item_code), 1, 1.0)
... for item_code in range(10)]
>>>
>>> Order(joe, long_order, best_promo)
<Order total: 10.00 due: 9.30>
>>> Order(joe, banana_cart, best_promo)
<Order total: 30.00 due: 28.50>

缺点：若想添加新的促销策略，要定义相应的函数，还要记得把它添加到 promos 列表中；否则，当新促销函数显式地作为参数传给 Order时，它是可用的，但是 best_promo 不会考虑它。

6.1.4 找出模块中的全部策略

在 Python 中，模块也是一等对象，而且标准库提供了几个处理模块的函数。
内置函数globals() 返回一个字典，表示当前的全局符号表。这个符号表始终针对当前模块（对函数或方法来说，是指定义它们的模块，而不是调用它们的模块）。
示例 6-7 使用 globals 函数帮助 best_promo 自动找到其他可用的*_promo 函数

promos = [globals()[name] for name in globals()    #1
        if name.endswith('_promo')    #2
        and name != 'best_promo']    #3
def best_promo(order):
    """选择可用的最佳折扣"""
    return max(promo(order) for promo in promos)    #4

说明：
#1 迭代 globals() 返回字典中的各个 name。
#2 只选择以 _promo 结尾的名称。
#3 过滤掉 best_promo 自身，防止无限递归。
#4 best_promo 内部的代码没有变化。

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, 'order4': <module 'order4' from '/root/pydir/order4.py'>}
>>>
>>> from order4 import *
>>>
>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, 'order4': <module 'order4' from '/root/pydir/order4.py'>, 'ABC': <class 'abc.ABC'>, 'abstractmethod': <function abstractmethod at 0x7f8033ec6a60>, 'namedtuple': <function namedtuple at 0x7f802c0a4940>, 'Customer': <class 'order4.Customer'>, 'LineItem': <class 'order4.LineItem'>, 'Order': <class 'order4.Order'>, 'fidelity_promo': <function fidelity_promo at 0x7f802c0a5670>, 'bulk_item_promo': <function bulk_item_promo at 0x7f802c0a54c0>, 'large_order_promo': <function large_order_promo at 0x7f802c0a5430>, 'promos': [<function fidelity_promo at 0x7f802c0a5670>, <function bulk_item_promo at 0x7f802c0a54c0>, <function large_order_promo at 0x7f802c0a5430>], 'best_promo': <function best_promo at 0x7f802c0a53a0>}
>>>
>>> promos
[<function fidelity_promo at 0x7f802c0a5670>, <function bulk_item_promo at 0x7f802c0a54c0>, <function large_order_promo at 0x7f802c0a5430>]
>>>

收集所有可用促销的另一种方法是，在一个单独的模块中保存所有策略函数，把 best_promo 排除在外。

示例 6-8 内省单独的 promotions 模块，构建 promos 列表

将全部三个promos函数放置到 promotions.py

order5.py 去除三个promos函数，并导入promotions 模块和提供高阶内省函数的 inspect 模块

from abc import ABC, abstractmethod
from collections import namedtuple
import inspect
import promotions
……
promos = [func for name, func in
         inspect.getmembers(promotions, inspect.isfunction)]
def best_promo(order):
    """选择可用的最佳折扣"""
    return max(promo(order) for promo in promos)

测试如下：

>>> import order5
>>> promos
[<function fidelity_promo at 0x7f802c0a5670>, <function bulk_item_promo at 0x7f802c0a54c0>, <function large_order_promo at 0x7f802c0a5430>]
>>>

6.2 命令模式

“命令”设计模式也可以通过把函数作为参数传递而简化。
我们可以不为调用者提供一个 Command 实例，而是给它一个函数。此时，调用者不用调用 command.execute()，直接调用 command() 即可。MacroCommand 可以实现成定义了 __call__ 方法的类。这样，MacroCommand 的实例就是维护一个函数列表的可调用对象。
示例 6-9 MacroCommand 的各个实例都在内部存储着命令列表

class MacroCommand:
    """一个执行一组命令的命令"""
    def __init__(self, commands):
        self.commands = list(commands)    #1
    def __call__(self):
        for command in self.commands:    #2
            command()

#1 使用 commands 参数构建一个列表，这样能确保参数是可迭代对象，还能在各个 MacroCommand 实例中保存各个命令引用的副本
#2 调用 MacroCommand 实例时，self.commands 中的各个命令依序执行