Python實(shí)現(xiàn)訪問者模式詳情

更新時間：2022年03月30日 10:34:43 作者：Moelimoe

這篇文章主要介紹了Python實(shí)現(xiàn)訪問者模式詳情，訪問者模式，指作用于一個對象結(jié)構(gòu)體上的元素的操作。訪問者可以使用戶在不改變該結(jié)構(gòu)體中的類的基礎(chǔ)上定義一個新的操作，下文更多相關(guān)資料,需要的朋友可以參考下

假設(shè)要實(shí)現(xiàn)一個存放多種類型數(shù)據(jù)結(jié)構(gòu)的對象，比如一個存放算術(shù)操作數(shù)和操作符的樹結(jié)點(diǎn)，需要存放包含一元操作符、二元操作符和數(shù)字類型的結(jié)點(diǎn)

class Node:
? ? pass


class UnaryOperator(Node):
? ? def __init__(self, operand):
? ? ? ? self.operand = operand


class BinaryOperator(Node):
? ? def __init__(self, left, right):
? ? ? ? self.left = left
? ? ? ? self.right = right


class Add(BinaryOperator):
? ? pass


class Sub(BinaryOperator):
? ? pass


class Mul(BinaryOperator):
? ? pass


class Div(BinaryOperator):
? ? pass


class Negative(UnaryOperator):
? ? pass


class Number(Node):
? ? def __init__(self, value):
? ? ? ? self.value = value

執(zhí)行運(yùn)算需要這樣調(diào)用：

# 假設(shè)運(yùn)算式子：2 - (2+2) * 2 / 1 = 2-(8) = -6.0
t1 = Add(Number(2), Number(2))
t2 = Mul(t1, Number(2))
t3 = Div(t2, Number(1))
t4 = Sub(Number(2), t3)

或者這樣調(diào)用：

t5 = Sub(Number(2), Div(Mul(Add(Number(2), Number(2)), Number(2)), Number(1)))

這樣子需要執(zhí)行多次類的調(diào)用，極不易讀寫且冗長，有沒有一種方法讓調(diào)用更加通用，訪問變得簡單呢。這里使用訪問者模式可以達(dá)到這樣的目的。

訪問者模式能夠在不改變元素所屬對象結(jié)構(gòu)的情況下操作元素，讓調(diào)用或調(diào)用者（caller）的方式變得簡單，這種操作常見于的士公司操作，當(dāng)一個乘客叫了一輛的士時，的士公司接收到了一個訪問者，并分配一輛的士去接這個乘客。

首先定義一個訪問者結(jié)點(diǎn)類VisitorNode，實(shí)現(xiàn)最基本的訪問入口，任何訪問的方式都需要繼承這個訪問者結(jié)點(diǎn)類，并通過這個訪問者結(jié)點(diǎn)類的visit()方法來訪問它的各種操作

# 訪問者節(jié)點(diǎn)的基類
class NodeVisitor:
? ? def visit(self, node):
? ? ? ? if not isinstance(node, Node): ?# 不是Node對象時當(dāng)做一個值返回，如果有其他情況可以根據(jù)實(shí)際來處理
? ? ? ? ? ? return node
? ? ? ? self.meth = "visit_" + type(node).__name__.lower() ?# type(node)也可以換成node.__class__（只要node.__class__不被篡改）
? ? ? ? meth = getattr(self, self.meth, None) ?
?? ??? ?if meth is None:
? ? ? ? ? ? meth = self.generic_visit
? ? ? ? return meth(node)

? ? def generic_visit(self, node):
? ? ? ? raise RuntimeError(f"No {self.meth} method")


# （一種）訪問者對應(yīng)的類
class Visitor(NodeVisitor):
? ? """
? ? 方法的名稱定義都要與前面定義過的結(jié)點(diǎn)類（Node）的名稱保證一致性
? ? """

? ? def visit_add(self, node):
? ? ? ? return self.visit(node.left) + self.visit(node.right)

? ? def visit_sub(self, node):
? ? ? ? return self.visit(node.left) - self.visit(node.right)

? ? def visit_mul(self, node):
? ? ? ? return self.visit(node.left) * self.visit(node.right)

? ? def visit_div(self, node):
? ? ? ? return self.visit(node.left) / self.visit(node.right)

? ? def visit_negative(self, node): ?# 如果class Negative 命名-> class Neg，那么 def visit_negative 命名-> def visit_neg
? ? ? ? return -self.visit(node.operand)

? ? def visit_number(self, node):
? ? ? ? return node.value

這里的meth = getattr(self, self.meth, None)使用了字符串調(diào)用對象方法，self.meth動態(tài)地根據(jù)各類Node類（Add, Sub, Mul…）的名稱定義了對應(yīng)于類Visitor中的方法（visit_add, visit_sub, visit_mul…）簡化了訪問入口的代碼，當(dāng)沒有獲取到對應(yīng)的方法時會執(zhí)行g(shù)eneric_visit()并拋出RuntimeError的異常提示訪問過程中的異常

如果需要添加一種操作，比如取絕對值，只需要定義一個類class Abs(Unaryoperator): pass并在類Visitor中定義一個visit_abs(self, node)方法即可，不需要做出任何多余的修改，更不需要改變存儲的結(jié)構(gòu)

這里visit()方法調(diào)用了visit_xxx()方法，而visit_xxx()可能也調(diào)用了visit()，本質(zhì)上是visit()的循環(huán)遞歸調(diào)用，當(dāng)數(shù)據(jù)量變大時，效率會變得很慢，且遞歸層次過深時會導(dǎo)致超過限制而失敗，而下面介紹的就是利用棧和生成器來消除遞歸提升效率的實(shí)現(xiàn)訪問者模式的方法

