[iyjUddlmZddlZddlmZmZmZmZddlm Z m Z ddl m Z m Z mZmZddlmZddlmZmZddlmZdd lmZe rdd lmZeeezZeeefeeeefzZd Zd e d <dZ!d e d<ee!gZ"de d<e#ee!gZ$de d<e GddZ%ddZ&e GddeeefZ'ddZ( ddZ) ddZ*y) ) annotationsN)IterableIteratorMappingMutableMapping) dataclassfield) TYPE_CHECKINGAnyFinalcast)parse)StreamlitAPIException!StreamlitQueryParamDictValueError) ForwardMsg)get_script_run_ctx)SupportsKeysAndGetItemembedz Final[str]EMBED_QUERY_PARAM embed_optionsEMBED_OPTIONS_QUERY_PARAMzFinal[list[str]]EMBED_QUERY_PARAMS_KEYSzFinal[frozenset[str]]PROTECTED_QUERY_PARAMSc:eZdZUdZded<ded<ded<ded<y) WidgetBindingz E- D;:D;>EEE;:E;ceZdZUdZeeZded<eeZded<eeZ ded<eeZ ded <d&d Z d'd Z d(d Z d(d Zd)dZ d* d+dZd,dZd-dZd.dZd/dZd/dZd0dZ d1dZd2dZd3d4dZ d5dZd6dZd7dZd8dZd9dZd7dZd:dZ d/d Z!d;d!Z"dd$Z$ d? d@d%Z%y#)A QueryParamszA lightweight wrapper of a dict that sends forwardMsgs when state changes. It stores str keys with str and List[str] values. Also manages widget bindings to query parameters for the bind="query-params" feature. )default_factorydict[str, list[str] | str] _query_paramszdict[str, WidgetBinding]_bindings_by_param_bindings_by_widgetzdict[str, list[str]]_initial_query_paramsc:td|jDS)Nc3LK|]}|jtvr|ywN)r6r).0keys r( z'QueryParams.__iter__..s' )yy{"99 )s"$)iterrGselfs r(__iter__zQueryParams.__iter__s" ))   r'c|jtvrtt| |j|}t |t rt|dk(ry|dS|S#t$rtt|wxYw)zRetrieves a value for a given key in query parameters. Returns the last item in a list or an empty string if empty. If the key is not present, raise KeyError. rr*)r6rKeyErrormissing_key_error_messagerGr4r5lenrSrOr;s r( __getitem__zQueryParams.__getitem__s 99;1 14S9: : ;&&s+E%&u:?Ry L ;4S9: : ;s-A!A!A!!A?c|j|rtd|d|j|||jy)N%Cannot directly set query parameter '=' - it is bound to a widget. Modify the widget value instead.)is_boundr_set_item_internal_send_query_param_msgrZs r( __setitem__zQueryParams.__setitem__sL == '7u=LM  U+ ""$r'c2t|j||yrM)_set_item_in_dictrGrZs r(r`zQueryParams._set_item_internals$,,c59r'c|jtvrtt||j |rt d|d |j |=|jy#t$rtt|wxYw)Nz(Cannot directly delete query parameter 'r^)r6rrWrXr_rrGrarSrOs r( __delitem__zQueryParams.__delitem__s 99;1 14S9: : == ':3%@LM  ;""3'  & & ( ;4S9: : ;s A**Bc 4t|drFt|dr:td|}t|j}|Dcgc] }|||f }}n t|}|Dcgc]\}}| } }}| j |j| D]"}|j |st d|d|D]\}} |j|| |jD]\}} |j|| |jycc}wcc}}w)Nkeysr[0SupportsKeysAndGetItem[str, str | Iterable[str]]r]r^) hasattrr r5riextendr_rr`itemsra) rSotherkwds other_dictrik other_as_listrO_keys_to_updater;s r(updatezQueryParams.updates 5& !ge]&CPRWXJ )*D9=>AaA/M>!KM-::M&#q#M:diik*"C}}S!+;C5APQ"(JC  # #C /(**,JC  # #C /' ""$-? ;s D# Dc||jvs|jtvrgS|j|}t|tr|S|gSrM)rGr6rr4r5rZs r(get_allzQueryParams.get_allsI d(( (CIIK;R,RI""3'"5$/u.s;lT!WlszA. Modify the widget values instead, or remove the bind parameter.Tpreserve_embed)rGr_rjoinclear_with_no_forward_msgra)rSrO bound_paramss r(clearzQueryParams.clears'+'9'9P'9T]]3=O'9 P 'V99;l;;<=RS  &&d&; ""$Qs A6A6ct|jDcic]}|jtvr||| c}Scc}wrM)rGr6rrfs r(to_dictzQueryParams.to_dictsF)) )yy{"99 cN)   s#5c|jj}|jd |j|y#t$r ||_wxYw)NTr)rGcopyrrur)rS_dict old_values r( from_dictzQueryParams.from_dict'sT &&++-  &&d&;  KK $ !*D   s AAc"||j|<yrM)rG)rSrOr<s r(set_with_no_forward_msgz#QueryParams.set_with_no_forward_msg5s"%3r'c|jjDcic] \}}|jtvr|r||"c}}|_ycc}}wrM)rGrmr6r)rSrrOr;s r(rz%QueryParams.clear_with_no_forward_msg8sQ#00668 8 Uyy{55. J8  s%A c h|jtvrtd|dtdtd|j j |}|r5|j|k7r&|jj|jdt||||}||j |<||j|<y)aRegister a widget binding to a query parameter. If another widget was previously bound to this param_key, its binding is replaced. The old widget's entry in _bindings_by_widget is cleaned up to prevent orphaned references. Parameters ---------- param_key : str The query parameter key (same as the widget's user key). widget_id : str The unique widget ID. value_type : str The WidgetState value type (e.g., "bool_value", "string_value"). script_hash : str The script hash for MPA support. Raises ------ StreamlitAPIException If the parameter is protected (embed, embed_options). z)Cannot bind to reserved query parameter 'z'. 'z' and 'z:' are used internally for Streamlit's embed functionality.N)rrrr ) r6rrrrrHgetrrIpopr)rSrrrr old_bindingbindings r( bind_widgetzQueryParams.bind_widget?s: ??  6 6';I;G%&g.G-HIGH --11)< ;00I=  $ $ ( ()>)> E!#   .5 *.5  +r'c|jj|d}|r'|jj|jdyy)zRemove a widget binding. Parameters ---------- widget_id : str The unique widget ID. N)rIrrHr)rSrrs r( unbind_widgetzQueryParams.unbind_widgetqs@**..y$?   # # ' '(9(94 @ r'c||jvS)aCheck if a query parameter is bound to a widget. Note: This check is case-sensitive, meaning "Foo" and "foo" are treated as different parameters. This is intentional because Python keys are case-sensitive and users explicitly choose their parameter names via the widget's `key` argument. This differs from embed parameter checks which are case-insensitive for URL compatibility. Parameters ---------- param_key : str The query parameter key (case-sensitive). Returns ------- bool True if the parameter is bound to a widget. )rHrSrs r(r_zQueryParams.is_bound}s&D3333r'c8|jj|S)aGet the binding for a query parameter. Parameters ---------- param_key : str The query parameter key. Returns ------- WidgetBinding | None The binding if found, None otherwise. )rHrrs r(get_binding_for_paramz!QueryParams.get_binding_for_params&&**955r'c8|jj|S)zGet the binding for a widget. Parameters ---------- widget_id : str The unique widget ID. Returns ------- WidgetBinding | None The binding if found, None otherwise. )rIr)rSrs r(get_binding_for_widgetz"QueryParams.get_binding_for_widgets''++I66r'c\||jvr|j|=|jyy)aRemove a query parameter without protection checks. This is an internal method for use by SessionState when clearing invalid URL-seeded values. It bypasses the bound param protection since the binding system itself needs to clear these values. Parameters ---------- param_key : str The query parameter key to remove. Returns ------- bool True if the param was removed, False if it didn't exist. TF)rGrars r( remove_paramzQueryParams.remove_params2" ** *""9-  & & (r'c@tj|d}||_y)zStore the initial query params from the URL for session state seeding. Parameters ---------- query_string : str The URL query string (without the leading '?'). Tkeep_blank_valuesN)rparse_qsrJ)rSrparseds r(set_initial_query_paramsz$QueryParams.set_initial_query_paramss E%+"r'c |jjDcic]\}}|t|tr|n|gc}}|_ycc}}w)aSet _initial_query_params from the current filtered _query_params. This is called after MPA page transitions where populate_from_query_string() has filtered out params bound to widgets on other pages. Using this ensures widget seeding only uses params that are valid for the current page, preventing stale values from previous pages from leaking through. N)rGrmr4r5rJ)rSrqvs r(%set_initial_query_params_from_currentz1QueryParams.set_initial_query_params_from_currentsL>B=O=O=U=U=W& =WTQAJq$'qaS 0=W& "& s Ach|jj|}|yt|dk(r|dS|S)a`Get the initial URL value for a query parameter. This is used for seeding session state on initial page load. Parameters ---------- param_key : str The query parameter key. Returns ------- str | list[str] | None The initial value(s) if present, None otherwise. Nr)rJrrY)rSrvaluess r(get_initial_valuezQueryParams.get_initial_values=++// : > v;! !9  r'cXdd}|dvrst|ttfrD|Dcgc]}|dk(r||n t|c}|j|<|j y|dk(r||n t|}n t|}||j|<|j ycc}w)aSet a corrected value for a query parameter. This is called when URL auto-correction is needed (e.g., after clamping a value to min/max bounds). It updates both the internal query params and sends a forward message to update the frontend URL. Parameters ---------- param_key : str The query parameter key. value : Any The corrected value to set. value_type : str The WidgetState value type (e.g., "double_value", "int_value"). ct|tr7tj|r"|t |k(rt t |St |S)zFormat a number, using integer format if value is a whole number. Examples: 5.0 -> "5", 5.5 -> "5.5", 5 -> "5" Handles special float values (NaN, Inf) by returning them as-is. )r4r9mathisfiniter8r)rs r( format_numberz7QueryParams._set_corrected_value..format_numbers:!U# a(8Q#a&[3q6{"q6Mr'>r3r2r1r2N)rr returnr)r4r5tuplerrGra)rSrr;rrr str_values r(_set_corrected_valuez QueryParams._set_corrected_values"    %$/#1")36J(JM!$PSTUPVV"1""9-**,!55e$Z  E I(19% ""$1sB'Nc,tj|d}|jg}|jD]\}}|jj |}d}|-|+|j |vr|j|jd}|sUt|dk(r|j|dwt|dk(r|j||d |j|||D]} |j| |r|jyy) aPopulate query params from a URL query string. Clears current params and repopulates from the URL. When valid_script_hashes is provided (for MPA page transitions), filters out params bound to other pages. Parameters ---------- query_string : str The raw query string from the URL (e.g., "foo=bar&baz=qux"). valid_script_hashes : set[str] | None If provided, only keep params that are: - Unbound (no widget binding) - Bound to a widget with script_hash in this set Params bound to other pages are filtered out. If None, all params are kept (no filtering). TrNFrrV)r<rr*) rrrrmrHrr r:rrYrrra) rSrvalid_script_hashesparsed_query_paramsstale_widget_idsrOr<r should_keeprs r(populate_from_query_stringz&QueryParams.populate_from_query_string-s*$nn\TR &&(&(+113HC--11#6GK$/'''/BB!''(9(9:# s8q=00"0=X]00#b'0B00c:)4.*I   y )*   & & ( r'cg}|jD]>}||vr|r$|r"|j|}|r|j|vr.|j|@d}|D]Y}|jj|}|r)|j} | |j vr|j | =d}|j |[|r|jyy)aRemove bindings and URL params for widgets that are no longer active. This cleans up query params for conditional widgets that have been unmounted. For fragment runs, widgets outside the running fragment(s) are preserved. Note: Page-based cleanup for MPA navigation is handled separately via populate_from_query_string() which is called before the script runs. Parameters ---------- active_widget_ids : set[str] Set of widget IDs that are currently active/rendered. fragment_ids_this_run : list[str] | None List of fragment IDs being run, or None for full script runs. widget_metadata : dict[str, Any] | None Widget metadata dict to check fragment IDs. FTN)rIr fragment_idr:rrGrra) rSactive_widget_idsfragment_ids_this_runwidget_metadatarrmetadataparams_removedrrs r(remove_stale_bindingsz!QueryParams.remove_stale_bindingses.11I--%*..y9 4 4@'%;'%  '%  '%R=  '  %  ;   & 060606 06  06  06d A4* 6 7. ,  ,5%t046)6)-6)  6)v3715 3)#3) 03)/ 3)  3)r'rDcd|dS)Nzst.query_params has no key "z".r&)rOs r(rXrXs )#b 11r'ct|tr t||jtvr t dt|t r-t|ts|Dcgc] }t|c}||<yt|||<ycc}w)zSet an item in a dictionary.zVQuery param embed and embed_options (case-insensitive) cannot be set programmatically.N)r4rrr6rrrr) target_dictrOr;items r(rdrds}%/44 yy{--# d  %":eS+A278%$CI%8 Cu: C9s!B c Di}t|dr@t|dr4td|}|jD]}||}t|||n|D]\}}||vrt |t r t |||}t |ts|g}t |tr9t |ts)|j|Dcgc] }t|c}n|jt||||<t|||tj|dScc}w)z5Convert query params into a URL-encoded query string.rir[rjTr})rkr rirdr4rrr5rrrlr:rr) query_paramsprocessed_paramsrOr; current_valrs r(process_query_paramsrs 46|V$})M >   $$&C %E .U ;''JC&&eT*;C@@.s3 !+t4#.-KeX.z%7M&&e'DedD e'DE&&s5z2(3 %!"2C?#'& ??+4 88(Es=D )r;zstr | list[str]rrrr r)rrFrOrr;rrr)rrrr)+ __future__rrcollections.abcrrrr dataclassesrr typingr r r r urllibrstreamlit.errorsrrstreamlit.proto.ForwardMsg_pb2r7streamlit.runtime.scriptrunner_utils.script_run_contextr _typeshedrrQueryParamValuerQueryParamsInputrr%rr frozensetrrrBrDrXrdrr&r'r(rs7# GG(22U5V0 %3/08E#BVQ& &&"97"9 "9r'