Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-07-08 17:34:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some tiny type annotations (#7870)

Browse source 
I found these made pycharm have more of a clue as to what was going on in other places.
This commit is contained in:
Richard van der Hoff 2020-07-16 13:52:29 +01:00 committed by GitHub
parent 12528dc42f
commit a973bcb8a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/7870.misc Normal file
View file

@ -0,0 +1 @@
Add some type annotations to `HomeServer` and `BaseHandler`.

10
synapse/handlers/_base.py
View file

@ -17,6 +17,8 @@ import logging
from twisted.internet import defer from twisted.internet import defer
import synapse.state
import synapse.storage
import synapse.types import synapse.types
from synapse.api.constants import EventTypes, Membership from synapse.api.constants import EventTypes, Membership
from synapse.api.ratelimiting import Ratelimiter from synapse.api.ratelimiting import Ratelimiter
@ -28,10 +30,6 @@ logger = logging.getLogger(__name__)
class BaseHandler(object): class BaseHandler(object):
""" """
Common base class for the event handlers. Common base class for the event handlers.
Attributes:
store (synapse.storage.DataStore):
state_handler (synapse.state.StateHandler):
""" """
def __init__(self, hs): def __init__(self, hs):
@ -39,10 +37,10 @@ class BaseHandler(object):
Args: Args:
hs (synapse.server.HomeServer): hs (synapse.server.HomeServer):
""" """
self.store = hs.get_datastore() self.store = hs.get_datastore() # type: synapse.storage.DataStore
self.auth = hs.get_auth() self.auth = hs.get_auth()
self.notifier = hs.get_notifier() 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.distributor = hs.get_distributor()
self.clock = hs.get_clock() self.clock = hs.get_clock()
self.hs = hs self.hs = hs

4
synapse/server.py
View file

@ -106,7 +106,7 @@ from synapse.server_notices.worker_server_notices_sender import (
WorkerServerNoticesSender, WorkerServerNoticesSender,
) )
from synapse.state import StateHandler, StateResolutionHandler 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.streams.events import EventSources
from synapse.util import Clock from synapse.util import Clock
from synapse.util.distributor import Distributor from synapse.util.distributor import Distributor
@ -312,7 +312,7 @@ class HomeServer(object):
def get_clock(self): def get_clock(self):
return self.clock return self.clock
def get_datastore(self): def get_datastore(self) -> DataStore:
return self.datastores.main return self.datastores.main
def get_datastores(self): def get_datastores(self):