summary refs log tree commit diff
path: root/synapse/handlers/__init__.py
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2016-07-19 10:18:40 +0100
committerMark Haines <mark.haines@matrix.org>2016-07-19 10:20:58 +0100
commit7e554aac86144ebde529aae259cd0895d4078f23 (patch)
treeddf228d085444e504b5a4850d32bbd6f2dec44fe /synapse/handlers/__init__.py
parentMerge pull request #928 from matrix-org/rav/refactor_login (diff)
downloadsynapse-7e554aac86144ebde529aae259cd0895d4078f23.tar.xz
Update docstring on Handlers.
To indicate it is deprecated.
Diffstat (limited to 'synapse/handlers/__init__.py')
-rw-r--r--synapse/handlers/__init__.py18
1 files changed, 15 insertions, 3 deletions
diff --git a/synapse/handlers/__init__.py b/synapse/handlers/__init__.py
index d28e07f0d9..c512077cb5 100644
--- a/synapse/handlers/__init__.py
+++ b/synapse/handlers/__init__.py
@@ -31,10 +31,22 @@ from .search import SearchHandler
 
 class Handlers(object):
 
-    """ A collection of all the event handlers.
+    """
+    Deprecated.
+
+    At some point most of the classes whose name ended "Handler" were
+    accessed through this class.
+
+    However this makes it painful to unit test the handlers and to run cut
+    down versions of synapse that only use specific handlers because using a
+    single handler required creating all of the handlers. So some of the
+    handlers have been lifted out of the Handlers object and are now accessed
+    directly through the homeserver object itself.
+
+    Any new handlers should follow the new pattern of being accessed through
+    the homeserver object and should not be added to the Handlers object.
 
-    There's no need to lazily create these; we'll just make them all eagerly
-    at construction time.
+    The remaining handlers should be moved out of the handlers object.
     """
 
     def __init__(self, hs):