firebase-admin-python/firebase_admin/firestore.py at master · jihoonpython/firebase-admin-python · GitHub

History

76 lines (59 loc) · 2.72 KB

Raw

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

"""Cloud Firestore module.

This module contains utilities for accessing the Google Cloud Firestore databases associated with

Firebase apps. This requires the ``google-cloud-firestore`` Python module.

"""

try:

from google.cloud import firestore # pylint: disable=import-error,no-name-in-module

existing = globals().keys()

for key, value in firestore.__dict__.items():

if not key.startswith('_') and key not in existing:

globals()[key] = value

except ImportError:

raise ImportError('Failed to import the Cloud Firestore library for Python. Make sure '

'to install the "google-cloud-firestore" module.')

from firebase_admin import _utils

_FIRESTORE_ATTRIBUTE = '_firestore'

def client(app=None):

"""Returns a client that can be used to interact with Google Cloud Firestore.

Args:

app: An App instance (optional).

Returns:

google.cloud.firestore.Firestore: A `Firestore Client`_.

Raises:

ValueError: If a project ID is not specified either via options, credentials or

environment variables, or if the specified project ID is not a valid string.

.. _Firestore Client: https://googlecloudplatform.github.io/google-cloud-python/latest\

/firestore/client.html

"""

fs_client = _utils.get_app_service(app, _FIRESTORE_ATTRIBUTE, _FirestoreClient.from_app)

return fs_client.get()

class _FirestoreClient:

"""Holds a Google Cloud Firestore client instance."""

def __init__(self, credentials, project):

self._client = firestore.Client(credentials=credentials, project=project)

def get(self):

return self._client

@classmethod

def from_app(cls, app):

"""Creates a new _FirestoreClient for the specified app."""

credentials = app.credential.get_credential()

project = app.project_id

if not project:

raise ValueError(

'Project ID is required to access Firestore. Either set the projectId option, '

'or use service account credentials. Alternatively, set the GOOGLE_CLOUD_PROJECT '

'environment variable.')

return _FirestoreClient(credentials, project)

firebase-admin-python/firebase_admin/firestore.py at master · jihoonpython/firebase-admin-python · GitHub

Expand file tree

Breadcrumbs

firestore.py

Latest commit

History

Breadcrumbs

firestore.py

File metadata and controls