What is the difference between `default` and `init_value`? about streamlit-pydantic HOT 3 OPEN

In the case of dicts, lists and objects I guess its a bug/missing feature. I've added a PR to address it.

from streamlit-pydantic.

default is a standard attribute of pydantic's Field and is usually defined as part of the model, such as "Jane Doe" in the example below:

class User(BaseModel):
    id: int
    name = 'Jane Doe'

init_value is a streamlit-pydantic specific attribute that is used internally to store the value of a field when sp.pydantic_form()/sp.pydantic_input() is initialised from an instance of a class.

In hindsight, init_value should have a more descriptive name (instance_value would be better!) and perhaps it should start with an underscore to make it more obvious that it for internal use.

In terms of which value should get passed through to the streamlit widgets when both attributes exist, init_value is considered to be higher priority than default (in the same way that instance values would override the schema defaults when using pydantic in a regular python script)

from streamlit-pydantic.

default is a standard attribute of pydantic's Field and is usually defined as part of the model, such as "Jane Doe" in the example below:

class User(BaseModel):
    id: int
    name = 'Jane Doe'

init_value is a streamlit-pydantic specific attribute that is used internally to store the value of a field when sp.pydantic_form()/sp.pydantic_input() is initialised from an instance of a class.

In hindsight, init_value should have a more descriptive name (instance_value would be better!) and perhaps it should start with an underscore to make it more obvious that it for internal use.

In terms of which value should get passed through to the streamlit widgets when both attributes exist, init_value is considered to be higher priority than default (in the same way that instance values would override the schema defaults when using pydantic in a regular python script)

I noticed that if the default value is passed to Dict using default, it will not be rendered. It will work when passing the default value using init_value:

from typing import Dict

import streamlit as st
from pydantic import BaseModel, Field

import streamlit_pydantic as sp

class ShowcaseModel(BaseModel):
    string_dict: Dict[str, str] = Field(
        # init_value={"foo": "1.0"},
        default={"foo": "bar"},
    )
    float_dict: Dict[str, float] = Field(
        init_value={"foo": 1.0},
    )

session_data = sp.pydantic_input(
    key="my_input", model=ShowcaseModel, group_optional_fields="sidebar"
)

with st.expander("Current Input State", expanded=False):
    st.json(session_data)

Is this as expected?
Thank you.

from streamlit-pydantic.