已初始化session_state仍遇Streamlit KeyError问题求助

我在Python脚本中使用Streamlit的session_state时，明明已初始化变量，终端启动时却触发KeyError，但浏览器中应用可正常运行。

问题代码 #

import streamlit as st

def main():
    if "show_text" not in st.session_state.keys():
        st.session_state["show_text"] = False

    st.markdown("# My App")

    if st.button("Show text!"):
        st.session_state["show_text"] = True

    if st.session_state["show_text"] is True:
        st.markdown("Lorem ipsum...")

if __name__ == "__main__":
    main()

终端报错信息 #

KeyError: 'st.session_state has no key "show_text". Did you forget to initialize it?'

更新说明 #

运行以下示例代码时终端无报错，想了解为何第一个示例会触发错误：

import streamlit as st

def main():
    if "show_text" not in st.session_state.keys():
        st.session_state["show_text"] = False

    st.markdown("# My App")

    if st.button("Show text!"):
        st.write(st.session_state["show_text"])

if __name__ == "__main__":
    main()

问题原因 #

Streamlit启动时会先执行一次预运行（用于缓存分析、组件初始化），这个阶段不会创建完整的session_state上下文，但会执行脚本里的所有代码。

• 第一个示例中，if st.session_state["show_text"] is True:这行代码在主流程中，预运行阶段会直接执行，此时session_state的初始化逻辑可能还没生效，导致触发KeyError。
• 第二个示例中，读取session_state的代码被包裹在st.button()的条件分支里，预运行时按钮点击条件为False，这部分代码不会执行，因此不会触发错误。

解决方法 #

方法1：使用get()方法安全读取

用st.session_state.get()代替直接键访问，设置默认值避免KeyError：

# 替换原有的判断逻辑
if st.session_state.get("show_text", False):
    st.markdown("Lorem ipsum...")

方法2：将初始化代码移到全局作用域

把session_state的初始化放在脚本最顶部，确保预运行阶段也能完成变量初始化：

import streamlit as st

# 全局初始化，确保所有运行阶段都能访问到该变量
if "show_text" not in st.session_state:
    st.session_state["show_text"] = False

def main():
    st.markdown("# My App")

    if st.button("Show text!"):
        st.session_state["show_text"] = True

    if st.session_state["show_text"]:
        st.markdown("Lorem ipsum...")

if __name__ == "__main__":
    main()

注："show_text" not in st.session_state比st.session_state.keys()写法更简洁，效果完全一致。

方法3：用条件判断跳过预运行阶段的读取

可以通过st.runtime.exists()判断当前是否处于交互运行阶段，不过前两种方法更直接实用：

import streamlit as st
from streamlit.runtime import exists as streamlit_exists

def main():
    if "show_text" not in st.session_state:
        st.session_state["show_text"] = False

    st.markdown("# My App")

    if st.button("Show text!"):
        st.session_state["show_text"] = True

    # 仅在交互运行阶段读取session_state
    if streamlit_exists() and st.session_state["show_text"]:
        st.markdown("Lorem ipsum...")

if __name__ == "__main__":
    main()

内容的提问来源于stack exchange，提问作者gtuor