o  i~4@sdZddlmZddlmZmZmZmZmZm Z ddl m Z m Z ddl m ZddlmZmZddlmZddlmZdd lmZmZmZmZmZmZmZmZerbdd lm Z dd l!m"Z"dd l#m$Z$Gd ddej%eZ&GdddeZ'dddZ(dS)zEHelpers for applying Google Cloud Firestore changes in a transaction.) annotations) TYPE_CHECKINGAnyAsyncGeneratorCallable CoroutineOptional) exceptionsgapic_v1) retry_async)_helpers async_batch)AsyncDocumentReference) AsyncQuery) _CANT_BEGIN _CANT_COMMIT_CANT_ROLLBACK_EXCEED_ATTEMPTS_TEMPLATE_WRITE_READ_ONLY MAX_ATTEMPTSBaseTransaction_BaseTransactional)AsyncStreamGenerator)DocumentSnapshot)ExplainOptionscseZdZdZedfd%fdd Zd&fd d Zd'd(ddZd%ddZd)ddZ e j j d fd*ddZ e j j d fd dd+d#d$ZZS),AsyncTransactionaOAccumulate read-and-write operations to be sent in a transaction. Args: client (:class:`~google.cloud.firestore_v1.async_client.AsyncClient`): 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`. FreturnNonecs"tt||t|||dSN)superr__init__r)selfclient max_attempts read_only __class__/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/google/cloud/firestore_v1/async_transaction.pyr :szAsyncTransaction.__init__ write_pbslistcs"|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 zAsyncTransaction._add_write_pbsNretry_id bytes | NonecsT|jrt|j}t||jjj|jj| |d|jj dIdH}|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_progressrformat_idr,_client_firestore_apibegin_transaction_database_string_options_protobuf _rpc_metadata transaction)r!r.msgtransaction_responser'r'r(_beginMs  zAsyncTransaction._begincsR|jsttz|jjj|jj|jd|jjdIdHW| dS| w)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r0r>r2N) r5r,rr8r9rollbackr;r7r= _clean_up)r!r'r'r( _rollbackds zAsyncTransaction._rollbackcs^|jstt|jjj|jj|j|jd|jj dIdH}| 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. )r0writesr>r2N)r5r,rr8r9commitr; _write_pbsr7r=rCr* write_results commit_time)r!commit_responser'r'r(_commit{s   zAsyncTransaction._commit referencesretry"retries.AsyncRetry | object | Nonetimeout float | None%AsyncGenerator[DocumentSnapshot, Any]cs,t||}|jj|fd|i|IdHS)atRetrieves multiple documents from Firestore. Args: references (List[.AsyncDocumentReference, ...]): 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. r>N)r make_retry_timeout_kwargsr8get_all)r!rLrMrOkwargsr'r'r(rSs zAsyncTransaction.get_all)explain_options ref_or_query#AsyncDocumentReference | AsyncQueryOptional[float]rUOptional[ExplainOptions]NAsyncGenerator[DocumentSnapshot, Any] | AsyncStreamGenerator[DocumentSnapshot]cs~t||}t|tr$|durtd|jj|gfd|i|IdHSt|tr;|dur1||d<|jdd|i|Std)a Retrieve a document or a query result from the database. Args: ref_or_query (AsyncDocumentReference | AsyncQuery): 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.r>rUzSValue for argument "ref_or_query" must be a AsyncDocumentReference or a AsyncQuery.r') r rR isinstancerr,r8rSrstream)r!rVrMrOrUrTr'r'r(gets* !  zAsyncTransaction.getrr)r)r*rrr)r.r/rr)rr*)rLr*rMrNrOrPrrQ) rVrWrMrNrOrXrUrYrrZ)__name__ __module__ __qualname____doc__rr r-rArDrKr methodDEFAULTrSr] __classcell__r'r'r%r(r,s      rcs4eZdZdZd fdd Zdd d Zd d ZZS)_AsyncTransactionalalProvide a callable object to use as a transactional decorater. This is surfaced via :func:`~google.cloud.firestore_v1.async_transaction.transactional`. Args: to_wrap (Coroutine[[:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`, ...], Any]): A coroutine that should be run (and retried) in a transaction. rrcstt||dSr)rrfr )r!to_wrapr%r'r(r sz_AsyncTransactional.__init__r>rrcsV||j|jdIdH|j|_|jdur|j|_|j|g|Ri|IdHS)a}Begin transaction and call the wrapped coroutine. Args: transaction (:class:`~google.cloud.firestore_v1.async_transaction.AsyncTransaction`): A transaction to execute the coroutine within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped coroutine. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped coroutine. Returns: Any: result of the wrapped coroutine. Raises: Exception: Any failure caused by ``to_wrap``. )r.N)rCrAr.r7 current_idrg)r!r>argsrTr'r'r( _pre_commits z_AsyncTransactional._pre_commitc s||js tjnd}d}zCt|jD]2}|j|g|Ri|IdH}z |IdH|WWS|yG}z|}WYd}~qd}~wwt |j} t | |t ya| IdHw)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+r Abortedrange _max_attemptsrjrKrr6r, BaseExceptionrD) r!r>rirTretryable_exceptionslast_excattemptresultexcr?r'r'r(__call__s*   z_AsyncTransactional.__call__r^)r>rrr)r_r`rarbr rjrurer'r'r%r(rfs  rfrg!Callable[[AsyncTransaction], Any]rcCst|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. )rf)rgr'r'r(async_transactionalCsrwN)rgrvrrf))rb __future__rtypingrrrrrrgoogle.api_corer r r retriesgoogle.cloud.firestore_v1r r (google.cloud.firestore_v1.async_documentr%google.cloud.firestore_v1.async_queryr*google.cloud.firestore_v1.base_transactionrrrrrrrr0google.cloud.firestore_v1.async_stream_generatorr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profilerAsyncWriteBatchrrfrwr'r'r'r(s"     (   9_