Skip to content

Upgrading firebase-admin 1 to 2

Breaking1.0.0 → 2.18.0Platform1Deprecated1New50Changed10Fixed5

Full comparisonBack to firebase-admin
BreakingUpgrade verdict

A platform requirement change.

In plain terms
  • If you run this package on Python 3.3, you can no longer use this version. Upgrade to Python 3.4 or newer. Python 2.7 still works.
  • The old spelling of this class name is deprecated; use the new spelling instead.
Must act 2 items need code or config changes

Requires Python >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.* from 2.15.0 (none stated before).

Adds cachecontrol >=0.12.4, google-api-core <2.0.0dev,>=1.7.0, google-api-python-client >=1.7.8, google-cloud-firestore >=0.31.0, google-cloud-storage >=1.13.0.

Drops oauth2client.

Installs 31 packages in all (was 7).

What you must change

Platform1
Drops support for Python 3.3; developers on Python 3 must use 3.4 or higher, while Python 2.7 support is unchanged.
2.15.0GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated1
Deprecates the WebpushFcmOptions type in favor of the PEP8 compliant name WebpushFCMOptions.
WebpushFcmOptionsWebpushFCMOptions
2.18.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published Python source. Not mixed with prose notes.

  • added: property App.project_id
  • removed: variable GCLOUD_PROJECT_ENV_VAR
  • changed: function verify_id_token(id_token, app=…) → function verify_id_token(id_token, app=…, check_revoked=…)
  • added: class AuthError(Exception)
  • added: constructor AuthError(code, message, error=…)
  • added: function create_session_cookie(id_token, expires_in, app=…)
  • added: function create_user(**kwargs)
  • added: function delete_user(uid, app=…)
  • added: function generate_email_verification_link(email, action_code_settings=…, app=…)
  • added: function generate_password_reset_link(email, action_code_settings=…, app=…)
  • added: function generate_sign_in_with_email_link(email, action_code_settings, app=…)
  • added: function get_user(uid, app=…)
  • added: function get_user_by_email(email, app=…)
  • added: function get_user_by_phone_number(phone_number, app=…)
  • added: function import_users(users, hash_alg=…, app=…)
  • added: function list_users(page_token=…, max_results=…, app=…)
  • added: function revoke_refresh_tokens(uid, app=…)
  • added: function set_custom_user_claims(uid, custom_claims, app=…)
  • added: function update_user(uid, **kwargs)
  • added: function verify_session_cookie(session_cookie, check_revoked=…, app=…)
  • added: variable ActionCodeSettings
  • added: variable DELETE_ATTRIBUTE
  • added: variable ErrorInfo
  • added: variable ExportedUserRecord
  • added: variable ImportUserRecord
  • added: variable ListUsersPage
  • added: variable UserImportHash
  • added: variable UserImportResult
  • added: variable UserInfo
  • added: variable UserMetadata
  • added: variable UserProvider
  • added: variable UserRecord
  • removed: method ApplicationDefault.get_access_token()
  • removed: method Certificate.get_access_token()
  • removed: method RefreshToken.get_access_token()
  • changed: constructor Certificate(file_path) → constructor Certificate(cert)
  • changed: constructor RefreshToken(file_path) → constructor RefreshToken(refresh_token)
  • added: property ApplicationDefault.project_id
  • added: variable AccessTokenInfo
  • added: class ApiCallError(Exception)
  • added: class Event(object)
  • added: class ListenerRegistration(object)
  • added: class Query(object)
  • added: class Reference(object)
  • added: class TransactionError(Exception)
  • added: constructor ApiCallError(message, error)
  • added: constructor Event(sse_event)
  • added: constructor ListenerRegistration(callback, sse)
  • added: constructor Query(**kwargs)
  • added: constructor Reference(**kwargs)
  • added: constructor TransactionError(message)
  • added: function reference(path=…, app=…, url=…)
  • added: method ListenerRegistration.close()
  • added: method Query.end_at(end)
  • added: method Query.equal_to(value)
  • added: method Query.get()
  • added: method Query.limit_to_first(limit)
  • added: method Query.limit_to_last(limit)
  • added: method Query.start_at(start)
  • added: method Reference.child(path)
  • added: method Reference.delete()
  • added: method Reference.get(etag=…, shallow=…)
  • added: method Reference.get_if_changed(etag)
  • added: method Reference.listen(callback)
  • added: method Reference.order_by_child(path)
  • added: method Reference.order_by_key()
  • added: method Reference.order_by_value()
  • added: method Reference.push(value=…)
  • added: method Reference.set(value)
  • added: method Reference.set_if_unchanged(expected_etag, value)
  • added: method Reference.transaction(transaction_update)
  • added: method Reference.update(value)
  • added: property Event.data
  • added: property Event.event_type
  • added: property Event.path
  • added: property Reference.key
  • added: property Reference.parent
  • added: property Reference.path
  • added: function client(app=…)
  • added: variable existing
  • added: class ApiCallError(Exception)
  • added: constructor ApiCallError(message, error)
  • added: function delete_instance_id(instance_id, app=…)
  • removed: function decode(token)
  • removed: function encode(payload, signer, headers=…)
  • removed: function verify_id_token(id_token, cert_uri, audience=…, kid=…, http=…)
  • added: class ApiCallError(Exception)
  • added: class BatchResponse(object)
  • added: class ErrorInfo(object)
  • added: class SendResponse(object)
  • added: class TopicManagementResponse(object)
  • added: constructor ApiCallError(code, message, detail=…)
  • added: constructor BatchResponse(responses)
  • added: constructor ErrorInfo(index, reason)
  • added: constructor SendResponse(resp, exception)
  • added: constructor TopicManagementResponse(resp)
  • added: function send(message, dry_run=…, app=…)
  • added: function send_all(messages, dry_run=…, app=…)
  • added: function send_multicast(multicast_message, dry_run=…, app=…)
  • added: function subscribe_to_topic(tokens, topic, app=…)
  • added: function unsubscribe_from_topic(tokens, topic, app=…)
  • added: property BatchResponse.failure_count
  • added: property BatchResponse.responses
  • added: property BatchResponse.success_count
  • added: property ErrorInfo.index
  • added: property ErrorInfo.reason
  • added: property SendResponse.exception
  • added: property SendResponse.message_id
  • added: property SendResponse.success
  • added: property TopicManagementResponse.errors
  • added: property TopicManagementResponse.failure_count
  • added: property TopicManagementResponse.success_count
  • added: variable APNSConfig
  • added: variable APNSFCMOptions
  • added: variable APNSPayload
  • added: variable AndroidConfig
  • added: variable AndroidFCMOptions
  • added: variable AndroidNotification
  • added: variable Aps
  • added: variable ApsAlert
  • added: variable CriticalSound
  • added: variable FCMOptions
  • added: variable Message
  • added: variable MulticastMessage
  • added: variable Notification
  • added: variable WebpushConfig
  • added: variable WebpushFCMOptions
  • added: variable WebpushNotification
  • added: variable WebpushNotificationAction
  • added: class AndroidApp(object)
  • added: class AndroidAppMetadata(_AppMetadata)
  • added: class ApiCallError(Exception)
  • added: class IosApp(object)
  • added: class IosAppMetadata(_AppMetadata)
  • added: class ShaCertificate(object)
  • added: constructor AndroidApp(app_id, service)
  • added: constructor AndroidAppMetadata(package_name, name, app_id, display_name, project_id)
  • added: constructor ApiCallError(message, error)
  • added: constructor IosApp(app_id, service)
  • added: constructor IosAppMetadata(bundle_id, name, app_id, display_name, project_id)
  • added: constructor ShaCertificate(sha_hash, name=…)
  • added: field ShaCertificate.SHA_1
  • added: field ShaCertificate.SHA_256
  • added: function android_app(app_id, app=…)
  • added: function create_android_app(package_name, display_name=…, app=…)
  • added: function create_ios_app(bundle_id, display_name=…, app=…)
  • added: function ios_app(app_id, app=…)
  • added: function list_android_apps(app=…)
  • added: function list_ios_apps(app=…)
  • added: method AndroidApp.add_sha_certificate(certificate_to_add)
  • added: method AndroidApp.delete_sha_certificate(certificate_to_delete)
  • added: method AndroidApp.get_config()
  • added: method AndroidApp.get_metadata()
  • added: method AndroidApp.get_sha_certificates()
  • added: method AndroidApp.set_display_name(new_display_name)
  • added: method IosApp.get_config()
  • added: method IosApp.get_metadata()
  • added: method IosApp.set_display_name(new_display_name)
  • added: property AndroidApp.app_id
  • added: property AndroidAppMetadata.package_name
  • added: property IosApp.app_id
  • added: property IosAppMetadata.bundle_id
  • added: property ShaCertificate.cert_type
  • added: property ShaCertificate.name
  • added: property ShaCertificate.sha_hash
  • added: function bucket(name=…, app=…)