XjX50dZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlZddlZddlZddlmZddlmZmZddlmZddlmZddlmZdd lmZdd l m!Z!dd l"m#Z#dd lm$Z$dd l%m&Z&m'Z'ddl(Z(ddl)Z)ddl)m*Z*m+Z+ddl,m-Z-m.Z.m/Z/ddl0m1Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9m:Z:m;Z;ddlZ>m?Z?m@Z@mAZAmBZBmCZCmDZDe jEFdp#eGe#e jHdz ZIdZJdZKdZLe7ddddGdd ZMeGd!d"ZNeGd#d$ZOGd%d&ZPe7d'd(d)Gd*d+eZQdS),z,The main Client class for the Python client.) annotationsN)deque)AsyncGeneratorCallable)Future) copy_context) dataclass)datetime)partial)Path)Lock)AnyLiteral) SpaceHardware SpaceStage)RepositoryNotFoundErrorbuild_hf_headerssend_telemetry)version)utils) ParameterInfo)document)AppErrorAuthenticationErrorValidationError) Communicator JobStatusMessage QueueError ServerMessageStatus StatusUpdateUpdateGRADIO_TEMP_DIRgradio<predictsubmitview_api duplicatec,eZdZdZ dZdedddddd[dZdZed\d!Zd]d'Z d(Z e d^d_d1Z d2Z dddd3d`d8Z dadbd:Zddddd;dcd?Zd@Z dddedGZdfdHZdgdJZdhdOZdPZdQZdfdRZdidSZdTZdjdUZdkdWZdldYZdS)mClienta The main Client class for the Python client. This class is used to connect to a remote Gradio app and call its API endpoints. Example: from gradio_client import Client client = Client("abidlabs/whisper-large-v2") # connecting to a Hugging Face Space client.predict("test.mp4", api_name="/predict") >> What a nice recording! # returns the result of the remote API call client = Client("https://bec81a83-5b5c-471e.gradio.live") # connecting to a temporary Gradio share URL job = client.submit("hello", api_name="/predict") # runs the prediction in a background thread job.result() >> 49 # returns the result of the remote API call (blocking call) N(T)headersdownload_files ssl_verify_skip_componentsanalytics_enabled oauth_tokensrcstrtoken str | None max_workersintverboseboolauthtuple[str, str] | None httpx_kwargsdict[str, Any] | Noner0dict[str, str] | Noner1str | Path | Literal[False]r2r3r4r5c|_|_| _|_| _t |dt j_djvrjdjd<jd=|rj || _ d_ d_ |in|_ tj dipi_t#jt$t&frt(jjst)jjd t(jjst3d jd t%j_n t6_|d s|d r|dr|n|dz} n1|} | t3d|d|_ | _ }|tBj"krojrtGd tBj"kr7tIj%d tBj"k7|t j&vrt3d|djrtGdj|'|(_)j)*dd_+j)*dd}|,ddz_-t\j/0jj-1ddz_2t\j/0j2t j3_4t\j/0j2j+dkr t j5n t j6_7t\j/0j2t j8_9t\j/0j2j+dkr t j:n t j;_<t\j/0j2=dddt j>_?t\j/0j2t j@_At\j/0j2t jB_Ctj/j)*dd_EF_Gt%tjI_Jfdtj)d D_LtjNO|!_PtjNOd|z!_QtjNOd!_R| pt)jSd"d#d#k_TjTr-tjVjWd$XtjY_ZtjY_[tjVtj]tj_jZj[fd%_`j)*d&drj`Xd_ad_bi_ct_etjf_gd'_hi_idS)(u Parameters: src: either the name of the Hugging Face Space to load, (e.g. "abidlabs/whisper-large-v2") or the full URL (including "http" or "https") of the hosted Gradio app to load (e.g. "http://mydomain.com/app" or "https://bec81a83-5b5c-471e.gradio.live/"). token: optional Hugging Face token to use to access private Spaces. By default, the locally saved token is used if there is one. Find your tokens here: https://huggingface.co/settings/tokens. max_workers: maximum number of thread workers that can be used to make requests to the remote Gradio app simultaneously. verbose: whether the client should print statements to the console. headers: additional headers to send to the remote Gradio app on every request. By default only the HF authorization and user-agent headers are sent. This parameter will override the default headers if they have the same keys. download_files: directory where the client should download output files on the local machine from the remote API. By default, uses the value of the GRADIO_TEMP_DIR environment variable which, if not set by the user, is a temporary directory on your machine. If False, the client does not download files and returns a FileData dataclass object with the filepath on the remote machine instead. ssl_verify: if False, skips certificate validation which allows the client to connect to Gradio apps that are using self-signed certificates. httpx_kwargs: additional keyword arguments to pass to `httpx.Client`, `httpx.stream`, `httpx.get` and `httpx.post`. This can be used to set timeouts, proxies, http auth, etc. analytics_enabled: Whether to allow basic telemetry. If None, will use GRADIO_ANALYTICS_ENABLED environment variable or default to True. oauth_token: optional Hugging Face token for the app to act on your behalf, for endpoints whose function takes a `gr.OAuthToken`. Unlike `token`, which only authenticates you to the app, this is passed to the app's code, so it is sent only to endpoints that declare they need it — `view_api()` marks those. It is never sent anywhere else, and is not inferred from your locally saved token. gradio_client)r8 library_namelibrary_version authorizationzx-hf-authorizationNFcookiesTexist_okzPath: z is not a directory.http://https:///Could not find Space: z@. If it is a private Space, please provide a Hugging Face token.z'Space is still building. Please wait...z+The current space is in the invalid state: z'. Please contact the owner to fix this.zLoaded as API: protocolws api_prefixssehttpr&rz2.0c i|]E\}}|d|t|d||jFS)id)getEndpointrQ).0fn_index dependencyselfs EC:\Projects\Historical\venv\Lib\site-packages\gradio_client/client.py z#Client.__init__..sb   %* NN4 * *HjnnT844j$---   dependencies)r:GRADIO_ANALYTICS_ENABLEDTrue)targetdaemon)reargsrfconnect_heartbeatr)jr<r8r5r1r3rr __version__r0updater2space_id_space_is_privater@dictpoprI isinstancer7r ospathexistsmakedirsisdir ValueError output_dirDEFAULT_TEMP_DIR startswithendswith_space_name_to_srcr6_get_space_staterBUILDINGprinttimesleepINVALID_RUNTIME_login _get_configconfigrYrQlstriprSurllibparseurljoinrstrip src_prefixedAPI_URLapi_url SSE_URL_V0SSE_URLsse_url HEARTBEAT_URL heartbeat_urlSSE_DATA_URL_V0 SSE_DATA_URL sse_data_urlreplaceWS_URLws_url UPLOAD_URL upload_url RESET_URL reset_urlr app_version _get_api_info_infouuiduuid4 session_hash enumerate endpoints concurrentfuturesThreadPoolExecutorexecutorhelper_executorstream_executorgetenvr4 threadingThread_telemetry_threadstartEvent_refresh_heartbeat_kill_heartbeatr._stream_heartbeatweakrefref heartbeat stream_openstreaming_futurepending_messages_per_eventsetpending_event_idsr pending_lock stream_epochpending_event_epoch)r^r6r8r:r<r>r@r0r1r2r3r4r5_srcstaterSs` r___init__zClient.__init__Ts:  &, 0'(!-    dl * *15o1NDL- . _-  ) L   ( ( ($ !&"."6BBL'+   " "9b 1 1 8b( (   d)C; 7 7 /7>>$"566 @ D/$????7==!455 U !S$*=!S!S!STTT!$"566DOO.DO >>) $ $ z(B(B ,,s++:33sDD**3//D| rSrrr DM%%'' J' ' '| A?@@@''))Z-@@@ 1 ''))Z-@@@ E) ) )8e888  < 0 .DH.. / / /   KK   &&(( KOOJ - - +//,;; $++C0036 L 4? ; ; B B3 G G# M |++D,=u}MM |++   $  6 6E  EM   $\11  u2  #L00  %)]e%;%;E ! !AS  l**   % %fdA 6 6    !,..t/@%BRSS--d.?QQ"=E)J)JKK''))  --    )2$+n2M(N(N    #*==+=VV  *1DDK E   *1DDQRDSS  X+Ev!N!NRX!X   ! Q  D$:4 H H H N N P P P"+/"3"3(00")++d##T%RS    ;??. 5 5 # N " " " /3LN'+.55%N,,35   rac|j|jr|jddSdS)Nr&timeout)rrris_alivejoinr^s r_closez Client.closesV   """ > " " $ $ + N    * * * * * + +ra client_refweakref.ref[Client]refresh_heartbeatthreading.Eventkill_heartbeatcFt}|s|}|dS||j|j}|j}|dd|j |j |j } }}~d} tj d|f||| d|5} | jp | jdk} | js| s ddddS| j dd d } | jr| rt'j}| D]b}t'j|z t,krt}|rddddS|rd } ncdddn #1swxYwYn#tj$rYdSwxYw| r||rdSt3|d zt4}|dSdS) NrrFGETr0rIverifyz content-typerTztext/event-streamTrP)HEARTBEAT_RETRY_DELAY_MINis_setclearrformatrr@copy setdefaultr0rIr2httpxstreamis_server_error status_code is_successrYrxr~ monotonic iter_linesHEARTBEAT_RETRY_RESET_AFTERTransportErrorwaitminHEARTBEAT_RETRY_DELAY_MAX)rrr retry_delayclienturlr@r0rIr2 refreshedresponse retryableis_event_streamstream_started_s r_rzClient._stream_heartbeats 0  ''))1 JZ\\F~  # # % % %&--6;N-OOC!.3355L  # #Ir 2 2 2!)WG I \$#%  # & ( 8 WH A#>!?!?/H -4466' &/&&&&&&&&0 17799&,0 %&1&&&&&&&&&&&&&&&6'     "";// kAo/HIIKc!''))1 J1 J1 J1 J1 JsO'G>F5 G(BF5 GF5) G5F99G<F9=GGGrQ1Literal['sse_v1', 'sse_v2', 'sse_v2.1', 'sse_v3']rreturnNonec P |j}|dtjdtjdd|ji|5}|d|jd|i|j |j 5}d}| D]}||z }d|vr|| dd \}}| d d }t|sV|d rt#j|d d} | dt&jkr| ddt&jkrx|j5t1|j} dddn #1swxYwY| D]} | | dddddddS| dt&jkr?|j5d|_dddn #1swxYwYdddddddS| d} |j5| |jvrt=|j| <|j| | | dt&jkr|j !| t|j dko|dk} | rd|_dddn #1swxYwY| rdddddddSntEd|dd|v| dddn #1swxYwYddddS#1swxYwYdS#tF$r?}tI|tj%rYd}~dSddl&}|'|d}~wwxYw)Nrrrrr)paramsr0rIras r&zutf-8 zdata:msgmessagerTFevent_idrsse_v3zUnexpected SSE line: '')(r@rrrTimeoutr.r2rrr0rI iter_bytessplitdecoderlenrxjsonloadsr rrYserver_stoppedrlistrvaluesappend close_streamrrprocess_completedrdiscardru BaseExceptionroRemoteProtocolError traceback print_exc)r^rQrr@rrbufferchunklineresppendingpending_messagesrrer s r_stream_messageszClient.stream_messages3si H ,1133L  # #Iu}T/J/J/J K K K; S]]L*L9 L L #7S  F!)!4!4!6!6/S/S%%//+1<<+C+CLD&#';;w#7#7#>#>t#D#DD#&t99) (#w77(S'+z$qrr(';';#';-2I#I#I$,$(HHY$;$;'4'C%D%D*.):%*%*26,0,K,R,R,T,T3*3*%*%*%*%*%*%*%*%*%*%*%*%*%*%*%*=D%F%F(8(8(?(?(E(E(E(E$*;7S7S7S7S7S7S ; S; S; S; S; S; S; S; SD&*%[M4N%N%N)-):%A%A;@(8%A%A%A%A%A%A%A%A%A%A%A%A%A%A%A$*C7S7S7S7S7S7S ; S; S; S; S; S; S; S; SL,0 +;%)%6!A!A'/t7V'V'V,1GG)-(G(Q%)$CH$M$T$T(,%&%&%&(,E{m6U'U'U(,(>(F(Fx(P(P(P(+D,B(C(Cq(H)A,4,@%*(-%A;@(8!!A!A!A!A!A!A!A!A!A!A!A!A!A!A!A"$)!+$*k7S7S7S7S7S7S ; S; S; S; S; S; S; S; Sp!+'11Q$1Q1Q1Q&R&R R[&///S7S7S7S7S7S7S7S7S7S7S7S7S7S7S7S ; S; S; S; S; S; S; S; S; S; S; S; S; S; S; S; S; S; Sx   !U677         ! ! !G s AM,MC)L71'F$  L7$F( (L7+F( ,L7 M M"L7?H  L7H L7H L7 M* M7L7BK)  L7)K- -L70K- 1L77 M ML7+ M7L; ;M>L; ?M MMMMM N%&N N  N%c j}|i||}tjjfi||jjdj}|jdkrtdtj |x}t|| |}|d} j5j } | rd_xjdz c_j j| j| t- j| <t1jxjzc_fdjD_dddn #1swxYwY| rFfd} fd } j| _j| | S) Nrr0rIriz Queue is full! Please try again.rTr&c$i|] \}}|v || Srr)r[eidtaggedlives r_r`z$Client.send_data..s0(((C$;;V;;rac>dS)Nrr)r) hash_datarQr^sr_ open_streamz%Client.send_data..open_streams*++9^+D,rac j5j|urd_jkrd_fdjD}dddn #1swxYwY|D]}|ddS)NFc^g|])\}}j|dzk'|*S)r&)rrY)r[rmessagesepochr^s r_ z:Client.send_data..close_stream..sI)C377UQYGG5PP!PPPra)rrrrritemsr)futurerrr!r^s r_rz&Client.send_data..close_streams&  ,6604-(E11,1(-1-L-R-R-T-TG               )022$$++D111122sA AA"%A")add_zero_gpu_headersr0rpostrrIr2r@rrrextract_validation_messagerraise_for_statusrrrrraddrrrrrr#rr*radd_done_callback)r^datarrQrequest_headersr0reqvalidation_messagerr open_readerrrr!rs` `` @@r_ send_datazClient.send_datas++DL99  &44G4Gj   &D&I&L?       ?c ! !?@@ @"'"B3"G"G G  T!"455 5 xxzz #    "..K '#' !!Q&!!%E  " & &x 0 0 0  + 6 6x I I I16D $X .t677D  " "d * " "((((#'#;#A#A#C#C(((D $               &  B         2 2 2 2 2 2$%)$8$?$? $L$LD !  ! 3 3L A A As CFF"Frfrom_idto_idprivatehardware}Literal['cpu-basic', 'cpu-upgrade', 't4-small', 't4-medium', 'a10g-small', 'a10g-large', 'a100-large'] | SpaceHardware | Nonesecrets sleep_timeoutc  tj||} n&#t$r} td|d| d} ~ wwxYw|r6d|vr|dd}tj||} n/tj|dd|} tj| || r0t dtj | d|tj d n#t$r| rt d |d tj || d |d ||-|j D]\} }tj| | ||| r/t dtj | YnwxYwtj| |}|jptjj}|p| j}||kr*tj| ||t d|d|tjjkrtj| ||dz| rt d|| ||| }|S)a_ Duplicates a Hugging Face Space under your account and returns a Client object for the new Space. No duplication is created if the Space already exists in your account (to override this, provide a new name for the new Space using `to_id`). To use this method, you must provide an `token` or be logged in via the Hugging Face Hub CLI. The new Space will be private by default and use the same hardware as the original Space. This can be changed by using the `private` and `hardware` parameters. For hardware upgrades (beyond the basic CPU tier), you may be required to provide billing information on Hugging Face: https://huggingface.co/settings/billing Parameters: from_id: The name of the Hugging Face Space to duplicate in the format "{username}/{space_id}", e.g. "gradio/whisper". to_id: The name of the new Hugging Face Space to create, e.g. "abidlabs/whisper-duplicate". If not provided, the new Space will be named "{your_HF_username}/{space_id}". token: optional Hugging Face token to use to duplicating private Spaces. By default, no token is sent to the server. Set `token=None` to use the locally saved token if there is one. Find your tokens here: https://huggingface.co/settings/tokens. private: Whether the new Space should be private (True) or public (False). Defaults to True. hardware: The hardware tier to use for the new Space. Defaults to the same hardware tier as the original Space. Options include "cpu-basic", "cpu-upgrade", "t4-small", "t4-medium", "a10g-small", "a10g-large", "a100-large", subject to availability. secrets: A dictionary of (secret key, secret value) to pass to the new Space. Defaults to None. Secrets are only used when the Space is duplicated for the first time, and are not updated if the duplicated Space already exists. sleep_timeout: The number of minutes after which the duplicate Space will be puased if no requests are made to it (to minimize billing charges). Defaults to 5 minutes. max_workers: The maximum number of thread workers that can be used to make requests to the remote Gradio app simultaneously. verbose: Whether the client should print statements to the console. Example: import os from gradio_client import Client HF_TOKEN = os.environ.get("HF_TOKEN") client = Client.duplicate("abidlabs/whisper", token=HF_TOKEN) client.predict("audio_sample.wav") >> "This is a test of the whisper speech recognition model." r8rOz5. If it is a private Space, please provide a `token`.NrNr&zUsing your existing Space: u 🤗zSecrets are only used when the Space is duplicated for the first time, and are not updated if the duplicated Space already exists.zCreating a duplicate of u for your own use... 🤗spaceT)r1r2 repo_typer8rKr3zCreated new Space: z1------- NOTE: this Space uses upgraded hardware: zG... see billing info at https://huggingface.co/settings/billing -------r')r8timeout_in_secondsrT)r8r:r<)huggingface_hubget_space_runtimerrurget_full_repo_namer}r SPACE_URLrwarningswarnduplicate_repor#add_space_secretr4r CPU_BASICrequest_space_hardwareset_space_timeout)clsr1r2r8r3r4r6r7r:r< original_infornferkkeyvalue current_infocurrent_hardwarers r_r,zClient.duplicates j +=gUSSSMM&   gggg    e|| C((+&9%uMMMHH&9 c""1%UH P  -he D D D D Y%/2H2H2R2RYYY" Y' P P P USSSSTTT  *!     ""/'-//XXJC#4XsEQVWWWWW PNEO,B,B8,L,LNNOOO P '8OOO  ! L_%B%L 5}5 x ' '  28XU S S S S XXXXX    4> > >  #-":L       "IIIXU WUUU s$ <7<'ADBF"!F"cb|jsdStj|j|j}|jSNr9)rkr=r>r8stage)r^infos r_r{zClient._get_space_state=s2} 40djQQQzraapi_namer\r0rTr\ int | NonercH|j||||d|S)aC Calls the Gradio API and returns the result (this is a blocking call). Arguments can be provided as positional arguments or as keyword arguments (latter is recommended). Parameters: args: The positional arguments to pass to the remote API endpoint. The order of the arguments must match the order of the inputs in the Gradio app. api_name: The name of the API endpoint to call starting with a leading slash, e.g. "/predict". Does not need to be provided if the Gradio app has only one named API endpoint. fn_index: As an alternative to api_name, this parameter takes the index of the API endpoint to call, e.g. 0. Both api_name and fn_index can be provided, but if they conflict, api_name will take precedence. kwargs: The keyword arguments to pass to the remote API endpoint. headers: Additional headers to send to the remote Gradio app on this request. This parameter will overrides the headers provided in the Client constructor if they have the same keys. Returns: The result of the API call. Will be a Tuple if the API has multiple outputs. Example: from gradio_client import Client client = Client(src="gradio/calculator") client.predict(5, "add", 4, api_name="/predict") >> 9.0 rS)r*result)r^rTr\r0rgkwargss r_r)zClient.predictCs92t{ Hx  LR  &(( rarcttt|j|j|j|S)N)r,)rr rrprocess_predictionsr)r^r\r0s r_ new_helperzClient.new_helper`s> FF KK N8 $ 8 N#     ra)rTr\r0result_callbacksr\ Callable | list[Callable] | NoneJobc|||}|j|}t|trt j|j||}d} |jdvr6|pi}d|d<|||} | | } ntd|jz|j j tj| g|R} || } t!| | |j|j| } |r?t|t&r|g}d d }|D] }| ||!| S) aP Creates and returns a Job object which calls the Gradio API in a background thread. The job can be used to retrieve the status and result of the remote API call. Arguments can be provided as positional arguments or as keyword arguments (latter is recommended). Parameters: args: The arguments to pass to the remote API. The order of the arguments must match the order of the inputs in the Gradio app. api_name: The name of the API endpoint to call starting with a leading slash, e.g. "/predict". Does not need to be provided if the Gradio app has only one named API endpoint. fn_index: As an alternative to api_name, this parameter takes the index of the API endpoint to call, e.g. 0. Both api_name and fn_index can be provided, but if they conflict, api_name will take precedence. result_callbacks: A callback function, or list of callback functions, to be called when the result is ready. If a list of functions is provided, they will be called in order. The return values from the remote API are provided as separate parameters into the callback. If None, no callback will be called. kwargs: The keyword arguments to pass to the remote API endpoint. headers: Additional headers to send to the remote Gradio app on this request. This parameter will overrides the headers provided in the Client constructor if they have the same keys. Returns: A Job object that can be used to retrieve the status and result of the remote API call. Example: from gradio_client import Client client = Client(src="gradio/calculator") job = client.submit(5, "add", 4, api_name="/predict") job.status() >> job.result() # blocking call >> 9.0 N)rUsse_v1sse_v2sse_v2.1rapiz x-gradio-user)r0zUnknown protocol: ) communicatorr<rk _cancel_fnrrcfd}|S)Nct|tr|dS|dSN)rorWtuple)r$callbacks r_fnz,Client.submit..create_fn..fnsV!&--//5992 &--//2222 11111rar)rjrks` r_ create_fnz Client.submit..create_fns#22222  ra)rr)_infer_fn_indexrrorZrconstruct_argsparameters_inforQr[make_end_to_end_fnrurr*rrun make_cancelr^r<rkrr*)r^rTr\r0r\rgrXinferred_fn_indexendpointhelper end_to_end_fnr$ cancel_fnjobrlrjs r_r*z Client.submitks>!008DD>"34 h ) ) P'(@$OOD  !   mG',GO $__%6_HHF$77??MM1H4EEFF F%%lnn&8-O$OOO((00  L]      ;*H55 6$4#5     - ; ;%%ii&9&9:::: rac\tj|jtj}|jtjdkretj |f|j |j |j d|j}|jr|}nt#d|jd|jtjtjft!j|jdd|j |j |j d|j}|jr|d}nt#d|jd|ji}i}|d D]S\}}|d dd |vr|d d ks|d dr|||<T|dD]S\} }|d dd |vr|d d ks|d dr||| <T||d<||d <|S)Nz3.36.1rzCould not fetch api info for : F)r serializerrcnamed_endpoints code_snippetsapi_visibilityr3show_apiTunnamed_endpoints)rrrrrRAW_API_INFO_URLrrVersionrrYr0rIr2r@rrrur6textr&SPACE_FETCHER_URLdumpsrr#rn) r^ api_info_urlrrRfetchr|rrTrtr\s r_rzClient._get_api_infos~|++D,=u?UVV  goh77 7 7     # A| Wvvxx !U!U!UQV!U!UVVVJ' #j55!&    #  E zz||E* LDHLL LL"&'8"9"?"?"A"A 5 5 Hh LL$ / / / H,,LL!122i??,,z400@,4)"&':";"A"A"C"C 7 7 Hh LL$ / / / H,,LL!122i??,,z400@.6!(+$5 !"1  ra all_endpoints bool | None print_info return_formatLiteral['dict', 'str'] | Nonedict | str | Nonec,t|jd}t|jd}|dkr|d}d}|d|dz }|jdD]\}}||||z }|rU|d |dz }|jdD]+\} }||t | |z },n|dkr |d |d z }|rt ||d kr|S|d kr|jSdS) a Prints the usage info for the API. If the Gradio app has multiple API endpoints, the usage info for each endpoint will be printed separately. If return_format="dict" the info is returned in dictionary format, as shown in the example below. Parameters: all_endpoints: If True, prints information for both named and unnamed endpoints in the Gradio app. If False, will only print info about named endpoints. If None (default), will print info about named endpoints, unless there aren't any -- in which it will print info about unnamed endpoints. print_info: If True, prints the usage info to the console. If False, does not print the usage info. return_format: If None, nothing is returned. If "str", returns the same string that would be printed to the console. If "dict", returns the usage info as a dictionary that can be programmatically parsed, and *all endpoints are returned in the dictionary* regardless of the value of `all_endpoints`. The format of the dictionary is in the docstring of this method. Example: from gradio_client import Client client = Client(src="gradio/calculator") client.view_api(return_format="dict") >> { 'named_endpoints': { '/predict': { 'parameters': [ { 'label': 'num1', 'python_type': 'int | float', 'type_description': 'numeric value', 'component': 'Number', 'example_input': '5' }, { 'label': 'operation', 'python_type': 'str', 'type_description': 'string value', 'component': 'Radio', 'example_input': 'add' }, { 'label': 'num2', 'python_type': 'int | float', 'type_description': 'numeric value', 'component': 'Number', 'example_input': '5' }, ], 'returns': [ { 'label': 'output', 'python_type': 'int | float', 'type_description': 'numeric value', 'component': 'Number', }, ] }, '/flag': { 'parameters': [ ... ], 'returns': [ ... ] } } } 'unnamed_endpoints': { 2: { 'parameters': [ ... ], 'returns': [ ... ] } } } } r|rrNTz8Client.predict() Usage Info --------------------------- zNamed API endpoints: rz Unnamed API endpoints: z3, to view, run Client.view_api(all_endpoints=True) r7rm)rrr#_render_endpoints_infor;r}) r^rrrnum_named_endpointsnum_unnamed_endpoints human_inforT endpoint_infor\s r_r+zClient.view_apisX"$*->"?@@ #DJ/B$C D D ! # # (= MQ E.AEEEE '+z2C'D'J'J'L'L O O #Hm $55h NN NJJ  B O6KOOO OJ+/:6I+J+P+P+R+R X X'-d99#h--WWW  X#Q & & B6KBBB BJ   *    E ! !  f $ $: % $racttj|_|jdSrh)r7rrrrrrs r_ reset_sessionzClient.reset_sessionXs3 -- ##%%%%%radict[str, str]c|js|S ddlm}n#t$r|cYSwxYw|jd}|r)t |drd|jvr|jd|d<|S)a Adds the x-ip-token header to the headers dictionary to pass it to a Zero-GPU Space. This allows a user's ZeroGPU quota to be tracked and used by the underlying Space. For the x-ip-token header to be present, this method needs to be called when a Gradio app's LocalContext is defined. i.e. this method needs to be called when a Gradio app's LocalContext is defined. i.e. must be called from inside a Gradio app's event listener function or will not have any effect. r) LocalContextNr0z x-ip-token)rkgradio.contextr ImportErrorrequestrYhasattrr0)r^r0rrs r_r%zClient.add_zero_gpu_headers\s} N  3 3 3 3 3 3 3    NNN &**400  Bww 22 B|w7V7V$+OL$AGL !s  !! name_or_index str | intendpoints_infodict[str, list[ParameterInfo]]c $|d}d|D}d|D}d|}|r|dz}d|dD}d|D}d|}t|dkrd |d }t|trd |d }n*t|trd |}nt dd||d|d} |dr| d|ddz } | dz } |r|D]} | ddrd| ddd nd} | d} tj| dtj } | ddsdnd| d } | dd }| ddr| |d!z }| d"| d#d$tj | d%p| d&d'|d(| d(| d) z } n| d*z } | d+z } |drx|dD]n} | ddrd| ddd nd} | dd }| d"| d#d$tj | d&d'|| d)z } on| d*z } | S),N parameterscHg|]}|dp|d S)parameter_namelabel)rYr[ps r_r"z1Client._render_endpoints_info..ws;   67AEE" # # 1qz   rac6g|]}tj|Srrsanitize_parameter_namesrs r_r"z1Client._render_endpoints_info..zs#VVV59!<<VVVra, cg|] }|d S)rrrs r_r"z1Client._render_endpoints_info..~sGGG7GGGrareturnsc6g|]}tj|Srr)r[rs r_r"z1Client._render_endpoints_info..s#RRRq7::RRRrar&()z api_name=""z fn_index=z)name_or_index must be a string or integerz - predict(z) -> rr5zF Acts on your behalf: this endpoint takes your Hugging Face token (z:). Pass it with Client(..., oauth_token=...) to grant it. z Parameters: python_type descriptionz (rTparameter_defaultcd|ddS)Nz handle_file("rz")rxs r_z/Client._render_endpoints_info..s:ah:::raparameter_has_defaultFz (required)z(not required, defaults to: typez | Nonez - [ componentz] rrrz z z - None z Returns: ) rrror7r;rurYrtraverseis_file_obj_with_metar)r^rrparameter_infoparameter_namesrendered_parameters return_valuesrendered_return_values final_paramrrRdesc default_value default_infotype_s r_rzClient._render_endpoints_infoqs ( 5  ;I   WVoVVV"ii88  ="5"< GG^I-FGGG RRMRRR !%=!9!9 }   ! !%B)?%B%B%B " mS ) ) J7}777KK  s + + J5m55KKHII If%8f+ffLbfff   m , ,  ?(7??? J ))  *& n nM*..}==>m,];>>>> !%)< = = %!::/!!  88$;UCCKLLJ-JJJ ]+F3883U;;' @UY&Enk):nne>\]a]e]efv]w]w^I{AH|I?J?JnnNSnnVbnneinnnn ) n, / )J&& ) $ *&y1 @ @M*..}==>m,];>>>> ]+F3k):e>\]abi]j>k>kotvz  @ / )Jrac0|ddSNFr7)rrr+rs r___repr__zClient.__repr__}}U}CCCrac0|ddSrrrs r___str__zClient.__str__rracvd|ji} tddtj|dS#t$rYdSwxYw)Nr6zpy_client/initiatedrE)topicrFrG user_agent)r6rrri Exceptionr^r+s r_rzClient._telemetry_threadsk 48   +, % 1            DD s * 88cfd}|t|jdD][\}}|d}||dus|ddkr:d|z|kr|d|}n0\d|d }|ds|d z }t |n|1|}||jvs|j|jst d |d nSd |jD}t|d kr|dj }nt d|S)NrbrTFr~r3rNrXz(Cannot find a function with `api_name`: .z% Did you mean to use a leading slash?zInvalid function index: cRg|]$}|jr|j|j |jdk"|%S)Npublic)is_validrT backend_fnr~)r[rs r_r"z*Client._infer_fn_index..sN:J*L,$00  100rar&rzYThis Gradio app might have multiple endpoints. Please specify an `api_name` or `fn_index`) rrrYrxrurrrrr\) r^rTr\rsidconfig_api_name error_messagevalid_endpointss r_rmzClient._infer_fn_indexs   !$+n"=>> 0 01"#%% "3"3$+&%//uu-..);;(H44()dA%E5!W8 V V V **3//M!%LLM ///   ! ( !77~&78A8!!GH!G!G!GHHH8 ..00O?##q(($3A$6$?!! o! rac^t|dr|jt|dr|jdt|dr|jdt|dr|jddSdS)NrrF)rrr)rrrrshutdownrrrs r___del__zClient.__del__s 4* + + '  $ $ & & & 4 $ $ / M " " " . . . 4* + + 6  ) )u ) 5 5 5 4* + + 6  ) )u ) 5 5 5 5 5 6 6racxtj||j}t|j|_|jSrP)r= space_infor8r=r3rlhost)r^r:rs r_rzzClient._space_name_to_srcs4$/TZHHH !%j&8!9!9ratuple[str, str]ctjtj|jt jf|d|dd|jd|j }|j s;|j dkrtd|jdtd|jdd |jD|_d S) z Logs in to `utils.LOGIN_URL` using provided `auth` credentials. Warning: This method overwrites `self.cookies`. rr&)usernamepassword)r+rzCould not login to z. Invalid credentials.rci|] \}}||| Srhr)r[namerLs r_r`z!Client._login..s*   'D%5CTD%CTCTCTraN)rr&rrrr6r LOGIN_URLr2r@rrrrurIr#)r^r>rs r_rz Client._login s z L 5? ; ; "1g47;;?       D3&&)J$(JJJ!!Btx!B!B!BCCC  +/<+=+=+?+?    rarmctjtjjt jfjj j dj }|j rSfd|j D}j ||S|jdkrt#djd|jdkrt jddtjjfjj j dj }|j st'djt)jd |j} tj|d }n*#t2$r}t'd j|d}~wwxYwd |vrt'd |S)Nrc2i|]\}}||jv||Srh)rI)r[rrLr^s r_r`z&Client._get_config..0s;D%$T\)A)Ae)A)A)ArarzCould not load z0 as credentials were not provided. Please login.rz5Too many requests to the API, please try again later.zCould not fetch config for z+window.gradio_config = (.*?);[\s]*r&z"Could not get Gradio config from: allow_flaggingzcGradio 2.x is not supported by this client. Please upgrade your Gradio app to Gradio 3.x or higher.)rrYrrrr6r CONFIG_URLr0rIr2r@rr#rjrrrTooManyRequestsErrorruresearchrrgroupAttributeError)r^r new_cookiesrWraes` r_rzClient._get_config#s I L 5+; < < LL?       <*  #$9??#4#4K L   , , ,6688O ]c ! !%\$(\\\ ]c ! !,G      # A< K !Itx!I!IJJJYMqvVVF FLLOO44!    CCC  6)) yMs'F F-F((F-)Nr/TNN)r6r7r8r9r:r;r<r=r>r?r@rAr0rBr1rCr2r=r3r=r4r=r5r9)rrrrrr)rQrrr7rr)NNTNNrr/T)r1r7r2r9r8r9r3r=r4r5r6rBr7r;r:r;r<r=)rTr9r\rUr0rBrrrh)r\r;r0rBrr) rTr9r\rUr0rBr\r]rr^)NTN)rrrr=rrrr)rr)r0rrr)rrrrrr7)rTr9r\rUrr;rr9)r>r)rrm)__name__ __module__ __qualname____doc__rwrr staticmethodrrr0 classmethodr,r{r)r[r*rr+rr%rrrrrmrrzrrrrar_r.r.Bs&!'+.2^6*.6F!%"&"&^6^6^6^6^6^6@+++ 7J7J7J\7JrMMMM^GGGR! )-)oooo[ob $#)- <?C       $#)-=A PPPPPPd222l&*7; eeeeeN&&&&*GGGGRDDDDDD    *!*!*!*!X 6 6 6     ,222222rar.c.eZdZUded<ded<ded<dS)ComponentApiTyper=skip value_is_fileis_stateNrrr__annotations__rrar_rrXs.JJJNNNNNrarceZdZUded<dS) ReplaceMer;indexNrrrar_r r _sJJJJJrar ceZdZdZ d=d>d Zd?d Zd@dZdAdZdBdZe dCdZ e dDdZ e j dEdZ dZdZdFdZdGd!ZdFd"ZdHd$ZdHd%Zd&ZdHd'ZdHd(ZdId*ZdJd.ZdKd0ZdLd3ZdMd5ZdNd8ZdOd;Zd.ss4& & & .1D $ $S ) )& & & rainputsc:g|]}|Srrrs r_r"z%Endpoint.__init__..vs4' ' ' .1D $ $S ) )' ' ' raoutputsrr~r3Fr undocumentedr)rr_clientr\r]rYror7rTrrrQinput_component_typesoutput_component_types_get_parameters_inforo_get_oauth_token_requirementoauth_token_requirementrroot_urlrrr~)r^rr\r]rQrTs` r_rzEndpoint.__init__gs{6**   $>>*--(377 EC(NNX [&   & & & & 5?5I& & & "' ' ' ' 5? 5J' ' ' # $88::'+'H'H'J'J$ 0 $..66 z ) )&'78IEDM",-=">D   &NN:66eCDM= /&/### ++u44&4###&.###ra component_idctfd|jjdD}|d|dtjv}t ||||ddkS)Nc34K|]}|dk|VdSrXNr)r[rrs r_ z/Endpoint._get_component_type..s:  1T7l;R;RA;R;R;R;R  ra componentsskip_apirr)nextrrrYrSKIP_COMPONENTSrr)r^rrr#s ` r_rzEndpoint._get_component_types    {),7     ==Yv->%BW-WXX    y ) ) f  (   rarlist[ParameterInfo] | Nonecj|j|jdvr|jd|jdSdS)Nr|r)rTrrs r_rzEndpoint._get_parameters_infos6 =DJ'89 9 9:/0? M Mtrar9c|j|jdvr+|jd|jdSdS)zJReturns "required", "optional", or None for this endpoint's gr.OAuthToken.r|r5N)rTrrYrs r_rz%Endpoint._get_oauth_token_requirements? =DJ'89 9 9:/0?CCMRR Rtrarc8|jj}|r |jd|iSiS)zSThe oauth_token body field, if this endpoint takes one and the caller supplied one.Nr5)rr5r)r^r8s r_oauth_token_payloadzEndpoint.oauth_token_payloads, '  *T1=!5) ) rarr=cBd|vrdStj|dS)Napi_infoF)rr)rs r_rzEndpoint.value_is_files* Y & &5"9Z#8999racP|}|td|S)Nz?The Client this endpoint belongs to has been garbage collected.)rrur^rs r_rzEndpoint.clients0 >Q  rarcfd|_dS)NcSrhrrsr_rz!Endpoint.client..svra)rr.s `r_rzEndpoint.clients&~~~ rac@d|jjd|jd|jS)NzEndpoint src: z , api_name: z , fn_index: )rr6rTr\rs r_rzEndpoint.__repr__s*g ggT]ggX\Xegggrac*|Srh)rrs r_rzEndpoint.__str__s}}rarurcVjfd}|S)Nc.jstjjr j|}j|}|i|}j|}rJj5jj sjj |dddn #1swxYwY|Srh) rrInvalidAPIEndpointErrorr3insert_empty_stateprocess_input_filesrZlockrxrr)r+rX predictions_predictrrur^s r__innerz+Endpoint.make_end_to_end_fn.._inners= 63555& 6.t.5+4+T2D"(D3F33K2$2K@K ?[??!:-? *11+>>>??????????????? s,B  BB) make_predictr)r^rur<r;rs`` @@r_rpzEndpoint.make_end_to_end_fnsO$$V,,        $ raCommunicator | NonecZ dSj jtjdkr;tj jtj  fd dd ng}t j dD]=\}}j |dvr)| |fd|dDf>|rt|dnd \ } du d r*|r( fd |D}d d |d n sd fd j  fd}|S)Nz4.29.0c.jjjdS)Nr\rrrA)rrur^sr_ post_dataz'Endpoint.make_cancel..post_datas" $ $*$7 &raTrbcancelsc*g|]}|jk |Sr)r\)r[rr^s r_r"z(Endpoint.make_cancel..s%MMM1!t}:L:LQ:L:L:Lrac,t|dS)Nr&)rrs r_rz&Endpoint.make_cancel..sc!A$iira)rK)NNcbg|]+}djd|dz,S)rNrbrT)rrY)r[rrs r_r"z(Endpoint.make_cancel..sH###&-7:>>zJJJ###raz1Cancelled this job will also cancel any jobs for rz that are currently running.zCancelling this job will not stop the server from running. To fix this, an event must be added to the upstream app that explicitly cancels this one or the upstream app must be running Gradio 4.29.0 and greater.cgjdS)N)r+r\rr)rr\sr_rBz'Endpoint.make_cancel..post_datas ($*$7racrtjr5tjfjjjdjdSdS)Nr)rArBrr&r0rIr2r@) cancel_msg cancellablerrBrsr__cancelz%Endpoint.make_cancel.._cancels~ * j)))  ""N"N!,  )   ra)rrrrrrrrr CANCEL_URLrrr\rrrr)r^ru candidatesrdepother_cancelledother_api_namesrKrIrJrr\rBrs`` @@@@@@r_rrzEndpoint.make_cancels > F   9 9 9 9,&&v':E._predict+sK  M **,, D!M & >6;N O OI }%%y&AA"LLL!++)T]F4J#+,,VXt}MM !I$-!I!IJJJ&  '?*"_ %jj11G"==7=f===    OP+6vGGOO f$$&/)A)Ao)A4@MS_@@@  &&$VG_554?YQWYY  == sD F("BF##F(rrir1)r^rur;rs`` @r_r=zEndpoint.make_predict(s<5 !5 !5 !5 !5 !5 !5 !5 !nrarict|}t|jD]"\}}|jr||d#t |Srh)rrrrinsertri)r^r+rinput_component_types r_r7zEndpoint.insert_empty_statedsYDzz'01K'L'L % % #A##, % At$$$T{{racg}t|D]N\}}tj|t|j|tj}||Ot|S)N) data_index)rrrr _upload_filerrri)r^r+data_rrs r_r8zEndpoint.process_input_filesksldOO  DAq)a888+A LLOOOOU||racr|jjr |j|}|jjr |j|}|j|}|Srh)rr1r3remove_skipped_componentsreduce_singleton_output)r^r:s r_rZzEndpoint.process_predictionsvsR ; % <-$-{;K ; ' G8$8+FK2d2K@ ract|}|jjdkr&tj||jtj}n%tj||jtj}t|S)Nrb) rrrQrr_download_filer is_file_objri)r^r+rbs r_r1zEndpoint.download_filessdT  ; : - -Nt*E,GEEN5$*=u?PQQEU||racbdt||jdD}t|S)rTc&g|]\}}|j |Srr)r[rocts r_r"z6Endpoint.remove_skipped_components..s4   38    raF)strict)ziprrirs r_rdz"Endpoint.remove_skipped_componentss@  dD$?NNN    T{{rarc|jjrd|jD}n|j}t|dkr|dS|S)Nc g|] }|j | Srrk)r[os r_r"z4Endpoint.reduce_singleton_output..s/+++af++++rar&r)rr3rr)r^r+effective_output_componentss r_rez Endpoint.reduce_singleton_outputsb ; ' F++6+++ ' '+/*E ' * + +q 0 07NKrafr`dict[str, Any]c  |d}|jjrB|dds,||r||||St |}t j|so|jd| t fd|jj dDi}|jj dd}| tj n|}tj||kr0t!d|d |d |d d d zd t#|d5}d|j|ffg}t'j|jjf|jj|jj|jj|d|jj} dddn #1swxYwY| | } | d}|t j|jddidS)Nrq is_streamFrc34K|]}|dk|VdSr r)r[crs r_r!z(Endpoint._upload_file..s>w,......rar" max_file_sizezFile z" exceeds the maximum file size of z bytes set in rrTz component.rbfiles)r0rIrr{r_typezgradio.FileData)rq orig_namemeta)rrlrY_is_upstream_file_url_upload_upstream_filer ris_http_url_liker]r$rmathinfrprqgetsizeruopenrrr&rr0rIr2r@r(r!strip_invalid_filename_characters) r^rsr` file_pathr}component_configryf_r{rrWrs @r_razEndpoint._upload_filesfI K ) HEE+u-- H**955 H --iJGG GOO %i00 "?84Z@L#![/ =     !K.22?DIIM(5(=DHH=Mwy))M99 RIRRRR.227B??"DRRRi&& "!INB#789JK* K/ K/;1  k.                    VVXXFq I@PP/0   sAF00F47F4rctj|sdS tj|}tj|jj}n#tj$rYdSwxYw|j|j|j f|j|j|j fkrdS|j d}|j |d|d|dfS)NFrNz/file=z/file/z/proxy=) rrrURLrr InvalidURLschemerportrqrrx)r^rfile_url upstream_urlapi_paths r_rzEndpoint._is_upstream_file_urls%i00 5 y++H 9T[%=>>LL   55  O M M         5$++C00}'' X"5"5"5(7K7K7K L   s2A AAr file_datac0|dp#tj|j}t |jpd}i|jjddi}tj 5}t ||z }tj d|f|jj |jj|jjd|5} | t#|d5} | D]} | |  dddn #1swxYwYdddn #1swxYwYi|d t)|i} | d d|| |cdddS#1swxYwYdS) zECopy a private upstream file into its cache before using it as input.r}filefollow_redirectsFrrwbNrqr)rYrrurlparserqr rrr@tempfileTemporaryDirectoryrrr0rIr2r(rrwriter7rnra) r^rrr` original_name file_namerequest_kwargstemp_dir temp_pathr temp_filer upload_datas r_rzEndpoint._upload_upstream_filesi MM+ & & N&,*?*?*I*I*N '',6 PDK4P6H%PP  ( * * >hX2I + +{-  !  /))+++)T**/i!)!4!4!6!6//!....//////////////// / / / / / / / / / / / / / / /@Y?I??K OOE4 ( ( ($$[*==# > > > > > > > > > > > > > > > > > >s\5AF =%D3"-D D3D D3#D $D3' F 3D7 7F :D7 ;AF  FFrc8|ddrSd|vrO|d}|ds|j|dz}t |j}nA|jdzt j|dz}t |djpd}|jj tj |jj d tj }t tjt!jd z }|d d t'jd |f|jj|jj|jjd d|jj5}|t5||z d5}|d|jzD],}||||- dddn #1swxYwYdddn #1swxYwYt |jj |z } | d d | |z } tAj!||z | tE| #S)NrvFr)rLrMrNzfile=rqrTrJr)rKparentsr)r0rIrrr) chunk_size)$rYrxrrr rrencode_file_pathrrvrprshashlibsha256r gettempdirr6 token_hexmkdirrrr0rIr2r@r(rr block_sizerjr hexdigestshutilmover7resolve) r^rurl_pathrsharrrsr directorydests r_rgzEndpoint._download_files 55e $ $ 7!xH&&'>?? @=8??3+?+??X+II}w.1G& 1R1RRHQvY,6I ; ! - K . > > > >n+--..1B21F1FFd333 \   K'K';)!   k&  #  % % ' ' 'h*D11 #Q%00C#.>"""s76(HA G7+ H7G; ;H>G; ?HHHr+rc ^tjdtjd|jjd|jj5}t j|||||jj|jj |jj |jj |jj|jj cdddS#1swxYwYdS)Nr)rrr) rr.rrr2r@rget_pred_from_sse_v0rrr0rIr)r^r+rrurs r_rUzEndpoint._sse_fn_v01s \ M$///;)  k&   - # ( # # & +                     sAB""B&)B&rrc tj||jj|jj|jj|jj|||jj|jj Srh) rget_pred_from_sse_v1plusrr0rIrrr2r)r^rurrQs r_rVzEndpoint._sse_fn_v1plusDsR -  K  K  K 2 K $   K " K '   raN)r`)rr.r\r;r]rmrQr7)rr;)rr&r)rr)rrmrr=)rr.)rr.rr)rur)rur>r[)rr)rsrmr`r;rrt)rr7rr=)rr7rrmr`r;rrt)rrmrr7)r+rmrrmrur)rurrr7rQr)rrrrrrrrr*rrpropertyrsetterrrrprrr=r7r8rZr1rdrerarrrgrUrVrrar_rZrZds=SSPX"/"/"/"/"/H       :::\:X ]&&&]&hhh0HHHHT::::x           . . . . `    2>>>>:)#)#)#)#V&      rarZrWrstatuscneZdZdZ dd dZd!dZd"dZd#dZd$d%fd Zd&dZ d'dZ d(dZ dZ xZ S))r^a A Job is a wrapper over the Future class that represents a prediction call that has been submitted by the Gradio client. This class is not meant to be instantiated directly, but rather is created by the Client.submit() method. A Job object includes methods to get the status of the prediction call, as well to get the outputs of the prediction call. Job objects are also iterable, and can be used in a loop to get the outputs of prediction calls as they become available for generator endpoints. NTr$rrdr>r<r=rkr9reCallable[[], None] | NonecZ||_||_d|_||_||_||_dS)a Parameters: future: The future object that represents the prediction call, created by the Client.submit() method communicator: The communicator object that is used to communicate between the client and the background thread running the job verbose: Whether to print any status-related messages to the console space_id: The space ID corresponding to the Client object that created this Job object rN)r$rd_counterr<rkrw)r^r$rdr<rkres r_rz Job.__init__cs3 (    #rarc|Srhrrs r___iter__z Job.__iter__ys ra tuple | Anyc|jst |jj5t|jjj|jdzkr:|jjj|j}|xjdz c_|cdddS|jjjjtj kr5|jt|jjjkrttj ddddn #1swxYwY)NTr&gMbP?) rd StopIterationr9rrxrr latest_statuscoder!FINISHEDr~r)r^rqs r___next__z Job.__next__|sH  "// ! ""' " "t(,4559JJJ)-5dmDAMMQ&MM " " " " " " " " %)7<OO T->-B-J)K)KKK'//) 5!!! " " " " " " " " " " " " " " " "sADA-DDDAsyncGenerator[Update, None]cK|jsdS |jj} tj|dd{V}|WVn,#tj$r|rYdSYjwxYwn)zKAsync iterator that yields all updates from the communicator.updates queue.NTg?r)rdupdatesrYasynciowait_for TimeoutErrordone)r^rYrjs r_ __aiter__z Job.__aiter__s   F #+//11C &/SAAAAAAAAA '   99;;FF   s!A#A76A7r float | NonercHt|S)a. Return the result of the call that the future represents. Raises CancelledError: If the future was cancelled, TimeoutError: If the future didn't finish executing before the given timeout, and Exception: If the call raised then that exception will be raised. Parameters: timeout: The number of seconds to wait for the result if the future isn't done. If None, then there is no limit on the wait time. Returns: The result of the call that the future represents. For generator functions, it will return the final iteration. Example: from gradio_client import Client calculator = Client(src="gradio/calculator") job = calculator.submit("foo", "add", 4, fn_index=0) job.result(timeout=5) >> 9 r)superrW)r^r __class__s r_rWz Job.resultsww~~g~...ralist[tuple | Any]c|jsgS|jj5|jjjcdddS#1swxYwYdS)a Returns a list containing the latest outputs from the Job. If the endpoint has multiple output components, the list will contain a tuple of results. Otherwise, it will contain the results without storing them in tuples. For endpoints that are queued, this list will contain the final job output even if that endpoint does not use a generator function. Example: from gradio_client import Client client = Client(src="gradio/count_generator") job = client.submit(3, api_name="/count") while not job.done(): time.sleep(0.1) job.outputs() >> ['0', '1', '2'] N)rdr9rxrrs r_rz Job.outputss(  5I"' 5 5(,4 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5s 488r"c tj}d}|jr0|jj5|jj}dddn #1swxYwY|r t t jddd|ddS|rL|j j s t t j ddd|ddSt t j ddd|ddS|js t t j ddd|ddS|jj5|jj jj}|jr7|jr0|r.|dkr(t%dt'|d|jd |jj jcdddS#1swxYwYdS) a< Returns the latest status update from the Job in the form of a StatusUpdate object, which contains the following fields: code, rank, queue_size, success, time, eta, and progress_data. progress_data is a list of updates emitted by the gr.Progress() tracker of the event handler. Each element of the list has the following fields: index, length, unit, progress, desc. If the event handler does not have a gr.Progress() tracker, the progress_data field will be None. Example: from gradio_client import Client client = Client(src="gradio/calculator") job = client.submit(5, "add", 4, api_name="/predict") job.status() >> job.status().eta >> 43.241 # seconds FNr)rrank queue_sizesuccessr~eta progress_dataTr(zIDue to heavy traffic on this app, the prediction will take approximately zn seconds.For faster predictions without waiting in queue, you may duplicate the space using: Client.duplicate(r)r nowrdr9 should_cancelr"r! CANCELLEDrr$ _exceptionr PROCESSINGrxrrr<rkr}r;)r^r~ cancelledrs r_rz Job.statuss~$|~~   <"' < < -;  < < < < < < < < < < < < < < <  %"  99;;' ;;) ## "&$#!"&" ;&" "' ; ;'+9=<DMccBhhQdghkdldlQQAEANQQQ(,: ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;s$ AA AA%E44E8;E8c|jrM|jj5d|j_|jr| ddddS#1swxYwY|jS)aCancels the job as best as possible. If the app you are connecting to has the gradio queue enabled, the job will be cancelled locally as soon as possible. For apps that do not use the queue, the job cannot be cancelled if it's been sent to the local executor (for the time being). Note: In general, this DOES not stop the process from running in the upstream server except for the following situations: 1. If the job is queued upstream, it will be removed from the queue and the server will not run the job 2. If the job has iterative outputs, the job will finish as soon as the current iteration finishes running 3. If the job has not been picked up by the queue yet, the queue will not pick up the job TN)rdr9rrwr$cancelrs r_rz Job.cancels   "'  26!/>%NN$$$                  {!!###s)A  AAc,t|j|S)z,Forwards any properties to the Future class.)getattrr$)r^rs r_ __getattr__zJob.__getattr__(st{D)))ra)NTNN) r$rrdr>r<r=rkr9rer)rr^)rr)rrrh)rrrr)rr)rr")rr=)rrrrrrrrrWrrrr __classcell__)rs@r_r^r^Ws-1#04 $$$$$,"""""    ///////"55554H;H;H;H;T$$$$.*******rar^)Rr __future__rrconcurrent.futuresrrrrrprr6rrrr~ urllib.parserrrAr collectionsrcollections.abcrrr contextvarsr dataclassesr r functoolsr pathlibr r typingrrrr=rrhuggingface_hub.utilsrrr packagingrrErgradio_client.data_classesrgradio_client.documentationrgradio_client.exceptionsrrrgradio_client.utilsrrrrr r!r"r#environrYr7rrwrrrr.rr rZr^rrar_rs=22""""""    44444444%%%%%%$$$$$$!!!!!! 55555555 444444000000SSSSSSSSSS                    :>>"344D    (*99  )Xz;77RRRRRRR87Rj      p p p p p p p p f (Ix((R*R*R*R*R*&R*R*)(R*R*R*ra