Fix cyclic import in the module API

changelog.d/11180.feature

@@ -0,0 +1 @@
+Port the Password Auth Providers module interface to the new generic interface.

synapse/module_api/__init__.py

@@ -45,14 +45,14 @@
 from synapse.http.site import SynapseRequest
 from synapse.logging.context import make_deferred_yieldable, run_in_background
 from synapse.metrics.background_process_metrics import run_as_background_process
-from synapse.rest.client.login import LoginResponse
 from synapse.storage import DataStore
 from synapse.storage.database import DatabasePool, LoggingTransaction
 from synapse.storage.databases.main.roommember import ProfileInfo
 from synapse.storage.state import StateFilter
 from synapse.types import (
     DomainSpecificString,
     JsonDict,
+    LoginResponse,
     Requester,
     UserID,
     UserInfo,

synapse/rest/client/login.py

@@ -14,9 +14,7 @@
 
 import logging
 import re
-from typing import TYPE_CHECKING, Any, Awaitable, Callable, Dict, List, Optional, Tuple
-
-from typing_extensions import TypedDict
+from typing import TYPE_CHECKING, Awaitable, Callable, Dict, List, Optional, Tuple
 
 from synapse.api.errors import Codes, LoginError, SynapseError
 from synapse.api.ratelimiting import Ratelimiter
@@ -36,24 +34,14 @@
 from synapse.http.site import SynapseRequest
 from synapse.rest.client._base import client_patterns
 from synapse.rest.well_known import WellKnownBuilder
-from synapse.types import JsonDict, UserID
+from synapse.types import JsonDict, LoginResponse, UserID
 
 if TYPE_CHECKING:
     from synapse.server import HomeServer
 
 logger = logging.getLogger(__name__)
 
 
-class LoginResponse(TypedDict, total=False):
-    user_id: str
-    access_token: str
-    home_server: str
-    expires_in_ms: Optional[int]
-    refresh_token: Optional[str]
-    device_id: str
-    well_known: Optional[Dict[str, Any]]
-
-
 class LoginRestServlet(RestServlet):
     PATTERNS = client_patterns("/login$", v1=True)
     CAS_TYPE = "m.login.cas"

synapse/types.py

@@ -32,6 +32,7 @@
 import attr
 from frozendict import frozendict
 from signedjson.key import decode_verify_key_bytes
+from typing_extensions import TypedDict
 from unpaddedbase64 import decode_base64
 from zope.interface import Interface
 
@@ -796,3 +797,22 @@ class UserInfo:
     is_deactivated: bool
     is_guest: bool
     is_shadow_banned: bool
+
+
+class LoginResponse(TypedDict, total=False):
+    """Represents a response to a POST /login request.
+
+    The description of the fields can be found here:
+    https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-login
+
+    This response may also include the two additional fields from MSC2918 (refresh
+    tokens), which are `expires_in_ms` and `refresh_token`.
+    """
+
+    user_id: str
+    access_token: str
+    home_server: str
+    expires_in_ms: Optional[int]
+    refresh_token: Optional[str]
+    device_id: str
+    well_known: Optional[Dict[str, Any]]