;3hV"dZddlmZddlZddlmZmZmZddlm Z m Z ddl m Z m Z mZmZmZddlmZddlmZdd lmZmZe rdd lmZmZmZdd lmZdd lmZdd l m!Z!ddl"m#Z#m$Z$m%Z% d9dZ&eGdde'Z(eGddZ)eGdde)Z*eGdde)Z+eGdde)Z,eGdde)Z-eGdde)Z.eGdde)Z/eGd d!e)Z0eGd"d#e)Z1eGd$d%e)Z2ejfGd&d'Z4e reeed(e fdfeeeedfeeeeeeedfee5ded)fe6ed*eeeedfee6dfe6e7e6e6ee'e5e fe8e'e5e fdfee9dfeed+dfee5dfee7ded,fee5dfe6ge(fZ:Gd-d.e5Z;e d:dd)d/dd0d)d1d0d0dddd,dd0dd2d3 d;d4Z<e dy)>zContains all of the events that can be triggered in a gr.Blocks() app, with the exception of the on-page-load event, which is defined in gr.Blocks().load().) annotationsN)CallableSequenceSet)partialwraps) TYPE_CHECKINGAnyLiteralUnioncast)document)Template)FileData FileDataDict)Block BlockContext ComponentTimer)python_type_to_json_schema)get_blocks_context)get_cancelled_fn_indicesget_function_paramsget_return_typesc p|syt}| tdt|ts|g}g}g|D]4}t |dd}|rj |$|j |6r ddlm|j|fddd|r&t|}|j|dddddd|d yy) Nz1Cannot cancel outside of a gradio.Blocks context.associated_timerrrcjtdkDrDcgc] }d c}SdScc}w)NF)active)len)_rtimers_to_cancels M/var/www/html/audio-gradio/venv/lib/python3.12/site-packages/gradio/events.pyz#set_cancel_events..<s='(1,/??e$?%(?s0F)fninputsoutputsshow_apiT)r&r'r(queue preprocessr)cancelsis_cancel_function) rAttributeError isinstancelistgetattrappendgradio.componentsrset_event_triggerr) triggersr, root_blockregular_cancelscancelrfn_indices_to_cancelrr#s @@r$set_cancel_eventsr: s #%JPQQ gt $),.O(*+"6+=tD   # #$4 5  " "6 * ++$$  $ % 7H$$ (# % c,eZdZ d dfd ZdZxZS) Dependencyct||||_||_t t d|ddj ||_ t t d|ddj ||_y)a The Dependency object is usualy not created directly but is returned when an event listener is set up. It contains the configuration data for the event listener, and can be used to set up additional event listeners that depend on the completion of the current event listener using .then() and .success(). Demos: chatbot_consecutive, blocks_chained_events thenF) trigger_aftertrigger_only_on_success has_triggersuccessTN) super__init__r&rr EventListenerlistenerr?rC)selftriggerkey_vals dep_indexr&r __class__s r$rEzDependency.__init__Ws " 0 '(-!   h     '(,!   h    r;c&|j|i|SN)r&)rHargskwargss r$__call__zDependency.__call__~stww'''r;rN)rz Timer | None)__name__ __module__ __qualname__rErQ __classcell__rLs@r$r=r=UsRV% BN% N(r;r=ceZdZdZddZy) EventDataa When gr.EventData or one of its subclasses is added as a type hint to an argument of a prediction function, a gr.EventData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. The gr.EventData object itself contains a `.target` attribute that refers to the component that triggered the event, while subclasses of gr.EventData contains additional attributes that are different for each class. Example: import gradio as gr with gr.Blocks() as demo: table = gr.Dataframe([[1, 2, 3], [4, 5, 6]]) gallery = gr.Gallery([("cat.jpg", "Cat"), ("dog.jpg", "Dog")]) textbox = gr.Textbox("Hello World!") statement = gr.Textbox() def on_select(value, evt: gr.EventData): return f"The {evt.target} component was selected, and its value was {value}." table.select(on_select, table, statement) gallery.select(on_select, gallery, statement) textbox.select(on_select, textbox, statement) demo.launch() Demos: gallery_selections, tictactoe c ||_||_y)z Parameters: target: The component object that triggered the event. Can be used to distinguish multiple components bound to the same listener. N)target_data)rHrZr[s r$rEzEventData.__init__s   r;N)rZ Block | Noner[r )rRrSrT__doc__rEr;r$rXrXs *r;rXc$eZdZdZdfd ZxZS) SelectDataa& The gr.SelectData class is a subclass of gr.EventData that specifically carries information about the `.select()` event. When gr.SelectData is added as a type hint to an argument of an event listener method, a gr.SelectData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr with gr.Blocks() as demo: table = gr.Dataframe([[1, 2, 3], [4, 5, 6]]) gallery = gr.Gallery([("cat.jpg", "Cat"), ("dog.jpg", "Dog")]) textbox = gr.Textbox("Hello World!") statement = gr.Textbox() def on_select(evt: gr.SelectData): return f"You selected {evt.value} at {evt.index} from {evt.target}" table.select(on_select, table, statement) gallery.select(on_select, gallery, statement) textbox.select(on_select, textbox, statement) demo.launch() Demos: gallery_selections, tictactoe ct||||d|_ |d|_ |j d|_ |j d|_ |j dd|_y)Nindexvalue row_value col_valueselectedT)rDrErbrcgetrdrerfrHrZdatarLs r$rEzSelectData.__init__s{ &w-  w-  #hh{3 #hh{3 #hhz48  r;rZr\rir rRrSrTr]rErUrVs@r$r`r`s*  r;r`c$eZdZdZdfd ZxZS) KeyUpDataan The gr.KeyUpData class is a subclass of gr.EventData that specifically carries information about the `.key_up()` event. When gr.KeyUpData is added as a type hint to an argument of an event listener method, a gr.KeyUpData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def test(value, key_up_data: gr.KeyUpData): return { "component value": value, "input value": key_up_data.input_value, "key": key_up_data.key } with gr.Blocks() as demo: d = gr.Dropdown(["abc", "def"], allow_custom_value=True) t = gr.JSON() d.key_up(test, d, t) demo.launch() Demos: dropdown_key_up cPt||||d|_ |d|_y)Nkey input_value)rDrErorprhs r$rEzKeyUpData.__init__s6 &U  !%] 3 r;rjrkrVs@r$rmrms*   r;rmc$eZdZdZdfd ZxZS)DeletedFileDataa  The gr.DeletedFileData class is a subclass of gr.EventData that specifically carries information about the `.delete()` event. When gr.DeletedFileData is added as a type hint to an argument of an event listener method, a gr.DeletedFileData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def test(delete_data: gr.DeletedFileData): return delete_data.file.path with gr.Blocks() as demo: files = gr.File(file_count="multiple") deleted_file = gr.File() files.delete(test, None, deleted_file) demo.launch() Demos: file_component_events cFt|||tdi||_yNr^rDrErfilerhs r$rEzDeletedFileData.__init__& &&..  r;rZr\rirrkrVs@r$rrrrs   r;rrc$eZdZdZdfd ZxZS)LikeDataa The gr.LikeData class is a subclass of gr.EventData that specifically carries information about the `.like()` event. When gr.LikeData is added as a type hint to an argument of an event listener method, a gr.LikeData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def test(value, like_data: gr.LikeData): return { "chatbot_value": value, "liked_message": like_data.value, "liked_index": like_data.index, "liked_or_disliked": like_data.liked } with gr.Blocks() as demo: c = gr.Chatbot([("abc", "def")]) t = gr.JSON() c.like(test, c, t) demo.launch() Demos: chatbot_core_components_simple ct||||d|_ |d|_ |j dd|_y)NrbrclikedT)rDrErbrcrgr|rhs r$rEzLikeData.__init__'sM &,0M  w-  "&'4!8  r;rjrkrVs@r$rzrzs*   r;rzc$eZdZdZdfd ZxZS) RetryDataa} The gr.RetryData class is a subclass of gr.Event data that specifically carries information about the `.retry()` event. When gr.RetryData is added as a type hint to an argument of an event listener method, a gr.RetryData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def retry(retry_data: gr.RetryData, history: list[gr.MessageDict]): history_up_to_retry = history[:retry_data.index] new_response = "" for token in api.chat_completion(history): new_response += token yield history + [new_response] with gr.Blocks() as demo: chatbot = gr.Chatbot() chatbot.retry(retry, chatbot, chatbot) demo.launch() cPt||||d|_ |d|_yNrbrcrDrErbrcrhs r$rEzRetryData.__init__M4 &,0M  w-  r;rjrkrVs@r$r~r~7s(   r;r~c$eZdZdZdfd ZxZS)UndoDataa The gr.UndoData class is a subclass of gr.Event data that specifically carries information about the `.undo()` event. When gr.UndoData is added as a type hint to an argument of an event listener method, a gr.UndoData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def undo(retry_data: gr.UndoData, history: list[gr.MessageDict]): history_up_to_retry = history[:retry_data.index] return history_up_to_retry with gr.Blocks() as demo: chatbot = gr.Chatbot() chatbot.undo(undo, chatbot, chatbot) demo.launch() cPt||||d|_ |d|_yrrrhs r$rEzUndoData.__init__lrr;rjrkrVs@r$rrYs"   r;rc$eZdZdZdfd ZxZS)EditDataa# The gr.EditData class is a subclass of gr.Event data that specifically carries information about the `.edit()` event. When gr.EditData is added as a type hint to an argument of an event listener method, a gr.EditData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def edit(edit_data: gr.EditData, history: list[gr.MessageDict]): history_up_to_edit = history[:edit_data.index] history_up_to_edit[-1] = edit_data.value return history_up_to_edit with gr.Blocks() as demo: chatbot = gr.Chatbot() chatbot.undo(edit, chatbot, chatbot) demo.launch() cft||||d|_ |d|_ |d|_y)Nrbprevious_valuerc)rDrErbrrcrhs r$rEzEditData.__init__sI &,0M  $((8#9 w-  r;rjrkrVs@r$rrxs$   r;rc$eZdZdZdfd ZxZS) DownloadDataa The gr.DownloadData class is a subclass of gr.EventData that specifically carries information about the `.download()` event. When gr.DownloadData is added as a type hint to an argument of an event listener method, a gr.DownloadData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def on_download(download_data: gr.DownloadData): return f"Downloaded file: {download_data.file.path}" with gr.Blocks() as demo: files = gr.File() textbox = gr.Textbox() files.download(on_download, None, textbox) demo.launch() cFt|||tdi||_yrtrurhs r$rEzDownloadData.__init__rwr;rxrkrVs@r$rr   r;rc$eZdZdZdfd ZxZS)CopyDataa The gr.CopyData class is a subclass of gr.EventData that specifically carries information about the `.copy()` event. When gr.CopyData is added as a type hint to an argument of an event listener method, a gr.CopyData object will automatically be passed as the value of that argument. The attributes of this object contains information about the event that triggered the listener. Example: import gradio as gr def on_copy(copy_data: gr.CopyData): return f"Copied text: {copy_data.value}" with gr.Blocks() as demo: textbox = gr.Textbox("Hello World!") copied = gr.Textbox() textbox.copy(on_copy, None, copied) demo.launch() c:t||||d|_y)Nrc)rDrErcrhs r$rEzCopyData.__init__s" &w-  r;rjrkrVs@r$rrrr;rc"eZdZUded<ded<y)EventListenerMethodr\blockstr event_nameN)rRrSrT__annotations__r^r;r$rrs Or;r.F)fullminimalhidden)oncemultiple always_lastdefaultc eZdZfdZdddddddddf d fd Zdd Zd Ze d dd ZxZ S)rFc$t|||SrN)rD__new__)clsr_args_kwargsrLs r$rzEventListener.__new__swsJ//r;TciSrNr^r^r;r$r%zEventListener.sRr;rNFssec t |||_||_||_||_||_||_||_||_ | |_ | xsg|_ |j|||||||j|j|_ |r@|jjr)||jjz|j_yyyrN)rDrErB config_datar show_progressr@rAcallbackdoc connectionevent_specific_args_setuprGr]) rHrrBrrrr@rArrrrLs r$rEzEventListener.__init__s &&$**'>$  $#6#<"       #  $ $ OO    4==(($'$--*?*?$?DMM !)3r;c|jjrAt|jjj|}||j_yy)N) component)rGr]rrender)rHrrs r$set_doczEventListener.set_docsB == 4==0018898MC$'DMM ! !r;c t|j|j|j|j|j |j |j|j|j|j SrN) rFrrBrrrr@rArrr)rHs r$copyzEventListener.copysa OO          MM     ( ( HH OO  $ $  r;c^ ddddd|dddddddddddddddf d  fd _ _ _ _r(Dcgc]}|j dd d k7r|d c}nd} | _ Scc}w) N decoratorFTr?c!~ |dk(r% $  fd}tdid|Sddlm}t|rdjvrj tt rrdndt}|td d t!rnd}|j|g|  "#||| r( Dcgc]}|jd d d k7r|dc}nd\}}t|g rt|j||Scc}w)a Parameters: fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. inputs: List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. outputs: List of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. api_name: defines how the endpoint appears in the API docs. Can be a string, None, or False. If set to a string, the endpoint will be exposed in the API docs with the given name. If None (default), the name of the function will be used as the API endpoint. If False, the endpoint will not be exposed in the API docs and downstream apps (including those that `gr.load` this app) will not be able to use this event. scroll_to_output: If True, will scroll to output component on completion show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. queue: If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. batch: If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. max_batch_size: Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) preprocess: If False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). postprocess: If False, will not run postprocessing of component data before returning 'fn' output to the browser. cancels: A list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. trigger_mode: If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. js: Optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components. concurrency_limit: If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). concurrency_id: If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. rcdiddd d ddddd d d d d ddd dddtfd}|S)Nrr&r'r(api_namescroll_to_outputrshow_progress_onr*batchmax_batch_sizer+ postprocessr, trigger_modejsconcurrency_limitconcurrency_idr)c|i|SrNr^rOrPfuncs r$innerzKEventListener._setup..event_trigger..wrapper..inners#T4V44r;r^)r)rrrrrr,rr event_triggerr'rrr(rr+r*rr)rrrs` r$wrapperz.event_trigger..wrapperns!# &!(  "*  *: '4*:$$(6$.%0!(&2 !"+<#$(6%&"*',4[5!5!Lr;Nr)StreamingInputstreamrrz Cannot call z$ outside of a gradio.Blocks context.component_proptruefalsename)r+rrrrrrrrr*rrr@rArr)r time_limit stream_everylike_user_messager)r=gradio.components.baserr/eventscheck_streamableboolrr.rr4rgr: get_config)%rr&r'r(rrrrr*rrr+rr,rrrrr)rrrrrr6 event_targetddeprK _callback _connection _event_name_event_specific_args _has_trigger_trigger_after_trigger_only_on_successrs%` ````````````````` r$rz+EventListener._setup..event_trigger6sl[ !!!:"$D':: =%0X5M&&(-.*7X +-J!$";-/ST/%4L(99%'!1+!1!"3--,(@)!&%)"3 (2%uu-v6'AfI% ?: NCB  % eS^^%5y"E E%s!D:8rrrr).rr\r&z&Callable | None | Literal['decorator']r'dComponent | BlockContext | Sequence[Component | BlockContext] | Set[Component | BlockContext] | Noner(rrstr | None | Literal[False]rrr$Literal['full', 'minimal', 'hidden']r&Component | Sequence[Component] | Noner*rrrrintr+rrrr,,dict[str, Any] | list[dict[str, Any]] | Noner1Literal['once', 'multiple', 'always_last'] | Nonerstr | Literal[True] | Nonerint | None | Literal['default']r str | Noner)rr int | Nonerfloatrrreturnr=)rrBrrrgr) rr_show_progressrrrrrrrrs `` ````` @r$rzEventListener._setup+s:E  48%*BPGK"## $DHNR-1AJ)-!%)"%&+=O FO F6O FO FO F2O F#O F@O F E!O F"#O F$%O F& 'O F()O F*+O F,B-O F.L/O F0+1O F2 ?3O F4'5O F67O F8#9O F: ;O F< $=O F>?O FO Fb$/  $0 !!* #.  $. 55)62g=&    -@ ) s;!B*)rrrBrrzCallable[..., dict[str, Any]]rrrCallable | Noner@rrArrrrLiteral['sse', 'stream']rzlist[dict[str, str]] | None)rr)r)rrrrrrrrrrrrrzlist[dict[str, str]]rr) rRrSrTrrErr staticmethodrrUrVs@r$rFrFs0 !5?>D$($((-/4;?#@#@#@3 #@ < #@ " #@"#@"&#@#@-#@9#@J(  16iii=i# i # i #' i3i.iir;rFrTrr)rrrrr*rrr+rr,rrrrr)rrc ddlm}ttsgt tt }t|rg|dk(r&   fd}t did|St}| td-Dcgc]}t|dc}ngt|dgz}n;|Dcgc]0}t|jr |jnd|j2}}r/D]*}|js|j|j,|j||  td |xsgDrd nd |xsgDcgc].}t t t"|j$xsgD]}|0c}} \}}t'| t d|j)||Scc}wcc}wcc}}w) a Sets up an event listener that triggers a function when the specified event(s) occur. This is especially useful when the same function should be triggered by multiple events. Only a single API endpoint is generated for all events in the triggers list. Parameters: triggers: List of triggers to listen to, e.g. [btn.click, number.change]. If None, will run on app load and changes to any inputs. fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. inputs: List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. outputs: List of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. api_name: Defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. scroll_to_output: If True, will scroll to output component on completion show_progress: how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all, show_progress_on: Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. queue: If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. batch: If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. max_batch_size: Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) preprocess: If False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). postprocess: If False, will not run postprocessing of component data before returning 'fn' output to the browser. cancels: A list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. trigger_mode: If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. js: Optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs', return should be a list of values for output components. concurrency_limit: If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). concurrency_id: If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. time_limit: The time limit for the function to run. Parameter only used for the `.stream()` event. stream_every: The latency (in seconds) at which stream chunks are sent to the backend. Defaults to 0.5 seconds. Parameter only used for the `.stream()` event. Example: import gradio as gr with gr.Blocks() as demo: with gr.Row(): input = gr.Textbox() button = gr.Button("Submit") output = gr.Textbox() gr.on( triggers=[button.click, input.submit], fn=lambda x: x, inputs=[input], outputs=[output] ) demo.launch() r)rNrctfiddd ddddd d d d d d dddddddtfd}|S)Nr&r'r(rrrrr*rrr+rr,rrrr)rrrc|i|SrNr^rs r$rz"on..wrapper..innerGT,V,,r;)onr)rrrrr,rrr'rrr(rr+r*rr)rrrrrr5s` r$rzon..wrapper.s       "   "2  , "2    . & (     #4! " .# $"% &*' (&) **+ 04[ - -Lr;z4Cannot call on() outside of a gradio.Blocks context.changeloadc3:K|]}|jdk(yw)rN)r).0ts r$ zon..vsHAq||x'Hsrr)r+rrrrrrrrr*rrr)rrrrr) gradio.blocksrr/rr rFr=r ExceptionrrB__self__rrr4anyr0rrr:r) r5r&r'r(rrrrr*rrr+rr,rrrrr)rrrtriggers_typedrr6inputmethodsrrIarrKs ` ``````````````````` r$rrsV$ h )h.B:(=18$D'22#%JNOO!@F Fe  1 F V 4 5 6$  amm q|| T   3G  !1!12 3 11 )#) +%%! H.2FBH H %* $s)Q%:%:%@bA    !92NC<gw' dCNN,i <<[ G  > s G 5G 23G%0) rr*rrrrr)rrc  |dk(r f d} tdid| St} | tdddlm} t |} t |}d}td| Dr td t| Dcgc]*\}\}}}}| |r|ndt|||d z,}}}}}}t|Dcgc]!\}}| dt|||d z#}}}| jg|||d d d d dd \}}td|j||Scc}}}}}wcc}}w)aC Sets up an API endpoint for a generic function that can be called via the gradio client. Derives its type from type-hints in the function signature. Parameters: fn: the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. api_name: Defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, will use the functions name as the endpoint route. If set to a string, the endpoint will be exposed in the api docs with the given name. queue: If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. batch: If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. max_batch_size: Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) concurrency_limit: If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). concurrency_id: If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. show_api: whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False. time_limit: The time limit for the function to run. Parameter only used for the `.stream()` event. stream_every: The latency (in seconds) at which stream chunks are sent to the backend. Defaults to 0.5 seconds. Parameter only used for the `.stream()` event. Example: import gradio as gr with gr.Blocks() as demo: with gr.Row(): input = gr.Textbox() button = gr.Button("Submit") output = gr.Textbox() def fn(a: int, b: int, c: list[str]) -> tuple[int, str]: return a + b, c[a:b] gr.api(fn, api_name="add_and_slice") _, url, _ = demo.launch() from gradio_client import Client client = Client(url) result = client.predict( a=3, b=5, c=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], api_name="/add_and_slice" ) print(result) rc Z t  tfd}|S)N) r&rr*rrrrr)rrc|i|SrNr^rs r$rz#api..wrapper..innerrr;)apir) rrrrrrrr*r)rrs ` r$rzapi..wrappersH !-"3-!%) 4[ - -Lr;Nz5Cannot call api() outside of a gradio.Blocks context.r)Apicb|d|dzcxkrdkrdSddddj|dzdS) N dthstndrd)r)rg)ns r$ordinalzapi..ordinalsLR1s70b0Tdee0$4D6Q6U6UVWZ\V\^b6cdeer;c3*K|] }|ddu yw)rNr^)rparams r$rzapi..s 358t  3szRAPI endpoints must have type hints. Please specify a type hint for all parameters.rFr)r+rrrrrrrr*rrr)rrr) r=rrgradio.components.api_componentr rrr ValueError enumeraterr4r)r&rr*rrrrr)rrrr6r  fn_params return_typesrir" has_default default_value_typer'typer(rrKs ````````` r$r r sd [  ($D'22#%JOPP3#B'I#B'Lf 3 33 `  :C99M  6A5; u (Md &u - AEN F!. At D,T2GAENCG  11   +%%!'2NC* dCNN,i <d?d@d4gdABZedCdDZedEdFZedGdHZedIdJZedKdLZedMdNZedOdPdQRZedSdTdUdVWZ edXdYdZd[WZ!ed\d]Z"ed^d_Z#ed`daZ$edbdcZ%yd)eEventsraTriggered when the value of the {{ component }} changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input.)rrzRThis listener is triggered when the user changes the value of the {{ component }}.clickz.Triggered when the {{ component }} is clicked. double_clickz5Triggered when the {{ component }} is double clicked.submitzdThis listener is triggered when the user presses the Enter key while the {{ component }} is focused.stopzKThis listener is triggered when the user clicks on the stop button or icon.editzjThis listener is triggered when the user edits the {{ component }} (e.g. image) using the built-in editor.c:t|dd t|ddSdS)Neditableuser)r1setattrrs r$r%zEvents.s) 5*d + 3 'uj&A r;)rrclearzmThis listener is triggered when the user clears the {{ component }} using the clear button for the component.playzPThis listener is triggered when the user plays the media in the {{ component }}.pausezVThis listener is triggered when the media in the {{ component }} stops for any reason.zeThis listener is triggered when the user reaches the end of the media playing in the {{ component }}.endstart_recordingzSThis listener is triggered when the user starts recording with the {{ component }}.pause_recordingzSThis listener is triggered when the user pauses recording with the {{ component }}.stop_recordingzRThis listener is triggered when the user stops recording with the {{ component }}.focusz?This listener is triggered when the {{ component }} is focused.blurzIThis listener is triggered when the {{ component }} is unfocused/blurred.uploadzQThis listener is triggered when the user uploads a file into the {{ component }}.releasezTThis listener is triggered when the user releases the mouse on this {{ component }}.selectct|ddS)N _selectableTr.r/s r$r%zEvents.PswumTBr;aEvent listener for when the user selects or deselects the {{ component }}. Uses event data gradio.SelectData to carry `value` referring to the label of the {{ component }}, and `selected` to refer to state of the {{ component }}. See EventData documentation on how to use this event data)rrrc ddiS)N streamableFr^r^r;r$r%zEvents.U \51r;ct|ddS)N streamingTr>r/s r$r%zEvents.Vwuk4@r;zEThis listener is triggered when the user streams the {{ component }}.rrz float = 0.5zThe latency (in seconds) at which stream chunks are sent to the backend. Defaults to 0.5 seconds. Parameter only used for the `.stream()` event.)rr#rrzfloat | None = NonezVThe time limit for the function to run. Parameter only used for the `.stream()` event.r)rr#rr)rrrrrrlikec ddiS)NlikeableFr^r^r;r$r%zEvents.js Z/r;ct|ddS)NrGTr>r/s r$r%zEvents.kswuj$?r;rz bool = FalsezEWhether to display the like buttons for user messages in the chatbot.aThis listener is triggered when the user likes/dislikes from within the {{ component }}. This event has EventData of type gradio.LikeData that carries information, accessible through LikeData.index and LikeData.value. See EventData documentation on how to use this event data.)rrrrexample_selecta"This listener is triggered when the user clicks on an example from within the {{ component }}. This event has SelectData of type gradio.SelectData that carries information, accessible through SelectData.index and SelectData.value. See SelectData documentation on how to use this event data. option_selecta!This listener is triggered when the user clicks on an option from within the {{ component }}. This event has SelectData of type gradio.SelectData that carries information, accessible through SelectData.index and SelectData.value. See SelectData documentation on how to use this event data.rzSThis listener is triggered when the {{ component }} initially loads in the browser.key_upz\This listener is triggered when the user presses a key while the {{ component }} is focused.applyzpThis listener is triggered when the user applies changes to the {{ component }} through an integrated UI action.deleteaThis listener is triggered when the user deletes and item from the {{ component }}. Uses event data gradio.DeletedFileData to carry `value` referring to the file that was deleted as an instance of FileData. See EventData documentation on how to use this event datatickzOThis listener is triggered at regular intervals defined by the {{ component }}.r)rrundozWThis listener is triggered when the user clicks the undo button in the chatbot message.ct|ddS)N _undoableTr>r/s r$r%zEvents.rDr;c ddiS)NrQFr^r^r;r$r%zEvents.s [%0r;)rrrretryzXThis listener is triggered when the user clicks the retry button in the chatbot message.ct|ddS)N _retryableTr>r/s r$r%zEvents.swulDAr;c ddiS)NrUFr^r^r;r$r%zEvents.rAr;expandz@This listener is triggered when the {{ component }} is expanded.collapsezAThis listener is triggered when the {{ component }} is collapsed.downloadzThis listener is triggered when the user downloads a file from the {{ component }}. Uses event data gradio.DownloadData to carry information about the downloaded file as a FileData object. See EventData documentation on how to use this event datarzThis listener is triggered when the user copies content from the {{ component }}. Uses event data gradio.CopyData to carry information about the copied content. See EventData documentation on how to use this event dataN)&rRrSrTrFrrr&r'r(r)r*r0r1r2r3r4r5r6r7r8r9r:r;rrErIrJrrKrLrMrNrOrSrWrXrYrr^r;r$r%r%s  nF  ` E ''W XE SL rF  Y D  x D  { E  ^ D  d E  s D  s C$ aO$ aO# `N V E  W D _F bGB nF 1@ S'%j  %-o")    F* /?,&^   c D# qN" pM  a D jF  ~ E WF  ] D  e@0  D  fA1  E  NF OH EH  i Dr;r%)r5zSequence[EventListenerMethod]r,z,None | dict[str, Any] | list[dict[str, Any]])NrNN),r5z>Sequence[EventListenerCallable] | EventListenerCallable | Noner&z0Callable[..., Any] | None | Literal['decorator']r'rr(rrrrrrrrrr*rrrrrr+rrrr,rrrrrrrrrr)rrrrrrr=)r)r&zCallable | Literal['decorator']rrr*rrrrrrrrrr)rrrrrrr=)?r] __future__r dataclassescollections.abcrrr functoolsrrtypingr r r r r gradio_client.documentationrjinja2rgradio.data_classesrrrrrrr3rgradio_client.utilsrgradio.contextr gradio.utilsrrrr:dictr=rXr`rmrrrzr~rrrr dataclassrrrrr0rEventListenerCallablerFrr r%r^r;r$rhsF#33$16<<':-XX2 +2 92 j )()( )(X  > + +  + \ ! !  ! H  i   2 # y#  # L     B  y   <   y     F  9   0  y   0  $ (38$d* + )Xi0$6 7 %%(9*=y$N O #tWU^+ ,  / 0 )Xi0$6 7 $*      $sCx.$tCH~"6< = %+  ';