add comment explaining attributeerror

1 files changed, 3 insertions, 0 deletions

diff --git a/synapse/events/__init__.py b/synapse/events/__init__.py
index d4d1b92f7a..c3ff85c49a 100644
--- a/synapse/events/__init__.py
+++ b/synapse/events/__init__.py
@@ -47,6 +47,9 @@ class _EventInternalMetadata(object):
 
 
 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]