Streamlit form component defined by a Pydantic model
Project description
Streamlit Pydnatic Form
Streamlit form component defined by a Pydantic model.
Installation
pip install streamlit-pydantic-form
Usage
Without streamlit-pydantic-form
import streamlit as st
with st.form("form_0"):
slider_val = st.slider("Form slider")
checkbox_val = st.checkbox("Form checkbox")
submitted = st.form_submit_button("Submit")
if submitted:
st.write("slider", slider_val, "checkbox", checkbox_val)
With streamlit-pydantic-form
With streamlit-pydantic-form
you can define a Pydantic model and use it to automatically generate a form.
from typing import Annotated
import streamlit as st
from pydantic import BaseModel
from streamlit_pydantic_form import st_auto_form, widget
class SimpleFormModel(BaseModel):
slider_val: Annotated[int, widget.Slider("Form slider")]
checkbox_val: Annotated[bool, widget.Checkbox("Form checkbox")]
with st_auto_form("form_1", model=SimpleFormModel) as simple_form:
val = simple_form.input_widgets()
submitted = st.form_submit_button("Submit")
if submitted:
st.write("slider", val.slider_val, "checkbox", val.checkbox_val)
Nested Model
You can also define a nested model.
from typing import Annotated
import streamlit as st
from pydantic import BaseModel
from streamlit_pydantic_form import st_auto_form, widget
class ChildFormModel(BaseModel):
slider_val: Annotated[int, widget.Slider("Child slider")]
class ParentFormModel(BaseModel):
slider_val: Annotated[int, widget.Slider("Parent slider")]
checkbox_val: Annotated[bool, widget.Checkbox("Parent checkbox")]
child: ChildFormModel
with st_auto_form("form_2", model=ParentFormModel) as parent_form:
val2 = parent_form.input_widgets()
submitted = st.form_submit_button("Submit")
if submitted:
st.write(
"parent slider",
val2.slider_val,
"parent checkbox",
val2.checkbox_val,
"child slider",
val2.child.slider_val,
)
Custom Widget
You can define a custom widget by defining a custom WidgetBuilder
.
from typing import Annotated
import streamlit as st
from pydantic import BaseModel
from streamlit_pydantic_form import st_auto_form, widget
# External model
class PointModel(BaseModel):
x: int
y: int
# Custom widget
class PointWidget(widget.WidgetBuilder):
def build(self) -> PointModel:
x = st.slider("X")
y = st.slider("Y")
return PointModel(x=x, y=y)
# Form model
class PointFormModel(BaseModel):
p: Annotated[PointModel, PointWidget()]
with st_auto_form("form_3", model=PointFormModel) as point_form:
val3 = point_form.input_widgets()
submitted = st.form_submit_button("Submit")
if submitted:
st.write("p", val3.p)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for streamlit_pydantic_form-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b12ba7bae865256bfaa8f2189cbb60c30f95c5aa18285f4b2a5c8504c1c288f8 |
|
MD5 | 4433c1b926a49ac6ad14e31cecacdc39 |
|
BLAKE2b-256 | c71f9d29c7a85b86fef457afcbeccbbdff794c93675375cf44c6d2745f1e88c0 |
Close
Hashes for streamlit_pydantic_form-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f4ec1b1aa66b58e1ad812560534c385e2c9f2b3011b62e37c71da16934082d1 |
|
MD5 | e1f0925f301100529f3acc39c0fa7469 |
|
BLAKE2b-256 | c04844cac20576cb5f2bcaa33f60a3407e2bdc5717b8e16534248adeae9f89e8 |