. 0h2dZddlmZddlmZmZmZmZmZddl m Z m Z ddl m Z ddlmZmZddlmZmZmZmZmZmZmZmZddlmZdd lmZerdd lmZdd l m!Z!dd l"m#Z#Gd dej$eZ%GddeZ&ddZ'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)StreamGeneratorceZdZdZedfdfd Zdfd Zd d!d Zdd Zd"dZ e j j d fd#dZ e j j d fd dd$dZxZS)% 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`. FreturnNonectt||tj|||dSN)superr__init__r)selfclient max_attempts read_only __class__s `/var/www/html/nourish/venv/lib/python3.11/site-packages/google/cloud/firestore_v1/transaction.pyr"zTransaction.__init__:s< k4  ))&111 |Y????? write_pbslistc|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 ValueErrorrr!r_add_write_pbs)r#r*r's r(r/zTransaction._add_write_pbs>sB ? /-.. . k4  // :::::r)Nretry_id bytes | Nonec|jr(tj|j}t ||jj|jj| |d|jj }|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#r0msgtransaction_responses r(_beginzTransaction._beginMs   "$TX..CS// !#|:LL L911(;;\/ M  (3r)c|jstt |jj|jj|jd|jj| dS#| wxYw)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r3rAr5N) r8r.rr;r<rollbackr>r:r@ _clean_up)r#s r( _rollbackzTransaction._rollbackds -^,, ,  L ' 0 0 $ =#'83 1    NN     DNN    s =A00Bc>|jstt|jj|jj|j|jd|jj }| 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. )r3writesrAr5)r8r.rr;r<commitr> _write_pbsr:r@rGr+ write_results commit_time)r#commit_responses r(_commitzTransaction._commit{s +\** *,5<< L9/#x \/ =   !/"?@@*6!!r) referencesr retries.Retry | object | Nonetimeout float | None&Generator[DocumentSnapshot, Any, None]cVtj||}|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. rA)r make_retry_timeout_kwargsr;get_all)r#rQr rSkwargss r(rXzTransaction.get_alls8(3E7CC#t|#JKKDKFKKKr))explain_options ref_or_queryDocumentReference | QueryOptional[float]rZOptional[ExplainOptions]JStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None]ctj||}t|tr'|t d|jj|gfd|i|St|tr|||d<|jdd|i|St d)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.rArZzIValue for argument "ref_or_query" must be a DocumentReference or a Query.) r rW isinstancerr.r;rXrstream)r#r[r rSrZrYs r(getzTransaction.gets@3E7CC l$5 6 6 * <(4<'SSDSFSS S  e , , *,;()&<&BB4B6BB B[ r)rr)r*r+rrr )r0r1rr)rr+)rQr+r rRrSrTrrU) r[r\r rRrSr]rZr^rr_)__name__ __module__ __qualname____doc__rr"r/rDrHrPr methodDEFAULTrXrd __classcell__r's@r(rr,s  -9E@@@@@@@ ; ; ; ; ; ;44444..""""@08/F $ LLLLL408/F#' / 59 //////////r)rc4eZdZdZd fd Zd dZd d ZxZS) _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. rrcXtt||dSr )r!ror")r#to_wrapr's r(r"z_Transactional.__init__s' nd##,,W55555r)rArrc|||j|j|_|j |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``. )r0)rGrDr0r: current_idrq)r#rAargsrYs r( _pre_commitz_Transactional._pre_commitsm& DM222&/ =  ODMt|K9$999&999r)c||js tjnd}d} t |jD]?}|j|g|Ri|} ||cS#|$r }|}Yd}~8d}~wwxYwtj |j} t| |#t$r| wxYw)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``. raN) _resetr-r Abortedrange _max_attemptsrurPrr9r. BaseExceptionrH) r#rArtrYretryable_exceptionslast_excattemptresultexcrBs r(__call__z_Transactional.__call__ s& (3(> FZ  B   !:;; # #))+GGGGGG#'')))!MMM+###"HHHHHH#,2;3LMMCS//x /     ! ! # # #   s5'B*A-*B*-A>2A94B*9A>>,B** C re)rArrr)rAr)rfrgrhrir"rurrlrms@r(roroso666666::::8////////r)rorqrrc t|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. )ro)rqs r( transactionalr=s ' " ""r)N)rqrrro)(ri __future__rtypingrrrrrgoogle.api_corer r r retriesgoogle.cloud.firestore_v1r r *google.cloud.firestore_v1.base_transactionrrrrrrrr"google.cloud.firestore_v1.documentrgoogle.cloud.firestore_v1.queryr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profiler*google.cloud.firestore_v1.stream_generatorr WriteBatchrrorrar)r(rsLK""""""DDDDDDDDDDDDDD00000000,,,,,,55555555                    A@@@@@111111KHHHHHHFFFFFFJJJJJJrrrrr%"OrrrjYYYYY'YYYx # # # # # #r)