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

models: Improve comments about get_user_profile_by_*_email.

Browse Source 
This should help avoid folks accidentally using methods they should
not.
This commit is contained in:
Tim Abbott
2019-08-05 17:10:58 -07:00
parent ba67a9b76a
commit 441bb844d2
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
zerver/models.py
View File

@@ -2025,6 +2025,12 @@ def get_user_profile_by_id(uid: int) -> UserProfile:
@cache_with_key(user_profile_by_email_cache_key, timeout=3600*24*7)
def get_user_profile_by_email(email: str) -> UserProfile:
"""This should only be used by our unit tests and for manual manage.py
shell work; robust code must use get_user instead, because Zulip
supports multiple users with a given email address existing (in
different realms). Also, for many applications, we should prefer
get_user_by_delivery_email.
"""
return UserProfile.objects.select_related().get(delivery_email__iexact=email.strip())
@cache_with_key(user_profile_by_api_key_cache_key, timeout=3600*24*7)
@@ -2034,7 +2040,10 @@ def get_user_profile_by_api_key(api_key: str) -> UserProfile:
def get_user_by_delivery_email(email: str, realm: Realm) -> UserProfile:
# Fetches users by delivery_email for use in
# authentication/registration contexts. Do not use for user-facing
# views (e.g. Zulip API endpoints); for that, you want get_user.
# views (e.g. Zulip API endpoints); for that, you want get_user,
# both because it does lookup by email (not delivery_email) and
# because it correctly handles Zulip's support for multiple users
# with the same email address in different realms.
return UserProfile.objects.select_related().get(delivery_email__iexact=email.strip(), realm=realm)
@cache_with_key(user_profile_cache_key, timeout=3600*24*7)