Ѯh2dZddlmZddlmZmZmZmZmZddl m Z m Z ddl m Z ddlmZmZddlmZmZmZmZmZmZmZmZddlmZdd lmZerdd lmZdd l m!Z!dd l"m#Z#Gd dejHeZ%GddeZ&ddZ'y)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)StreamGeneratorceZdZdZedfd fd Zd fd ZdddZd dZddZ e jjdf dd Z e jjdfdd  dd ZxZS) 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`. FcZtt| |tj|||yN)superr__init__r)selfclient max_attempts read_only __class__s w/home/www/academy-backend.kofcorporation.com/venv/lib/python3.12/site-packages/google/cloud/firestore_v1/transaction.pyr zTransaction.__init__:s$ k4)&1  |Y?cb|jrtttt||y)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! write_pbsr%s r&r+zTransaction._add_write_pbs>s' ??-. . k4/ :r'NcT|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!retry_idmsgtransaction_responses r&_beginzTransaction._beginMs   $$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<r0N) r3r*rr6r7rollbackr9r5r; _clean_up)r!s r& _rollbackzTransaction._rollbackdsy^, ,  LL ' ' 0 0 $ = =#'8833 1  NN DNN s AB Bc|jstt|jjj |jj |j|jd|jj}|jt|j|_ |j|_ |jS)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.writesr<r0)r3r*rr6r7commitr9 _write_pbsr5r;rClist write_results commit_time)r!commit_responses r&_commitzTransaction._commit{s\* *,,55<< LL99//#xx \\// =  !/"?"?@*66!!!r'cltj||}|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<)r make_retry_timeout_kwargsr6get_all)r! referencesr timeoutkwargss r&rPzTransaction.get_alls7(33E7C#t||##JKDKFKKr')explain_optionsctj||}t|tr-| t d|j j |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. z^When type of `ref_or_query` is `AsyncDocumentReference`, `explain_options` cannot be provided.r<rTzIValue for argument "ref_or_query" must be a DocumentReference or a Query.) r rO isinstancerr*r6rPrstream)r! ref_or_queryr rRrTrSs r&getzTransaction.gets@33E7C l$5 6* <(4<<''SDSFS S  e ,*,;()&<&&B4B6B B[ r'returnNone)r,rIr\r]r)r=z bytes | Noner\r])r\rI)rQrIr retries.Retry | object | NonerRz float | Noner\z&Generator[DocumentSnapshot, Any, None]) rYzDocumentReference | Queryr r^rRzOptional[float]rTzOptional[ExplainOptions]r\zJStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None])__name__ __module__ __qualname____doc__rr r+r@rDrMr methodDEFAULTrPrZ __classcell__r%s@r&rr,s -9E@ ;4.."@08/F/F $ LL-L L 0 L408/F/F#' / 59 ///-/! / 2 / T/r'rc4eZdZdZdfd ZddZddZxZS)_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. c,tt| |yr)rrhr )r!to_wrapr%s r&r z_Transactional.__init__s nd,W5r'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=r5 current_idrj)r!r<argsrSs 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``. rVN) _resetr)r Abortedrange _max_attemptsrnrMrr4r* BaseExceptionrD) r!r<rmrSretryable_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-B22B55Cr[)r<rr\r)r<r)r_r`rarbr rnrzrerfs@r&rhrhs6:8/r'rhct|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. )rh)rjs r& transactionalr|=s ' ""r'N)rjrr\rh)(rb __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 WriteBatchrrhr|rVr'r&rsoL"DD0,5   A1HFJr%""OrjY'Yx #r'