a !f?@sdZddlZddlmZddlmZddlmZddlmZ ddl m Z ddl m Z dd lmZdd lmZdd lmZdd lmZdd lmZddlmZdZddZdddZdddZGddde eZdS)z=Convenience wrapper for invoking APIs/factories w/ a project.N) _LocalStack_determine_default_project)_ClientProjectMixin)Client)helpers) ConnectionBatch)Entity)Key)Query Transaction) GCD_DATASETcCs ttS)z2Gets the GCD application ID if it can be inferred.)osgetenvrrrX/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/datastore/client.py_get_gcd_project$srcCs$|durt}|dur t|d}|S)aDDetermine default project explicitly or implicitly as fall-back. In implicit case, supports four environments. In order of precedence, the implicit environments are: * DATASTORE_DATASET environment variable (for ``gcd`` / emulator testing) * GCLOUD_PROJECT environment variable * Google App Engine application ID * Google Compute Engine project ID (from metadata server) :type project: string :param project: Optional. The project to use as default. :rtype: string or ``NoneType`` :returns: Default project if it can be determined. Nproject)r_base_default_projectrrrrr)s  rFc Cs|dur|gkrtd|dur0|gkr0tdg}d}|tkr|d7}|j||||d\} } } || |dur||| |dur|| qt| dkrq| }q8|S)aRepeat lookup until all keys found (unless stop requested). Helper function for :meth:`Client.get_multi`. :type connection: :class:`gcloud.datastore.connection.Connection` :param connection: The connection used to connect to datastore. :type project: string :param project: The project to make the request for. :type key_pbs: list of :class:`gcloud.datastore._generated.entity_pb2.Key` :param key_pbs: The keys to retrieve from the datastore. :type missing: list :param missing: (Optional) If a list is passed, the key-only entity protobufs returned by the backend as "missing" will be copied into it. :type deferred: list :param deferred: (Optional) If a list is passed, the key protobufs returned by the backend as "deferred" will be copied into it. :type eventual: bool :param eventual: If False (the default), request ``STRONG`` read consistency. If True, request ``EVENTUAL`` read consistency. :type transaction_id: string :param transaction_id: If passed, make the request in the scope of the given transaction. Incompatible with ``eventual==True``. :rtype: list of :class:`gcloud.datastore._generated.entity_pb2.Entity` :returns: The requested entities. :raises: :class:`ValueError` if missing / deferred are not null or empty list. Nz%missing must be None or an empty listz&deferred must be None or an empty listr)rkey_pbseventualtransaction_id) ValueError _MAX_LOOPSlookupextendlen) connectionrrmissingdeferredrrresultsZloop_numZ results_foundZ missing_foundZdeferred_foundrrr_extended_lookupCs0(     r'cseZdZdZeZd%fdd ZeddZddZ d d Z e d d Z e d dZ d&ddZd'ddZddZddZddZddZddZddZdd Zd!d"Zd#d$ZZS)(raConvenience wrapper for invoking APIs/factories w/ a project. :type project: string :param project: (optional) The project to pass to proxied API methods. :type namespace: string :param namespace: (optional) namespace to pass to proxied API methods. :type credentials: :class:`oauth2client.client.OAuth2Credentials` or :class:`NoneType` :param credentials: The OAuth2 Credentials to use for the connection owned by this client. If not passed (and if no ``http`` object is passed), falls back to the default inferred from the environment. :type http: :class:`httplib2.Http` or class that defines ``request()``. :param http: An optional HTTP object to make requests. If not passed, an ``http`` object is created that is bound to the ``credentials`` for the current object. Ncs2tj||d||_t|_tt|||dS)Nr)r__init__ namespacer _batch_stacksuperr)selfrr) credentialshttp __class__rrr(szClient.__init__cCst|S)z,Helper: override default project detection.rrrrr_determine_defaultszClient._determine_defaultcCs|j|dS)a(Push a batch/transaction onto our stack. "Protected", intended for use by batch / transaction context mgrs. :type batch: :class:`gcloud.datastore.batch.Batch`, or an object implementing its API. :param batch: newly-active batch/transaction. N)r*push)r,batchrrr _push_batchs zClient._push_batchcCs |jS)a`Pop a batch/transaction from our stack. "Protected", intended for use by batch / transaction context mgrs. :raises: IndexError if the stack is empty. :rtype: :class:`gcloud.datastore.batch.Batch`, or an object implementing its API. :returns: the top-most batch/transaction, after removing it. )r*popr,rrr _pop_batchs zClient._pop_batchcCs|jjS)zCurrently-active batch. :rtype: :class:`gcloud.datastore.batch.Batch`, or an object implementing its API, or ``NoneType`` (if no batch is active). :returns: The batch/transaction at the top of the batch stack. )r*topr6rrr current_batchszClient.current_batchcCs|j}t|tr|SdS)aCurrently-active transaction. :rtype: :class:`gcloud.datastore.transaction.Transaction`, or an object implementing its API, or ``NoneType`` (if no transaction is active). :returns: The transaction at the top of the batch stack. N)r9 isinstancer)r, transactionrrrcurrent_transactions  zClient.current_transactioncCs$|j|g|||d}|r |dSdS)a{Retrieve an entity from a single key (if it exists). .. note:: This is just a thin wrapper over :meth:`get_multi`. The backend API does not make a distinction between a single key or multiple keys in a lookup request. :type key: :class:`gcloud.datastore.key.Key` :param key: The key to be retrieved from the datastore. :type missing: list :param missing: (Optional) If a list is passed, the key-only entities returned by the backend as "missing" will be copied into it. :type deferred: list :param deferred: (Optional) If a list is passed, the keys returned by the backend as "deferred" will be copied into it. :type transaction: :class:`gcloud.datastore.transaction.Transaction` :param transaction: (Optional) Transaction to use for read consistency. If not passed, uses current transaction, if set. :rtype: :class:`gcloud.datastore.entity.Entity` or ``NoneType`` :returns: The requested entity if it exists. )keysr$r%r;rN) get_multi)r,keyr$r%r;entitiesrrrgets  z Client.getcCs|sgStdd|D}|D]}||jkrtdq|durD|j}t|j|jdd|D|||of|jd}|durdd|D|dd<|durd d|D|dd<d d|DS) aRetrieve entities, along with their attributes. :type keys: list of :class:`gcloud.datastore.key.Key` :param keys: The keys to be retrieved from the datastore. :type missing: list :param missing: (Optional) If a list is passed, the key-only entities returned by the backend as "missing" will be copied into it. If the list is not empty, an error will occur. :type deferred: list :param deferred: (Optional) If a list is passed, the keys returned by the backend as "deferred" will be copied into it. If the list is not empty, an error will occur. :type transaction: :class:`gcloud.datastore.transaction.Transaction` :param transaction: (Optional) Transaction to use for read consistency. If not passed, uses current transaction, if set. :rtype: list of :class:`gcloud.datastore.entity.Entity` :returns: The requested entities. :raises: :class:`ValueError` if one or more of ``keys`` has a project which does not match our project. css|] }|jVqdS)Nr).0r?rrr z#Client.get_multi..zKeys do not match projectNcSsg|] }|qSr) to_protobuf)rBkrrr *rDz$Client.get_multi..)r#rrr$r%rcSsg|]}t|qSrrZentity_from_protobuf)rBZ missed_pbrrrrG1scSsg|]}t|qSr)rZkey_from_protobuf)rBZ deferred_pbrrrrG6scSsg|]}t|qSrrH)rBZ entity_pbrrrrG:s)setrrr<r'r#id)r,r=r$r%r;ZidsZ current_idZ entity_pbsrrrr>s6    zClient.get_multicCs|j|gddS)aSave an entity in the Cloud Datastore. .. note:: This is just a thin wrapper over :meth:`put_multi`. The backend API does not make a distinction between a single entity or multiple entities in a commit request. :type entity: :class:`gcloud.datastore.entity.Entity` :param entity: The entity to be saved to the datastore. )r@N) put_multi)r,entityrrrput=s z Client.putcCsXt|trtd|sdS|j}|du}|s4|}|D]}||q8|sT|dS)aSave entities in the Cloud Datastore. :type entities: list of :class:`gcloud.datastore.entity.Entity` :param entities: The entities to be saved to the datastore. :raises: :class:`ValueError` if ``entities`` is a single entity. zPass a sequence of entitiesN)r:r rr9r3rMcommit)r,r@currentin_batchrLrrrrKKs  zClient.put_multicCs|j|gddS)avDelete the key in the Cloud Datastore. .. note:: This is just a thin wrapper over :meth:`delete_multi`. The backend API does not make a distinction between a single key or multiple keys in a commit request. :type key: :class:`gcloud.datastore.key.Key` :param key: The key to be deleted from the datastore. )r=N) delete_multi)r,r?rrrdeletees z Client.deletecCsF|sdS|j}|du}|s"|}|D]}||q&|sB|dS)zDelete keys from the Cloud Datastore. :type keys: list of :class:`gcloud.datastore.key.Key` :param keys: The keys to be deleted from the datastore. N)r9r3rRrN)r,r=rOrPr?rrrrQss zClient.delete_multicsXjstdf}|g|}|j}|j|}dd|D}fdd|DS)aAllocate a list of IDs from a partial key. :type incomplete_key: :class:`gcloud.datastore.key.Key` :param incomplete_key: Partial key to use as base for allocated IDs. :type num_ids: int :param num_ids: The number of IDs to allocate. :rtype: list of :class:`gcloud.datastore.key.Key` :returns: The (complete) keys allocated with ``incomplete_key`` as root. :raises: :class:`ValueError` if ``incomplete_key`` is not a partial key. zKey is not partial.cSsg|]}|jdjqS))pathrJ)rBZallocated_key_pbrrrrGsz'Client.allocate_ids..csg|]}|qSr)Z completed_key)rBZ allocated_idincomplete_keyrrrGs)Z is_partialrrEr# allocate_idsr)r,rVZnum_idsZincomplete_key_pbZincomplete_key_pbsconnZallocated_key_pbsZ allocated_idsrrUrrWs   zClient.allocate_idscOs:d|vrtd|j|d<d|vr,|j|d<t|i|S)zUProxy to :class:`gcloud.datastore.key.Key`. Passes our ``project``. rCannot pass projectr)) TypeErrorrr)r )r,Z path_argskwargsrrrr?s   z Client.keycCst|S)z/Proxy to :class:`gcloud.datastore.batch.Batch`.r r6rrrr3sz Client.batchcCst|S)z;Proxy to :class:`gcloud.datastore.transaction.Transaction`.rr6rrrr;szClient.transactioncKsLd|vrtdd|vr td|j|d<d|vr<|j|d<t|fi|S)zYProxy to :class:`gcloud.datastore.query.Query`. Passes our ``project``. clientzCannot pass clientrrYr))rZrr)r )r,r[rrrquerys  z Client.query)NNNN)NNN)NNN)__name__ __module__ __qualname____doc__rZ_connection_classr( staticmethodr1r4r7propertyr9r<rAr>rMrKrRrQrWr?r3r;r] __classcell__rrr/rrs0     ! : r)N)NNFN)rarZgcloud._helpersrrrZ gcloud.clientrrZ _BaseClientZgcloud.datastorerZgcloud.datastore.connectionrZgcloud.datastore.batchr Zgcloud.datastore.entityr Zgcloud.datastore.keyr Zgcloud.datastore.queryr Zgcloud.datastore.transactionrZgcloud.environment_varsrrrr'rrrrs(              N