add comment explaining attributeerror

lagman · Apr 30, 2018 · 0c9db26 · 0c9db26
1 parent bfc2ade
commit 0c9db26
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/synapse/events/__init__.py b/synapse/events/__init__.py
@@ -47,6 +47,9 @@ def get_send_on_behalf_of(self):
 
 
 def _event_dict_property(key):
+    # We want to be able to use hasattr with the event dict properties.
+    # However, (on python3) hasattr expects AttributeError to be raised. Hence,
+    # we need to transform the KeyError into an AttributeError
     def getter(self):
         try:
             return self._event_dict[key]