o Fh7 @s8dZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lm Z m!Z!m"Z"Gdddej#e Z$GdddeZ%de!de%fddZ&de'de(defddZ)eefde*de*de*de*fddZ+dS)zEHelpers for applying Google Cloud Firestore changes in a transaction.N)gapic_v1)retry) _BaseTransactionalBaseTransaction MAX_ATTEMPTS _CANT_BEGIN_CANT_ROLLBACK _CANT_COMMIT_WRITE_READ_ONLY_INITIAL_SLEEP _MAX_SLEEP _MULTIPLIER_EXCEED_ATTEMPTS_TEMPLATE) exceptions)batch)DocumentReference)_helpers)Query)DocumentSnapshot)CommitResponse)AnyCallable Generatorc seZdZdZedfdfdd Zdeddffdd Zdd eddfd d Z dd dZ defddZ e j jdfdedejdedeeedffddZe j jdfdejdedeeedffddZZS) 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`. FreturnNcs"tt||t|||dSN)superr__init__r)selfclient max_attempts read_only __class__^/var/www/html/loop/nvenv/lib/python3.10/site-packages/google/cloud/firestore_v1/transaction.pyr@szTransaction.__init__ write_pbscs"|jrtttt||dS)aAdd `Write`` protobufs to this transaction. Args: write_pbs (List[google.cloud.proto.firestore.v1. write.Write]): A list of write protobufs to be added. Raises: ValueError: If this transaction is read-only. N) _read_only ValueErrorr rr_add_write_pbs)rr&r"r$r%r)Ds zTransaction._add_write_pbsretry_idcCsL|jr t|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_progressrformat_idr(_client_firestore_apibegin_transaction_database_string_options_protobuf _rpc_metadata transaction)rr*msgtransaction_responser$r$r%_beginSs  zTransaction._begincCsJ|jsttz|jjj|jj|jd|jjdW| dS| w)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r+r9r-N) r0r(rr3r4rollbackr6r2r8 _clean_up)rr$r$r% _rollbackjs zTransaction._rollbackcCs2|jsttt|j|j|j}|t|j S)aTransactionally commit the changes accumulated. Returns: List[:class:`google.cloud.proto.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. ) r0r(r _commit_with_retryr3 _write_pbsr2r>list write_results)rcommit_responser$r$r%_commits   zTransaction._commit referencesrtimeoutcCs$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)rmake_retry_timeout_kwargsr3get_all)rrFrrGkwargsr$r$r%rIs zTransaction.get_allcCsVt||}t|tr|jj|gfd|i|St|tr'|jdd|i|Std)aORetrieve a document or a query result from the database. Args: ref_or_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. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. r9zIValue for argument "ref_or_query" must be a DocumentReference or a Query.Nr$) rrH isinstancerr3rIrstreamr()r ref_or_queryrrGrJr$r$r%gets   zTransaction.getrNr)__name__ __module__ __qualname____doc__rrrBr)bytesr<r?rErmethodDEFAULTretriesRetryfloatrrrrIrN __classcell__r$r$r"r%r2s6     rcsBeZdZdZd fdd ZdedefddZdefd d ZZ S) _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. rNcstt||dSr)rr[r)rto_wrapr"r$r%rsz_Transactional.__init__r9cOsH||j|jd|j|_|jdur|j|_|j|g|Ri|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*r2 current_idr\)rr9argsrJr$r$r% _pre_commits  z_Transactional._pre_commitc Os||js tjnd}d}z=t|jD],}|j|g|Ri|}z ||WWS|y@}z|}WYd}~qd}~wwt |j} t | |t yW| w)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'rAbortedrange _max_attemptsr_rErr1r( BaseExceptionr?) rr9r^rJretryable_exceptionslast_excattemptresultexcr:r$r$r%__call__s(   z_Transactional.__call__rO) rPrQrRrSrrrr_rjrZr$r$r"r%r[s  r[r\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. )r[)r\r$r$r% transactional&s rkr&transaction_idcCsDt} z|jj|j||d|jdWStjyYnwt|}q)a.Call ``Commit`` on the GAPIC client with retry / sleep. Retries the ``Commit`` RPC on Unavailable. Usually this RPC-level retry is handled by the underlying GAPICd client, but in this case it doesn't because ``Commit`` is not always idempotent. But here we know it is "idempotent"-like because it has a transaction ID. We also need to do our own retry to special-case the ``INVALID_ARGUMENT`` error. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): A client with GAPIC client and configuration details. write_pbs (List[:class:`google.cloud.proto.firestore.v1.write.Write`, ...]): A ``Write`` protobuf instance to be committed. transaction_id (bytes): ID of an existing transaction that this commit will run in. Returns: :class:`google.cloud.firestore_v1.types.CommitResponse`: The protobuf response from ``Commit``. Raises: ~google.api_core.exceptions.GoogleAPICallError: If a non-retryable exception is encountered. T)r+writesr9r-)r r4commitr6r8rServiceUnavailable_sleep)rr&rl current_sleepr$r$r%r@5sr@rq max_sleep multipliercCs$td|}t|t|||S)aSleep and produce a new sleep time. .. _Exponential Backoff And Jitter: https://www.awsarchitectureblog.com/ 2015/03/backoff.html Select a duration between zero and ``current_sleep``. It might seem counterintuitive to have so much jitter, but `Exponential Backoff And Jitter`_ argues that "full jitter" is the best strategy. Args: current_sleep (float): The current "max" for sleep interval. max_sleep (Optional[float]): Eventual "max" sleep time multiplier (Optional[float]): Multiplier for exponential backoff. Returns: float: Newly doubled ``current_sleep`` or ``max_sleep`` (whichever is smaller) g)randomuniformtimesleepmin)rqrrrs actual_sleepr$r$r%rpbs  rp),rSrtrvgoogle.api_corerrrW*google.cloud.firestore_v1.base_transactionrrrrrr r r r r rrgoogle.cloud.firestore_v1r"google.cloud.firestore_v1.documentrrgoogle.cloud.firestore_v1.queryr'google.cloud.firestore_v1.base_documentrgoogle.cloud.firestore_v1.typesrtypingrrr WriteBatchrr[rkrBrTr@rYrpr$r$r$r%sF  4       \ .