U >i>@sdZddlmZddlZddlmZmZddlmZ ddl m Z ddl m Z ddlmZGd d d ejd ZGd d d eZdS)z=Helpers for batch requests to the Google Cloud Firestore API.) annotationsN)DictUnion)retry)_helpers)BaseDocumentReference)writec@seZdZdZddddZddZdd d d Zd dd ddZej ddZ ddddddZ d#dddddddZ d$dddddddZ d%dddd d!d"ZdS)& BaseBatchaAccumulate write operations to be sent in a batch. This has the same set of methods for write operations that :class:`~google.cloud.firestore_v1.document.DocumentReference` does, e.g. :meth:`~google.cloud.firestore_v1.document.DocumentReference.create`. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): The client that created this batch. None)returncCs"||_g|_i|_d|_d|_dSN)_client _write_pbs_document_referencesZ write_resultsZ commit_time)selfclientrH/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/base_batch.py__init__(s zBaseBatch.__init__cCs t|jSr )lenrrrrr__len__/szBaseBatch.__len__r) referencecCs |j|jkSr )_document_pathr)rrrrr __contains__2szBaseBatch.__contains__zlist[write_pb.Write]) write_pbsr cCs|j|dS)aAdd `Write`` protobufs to this transaction. This method intended to be over-ridden by subclasses. Args: write_pbs (List[google.cloud.firestore_v1. write_pb2.Write]): A list of write protobufs to be added. N)rextend)rrrrr_add_write_pbs5s zBaseBatch._add_write_pbscCs tdS)zySends all accumulated write operations to the server. The details of this write depend on the implementing class.N)NotImplementedErrorrrrrcommit@szBaseBatch.commitdict)r document_datar cCs(t|j|}||j|j<||dS)aAdd a "change" to this batch to create a document. If the document given by ``reference`` already exists, then this batch will fail when :meth:`commit`-ed. Args: reference (:class:`~google.cloud.firestore_v1.document.DocumentReference`): A document reference to be created in this batch. document_data (dict): Property names and values to use for creating a document. N)rZpbs_for_createrrr)rrr!rrrrcreateFs  zBaseBatch.createFzUnion[bool, list])rr!merger cCsB|dk rt|j||}nt|j|}||j|j<||dS)aAdd a "change" to replace a document. See :meth:`google.cloud.firestore_v1.document.DocumentReference.set` for more information on how ``option`` determines how the change is applied. Args: reference (:class:`~google.cloud.firestore_v1.document.DocumentReference`): A document reference that will have values set in this batch. document_data (dict): Property names and values to use for replacing a document. merge (Optional[bool] or Optional[List]): If True, apply merging instead of overwriting the state of the document. FN)rZpbs_for_set_with_mergerZpbs_for_set_no_mergerr)rrr!r#rrrrsetVs z BaseBatch.setNz_helpers.WriteOption | None)r field_updatesoptionr cCs>|jjdkrtdt|j||}||j|j<||dS)aAdd a "change" to update a document. See :meth:`google.cloud.firestore_v1.document.DocumentReference.update` for more information on ``field_updates`` and ``option``. Args: reference (:class:`~google.cloud.firestore_v1.document.DocumentReference`): A document reference that will be updated in this batch. field_updates (dict): Field names or paths to update and values to update with. option (Optional[:class:`~google.cloud.firestore_v1.client.WriteOption`]): A write option to make assertions / preconditions on the server state of the document before applying changes. Z ExistsOptionz5you must not pass an explicit write option to update.N) __class____name__ ValueErrorrZpbs_for_updaterrr)rrr%r&rrrrupdatexs  zBaseBatch.update)rr&r cCs*t|j|}||j|j<||gdS)ayAdd a "change" to delete a document. See :meth:`google.cloud.firestore_v1.document.DocumentReference.delete` for more information on how ``option`` determines how the change is applied. Args: reference (:class:`~google.cloud.firestore_v1.document.DocumentReference`): A document reference that will be deleted in this batch. option (Optional[:class:`~google.cloud.firestore_v1.client.WriteOption`]): A write option to make assertions / preconditions on the server state of the document before applying changes. N)rZ pb_for_deleterrr)rrr&write_pbrrrdeletes zBaseBatch.delete)F)N)N)r( __module__ __qualname____doc__rrrrabcabstractmethodrr"r$r*r,rrrrr s   & r ) metaclassc@s eZdZdZdddddZdS)BaseWriteBatchzBase class for a/sync implementations of the `commit` RPC. `commit` is useful for lower volumes or when the order of write operations is important.z2retries.Retry | retries.AsyncRetry | object | Nonez float | None)rtimeoutcCs&|jj|jdd}t||}||fS)z+Shared setup for async/sync :meth:`commit`.N)ZdatabaseZwritesZ transaction)r Z_database_stringrrZmake_retry_timeout_kwargs)rrr4requestkwargsrrr _prep_commits  zBaseWriteBatch._prep_commitN)r(r-r.r/r7rrrrr3sr3)r/ __future__rr0typingrrZgoogle.api_corerretriesZgoogle.cloud.firestore_v1rZ'google.cloud.firestore_v1.base_documentrZgoogle.cloud.firestore_v1.typesrr+ABCMetar r3rrrrs