Streamlit

Контейнеры - элемент, позволяющий группировать другие произвольные элементы внутри себя. Позволяет в том числе управлять порядком отрисовки элементов.

my_container = st.container()

st.write("a") # --- 3
st.write("b") # --- 4

my_container.write("Inside container") # --- 1
my_container.write("Also inside container") # --- 2

Форма - составной элемент интерфейса, который считается заполненным, только когда заполнены все его элементы. Позволяет сгруппировать элементы в единый логический элемент и таким образом перезапускать скрипт только после заполнения всех элементов формы.

with st.form("my_form"):
    name = st.text_input("Name")
    email = st.text_input("Email")
    st.form_submit_button("Submit")

Фрагмент - обособленный участок кода, который может перезагружаться отдельно от основного скрипта.

• Есть возможность обновлять фрагмент по заданному расписанию с помощью параметра run_every

  (принимает float (seconds) | str (Pandas Timedelta constructor) | datetime.timedelta()).

• Подробнее здесь

• ...
  
  @st.experimental_fragment(run_every="10s")
  def fragment():
          ...
          st.button("Rerun fragment manually")
  ...
  fragment()
  ...

Callback-функции - функции, которые передаются в виджеты через параметры on_change или on_click. Позволяют управлять порядком выполнения кода, так как код в callback-функциях выполняется перед отрисовкой всего скрипта.

def my_callback():
    ...

checkbox_input = st.checkbox(
    "Yes or No",
    on_change=my_callback,
)

Кеширование. Любую функцию можно дополнить декоратором @st.cache_data, тогда при её вызове вычисления проводиться по возможности не будут и значение будет взято из кэша.

Состояние сессии - st.session_state, dictionary-like интерфейс. Позволяет управлять значениями объектов в пределах одной сессии.

• Cоздаётся словарь, где ключ - набор аргументов, а значение - результат выполнения функции на этом наборе.

• При использовании значения функции помеченной декоратором, создаётся копия закешированного объекта.

  @st.cache_data
  def transform(df):
      df = df.filter(items=['one', 'three'])
      df = df.apply(np.sum, axis=0)
      return df

• Возвращается не копия, а сам объект, то есть singleton: глобальный изменяемый объект.

• При изменении объекта, изменятся значения всех обращающихся к нему переменных.

• Bad example

  from transformers import pipeline
  model = pipeline("sentiment-analysis")

• Good example

  from transformers import pipeline
  
  @st.cache_resource
  def load_model():
      return pipeline("sentiment-analysis")
  
  model = load_model()

• func.clear() | st.cache_data.clear() – очистить кеш
• ttl: time-to-live – время жизни
• max_entries - максимальное количество хранящихся закешированных объектов
• persist=True | persist='disk' - сохраняет результаты кеширования на диск (~/.streamlit/cache/): pickle-объекты
• _some_arg: некешируемый аргумент в функции.

В словарь состояния сессии также попадают значения виджетов, если при их создании передать параметр key.

def my_callback():
        st.session_state["key"] = "value"

checkbox_input = st.checkbox(
        "Yes or No",
        key="my_checkbox_key",
        on_change=my_callback,
)

st.write(st.session_state)

Можно заранее создать ключ в словаре сессии, тогда созданный после элемент примет указанное значение как дефолтное.

if "my_slider" not in st.session_state:
        st.session_state.my_slider = 8

st.slider(
        "Slider",
        min_value=0,
        max_value=20,
        key="my_slider",
)

Как конфигурировать:

• Передать параметры при запуске через cli при запуске;
• Использовать файл с настройками config.toml;

Местоположение файла:

• Глобальный файл конфигурации: ~/.streamlit/config.toml (Linux, MacOS) или %userprofile%\.streamlit\config.toml (Windows);
• Локальный файл конфигурации: ./.streamlit/config.toml;

Как проверить текущие и доступные настройки приложения:

streamlit config show

Пример конфигурационного файла

[server]
port = 8503
fileWatcherType = "none"
maxUploadSize = 2048

[global]
developmentMode = false

[browser]
gatherUsageStats = false

файл с секретами secrets.toml

db_username = "Jane"

[section]
user = "Egor"

Используются с помощью dict-like интерфейса st.secrets

st.secrets["db_username"] # Jane

st.secrets["section"]["user"] # Egor

Местоположение файла:

1. Глобальный файл с секретами: ~/.streamlit/secrets.toml (Linux, MacOS) или %userprofile%\.streamlit\secrets.toml (Windows)
2. Локальный файл с секретами: ./.streamlit/secrets.toml

st.connection("sql") (python) соотносится с секцией [connections.sql] (toml) в файле с секретами.

st.connection("my_connection", type="sql") (python) соотносится с секцией [connections.my_connection] (toml) в файле с секретами.

Доступны: sql, snowflake. Можно создать своё подключение к любому источнику, подробнее (не рекомендуется)

.streamlit/secrets.toml:

[connections.my_db]
    dialect = "mysql"
    username = "myuser"
    password = "password"
    host = "localhost"
    database = "mydb"

Приложение Streamlit:

conn = st.connection("mydb", type="sql", autocommit=True)