o h"@sUddlmZddlZddlZddlZddlZddlmZddlm Z m Z m Z ddl m Z ddlmmZddlmZmZddlmZddlmZdd lmZmZdd lmZdd lmZdd l m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'ddl(m)Z)ddl*m+Z+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2m3Z3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:ddl;mZ>ddl?m@Z@ddlAmBZBddlCmDZDddlEmFZFddlGmHZHmIZIeeJZKdeLd<Gdd d eZMd7d#d$ZNGd%d&d&ZOd8d(d)ZPd9d-d.ZQd:d;d2d3ZRdsr+returnstrcCs ttS)z5Randomly generate a unique ID for a script execution.)r5uuiduuid4r2r2r2r3_generate_scriptrun_idD r8c@seZdZdZ dudvddZdwddZdwddZdwddZdxddZdwddZ dyd d!Z dzd#d$Z d{d'd(Z d|d+d,Z dwd-d.Zdwd/d0Zd}d3d4Zed~d6d7Zdd;d<Zdudd=d>Zdwd?d@ZduddCdDZ      dddPdQZ      dddRdSZddTdUZddVdWZ  dddXdYZdd\d]Zdd^d_Zdwd`daZ dud|dbdcZdwdddeZ dwdfdgZ!dwdhdiZ"ddkdlZ#ddodpZ$ddsdtZ%dS) AppSessiona! Contains session data for a single "user" of an active app (that is, a connected browser tab). Each AppSession has its own ScriptData, root DeltaGenerator, ScriptRunner, and widget state. An AppSession is attached to each thread involved in running its script. N script_datar#uploaded_file_managerr' script_cacher$message_enqueued_callbackCallable[[], None] | None user_infodict[str, str | bool | None]session_id_override str | Noner4NonecCs|ptt|_t|_||_||_||_ t |j |j |_ t |_||_tj|_t|_d|_d|_d|_tddkrB|td|_d|_ddlm}||_||_ d|_!t"|_#t$%d|jdS)aInitialize the AppSession. Parameters ---------- script_data Object storing parameters related to running a script uploaded_file_manager Used to manage files uploaded by users via the Streamlit web client. script_cache The app's ScriptCache instance. Stores cached user scripts. ScriptRunner uses the ScriptCache to avoid having to reload user scripts from disk on each rerun. message_enqueued_callback After enqueuing a message, this callable notification will be invoked. user_info A dict that contains information about the current user. For now, it only contains the user's email address. { "email": "example@example.com" } Information about the current user is optionally provided when a websocket connection is initialized via the "X-Streamlit-User" header. session_id_override The ID to assign to this session. Setting this can be useful when the service that a Streamlit Runtime is running in wants to tie the lifecycle of a Streamlit session to some other session-like object that it manages. Nzserver.fileWatcherTypenonezserver.runOnSaverr%zAppSession initialized (id=%s))&r5r6r7idasyncioget_running_loop _event_loop _script_data_uploaded_file_mgr _script_cachermain_script_path_pages_managerr_browser_queue_message_enqueued_callbackr+r,_stater _client_state_local_sources_watcher_stop_config_listener_stop_pages_listenerr get_optionregister_file_watchers _run_on_save _scriptrunnerstreamlit.runtime.stater&_session_state _user_info_debug_last_backmsg_idr_fragment_storager*debug)selfr;r<r=r>r@rBr&r2r2r3__init__Us2-   zAppSession.__init__cC |dS)zGEnsure that we call shutdown() when an AppSession is garbage collected.N)shutdownr`r2r2r3__del__r9zAppSession.__del__cCsH|jdur t|j|_|j|jtj|jdd|_tj |j dS)a8Register handlers to be called when various files are changed. Files that we watch include: - source files that already exist (for edits) - `.py` files in the the main script's `pages/` directory (for file additions and deletions) - project and user-level config.toml files - the project-level secrets.toml files This method is called automatically on AppSession construction, but it may be called again in the case when a session is disconnected and is being reconnect to. NT) force_connect) rSr!rNregister_file_change_callback_on_source_file_changedron_config_parsedrTrfile_change_listenerconnect_on_secrets_file_changedrdr2r2r3rWs  z!AppSession.register_file_watcherscCs\|jdur |j|jdur||jdur|tj|jd|_d|_d|_dS)zJDisconnect the file watcher handlers registered by register_file_watchers.N)rScloserTrUrrj disconnectrlrdr2r2r3disconnect_file_watcherss     z#AppSession.disconnect_file_watcherslist[ForwardMsg]cCs |jS)aiClear the forward message queue and return the messages it contained. The Server calls this periodically to deliver new messages to the browser connected to this app. Returns ------- list[ForwardMsg] The messages that were removed from the queue and should be delivered to the browser. )rOflushrdr2r2r3flush_browser_queues zAppSession.flush_browser_queuecCsp|jtjkr6td|j|j|jt r(t }|j |j|j |tj|_|dSdS)ziShut down the AppSession. It's an error to use a AppSession after it's been shut down. zShutting down (id=%s)N)rQr+r.r*r_rFrKremove_session_filesr exists get_instancemedia_file_mgrclear_session_refsremove_orphaned_filesrequest_script_stopro)r`rtr2r2r3rcs   zAppSession.shutdownmsgrcCs0|jr|j|_|j||jr|dSdS)zEnqueue a new ForwardMsg to our browser queue. This can be called on both the main thread and a ScriptRunner run thread. Parameters ---------- msg : ForwardMsg The message to enqueue N)r]debug_last_backmsg_idrOenqueuerPr`r{r2r2r3_enqueue_forward_msgs    zAppSession._enqueue_forward_msgr"c Cs zh|d}|dkr|jr|j|_||jWd S|dkr%|Wd S|dkr0|Wd S|dkr;|Wd S|dkrH||j Wd S|dkrS| Wd S|dkr`| |j Wd St d |Wd Sty}zt d ||WYd }~d Sd }~ww) zProcess a BackMsg.type rerun_script load_git_info clear_cache app_heartbeatset_run_on_save stop_scriptfile_urls_requestzNo handler for "%s"zError processing back messageN) WhichOneofr|r]_handle_rerun_script_requestr_handle_git_information_request_handle_clear_cache_request_handle_app_heartbeat_request_handle_set_run_on_save_requestr_handle_stop_script_request_handle_file_urls_requestrr*warning Exception exceptionhandle_backmsg_exception)r`r{msg_typeexr2r2r3handle_backmsgs0  zAppSession.handle_backmsge BaseExceptioncsNjtjjjtjddjtjjfdddS)zGHandle an Exception raised while processing a BackMsg from the browser.)page_script_hashcsSN)r_create_exception_messager2rr`r2r3Pz5AppSession.handle_backmsg_exception..N)_on_scriptrunner_eventrYrSCRIPT_STOPPED_WITH_SUCCESSSCRIPT_STARTEDrIcall_soon_threadsafe)r`rr2rr3r6s z#AppSession.handle_backmsg_exception client_stateClientState | Nonec Cs|jtjkr tddS|rH|j}|r%|j|s%td|ddS| dr2|j j |j t |j|j|j|j|r?|nd|j|j d}nt }|jdurmttdrc|jsc|jd|_n |j|}|rmdS||dS)aSignal that we're interested in running the script. If the script is not already running, it will be started immediately. Otherwise, a rerun will be requested. Parameters ---------- client_state : streamlit.proto.ClientState_pb2.ClientState | None The ClientState protobuf to run the script with, or None to use previous client state. z'Discarding rerun request after shutdownNzThe fragment with id zW does not exist anymore - it might have been removed during a preceding full-app rerun. context_info) fragment_id is_auto_rerunrzrunner.fastReruns)rQr+r.r*rrr^containsinfoHasFieldrRrCopyFromr query_string widget_statesr page_namerrYboolrrV request_stop request_rerun_create_scriptrunner)r`rr rerun_datasuccessr2r2r3rSsB         zAppSession.request_reruncCs|jdur |jdSdS)zgRequest that the scriptrunner stop execution. Does nothing if no scriptrunner exists. N)rYrrdr2r2r3rys zAppSession.request_script_stopcCs|jdS)z%Clear the user info for this session.N)r\clearrdr2r2r3clear_user_infoszAppSession.clear_user_infoinitial_rerun_datarc CsLt|j|jj|j|j|j||j|j|j d |_ |j j |j |j dS)z;Create and run a new ScriptRunner with the given RerunData.) session_idrM session_stateuploaded_file_mgrr=rr@fragment_storage pages_managerN)rrFrJrMr[rKrLr\r^rNrYon_eventrkrstart)r`rr2r2r3rs zAppSession._create_scriptrunnerr&cCs|jSr)r[rdr2r2r3rszAppSession.session_statefilepathr5rcs@|jttfddd}|dur|jj}||kSdS)Ncs|dkS)N script_pathr2)krpagesr2r3rrz9AppSession._should_rerun_on_file_change..T)rN get_pagesnextfilterrRr)r`rchanged_page_script_hashcurrent_page_script_hashr2rr3_should_rerun_on_file_changes z'AppSession._should_rerun_on_file_changecCsH|j|dur||sdS|jr||jdS||dS)zfOne of our source files changed. Clear the cache and schedule a rerun if appropriate. N)rLrrrXrrRr_create_file_change_message)r`rr2r2r3rhs z"AppSession._on_source_file_changedcCrb)z:Called when `secrets.file_change_listener` emits a Signal.N)rh)r`_r2r2r3rls z#AppSession._on_secrets_file_changedfragment_ids_this_runlist[str] | NonecCs|jjd|ddS)NT)retain_lifecycle_msgsr)rOr)r`rr2r2r3 _clear_queues zAppSession._clear_queuesenderScriptRunner | Noneeventr forward_msgForwardMsg | NonerBaseException | Nonerrdict[PageHash, PageInfo] | Nonec s(jf dddS)aCalled when our ScriptRunner emits an event. This is generally called from the sender ScriptRunner's script thread. We forward the event on to _handle_scriptrunner_event_on_event_loop, which will be called on the main thread. c sSr)(_handle_scriptrunner_event_on_event_loopr2 rrrrrrrr`rr2r3rsz3AppSession._on_scriptrunner_event..N)rIr) r`rrrrrrrrr2rr3rsz!AppSession._on_scriptrunner_eventc CsF|jtks Jd||jurtd|dS|j} |tjkrL|jt j kr*t j |_|dus2Jd||j j kr<||j _ |||||||n|tjks[|tjks[|tjkr|jt j kret j|_|tjkrntj} n |tjkrwtj} ntj} ||| d|_|tjks|tjkr|jr|j|jnk|dusJdt} t| j j!||| nR|tj"krt j|_||tj#|jr|jn7|tj$kr|dusJd|jt j krt%&j'(|j)||_ d|_n|tj*kr|dusJd||| t j k} |jt j k} | | kr!||+dSdS)a#Handle a ScriptRunner event. This function must only be called on our eventloop thread. Parameters ---------- sender : ScriptRunner | None The ScriptRunner that emitted the event. (This may be set to None when called from `handle_backmsg_exception`, if no ScriptRunner was active when the backmsg exception was raised.) event : ScriptRunnerEvent The event type. forward_msg : ForwardMsg | None The ForwardMsg to send to the frontend. Set only for the ENQUEUE_FORWARD_MSG event. exception : BaseException | None An exception thrown during compilation. Set only for the SCRIPT_STOPPED_WITH_COMPILE_ERROR event. client_state : streamlit.proto.ClientState_pb2.ClientState | None The ScriptRunner's final ClientState. Set only for the SHUTDOWN event. page_script_hash : str | None A hash of the script path corresponding to the page currently being run. Set only for the SCRIPT_STARTED event. fragment_ids_this_run : list[str] | None The fragment IDs of the fragments being executed in this script run. Only set for the SCRIPT_STARTED event. If this value is falsy, this script run must be for the full script. clear_forward_msg_queue : bool If set (the default), clears the queue of forward messages to be sent to the browser. Set only for the SCRIPT_STARTED event. zXThis function must only be called on the eventloop thread the AppSession was created on.z0Ignoring event from non-current ScriptRunner: %sNz9page_script_hash must be set for the SCRIPT_STARTED eventzEexception must be set for the SCRIPT_STOPPED_WITH_COMPILE_ERROR eventz/client_state must be set for the SHUTDOWN eventz-null forward_msg in ENQUEUE_FORWARD_MSG event),rIrGrHrYr*r_rQrrr+r.r-rRrrr_create_new_session_messager!SCRIPT_STOPPED_WITH_COMPILE_ERRORFRAGMENT_STOPPED_WITH_SUCCESSr,rFINISHED_SUCCESSFULLY"FINISHED_FRAGMENT_RUN_SUCCESSFULLYFINISHED_WITH_COMPILE_ERROR_create_script_finished_messager]rSupdate_watched_modulesupdate_watched_pagesexception_utilsmarshall session_eventscript_compilation_exceptionSCRIPT_STOPPED_FOR_RERUNFINISHED_EARLY_FOR_RERUNSHUTDOWNr rurvrwrFENQUEUE_FORWARD_MSG&_create_session_status_changed_message)r`rrrrrrrr prev_statestatusr{app_was_runningapp_is_runningr2r2r3rs3                              z3AppSession._handle_scriptrunner_event_on_event_loopcCs$t}|j|j_|jtjk|j_|S)z6Create and return a session_status_changed ForwardMsg.)rrXsession_status_changed run_on_saverQr+r-script_is_runningr~r2r2r3rs   z1AppSession._create_session_status_changed_messagecCst}d|j_|S)z8Create and return a 'script_changed_on_disk' ForwardMsg.T)rrscript_changed_on_diskr~r2r2r3rsz&AppSession._create_file_change_messagecCst}t|j_|jj|j_|jj|j_|jj|j_||j_ |r'|jj || |j|p1|j t|jjt|jjt|jjjdtjjj|jj}t|jt|j_dtttj |j_!|j"|j#_$|j%t&j'k|j#_(|jj)|_)|j*|_+|S)z+Create and return a new_session ForwardMsg.ztheme..),rr8 new_session script_run_idrJnamerNrMmain_script_hashrrextend_populate_app_pagesr_populate_config_msgr_populate_theme_msg custom_themesidebarCustomThemeCategoriesSIDEBARvalue initialize_populate_user_info_msgr@r environment_infostreamlit_versionjoinmapr5sys version_infopython_versionrXsession_statusrrQr+r-ris_hellorFr)r`rrrr{imsgr2r2r3rs6          z&AppSession._create_new_session_messager)ForwardMsg.ScriptFinishedStatus.ValueTypecCst}||_|S)z/Create and return a script_finished ForwardMsg.)rscript_finished)r`rr{r2r2r3rsz*AppSession._create_script_finished_messagecCst}t|jjj||S)z*Create and return an Exception ForwardMsg.)rrrdelta new_elementr)r`rr{r2r2r3rsz$AppSession._create_exception_messagec Cst}zeddlm}||jj}|}|durWdS|\}}}|d}||j_||j_ ||j_ |j |jj dd<|j |jj dd<|j rMtjj|j_nt|jdkr[tjj|j_ntjj|j_||WdSty}ztjd|dWYd}~dSd}~ww)Nr)GitRepoz.gitz+Obtaining Git information produced an errorexc_info)rstreamlit.git_utilrrJrM get_repo_info removesuffixgit_info_changed repositorybranchmoduleuntracked_filesuncommitted_filesis_head_detachedr GitStates HEAD_DETACHEDstatelen ahead_commitsAHEAD_OF_REMOTEDEFAULTrrr*r_) r`r{rrepo repo_inforepository_namerrrr2r2r3rs0     z*AppSession._handle_git_information_requestcCs||dS)aTell the ScriptRunner to re-run its script. Parameters ---------- client_state : streamlit.proto.ClientState_pb2.ClientState | None The ClientState protobuf to run the script with, or None to use previous client state. N)r)r`rr2r2r3r%s z'AppSession._handle_rerun_script_requestcCrb)z1Tell the ScriptRunner to stop running its script.N)ryrdr2r2r3r3r9z&AppSession._handle_stop_script_requestcCs"tjtj|jdS)zjClear this app's cache. Because this cache is global, it will be cleared for all users. N)r cache_datarcache_resourcer[rdr2r2r3r7s  z&AppSession._handle_clear_cache_requestcCsdS)zHandle an incoming app heartbeat. The heartbeat indicates the frontend is active and keeps the websocket from going idle and disconnecting. The actual handler here is a noop Nr2rdr2r2r3rAs z(AppSession._handle_app_heartbeat_request new_valuecCs||_||dS)zChange our run_on_save flag to the given value. The browser will be notified of the change. Parameters ---------- new_value : bool New run_on_save value N)rXrr)r`r+r2r2r3rLs z*AppSession._handle_set_run_on_save_requestrr cCsXt}|j|j_|j|j|j}|D]}|jj t |j |j |j dq||dS)z6Handle a file_urls_request BackMsg sent by the client.)file_id upload_url delete_urlN)r request_idfile_urls_response response_idrKget_upload_urlsrF file_names file_urlsappendr r,r-r.r)r`rr{upload_url_infosupload_url_infor2r2r3rZs z$AppSession._handle_file_urls_requestrdict[PageHash, PageInfo]cCsL|D]\}}|j}||_|ddd|_|d|_|d|_qdS)Nrr icon)items app_pagesaddrreplacer url_pathnamer:)r`r{rr page_info page_protor2r2r3rns   zAppSession._populate_app_pagesr)r;r#r<r'r=r$r>r?r@rArBrCr4rD)r4rD)r4rp)r{rr4rD)r{r"r4rD)rrr4rD)rrr4rD)rrr4rD)r4r&)rr5r4r)rrCr4rD)rrr4rD)NNNNNN)rrrrrrrrrrrrCrrrrr4rD)r4r)NN)rr5rrrrr4r)rrr4r)rrr4r)r+rr4rD)rr r4rD)r{rrr8r4rD)&r/r0r1__doc__rarerWrorrrcrrrrryrrpropertyrrrhrlrrrrrrrrrrrrrrrrr2r2r2r3r:Isj Z         R         "  $   1  %   r:Config.ToolbarMode.ValueTypecCs^d}t|}ttj|}|dur-dddtjD}td|d|d||S)Nzclient.toolbarModez, css|]}|VqdSr)lower).0rr2r2r3 z$_get_toolbar_mode..zConfig z. expects to have one of the following values: z. Current value: ) rrVgetattrr ToolbarModeupperrkeys ValueError) config_key config_value enum_valueallowed_valuesr2r2r3_get_toolbar_modes  rRr{rrDcCsPtd|_td|_td|_td|_tddur"d|_t|_dS)Nzbrowser.gatherUsageStatszglobal.maxCachedMessageAgezserver.allowRunOnSavez ui.hideTopBarzclient.showSidebarNavigationFT) rrVgather_usage_statsmax_cached_message_ageallow_run_on_save hide_top_barhide_sidebar_navrR toolbar_moder{r2r2r3rs     rthemersectionc Cst|}tdd|DrdS|D]\}}|dvr*|dur*t|t||q|jj|jj d}| dd}|durX||vrSt d|dt |dn|||_| d d}|rc||_| d d}t|trzt|}Wnty} zt j d |d | d d}WYd} ~ nd} ~ ww|dur|D]-} z |jt| tWqty} zt j d| d | d WYd} ~ qd} ~ wwdSdS)Ncss|]}|duVqdSrr2)rFvalr2r2r3rGrHz&_populate_theme_msg..>basefont fontFaces)lightdarkr]"z=" is an invalid value for theme.base. Allowed values include z . Setting theme.base to "light".r^r_zCFailed to parse the theme.fontFaces config option with json.loads: rrz3Failed to parse the theme.fontFaces config option: )rget_options_for_sectionallvaluesr;setattrr BaseThemeLIGHTDARKgetr*rlistrLr] body_font isinstancer5jsonloadsr font_facesr5rr) r{r[ theme_opts option_name option_valbase_mapr]rlrpr font_facer2r2r3rsb        rrcCstj|_tj|_dSr)rinstanceinstallation_idinstallation_id_v3rYr2r2r3rs r)r4r5)r4rD)r{rr4rD)rZ)r{rr[r5r4rD)r{rr4rD)T __future__rrGrnrr6enumrtypingrrrgoogle.protobuf.json_formatrstreamlit.elements.exceptionelementsrr streamlitrr streamlit.loggerr streamlit.proto.ClientState_pb2r streamlit.proto.Common_pb2r r streamlit.proto.ForwardMsg_pb2rstreamlit.proto.GitInfo_pb2rstreamlit.proto.NewSession_pb2rrrrrstreamlit.runtimer#streamlit.runtime.forward_msg_queuerstreamlit.runtime.fragmentrrstreamlit.runtime.metrics_utilrstreamlit.runtime.pages_managerrstreamlit.runtime.scriptrunnerrrrstreamlit.runtime.secretsrstreamlit.string_utilrstreamlit.versionr streamlit.watcherr!streamlit.proto.BackMsg_pb2r"streamlit.runtime.script_datar#+streamlit.runtime.scriptrunner.script_cacher$rZr&'streamlit.runtime.uploaded_file_managerr'streamlit.source_utilr(r)r/r*__annotations__r+r8r:rRrrrr2r2r2r3s^                     <  >