מדריך להעברה של Admin SDK עבור Python 3.0.0

גירסה 3.0.0 של מנהל ה- SDK לניהול Firebase עבור Python מציגה מספר שינויים חשובים ב- API. שינויי ה- API במהדורה זו הם תוספות ושיפורים בטיפול בשגיאות עבור Auth, FCM ותכונות Firebase אחרות.

שינויים כלליים בטיפול בשגיאות

סוגי החריגים הבאים הוסרו:

  • auth.AuthError
  • db.ApiCallError
  • instance_id.ApiCallError
  • messaging.ApiCallError
  • project_management.ApiCallError

במקום זאת, חדשות firebase_admin.exceptions מודול כבר הציג. APIs הציבורי auth , db , instance_id , messaging ו project_management מודולים עכשיו להעלות מקרים של exceptions.FirebaseError סוג.

# Before
from firebase_admin import messaging

try:
    messaging.send(build_message())
except messaging.ApiCallError as ex:
    print('Error message:', ex)

# v3
from firebase_admin import exceptions
from firebase_admin import messaging

try:
    messaging.send(build_message())
except exceptions.FirebaseError as ex:
    print('Error message:', ex)
    print('Error code:', ex.code) # Platform-wide error code
    print('HTTP response:', ex.http_response) # requests HTTP response object

exceptions.FirebaseError סוג יש תת רבים. ממשקי API ציבוריים ב- SDK לניהול יכולים להעלות רק תת -סוגים אלה. לכן, אתה יכול לכתוב קוד שתופס סוג משנה ספציפי ומטפל בשגיאות בצורה מפורטת יותר. לדוגמה:

try:
    messaging.send(build_message())
except exceptions.InvalidArgumentError as ex:
    print(ex) # One or more arguments were invalid
except exceptions.UnavailableError as ex:
    print(ex) # FCM service is temporarily down
except exceptions.FirebaseError as ex:
    print(ex) # All other errors

במקום לתפוס סוגי שגיאה ספציפית, אפשר גם לתפוס את ההורה FirebaseError הסוג וקודי שגיאה להשוות.

try:
    messaging.send(build_message())
except exceptions.FirebaseError as ex:
    if ex.code == exceptions.INVALID_ARGUMENT:
        print(ex) # One or more arguments were invalid
    elif ex.code == exceptions.UNAVAILABLE:
        print(ex) # FCM service is temporarily down
    else:
        print(ex) # All other errors

כל מודול להכריז תת נוספים המשתרעת exceptions.FirebaseError סוג ההורה (ראה להלן).

מנחה כללית עבור טיפול בשגיאות: תפוס exceptions.FirebaseError כשאתה לא צריך להבדיל בין מצבי שגיאה. חפש תת -סוג שגיאה ספציפי יותר או קוד שגיאה כאשר עליך להבדיל בין תנאי שגיאה.

שינויים בטיפול בשגיאות אימות

אימות JWT

auth.verify_id_token() השיטה כבר לא מעלה ValueError כדי לציין שגיאות אימות אסימון. במקום זאת, תקבל אחד מסוגי השגיאות הבאים:

  • InvalidIdTokenError
  • ExpiredIdTokenError
  • RevokedIdTokenError

InvalidIdTokenError סוג מרחיב את exceptions.InvalidArgumentError סוג, אשר כל אחד בתורו מרחיב את exceptions.FirebaseError סוג. ExpiredIdTokenError ו RevokedIdTokenError להאריך InvalidIdTokenError .

# Before
from firebase_admin import auth

try:
    auth.verify_id_token(id_token, check_revoked=True)
except ValueError as ex:
    print('Error message:', ex)

 # v3
from firebase_admin import auth

# Coarse-grained error handling
try:
    auth.verify_id_token(id_token, check_revoked=True)
except auth.InvalidIdTokenError as ex:
    print('ID token is invalid, expired or revoked')

# Fine-grained error handling
try:
    auth.verify_id_token(id_token, check_revoked=True)
except auth.RevokedIdTokenError as ex:
    print('ID token has been revoked')
except auth.ExpiredIdTokenError as ex:
    print('ID token is expired')
except auth.InvalidIdTokenError as ex:
    print('ID token is invalid')

באופן דומה, auth.verify_session_cookie() השיטה מעלה את סוגי החריגים הבאים:

  • InvalidSessionCookieError
  • ExpiredSessionCookieError
  • RevokedSessionCookieError

היררכית סמנטיקת מח' דומה verify_id_token() API.

אסימונים בהתאמה אישית

create_custom_token() API מעלה auth.TokenSignError במקום ValueError כדי לציין כשלים.

# Before
from firebase_admin import auth

try:
    auth.create_custom_token(uid)
except ValueError as ex:
    print('Error message:', ex)

 # v3
from firebase_admin import auth

try:
    auth.create_custom_token(uid)
except auth.TokenSignError as ex:
    print('Error message:', ex)

ניהול משתמשים

סוגי השגיאה החדשות הבאות הוכנסו אל auth מודול:

  • EmailAlreadyExistsError
  • InvalidDynamicLinkDomainError
  • PhoneNumberAlreadyExistsError
  • UidAlreadyExistsError
  • UnexpectedResponseError
  • UserNotFoundError
# Before
from firebase_admin import auth

try:
    auth.get_user(uid)
except auth.AuthError as ex:
    if ex.code == auth.USER_NOT_FOUND_ERROR:
        print('Specified user does not exist')
    else:
        print('Something else went wrong')

 # v3
from firebase_admin import auth
from firebase_admin import exceptions

try:
    auth.get_user(uid)
except auth.UserNotFoundError as ex:
    print('Specified user does not exist')
except exceptions.FirebaseError as ex:
    print('Something else went wrong')

FCM שגיאה בטיפול בשינויים

סוגי השגיאה החדשות הבאות הוכנסו אל messaging מודול.

  • QuotaExceededError
  • SenderIdMismatchError
  • ThirdPartyAuthError
  • UnregisteredError
# Before
from firebase_admin import messaging

try:
    messaging.send(msg)
except messaging.ApiCallError as ex:
    if ex.code == 'registration-token-not-registered':
        print('Registration token has been unregistered')
    elif ex.code == 'invalid-argument':
        print('One or more arguments invalid')
    else:
        print('Something else went wrong')

# v3
from firebase_admin import exceptions
from firebase_admin import messaging

try:
    messaging.send(msg)
except messaging.UnregisteredError as ex:
    print('Registration token has been unregistered')
except exceptions.InvalidArgumentError as ex:
    print('One or more arguments invalid')
except exceptions.FirebaseError as ex:
    print('Something else went wrong')

מחיקת נכס משתמש

זה כבר לא ניתן למחוק נכסים display_name , photo_url , phone_number ו custom_claims ידי הגדרת אותם None . הגדרה אלה None עלי תכונות אלה ללא שינוי. הם חייבים להיות מוגדרים במפורש auth.DELETE_ATTRIBUTE למחוק אותם.

# Before
from firebase_admin import auth

auth.update_user(uid, display_name=None, photo_url=None)

 # v3
from firebase_admin import auth

auth.update_user(
  uid, display_name=auth.DELETE_ATTRIBUTE, photo_url=auth.DELETE_ATTRIBUTE)