Fix some types in the CAS code.

changelog.d/8784.misc

@@ -0,0 +1 @@
+Fix type hints in CAS handler.

synapse/handlers/cas_handler.py

@@ -14,7 +14,7 @@
 # limitations under the License.
 import logging
 import urllib
-from typing import Dict, Optional, Tuple
+from typing import TYPE_CHECKING, Dict, Optional, Tuple
 from xml.etree import ElementTree as ET
 
 from twisted.web.client import PartialDownloadError
@@ -23,6 +23,9 @@
 from synapse.http.site import SynapseRequest
 from synapse.types import UserID, map_username_to_mxid_localpart
 
+if TYPE_CHECKING:
+    from synapse.app.homeserver import HomeServer
+
 logger = logging.getLogger(__name__)
 
 
@@ -31,10 +34,10 @@ class CasHandler:
     Utility class for to handle the response from a CAS SSO service.
 
     Args:
-        hs (synapse.server.HomeServer)
+        hs
     """
 
-    def __init__(self, hs):
+    def __init__(self, hs: "HomeServer"):
         self.hs = hs
         self._hostname = hs.hostname
         self._auth_handler = hs.get_auth_handler()
@@ -205,11 +208,16 @@ async def handle_ticket(
         registered_user_id = await self._auth_handler.check_user_exists(user_id)
 
         if session:
+            # If there's a session then the user must already exist.
+            assert registered_user_id
+
             await self._auth_handler.complete_sso_ui_auth(
                 registered_user_id, session, request,
             )
-
         else:
+            # If this not a UI auth request than there must be a redirect URL.
+            assert client_redirect_url
+
             if not registered_user_id:
                 # Pull out the user-agent and IP from the request.
                 user_agent = request.get_user_agent("")
@@ -221,6 +229,8 @@ async def handle_ticket(
                     user_agent_ips=(user_agent, ip_address),
                 )
 
+            assert registered_user_id
+
             await self._auth_handler.complete_sso_login(
                 registered_user_id, request, client_redirect_url
             )

synapse/handlers/register.py

@@ -152,7 +152,7 @@ async def register_user(
         bind_emails=[],
         by_admin=False,
         user_agent_ips=None,
-    ):
+    ) -> str:
         """Registers a new client on the server.
 
         Args:

synapse/handlers/saml_handler.py

@@ -39,7 +39,7 @@
 from synapse.util.iterutils import chunk_seq
 
 if TYPE_CHECKING:
-    import synapse.server
+    from synapse.server import HomeServer
 
 logger = logging.getLogger(__name__)
 
@@ -56,7 +56,7 @@ class Saml2SessionData:
 
 
 class SamlHandler(BaseHandler):
-    def __init__(self, hs: "synapse.server.HomeServer"):
+    def __init__(self, hs: "HomeServer"):
         super().__init__(hs)
         self._saml_client = Saml2Client(hs.config.saml2_sp_config)
         self._saml_idp_entityid = hs.config.saml2_idp_entityid