-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce SessionState.py to hold answer object over executions and s…
…end it back to frontend with st.experimental_rerun()
- Loading branch information
Showing
3 changed files
with
148 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
"""Hack to add per-session state to Streamlit. | ||
Usage | ||
----- | ||
>>> import SessionState | ||
>>> | ||
>>> session_state = SessionState.get(user_name='', favorite_color='black') | ||
>>> session_state.user_name | ||
'' | ||
>>> session_state.user_name = 'Mary' | ||
>>> session_state.favorite_color | ||
'black' | ||
Since you set user_name above, next time your script runs this will be the | ||
result: | ||
>>> session_state = get(user_name='', favorite_color='black') | ||
>>> session_state.user_name | ||
'Mary' | ||
""" | ||
try: | ||
import streamlit.ReportThread as ReportThread | ||
from streamlit.server.Server import Server | ||
except Exception: | ||
# Streamlit >= 0.65.0 | ||
import streamlit.report_thread as ReportThread | ||
from streamlit.server.server import Server | ||
|
||
|
||
class SessionState(object): | ||
def __init__(self, **kwargs): | ||
"""A new SessionState object. | ||
Parameters | ||
---------- | ||
**kwargs : any | ||
Default values for the session state. | ||
Example | ||
------- | ||
>>> session_state = SessionState(user_name='', favorite_color='black') | ||
>>> session_state.user_name = 'Mary' | ||
'' | ||
>>> session_state.favorite_color | ||
'black' | ||
""" | ||
for key, val in kwargs.items(): | ||
setattr(self, key, val) | ||
|
||
|
||
def get(**kwargs): | ||
"""Gets a SessionState object for the current session. | ||
Creates a new object if necessary. | ||
Parameters | ||
---------- | ||
**kwargs : any | ||
Default values you want to add to the session state, if we're creating a | ||
new one. | ||
Example | ||
------- | ||
>>> session_state = get(user_name='', favorite_color='black') | ||
>>> session_state.user_name | ||
'' | ||
>>> session_state.user_name = 'Mary' | ||
>>> session_state.favorite_color | ||
'black' | ||
Since you set user_name above, next time your script runs this will be the | ||
result: | ||
>>> session_state = get(user_name='', favorite_color='black') | ||
>>> session_state.user_name | ||
'Mary' | ||
""" | ||
# Hack to get the session object from Streamlit. | ||
|
||
ctx = ReportThread.get_report_ctx() | ||
|
||
this_session = None | ||
|
||
current_server = Server.get_current() | ||
if hasattr(current_server, '_session_infos'): | ||
# Streamlit < 0.56 | ||
session_infos = Server.get_current()._session_infos.values() | ||
else: | ||
session_infos = Server.get_current()._session_info_by_id.values() | ||
|
||
for session_info in session_infos: | ||
s = session_info.session | ||
if ( | ||
# Streamlit < 0.54.0 | ||
(hasattr(s, '_main_dg') and s._main_dg == ctx.main_dg) | ||
or | ||
# Streamlit >= 0.54.0 | ||
(not hasattr(s, '_main_dg') and s.enqueue == ctx.enqueue) | ||
or | ||
# Streamlit >= 0.65.2 | ||
(not hasattr(s, '_main_dg') and s._uploaded_file_mgr == ctx.uploaded_file_mgr) | ||
): | ||
this_session = s | ||
|
||
if this_session is None: | ||
raise RuntimeError( | ||
"Oh noes. Couldn't get your Streamlit Session object. " | ||
'Are you doing something fancy with threads?') | ||
|
||
# Got the session object! Now let's attach some state into it. | ||
|
||
if not hasattr(this_session, '_custom_session_state'): | ||
this_session._custom_session_state = SessionState(**kwargs) | ||
|
||
return this_session._custom_session_state |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters