summary refs log tree commit diff
path: root/synapse/rest/admin/purge_room_servlet.py
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2021-03-08 16:34:38 +0100
committerGitHub <noreply@github.com>2021-03-08 10:34:38 -0500
commit7076eee4b9a1a3fccb660c2435c155f3d9a67435 (patch)
tree323e75f240cc98a77a03434896dfd98a6fb2c45a /synapse/rest/admin/purge_room_servlet.py
parentAdd a basic test for purging rooms. (#9541) (diff)
downloadsynapse-7076eee4b9a1a3fccb660c2435c155f3d9a67435.tar.xz
Add type hints to purge room and server notice admin API. (#9520)
Diffstat (limited to 'synapse/rest/admin/purge_room_servlet.py')
-rw-r--r--synapse/rest/admin/purge_room_servlet.py15
1 files changed, 9 insertions, 6 deletions
diff --git a/synapse/rest/admin/purge_room_servlet.py b/synapse/rest/admin/purge_room_servlet.py
index 8b7bb6d44e..49966ee3e0 100644
--- a/synapse/rest/admin/purge_room_servlet.py
+++ b/synapse/rest/admin/purge_room_servlet.py
@@ -12,13 +12,20 @@
 # 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 TYPE_CHECKING, Tuple
+
 from synapse.http.servlet import (
     RestServlet,
     assert_params_in_dict,
     parse_json_object_from_request,
 )
+from synapse.http.site import SynapseRequest
 from synapse.rest.admin import assert_requester_is_admin
 from synapse.rest.admin._base import admin_patterns
+from synapse.types import JsonDict
+
+if TYPE_CHECKING:
+    from synapse.server import HomeServer
 
 
 class PurgeRoomServlet(RestServlet):
@@ -36,16 +43,12 @@ class PurgeRoomServlet(RestServlet):
 
     PATTERNS = admin_patterns("/purge_room$")
 
-    def __init__(self, hs):
-        """
-        Args:
-            hs (synapse.server.HomeServer): server
-        """
+    def __init__(self, hs: "HomeServer"):
         self.hs = hs
         self.auth = hs.get_auth()
         self.pagination_handler = hs.get_pagination_handler()
 
-    async def on_POST(self, request):
+    async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
         await assert_requester_is_admin(self.auth, request)
 
         body = parse_json_object_from_request(request)