Note
Click here to download the full example code
Basic widgets demo#
Widget demonstration with magicgui.
This code demonstrates a few of the widget types that magicgui can create based on the parameter types in your function.
Out:
<MainFunctionGui widget_demo(boolean=True, integer=1, spin_float=3.14, slider_float=43.5, slider_int=550, string='Text goes here', dropdown=<Medium.Glass: 1.52>, radio_option=2, date=datetime.date(1999, 12, 31), time=datetime.time(1, 30, 20), datetime=datetime.datetime(2024, 3, 29, 3, 25, 22, 411000), filename=PosixPath('/Users/runner'))>
import datetime
from enum import Enum
from pathlib import Path
from magicgui import magicgui
class Medium(Enum):
"""Enum for various media and their refractive indices."""
Glass = 1.520
Oil = 1.515
Water = 1.333
Air = 1.0003
@magicgui(
main_window=True,
call_button="Calculate",
layout="vertical",
result_widget=True,
slider_float={"widget_type": "FloatSlider", "max": 100},
slider_int={"widget_type": "Slider", "readout": False},
radio_option={
"widget_type": "RadioButtons",
"orientation": "horizontal",
"choices": [("first option", 1), ("second option", 2)],
},
filename={"label": "Pick a file:"},
)
def widget_demo(
boolean=True,
integer=1,
spin_float=3.14159,
slider_float=43.5,
slider_int=550,
string="Text goes here",
dropdown=Medium.Glass,
radio_option=2,
date=datetime.date(1999, 12, 31),
time=datetime.time(1, 30, 20),
datetime=datetime.datetime.now(),
filename=Path.home(),
):
"""We can use numpy docstrings to provide tooltips.
Parameters
----------
boolean : bool, optional
A checkbox for booleans, by default True
integer : int, optional
Some integer, by default 1
spin_float : float, optional
This one is a float, by default "pi"
slider_float : float, optional
Hey look! I'm a slider, by default 43.5
slider_int : float, optional
I only take integers, and I've hidden my readout, by default 550
string : str, optional
We'll use this string carefully, by default "Text goes here"
dropdown : Enum, optional
Pick a medium, by default Medium.Glass
radio_option : int
A set of radio buttons.
date : datetime.date, optional
Your birthday, by default datetime.date(1999, 12, 31)
time : datetime.time, optional
Some time, by default datetime.time(1, 30, 20)
datetime : datetime.datetime, optional
A very specific time and date, by default ``datetime.datetime.now()``
filename : str, optional
Pick a path, by default Path.home()
"""
return locals().values()
widget_demo.changed.connect(print)
widget_demo.show(run=True)
Total running time of the script: ( 0 minutes 0.172 seconds)
Download Python source code: basic_widgets_demo.py