def test_map_set_del_3837_regression():
"""A regression test for `test_map_set_del` that involves too much setup
to conveniently use the hypothesis `example` decorator."""
meta1 = stst.mock_metadata(
"$$GENERATED_WIDGET_KEY-e3e70682-c209-4cac-629f-6fbed82c07cd-None", 0
)
meta2 = stst.mock_metadata(
"$$GENERATED_WIDGET_KEY-f728b4fa-4248-5e3a-0a5d-2f346baa9455-0", 0
)
m = SessionState()
m["0"] = 0
m.register_widget(
metadata=meta1,
widget_id="$$GENERATED_WIDGET_KEY-e3e70682-c209-4cac-629f-6fbed82c07cd-None",
user_key=None,
)
m.compact_state()
m.register_widget(
metadata=meta2,
widget_id="$$GENERATED_WIDGET_KEY-f728b4fa-4248-5e3a-0a5d-2f346baa9455-0",
user_key="0",
)
key = "0"
value1 = 0
m[key] = value1
l1 = len(m)
del m[key]
assert key not in m
assert len(m) == l1 - 1
def _session_state(draw) -> SessionState:
state = SessionState()
new_state = draw(NEW_SESSION_STATE)
for k, v in new_state.items():
state[k] = v
unkeyed_widgets = draw(
hst.dictionaries(keys=UNKEYED_WIDGET_IDS, values=hst.integers()))
for wid, v in unkeyed_widgets.items():
state.register_widget(mock_metadata(wid, v), user_key=None)
widget_key_val_triple = draw(
hst.lists(hst.tuples(hst.uuids(), USER_KEY, hst.integers())))
k_wids = {
key: (as_keyed_widget_id(wid, key), val)
for wid, key, val in widget_key_val_triple
}
for key, (wid, val) in k_wids.items():
state.register_widget(mock_metadata(wid, val), user_key=key)
if k_wids:
session_state_widget_entries = draw(
hst.dictionaries(
keys=hst.sampled_from(list(k_wids.keys())),
values=hst.integers(),
))
for k, v in session_state_widget_entries.items():
state[k] = v
return state
class SessionStateMethodTests(unittest.TestCase):
def setUp(self):
old_state = {"foo": "bar", "baz": "qux", "corge": "grault"}
new_session_state = {"foo": "bar2"}
new_widget_state = WStates(
{
"baz": Value("qux2"),
f"{GENERATED_WIDGET_KEY_PREFIX}-foo-None": Value("bar"),
},
)
self.session_state = SessionState(
old_state, new_session_state, new_widget_state
)
def test_compact(self):
self.session_state.compact_state()
assert self.session_state._old_state == {
"foo": "bar2",
"baz": "qux2",
"corge": "grault",
f"{GENERATED_WIDGET_KEY_PREFIX}-foo-None": "bar",
}
assert self.session_state._new_session_state == {}
assert self.session_state._new_widget_state == WStates()
def test_clear_state(self):
self.session_state.clear_state()
assert self.session_state._merged_state == {}
def test_safe_widget_state(self):
new_session_state = MagicMock()
wstate = {"foo": "bar"}
new_session_state.__getitem__.side_effect = wstate.__getitem__
new_session_state.keys = lambda: {"foo", "baz"}
self.session_state = SessionState({}, {}, new_session_state)
assert self.session_state._safe_widget_state() == wstate
def test_merged_state(self):
assert self.session_state._merged_state == {
"foo": "bar2",
"baz": "qux2",
"corge": "grault",
f"{GENERATED_WIDGET_KEY_PREFIX}-foo-None": "bar",
}
def test_filtered_state(self):
assert self.session_state.filtered_state == {
"foo": "bar2",
"baz": "qux2",
"corge": "grault",
}
def test_filtered_state_resilient_to_missing_metadata(self):
old_state = {"foo": "bar", "corge": "grault"}
new_session_state = {}
new_widget_state = WStates(
{f"{GENERATED_WIDGET_KEY_PREFIX}-baz": Serialized(None)},
)
self.session_state = SessionState(
old_state, new_session_state, new_widget_state
)
assert self.session_state.filtered_state == {
"foo": "bar",
"corge": "grault",
}
def is_new_state_value(self):
assert self.session_state.is_new_state_value("foo")
assert not self.session_state.is_new_state_value("corge")
def test_getitem(self):
assert self.session_state["foo"] == "bar2"
def test_getitem_error(self):
with pytest.raises(KeyError):
self.session_state["nonexistent"]
def test_setitem(self):
assert not self.session_state.is_new_state_value("corge")
self.session_state["corge"] = "grault2"
assert self.session_state["corge"] == "grault2"
assert self.session_state.is_new_state_value("corge")
def test_setitem_disallows_setting_created_widget(self):
mock_ctx = MagicMock()
mock_ctx.widget_ids_this_run = {"widget_id"}
with patch(
"streamlit.script_run_context.get_script_run_ctx", return_value=mock_ctx
):
with pytest.raises(StreamlitAPIException) as e:
self.session_state._key_id_mapping = {"widget_id": "widget_id"}
self.session_state["widget_id"] = "blah"
assert "`st.session_state.widget_id` cannot be modified" in str(e.value)
def test_setitem_disallows_setting_created_form(self):
mock_ctx = MagicMock()
mock_ctx.form_ids_this_run = {"form_id"}
with patch(
"streamlit.script_run_context.get_script_run_ctx", return_value=mock_ctx
):
with pytest.raises(StreamlitAPIException) as e:
self.session_state["form_id"] = "blah"
assert "`st.session_state.form_id` cannot be modified" in str(e.value)
def test_delitem(self):
del self.session_state["foo"]
assert "foo" not in self.session_state
def test_delitem_errors(self):
for key in ["_new_session_state", "_new_widget_state", "_old_state"]:
with pytest.raises(KeyError):
del self.session_state[key]
with pytest.raises(KeyError):
del self.session_state["nonexistent"]
def test_widget_changed(self):
assert self.session_state._widget_changed("foo")
self.session_state._new_widget_state.set_from_value("foo", "bar")
assert not self.session_state._widget_changed("foo")
def test_cull_nonexistent(self):
generated_widget_key = f"{GENERATED_WIDGET_KEY_PREFIX}-removed_widget"
self.session_state._old_state = {
"existing_widget": True,
generated_widget_key: True,
"val_set_via_state": 5,
}
wstates = WStates()
self.session_state._new_widget_state = wstates
self.session_state.cull_nonexistent({"existing_widget"})
assert self.session_state["existing_widget"] == True
assert generated_widget_key not in self.session_state
assert self.session_state["val_set_via_state"] == 5
def test_should_set_frontend_state_value_new_widget(self):
# The widget is being registered for the first time, so there's no need
# to have the frontend update with a new value.
wstates = WStates()
self.session_state._new_widget_state = wstates
WIDGET_VALUE = 123
metadata = WidgetMetadata(
id=f"{GENERATED_WIDGET_KEY_PREFIX}-0-widget_id_1",
deserializer=lambda _, __: WIDGET_VALUE,
serializer=identity,
value_type="int_value",
)
_, widget_value_changed = self.session_state.register_widget(
metadata=metadata,
widget_id=f"{GENERATED_WIDGET_KEY_PREFIX}-0-widget_id_1",
user_key="widget_id_1",
)
assert not widget_value_changed
assert self.session_state["widget_id_1"] == WIDGET_VALUE
