VSf7 PdZddlZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lm Z m!Z!m"Z"GddejFe Z$GddeZ%de!de%fdZ&de'de(defdZ)eefde*de*de*de*fdZ+y)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 ,eZdZdZedfdfd Zdeddffd Zddeddfd Z dd Z defd Z e jjdfd ed ej dedeeedffdZe jjdfd ej dedeeedffdZxZS) 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`. FreturnNcZtt| |tj|||yN)superr__init__r)selfclient max_attempts read_only __class__s dC:\Users\user\Documents\project_loop\venv\Lib\site-packages\google/cloud/firestore_v1/transaction.pyr zTransaction.__init__@s$ k4)&1  |Y? write_pbscb|jrtttt||y)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)r!r(r%s r&r,zTransaction._add_write_pbsDs' ??-. . k4/ :r'retry_idcT|jr*tj|j}t ||j j j|j j|j|d|j j}|j|_y)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_responses r&_beginzTransaction._beginSs   $$TXX.CS/ !#||::LL LL9911(;\\// M (33r'c>|jstt |jjj |jj |jd|jj|jy#|jwxYw)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r/r=r1N) r4r+r r7r8rollbackr:r6r< _clean_up)r!s r& _rollbackzTransaction._rollbackjsy^, ,  LL ' ' 0 0 $ = =#'8833 1  NN DNN s AB Bc|jsttt|j|j |j }|jt|jS)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. ) r4r+r _commit_with_retryr7 _write_pbsr6rClist write_results)r!commit_responses r&_commitzTransaction._commitsM\* *,T\\4??DHHU O1122r' referencesrtimeoutcltj||}|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. r=)rmake_retry_timeout_kwargsr7get_all)r!rLrrMkwargss r&rPzTransaction.get_alls7(33E7C#t||##JKDKFKKr'ctj||}t|tr |jj |gfd|i|St|t r|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. r=zIValue for argument "ref_or_query" must be a DocumentReference or a Query.) rrO isinstancerr7rPrstreamr+)r! ref_or_queryrrMrQs r&getzTransaction.getsy&33E7C l$5 6'4<<''SDSFS S  e ,&<&&B4B6B B[ r'rNr)__name__ __module__ __qualname____doc__rr rHr,bytesr@rDrKrmethodDEFAULTretriesRetryfloatrrrrPrW __classcell__r%s@r&rr2s -9E@ ; ; ;4u44..33. (66 LL}}L L #S$. / L4 (66 }}  #S$. / r'rc@eZdZdZdfd ZdedefdZdefdZxZ 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. rc,tt| |yr)rrfr )r!to_wrapr%s r&r z_Transactional.__init__s nd,W5r'r=c|j|j|j|j|_|j|j|_|j |g|i|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-)rCr@r-r6 current_idrh)r!r=argsrQs r& _pre_commitz_Transactional._pre_commitsb& DMM2&// ==  OODMt||K9$9&99r'c|j|jstjnd}d} t |j D],}|j |g|i|} |j|cStj|j } t| |#|$r }|}Yd}~fd}~wwxYw#t$r|jwxYw)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``. rSN) _resetr*rAbortedrange _max_attemptsrlrKrr5r+ BaseExceptionrD) r!r=rkrQretryable_exceptionslast_excattemptresultexcr>s r&__call__z_Transactional.__call__s& (3(>(>Z  B   !:!:; #)))+GGG#'')!M  #,22;3L3LMCS/x /,#"H#   ! ! #   s;.B5!B!2B55,B5!B2&B-(B5-B22B55CrX) rYrZr[r\r rrrlrxrcrds@r&rfrfs,6:{::8/K/r'rfrhrct|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)rhs r& transactionalrz&s ' ""r'r(transaction_idct} |jj|j||d|jS#t j $rYnwxYwt|}[)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. )r/writesr=r1)r r8commitr:r<rServiceUnavailable_sleep)r"r(r{ current_sleeps r&rFrF5sy6#M  ((// & 7 7'#1  -- 0 ,,   }-  s4>AAr max_sleep multipliercvtjd|}tj|t ||z|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)rrr actual_sleeps r&rrbs2,>>#}5LJJ| zM)9 55r'),r\rrgoogle.api_corerrr`*google.cloud.firestore_v1.base_transactionrrrrr r r r r rrrgoogle.cloud.firestore_v1r"google.cloud.firestore_v1.documentrrgoogle.cloud.firestore_v1.queryr'google.cloud.firestore_v1.base_documentrgoogle.cloud.firestore_v1.typesrtypingrrr WriteBatchrrfrzrHr]rFrbrrSr'r&rsL $,    '+@.1E:++U%""OUpY'Yx #8 # #*.*.-2*.*.\.8[66%*6EJ6 6r'