U $FZh2@sdZddlmZddlmZmZmZmZmZddl m Z m Z ddl m Z ddlmZmZddlmZmZmZmZmZmZmZmZddlmZdd lmZerdd lmZdd l m!Z!dd l"m#Z#Gd ddej$eZ%GdddeZ&dddddZ'dS)zEHelpers for applying Google Cloud Firestore changes in a transaction.) annotations) TYPE_CHECKINGAnyCallable GeneratorOptional) exceptionsgapic_v1)retry)_helpersbatch) _CANT_BEGIN _CANT_COMMIT_CANT_ROLLBACK_EXCEED_ATTEMPTS_TEMPLATE_WRITE_READ_ONLY MAX_ATTEMPTSBaseTransaction_BaseTransactional)DocumentReference)Query)DocumentSnapshot)ExplainOptions)StreamGeneratorcseZdZdZedfddfdd Zdddfd d Zd"d dd ddZddddZddddZ e j j d fdddddddZ e j j d fd dddddddd d!ZZS)# TransactionaDAccumulate read-and-write operations to be sent in a transaction. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): The client that created this transaction. max_attempts (Optional[int]): The maximum number of attempts for the transaction (i.e. allowing retries). Defaults to :attr:`~google.cloud.firestore_v1.transaction.MAX_ATTEMPTS`. read_only (Optional[bool]): Flag indicating if the transaction should be read-only or should allow writes. Defaults to :data:`False`. FNonereturncs"tt||t|||dSN)superr__init__r)selfclientZ max_attemptsZ read_only __class__l/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/google/cloud/firestore_v1/transaction.pyr :szTransaction.__init__list) write_pbsrcs"|jrtttt||dS)a Add `Write`` protobufs to this transaction. Args: write_pbs (List[google.cloud.firestore_v1. write.Write]): A list of write protobufs to be added. Raises: ValueError: If this transaction is read-only. N) _read_only ValueErrorrrr_add_write_pbs)r!r(r#r%r&r+>s zTransaction._add_write_pbsNz bytes | None)retry_idrcCsL|jrt|j}t||jjj|jj| |d|jj d}|j |_dS)zBegin the transaction. Args: retry_id (Optional[bytes]): Transaction ID of a transaction to be retried. Raises: ValueError: If the current transaction has already begun. )databaseoptionsrequestmetadataN) in_progressr format_idr*_client_firestore_apiZbegin_transaction_database_stringZ_options_protobuf _rpc_metadata transaction)r!r,msgZtransaction_responser%r%r&_beginMs  zTransaction._begincCsD|jsttz&|jjj|jj|jd|jj dW5|XdS)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r-r9r/N) r2r*r _clean_upr5r6rollbackr7r4r8)r!r%r%r& _rollbackds zTransaction._rollbackcCsV|jstt|jjj|jj|j|jd|jj d}| t |j |_ |j |_ |j S)aTransactionally commit the changes accumulated. Returns: List[:class:`google.cloud.firestore_v1.write.WriteResult`, ...]: The write results corresponding to the changes committed, returned in the same order as the changes were applied to this transaction. A write result contains an ``update_time`` field. Raises: ValueError: If no transaction is in progress. )r-Zwritesr9r/)r2r*rr5r6commitr7Z _write_pbsr4r8r<r'Z write_resultsZ commit_time)r!Zcommit_responser%r%r&_commit{s   zTransaction._commitzretries.Retry | object | Nonez float | Nonez&Generator[DocumentSnapshot, Any, None]) referencesr timeoutrcCs$t||}|jj|fd|i|S)aoRetrieves multiple documents from Firestore. Args: references (List[.DocumentReference, ...]): Iterable of document references to be retrieved. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (float): The timeout for this request. Defaults to a system-specified value. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. r9)r make_retry_timeout_kwargsr5get_all)r!rAr rBkwargsr%r%r&rDs zTransaction.get_all)explain_optionszDocumentReference | QueryzOptional[float]zOptional[ExplainOptions]zJStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None]) ref_or_queryr rBrFrcCszt||}t|tr@|dk r&td|jj|gfd|i|St|trn|dk rZ||d<|jfd|i|StddS)aRetrieve a document or a query result from the database. Args: ref_or_query (DocumentReference | Query): The document references or query object to return. retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (float): The timeout for this request. Defaults to a system-specified value. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Can only be used when running a query, not a document reference. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. Raises: ValueError: if `ref_or_query` is not one of the supported types, or explain_options is provided when `ref_or_query` is a document reference. Nz^When type of `ref_or_query` is `AsyncDocumentReference`, `explain_options` cannot be provided.r9rFzIValue for argument "ref_or_query" must be a DocumentReference or a Query.) r rC isinstancerr*r5rDrstream)r!rGr rBrFrEr%r%r&gets   zTransaction.get)N)__name__ __module__ __qualname____doc__rr r+r;r>r@r methodDEFAULTrDrJ __classcell__r%r%r#r&r,s  rcsDeZdZdZddfdd Zdddd d Zdd d d ZZS)_TransactionalaYProvide a callable object to use as a transactional decorater. This is surfaced via :func:`~google.cloud.firestore_v1.transaction.transactional`. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. rrcstt||dSr)rrRr )r!to_wrapr#r%r&r sz_Transactional.__init__rr)r9rcOsB||j|jd|j|_|jdkr0|j|_|j|f||S)amBegin transaction and call the wrapped callable. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): A transaction to execute the callable within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped callable. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped callable. Returns: Any: result of the wrapped callable. Raises: Exception: Any failure caused by ``to_wrap``. )r,N)r<r;r,r4Z current_idrS)r!r9argsrEr%r%r& _pre_commits  z_Transactional._pre_commit)r9c Os||jstjnd}d}zxt|jD]R}|j|f||}z||WWS|k rx}z|}W5d}~XYq(Xq(t |j} t | |Wnt k r| YnXdS)aExecute the wrapped callable within a transaction. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): A transaction to execute the callable within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped callable. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped callable. Returns: Any: The result of the wrapped callable. Raises: ValueError: If the transaction does not succeed in ``max_attempts``. r%N) _resetr)rZAbortedrangeZ _max_attemptsrUr@rr3r* BaseExceptionr>) r!r9rTrEZretryable_exceptionslast_excattemptresultexcr:r%r%r&__call__ s"  z_Transactional.__call__)rKrLrMrNr rUr]rQr%r%r#r&rRs rRr)rSrcCst|S)aDecorate a callable so that it runs in a transaction. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. Returns: Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]: the wrapped callable. )rR)rSr%r%r& transactional=s r^N)(rN __future__rtypingrrrrrZgoogle.api_corerr r retriesZgoogle.cloud.firestore_v1r r Z*google.cloud.firestore_v1.base_transactionr rrrrrrrZ"google.cloud.firestore_v1.documentrZgoogle.cloud.firestore_v1.queryrZ'google.cloud.firestore_v1.base_documentrZ'google.cloud.firestore_v1.query_profilerZ*google.cloud.firestore_v1.stream_generatorrZ WriteBatchrrRr^r%r%r%r&s   (     6\