paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

backends: Add missing @override declarations.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2025-02-18 17:26:56 -08:00
committed by Tim Abbott
parent 4703aed86f
commit 302b961ec1
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
zproject/backends.py
View File

@@ -2083,6 +2083,7 @@ class SocialAuthMixin(ZulipAuthMixin, ExternalAuthMethod, BaseAuth):
standard_relay_params = [*settings.SOCIAL_AUTH_FIELDS_STORED_IN_SESSION, "next"] standard_relay_params = [*settings.SOCIAL_AUTH_FIELDS_STORED_IN_SESSION, "next"]
@override
def auth_complete(self, *args: Any, **kwargs: Any) -> HttpResponse | None: def auth_complete(self, *args: Any, **kwargs: Any) -> HttpResponse | None:
"""This is a small wrapper around the core `auth_complete` method of """This is a small wrapper around the core `auth_complete` method of
python-social-auth, designed primarily to prevent 500s for python-social-auth, designed primarily to prevent 500s for
@@ -2197,6 +2198,7 @@ class GitHubAuthBackend(SocialAuthMixin, GithubOAuth2):
) )
] ]
@override
def user_data(self, access_token: str, *args: Any, **kwargs: Any) -> dict[str, str]: def user_data(self, access_token: str, *args: Any, **kwargs: Any) -> dict[str, str]:
"""This patched user_data function lets us combine together the 3 """This patched user_data function lets us combine together the 3
social auth backends into a single Zulip backend for GitHub OAuth2""" social auth backends into a single Zulip backend for GitHub OAuth2"""
@@ -2330,6 +2332,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
# This method replaces a method from python-social-auth; it is adapted to store # This method replaces a method from python-social-auth; it is adapted to store
# the state_token data in Redis. # the state_token data in Redis.
@override
def get_or_create_state(self) -> str: def get_or_create_state(self) -> str:
"""Creates the Oauth2 state parameter in first step of the flow, """Creates the Oauth2 state parameter in first step of the flow,
before redirecting the user to the IdP (aka Apple). before redirecting the user to the IdP (aka Apple).
@@ -2365,6 +2368,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
) )
return state return state
@override
def validate_state(self) -> str | None: def validate_state(self) -> str | None:
""" """
This method replaces a method from python-social-auth; it is This method replaces a method from python-social-auth; it is
@@ -2390,6 +2394,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
self.strategy.session_set(param, value) self.strategy.session_set(param, value)
return request_state return request_state
@override
def get_user_details(self, response: dict[str, Any]) -> dict[str, Any]: def get_user_details(self, response: dict[str, Any]) -> dict[str, Any]:
""" """
Overridden to correctly grab the user's name from the request params, Overridden to correctly grab the user's name from the request params,
@@ -2465,6 +2470,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
class ZulipSAMLIdentityProvider(SAMLIdentityProvider): class ZulipSAMLIdentityProvider(SAMLIdentityProvider):
@override
def get_user_details(self, attributes: dict[str, Any]) -> dict[str, Any]: def get_user_details(self, attributes: dict[str, Any]) -> dict[str, Any]:
""" """
Overridden to support plumbing of additional Attributes Overridden to support plumbing of additional Attributes
@@ -2669,12 +2675,14 @@ class SAMLAuthBackend(SocialAuthMixin, SAMLAuth):
del settings.SOCIAL_AUTH_SAML_ENABLED_IDPS[idp_name] del settings.SOCIAL_AUTH_SAML_ENABLED_IDPS[idp_name]
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
@override
def get_idp(self, idp_name: str) -> ZulipSAMLIdentityProvider: def get_idp(self, idp_name: str) -> ZulipSAMLIdentityProvider:
"""Given the name of an IdP, get a SAMLIdentityProvider instance. """Given the name of an IdP, get a SAMLIdentityProvider instance.
Forked to use our subclass of SAMLIdentityProvider for more flexibility.""" Forked to use our subclass of SAMLIdentityProvider for more flexibility."""
idp_config = self.setting("ENABLED_IDPS")[idp_name] idp_config = self.setting("ENABLED_IDPS")[idp_name]
return ZulipSAMLIdentityProvider(idp_name, **idp_config) return ZulipSAMLIdentityProvider(idp_name, **idp_config)
@override
def auth_url(self) -> str: def auth_url(self) -> str:
"""Get the URL to which we must redirect in order to """Get the URL to which we must redirect in order to
authenticate the user. Overriding the original SAMLAuth.auth_url. authenticate the user. Overriding the original SAMLAuth.auth_url.
@@ -2764,6 +2772,7 @@ class SAMLAuthBackend(SocialAuthMixin, SAMLAuth):
else: else:
return request_subdomain return request_subdomain
@override
def _check_entitlements( def _check_entitlements(
self, idp: SAMLIdentityProvider, attributes: dict[str, list[str]] self, idp: SAMLIdentityProvider, attributes: dict[str, list[str]]
) -> None: ) -> None:
@@ -3107,6 +3116,7 @@ class GenericOpenIdConnectBackend(SocialAuthMixin, OpenIdConnectAuth):
# configuration from. # configuration from.
OIDC_ENDPOINT = settings_dict.get("oidc_url") OIDC_ENDPOINT = settings_dict.get("oidc_url")
@override
def get_key_and_secret(self) -> tuple[str, str]: def get_key_and_secret(self) -> tuple[str, str]:
client_id = self.settings_dict.get("client_id", "") client_id = self.settings_dict.get("client_id", "")
assert isinstance(client_id, str) assert isinstance(client_id, str)