diff options
author | Patrick Cloke <clokep@users.noreply.github.com> | 2020-07-31 16:22:06 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-31 16:22:06 -0400 |
commit | d1008fe949cd39e36670ea8ae819cbb7c6db9c7a (patch) | |
tree | 8808d53e156dc1fb17abcc6f86879ec695ab886c /synapse/server_notices/server_notices_sender.py | |
parent | Merge pull request #8008 from matrix-org/erikj/add_rate_limiting_to_joins (diff) | |
download | synapse-d1008fe949cd39e36670ea8ae819cbb7c6db9c7a.tar.xz |
Fix some comments and types in service notices (#7996)
Diffstat (limited to 'synapse/server_notices/server_notices_sender.py')
-rw-r--r-- | synapse/server_notices/server_notices_sender.py | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/synapse/server_notices/server_notices_sender.py b/synapse/server_notices/server_notices_sender.py index be74e86641..a754f75db4 100644 --- a/synapse/server_notices/server_notices_sender.py +++ b/synapse/server_notices/server_notices_sender.py @@ -12,6 +12,8 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +from typing import Iterable, Union + from synapse.server_notices.consent_server_notices import ConsentServerNotices from synapse.server_notices.resource_limits_server_notices import ( ResourceLimitsServerNotices, @@ -32,22 +34,22 @@ class ServerNoticesSender(object): self._server_notices = ( ConsentServerNotices(hs), ResourceLimitsServerNotices(hs), - ) + ) # type: Iterable[Union[ConsentServerNotices, ResourceLimitsServerNotices]] - async def on_user_syncing(self, user_id): + async def on_user_syncing(self, user_id: str) -> None: """Called when the user performs a sync operation. Args: - user_id (str): mxid of user who synced + user_id: mxid of user who synced """ for sn in self._server_notices: await sn.maybe_send_server_notice_to_user(user_id) - async def on_user_ip(self, user_id): + async def on_user_ip(self, user_id: str) -> None: """Called on the master when a worker process saw a client request. Args: - user_id (str): mxid + user_id: mxid """ # The synchrotrons use a stubbed version of ServerNoticesSender, so # we check for notices to send to the user in on_user_ip as well as |