添加了 observer.py 解释注释

LMCallMe · LMCallMe · commit 73af270f2368 · 2016-11-10T16:55:51.000+08:00
diff --git a/cp13-Observer/observer.py b/cp13-Observer/observer.py
@@ -1,58 +1,59 @@
 class Publisher:
 
     def __init__(self):
-        self.observers = []
+        self.observers = [] # 观察者列表
 
-    def add(self, observer):
-        if observer not in self.observers:
-            self.observers.append(observer)
-        else:
-            print('Failed to add: {}'.format(observer))
-
-    def remove(self, observer):
-        try:
-            self.observers.remove(observer)
-        except ValueError:
-            print('Failed to remove: {}'.format(observer))
+    def add(self, observer): # 添加观察者
+        if observer not in self.observers: # 如果观察者不在列表中
+            self.observers.append(observer) # 向列表中添加观察者
+        else: # 否则，观察者已经在列表中，已经在观察，为避免多次 notify
+            print('Failed to add: {}'.format(observer)) # 添加失败提示
 
-    def notify(self):
-        [o.notify(self) for o in self.observers]
+    def remove(self, observer): # 移除观察者
+        try: #　尝试
+            self.observers.remove(observer) # 从列表移除观察者
+        except ValueError: # 如果观察者不在列表中，引发值异常
+            print('Failed to remove: {}'.format(observer)) # 移除失败提示
 
+    def notify(self): # 通知所有观察者，状态已经改变
+        # 通知列表中的每一个观察值，状态已经改变
+        [o.notify(self) for o in self.observers] 
+        
 
-class DefaultFormatter(Publisher):
+class DefaultFormatter(Publisher): # 默认的被观察者，发布者，主持者
 
     def __init__(self, name):
-        Publisher.__init__(self)
+        Publisher.__init__(self) # 调用发布者的初始化函数
         self.name = name
-        self._data = 0
+        self._data = 0 # _ 表示该属性不得被访问，私有
 
     def __str__(self):
         return "{}: '{}' has data = {}".format(type(self).__name__, self.name, self._data)
 
-    @property
+    @property # 将方法装饰成属性
     def data(self):
         return self._data
 
-    @data.setter
-    def data(self, new_value):
-        try:
-            self._data = int(new_value)
-        except ValueError as e:
-            print('Error: {}'.format(e))
+    @data.setter # 向被 property 装饰成的属性赋值时调用函数
+    def data(self, new_value): # self.data = x 等价于 self.data(x)?
+        try: # 尝试
+            self._data = int(new_value) # 将值转化为int并传递给 self._data
+        except ValueError as e: # 转化失败产生异常
+            print('Error: {}'.format(e)) # 输出
         else:
-            self.notify()
+            self.notify() # 通知所有注册的观察者
 
 
-class HexFormatter:
+class HexFormatter: # 十六进制的观察者
 
-    def notify(self, publisher):
+    def notify(self, publisher): # 被通知时的行为
         print("{}: '{}' has now hex data = {}".format(type(self).__name__,
                                                       publisher.name, hex(publisher.data)))
 
 
-class BinaryFormatter:
+class BinaryFormatter: # 二进制的观察者
 
-    def notify(self, publisher):
+    def notify(self, publisher): # 被通知时的行为
         print("{}: '{}' has now bin data = {}".format(type(self).__name__,
                                                       publisher.name, bin(publisher.data)))
 
@@ -63,24 +64,24 @@ def main():
 
     print()
     hf = HexFormatter()
-    df.add(hf)
+    df.add(hf) # 添加观察者
     df.data = 3
     print(df)
 
     print()
     bf = BinaryFormatter()
-    df.add(bf)
+    df.add(bf) # 添加观察者
     df.data = 21
     print(df)
 
     print()
-    df.remove(hf)
+    df.remove(hf) # 移除观察者
     df.data = 40
     print(df)
 
     print()
-    df.remove(hf)
-    df.add(bf)
+    df.remove(hf) # 移除观察者
+    df.add(bf) # 添加观察者
     df.data = 'hello'
     print(df)
 