import types


class Node:
? ? pass


class BinaryOperator(Node):
? ? def __init__(self, left, right):
? ? ? ? self.left = left
? ? ? ? self.right = right


class UnaryOperator(Node):
? ? def __init__(self, operand):
? ? ? ? self.operand = operand


class Add(BinaryOperator):
? ? pass


class Sub(BinaryOperator):
? ? pass


class Mul(BinaryOperator):
? ? pass


class Div(BinaryOperator):
? ? pass


class Negative(UnaryOperator):
? ? pass


class Number(Node):
? ? def __init__(self, value): ?# 與UnaryOperator區(qū)別僅命名不同
? ? ? ? self.value = value


class NodeVisitor:
? ? def visit(self, node):
? ? ? ? # 使用棧+生成器來替換原來visit()的遞歸寫法
? ? ? ? stack = [node]
? ? ? ? last_result = None ?# 執(zhí)行一個操作最終都會返回一個值
? ? ? ? while stack:
? ? ? ? ? ? last = stack[-1]
? ? ? ? ? ? try:
? ? ? ? ? ? ? ? if isinstance(last, Node):
? ? ? ? ? ? ? ? ? ? stack.append(self._visit(stack.pop()))
? ? ? ? ? ? ? ? elif isinstance(last, types.GeneratorType): ? # GeneratorType會是上一個if返回的對象，這個對象會返回兩個node執(zhí)行算術(shù)之后的結(jié)果
? ? ? ? ? ? ? ? ? ? # 如果是生成器，不pop掉，而是不斷send，直到StopIteration
? ? ? ? ? ? ? ? ? ? # 如果last_result不是None，這個值會給回到生成器（例如2被visit_add()的左值接收到）
? ? ? ? ? ? ? ? ? ? stack.append(last.send(last_result))
? ? ? ? ? ? ? ? ? ? last_result = None
? ? ? ? ? ? ? ? else: ? # 計(jì)算結(jié)果是一個值
? ? ? ? ? ? ? ? ? ? last_result = stack.pop()
? ? ? ? ? ? except StopIteration: ? # 生成器yield結(jié)束
? ? ? ? ? ? ? ? stack.pop()
? ? ? ? return last_result

? ? def _visit(self, node):
? ? ? ? self.method_name = "visit_" + type(node).__name__.lower()
? ? ? ? method = getattr(self, self.method_name, None)
? ? ? ? if method is None:
? ? ? ? ? ? self.generic_visit(node)
? ? ? ? return method(node)

? ? def generic_visit(self, node):
? ? ? ? raise RuntimeError(f"No {self.method_name} method")


class Visitor(NodeVisitor):
? ? def visit_add(self, node):
? ? ? ? yield (yield node.left) + (yield node.right) ? ?# node.left和node.right都可能是Node

? ? def visit_sub(self, node):
? ? ? ? yield (yield node.left) - (yield node.right)

? ? def visit_mul(self, node):
? ? ? ? yield (yield node.left) * (yield node.right)

? ? def visit_div(self, node):
? ? ? ? yield (yield node.left) / (yield node.right)

? ? def visit_negative(self, node):
? ? ? ? yield -(yield node.operand)

? ? def visit_number(self, node):
? ? ? ? return node.value

測試是否還會引起超過遞歸層數(shù)的異常

def test_time_cost():
? ? import time
? ? s = time.perf_counter()
? ? a = Number(0)
? ? for n in range(1, 100000):
? ? ? ? a = Add(a, Number(n))
? ? v = Visitor()
? ? print(v.visit(a))
? ? print(f"time cost:{time.perf_counter() - s}")

輸出正常，沒有問題

4999950000
time cost:0.9547078

最后琢磨出了一個似乎可以作為替代的方法：

clas Node:
? ? psass


class UnaryOperator(Node):
? ? def __init__(self, operand):
? ? ? ? self.operand = operand


class BinaryOperator(Node):
? ? def __init__(self, left, right):
? ? ? ? self.left = left
? ? ? ? self.right = right


class Add(BinaryOperator):
? ? def __init__(self, left, right):
? ? ? ? super().__init__(left, right)
? ? ? ? self.value = self.left.value + self.right.value
? ? pass


class Sub(BinaryOperator):
? ? def __init__(self, left, right):
? ? ? ? super().__init__(left, right)
? ? ? ? self.value = self.left.value - self.right.value
? ? pass


class Mul(BinaryOperator):
? ? def __init__(self, left, right):
? ? ? ? super().__init__(left, right)
? ? ? ? self.value = self.left.value * self.right.value
? ? pass


class Div(BinaryOperator):
? ? def __init__(self, left, right):
? ? ? ? super().__init__(left, right)
? ? ? ? self.value = self.left.value / self.right.value
? ? pass


class Negative(UnaryOperator):
? ? def __init__(self, operand):
? ? ? ? super().__init__(operand)
? ? ? ? self.value = -self.operand.value
? ? pass


class Number(Node):
? ? def __init__(self, value):
? ? ? ? self.value = value

運(yùn)行測試：

def test_time_cost():
? ? import time
? ? s = time.perf_counter()
? ? a = Number(0)
? ? for n in range(1, 100000):
? ? ? ? a = Add(a, Number(n))
? ? print(a.value)
? ? print(time.perf_counter() - s)

輸出：