Existe-t-il un moyen d'ajouter l'option "select all" dans le widget multiselect du paquet streamlit de python ?

Question

Je suis en train de développer un streamlit qui contient un widget multi-sélection avec 10 options. Existe-t-il une alternative pour ajouter un bouton qui sélectionne toutes les options afin d'éviter de les sélectionner une par une ?

J'ai essayé d'ajouter un bouton précédent à la sélection multiple, mais l'utilisation d'un autre widget réinitialise la sélection. Voici un exemple de code :

import streamlit as st

if st.sidebar.button('Add all years'):
    year_filter = st.sidebar.multiselect('Select a year',[2000,2001,2002,2003,2004], default=[2000,2001,2002,2003,2004])
else:
    year_filter = st.sidebar.multiselect('Select a year',[2000,2001,2002,2003,2004], default=[2000])

type_filter = st.sidebar.multiselect('Choose a type',['Control','Experimental'], default=['Experimental'])

st.write(year_filter, type_filter)

Answer 1

Il existe un moyen d'utiliser le state :

import streamlit as st
from streamlit.ReportThread import get_report_ctx
from streamlit.hashing import _CodeHasher
from streamlit.server.Server import Server

class _SessionState:
    def __init__(self, session, hash_funcs):
        """Initialize SessionState instance."""
        self.__dict__["_state"] = {
            "data": {},
            "hash": None,
            "hasher": _CodeHasher(hash_funcs),
            "is_rerun": False,
            "session": session,
        }

    def __call__(self, **kwargs):
        """Initialize state data once."""
        for item, value in kwargs.items():
            if item not in self._state["data"]:
                self._state["data"][item] = value

    def __getitem__(self, item):
        """Return a saved state value, None if item is undefined."""
        return self._state["data"].get(item, None)

    def __getattr__(self, item):
        """Return a saved state value, None if item is undefined."""
        return self._state["data"].get(item, None)

    def __setitem__(self, item, value):
        """Set state value."""
        self._state["data"][item] = value

    def __setattr__(self, item, value):
        """Set state value."""
        self._state["data"][item] = value

    def clear(self):
        """Clear session state and request a rerun."""
        self._state["data"].clear()
        self._state["session"].request_rerun()

    def sync(self):
        """Rerun the app with all state values up to date from the beginning to fix rollbacks."""

        # Ensure to rerun only once to avoid infinite loops
        # caused by a constantly changing state value at each run.
        #
        # Example: state.value += 1
        if self._state["is_rerun"]:
            self._state["is_rerun"] = False

        elif self._state["hash"] is not None:
            if self._state["hash"] != self._state["hasher"].to_bytes(self._state["data"], None):
                self._state["is_rerun"] = True
                self._state["session"].request_rerun()

        self._state["hash"] = self._state["hasher"].to_bytes(self._state["data"], None)

def _get_session():
    session_id = get_report_ctx().session_id
    session_info = Server.get_current()._get_session_info(session_id)

    if session_info is None:
        raise RuntimeError("Couldn't get your Streamlit Session object.")

    return session_info.session

def _get_state(hash_funcs=None):
    session = _get_session()

    if not hasattr(session, "_custom_session_state"):
        session._custom_session_state = _SessionState(session, hash_funcs)

    return session._custom_session_state

def main():
    state = _get_state()

    if state.previous_years_selected is None:
        state.previous_years_selected = [2000]

    if st.sidebar.button('Add all years'):
        year_filter = st.sidebar.multiselect('Select a year', [2000,2001,2002,2003,2004], default=[2000,2001,2002,2003,2004])
    else:
        year_filter = st.sidebar.multiselect('Select a year', [2000,2001,2002,2003,2004], default=state.previous_years_selected)

    # The next default (in case no one clicks on "Add all years")
    # will be the current years selected
    state.previous_years_selected = year_filter

    state.sync()

if __name__ == "__main__":
    main()

En _StateSession conserve les données à travers les rechargements de Streamlit, ce qui signifie que si vous interagissez avec un widget, la page se recharge mais l'objet state conserve l'information.
Ici, nous conservons les informations sur les années qui ont été sélectionnées lors de la dernière interaction avec le "sélecteur d'année" et les fournissons par défaut lors du prochain rechargement ( default=state.previous_years_selected ).

Vous pouvez ajouter toutes les données que vous voulez à la state objet. Il suffit de s'assurer qu'il existe bien avant de le modifier :

if state.previous_years_selected is None:
    state.previous_years_selected = [2000]