diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-07-16 13:52:29 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-16 13:52:29 +0100 |
| commit | a973bcb8a4dd73cc504a2928a5a4bd30ebf4aeae (patch) | |
| tree | 199a0621b184f3ef16d53a497cb74aee605f6964 | |
| parent | Remove obsolete comment. (diff) | |
| download | synapse-a973bcb8a4dd73cc504a2928a5a4bd30ebf4aeae.tar.xz | |
Add some tiny type annotations (#7870)
I found these made pycharm have more of a clue as to what was going on in other places.
| -rw-r--r-- | changelog.d/7870.misc | 1 | ||||
| -rw-r--r-- | synapse/handlers/_base.py | 10 | ||||
| -rw-r--r-- | synapse/server.py | 4 |
3 files changed, 7 insertions, 8 deletions
diff --git a/changelog.d/7870.misc b/changelog.d/7870.misc new file mode 100644 index 0000000000..27cce2f2f9 --- /dev/null +++ b/changelog.d/7870.misc @@ -0,0 +1 @@ +Add some type annotations to `HomeServer` and `BaseHandler`. diff --git a/synapse/handlers/_base.py b/synapse/handlers/_base.py index 61dc4beafe..6a4944467a 100644 --- a/synapse/handlers/_base.py +++ b/synapse/handlers/_base.py @@ -17,6 +17,8 @@ import logging from twisted.internet import defer +import synapse.state +import synapse.storage import synapse.types from synapse.api.constants import EventTypes, Membership from synapse.api.ratelimiting import Ratelimiter @@ -28,10 +30,6 @@ logger = logging.getLogger(__name__) class BaseHandler(object): """ Common base class for the event handlers. - - Attributes: - store (synapse.storage.DataStore): - state_handler (synapse.state.StateHandler): """ def __init__(self, hs): @@ -39,10 +37,10 @@ class BaseHandler(object): Args: hs (synapse.server.HomeServer): """ - self.store = hs.get_datastore() + self.store = hs.get_datastore() # type: synapse.storage.DataStore self.auth = hs.get_auth() self.notifier = hs.get_notifier() - self.state_handler = hs.get_state_handler() + self.state_handler = hs.get_state_handler() # type: synapse.state.StateHandler self.distributor = hs.get_distributor() self.clock = hs.get_clock() self.hs = hs diff --git a/synapse/server.py b/synapse/server.py index d5ebaea7f7..0e6ea96b33 100644 --- a/synapse/server.py +++ b/synapse/server.py @@ -106,7 +106,7 @@ from synapse.server_notices.worker_server_notices_sender import ( WorkerServerNoticesSender, ) from synapse.state import StateHandler, StateResolutionHandler -from synapse.storage import DataStores, Storage +from synapse.storage import DataStore, DataStores, Storage from synapse.streams.events import EventSources from synapse.util import Clock from synapse.util.distributor import Distributor @@ -312,7 +312,7 @@ class HomeServer(object): def get_clock(self): return self.clock - def get_datastore(self): + def get_datastore(self) -> DataStore: return self.datastores.main def get_datastores(self): |