Examples

Basic example

Source code :

import guidataguidata.qapplication() # not required if a QApplication has already been createdimport guidata.dataset.datatypes as dtimport guidata.dataset.dataitems as diclass Processing(dt.DataSet):    """Example"""    a = di.FloatItem("Parameter #1", default=2.3)    b = di.IntItem("Parameter #2", min=0, max=10, default=5)    type = di.ChoiceItem("Processing algorithm",                         ("type 1", "type 2", "type 3"))param = Processing()param.edit()

Output :

Assigning values to data items or using these values is very easy :

param.a = 5.34param.type = "type 3"print "a*b =", param.a*param.b

Other examples

A lot of examples are available in the guidata test module

from guidata import teststests.run()

The two lines above execute the guidata test launcher :

All guidata items demo

import tempfile, atexit, shutil, datetime, numpy as npfrom guidata.dataset.datatypes import DataSet, BeginGroup, EndGroupfrom guidata.dataset.dataitems import (FloatItem, IntItem, BoolItem, ChoiceItem,                             MultipleChoiceItem, ImageChoiceItem, FilesOpenItem,                             StringItem, TextItem, ColorItem, FileSaveItem,                             FileOpenItem, DirectoryItem, FloatArrayItem,                             DateItem, DateTimeItem)# Creating temporary files and registering cleanup functionsTEMPDIR = tempfile.mkdtemp(prefix="test_")atexit.register(shutil.rmtree, TEMPDIR)FILE_ETA = tempfile.NamedTemporaryFile(suffix=".eta", dir=TEMPDIR)atexit.register(FILE_ETA.close)FILE_CSV = tempfile.NamedTemporaryFile(suffix=".csv", dir=TEMPDIR)atexit.register(FILE_CSV.close)class TestParameters(DataSet):    """    DataSet test    The following text is the DataSet 'comment': 
Plain text or    rich text2 are both supported,    as well as special characters (α, β, γ, δ, ...)    """    dir = DirectoryItem("Directory", TEMPDIR)    fname = FileOpenItem("Open file", ("csv", "eta"), FILE_CSV.name)    fnames = FilesOpenItem("Open files", "csv", FILE_CSV.name)    fname_s = FileSaveItem("Save file", "eta", FILE_ETA.name)    string = StringItem("String")    text = TextItem("Text")    float_slider = FloatItem("Float (with slider)",                             default=0.5, min=0, max=1, step=0.01, slider=True)                                 integer = IntItem("Integer", default=5, min=3, max=16, slider=True                      ).set_pos(col=1)    dtime = DateTimeItem("Date/time", default=datetime.datetime(2010, 10, 10))    date = DateItem("Date", default=datetime.date(2010, 10, 10)).set_pos(col=1)    bool1 = BoolItem("Boolean option without label")    bool2 = BoolItem("Boolean option with label", "Label")    _bg = BeginGroup("A sub group")    color = ColorItem("Color")    choice = ChoiceItem("Single choice 1",                        [(16, "first choice"), (32, "second choice"),                         (64, "third choice")])    mchoice2 = ImageChoiceItem("Single choice 2",                               [("rect", "first choice", "gif.png" ),                                ("ell", "second choice", "txt.png" ),                                ("qcq", "third choice", "file.png" )]                               )    _eg = EndGroup("A sub group")    floatarray = FloatArrayItem("Float array", default=np.ones( (50,5), float),                                format=" %.2e ").set_pos(col=1)    mchoice3 = MultipleChoiceItem("MC type 1",                                  [ str(i) for i in range(12)]                                  ).horizontal(4)    mchoice1 = MultipleChoiceItem("MC type 2",                                  ["first choice", "second choice",                                   "third choice"]).vertical(1).set_pos(col=1)        if __name__ == "__main__":    # Create QApplication    import guidata    _app = guidata.qapplication()        e = TestParameters()    e.floatarray[:, 0] = np.linspace( -5, 5, 50)    print e    if e.edit():        print e    e.view()

All (GUI-related) guidata features demo

import tempfile, atexit, shutilimport numpy as npfrom guidata.dataset.datatypes import (DataSet, BeginTabGroup, EndTabGroup,                                       BeginGroup, EndGroup, ObjectItem)from guidata.dataset.dataitems import (FloatItem, IntItem, BoolItem, ChoiceItem,                             MultipleChoiceItem, ImageChoiceItem, FilesOpenItem,                             StringItem, TextItem, ColorItem, FileSaveItem,                             FileOpenItem, DirectoryItem, FloatArrayItem)from guidata.dataset.qtwidgets import DataSetEditLayout, DataSetShowLayoutfrom guidata.dataset.qtitemwidgets import DataSetWidget# Creating temporary files and registering cleanup functionsTEMPDIR = tempfile.mkdtemp(prefix="test_")atexit.register(shutil.rmtree, TEMPDIR)FILE_ETA = tempfile.NamedTemporaryFile(suffix=".eta", dir=TEMPDIR)atexit.register(FILE_ETA.close)FILE_CSV = tempfile.NamedTemporaryFile(suffix=".csv", dir=TEMPDIR)atexit.register(FILE_CSV.close)class SubDataSet(DataSet):    dir = DirectoryItem("Directory", TEMPDIR)    fname = FileOpenItem("Single file (open)", ("csv", "eta"), FILE_CSV.name)    fnames = FilesOpenItem("Multiple files", "csv", FILE_CSV.name)    fname_s = FileSaveItem("Single file (save)", "eta", FILE_ETA.name)class SubDataSetWidget(DataSetWidget):    klass = SubDataSetclass SubDataSetItem(ObjectItem):    klass = SubDataSetDataSetEditLayout.register(SubDataSetItem, SubDataSetWidget)DataSetShowLayout.register(SubDataSetItem, SubDataSetWidget)class TestParameters(DataSet):    """    DataSet test    The following text is the DataSet 'comment': 
Plain text or    rich text2 are both supported,    as well as special characters (α, β, γ, δ, ...)    """    files = SubDataSetItem("files")    string = StringItem("String")    text = TextItem("Text")    _bg = BeginGroup("A sub group")    float_slider = FloatItem("Float (with slider)",                             default=0.5, min=0, max=1, step=0.01, slider=True)                                 fl1 = FloatItem("Current", default=10., min=1, max=30, unit="mA",                    help="Threshold current")    fl2 = FloatItem("Float (col=1)", default=1., min=1, max=1,                    help="Help on float item").set_pos(col=1)    bool1 = BoolItem("Boolean option without label")    bool2 = BoolItem("Boolean option with label", "Label").set_pos(col=1,                                                                   colspan=2)    color = ColorItem("Color", default="red")    choice = ChoiceItem("Single choice",                        [(16, "first choice"), (32, "second choice"),                         (64, "third choice")]                        ).set_pos(col=1,colspan=2)    _eg = EndGroup("A sub group")    floatarray = FloatArrayItem("Float array", default=np.ones( (50,5), float),                                format=" %.2e ").set_pos(col=1)    g0 = BeginTabGroup("group")    mchoice1 = MultipleChoiceItem("MC type 1",                                  ["first choice", "second choice",                                   "third choice"]).vertical(2)    mchoice2 = ImageChoiceItem("MC type 2",                               [("rect", "first choice", "gif.png" ),                                ("ell", "second choice", "txt.png" ),                                ("qcq", "third choice", "file.png" )]                               ).set_pos(col=1) \                                .set_prop("display", icon="file.png")    mchoice3 = MultipleChoiceItem("MC type 3",                                  [ str(i) for i in range(10)] ).horizontal(2)    eg0 = EndTabGroup("group")    integer_slider = IntItem("Integer (with slider)",                             default=5, min=0, max=100, slider=True)    integer = IntItem("Integer", default=5, min=3, max=6).set_pos(col=1)        if __name__ == "__main__":    # Create QApplication    import guidata    _app = guidata.qapplication()        e = TestParameters()    e.floatarray[:, 0] = np.linspace( -5, 5, 50)    print e    if e.edit():        print e    e.view()

Embedding guidata objects in GUI layouts

from guidata.qt.QtGui import QMainWindow, QSplitterfrom guidata.qt.QtCore import SIGNALfrom guidata.dataset.datatypes import (DataSet, BeginGroup, EndGroup,                                       BeginTabGroup, EndTabGroup)from guidata.dataset.dataitems import (ChoiceItem, FloatItem, StringItem,                                       DirectoryItem, FileOpenItem)from guidata.dataset.qtwidgets import DataSetShowGroupBox, DataSetEditGroupBoxfrom guidata.configtools import get_iconfrom guidata.qthelpers import create_action, add_actions, get_std_icon# Local test import:from activable_dataset import ExampleDataSetclass AnotherDataSet(DataSet):    u"""    Example 2    Simple dataset example    """    param0 = ChoiceItem(u"Choice", ['deazdazk', 'aeazee', '87575757'])    param1 = FloatItem(u"Foobar 1", default=0, min=0)    a_group = BeginGroup("A group")    param2 = FloatItem(u"Foobar 2", default=.93)    param3 = FloatItem(u"Foobar 3", default=123)    _a_group = EndGroup("A group")class ExampleMultiGroupDataSet(DataSet):    param0 = ChoiceItem(u"Choice", ['deazdazk', 'aeazee', '87575757'])    param1 = FloatItem(u"Foobar 1", default=0, min=0)    t_group = BeginTabGroup("T group")    a_group = BeginGroup("A group")    param2 = FloatItem(u"Foobar 2", default=.93)    dir1 = DirectoryItem(u"Directory 1")    file1 = FileOpenItem(u"File 1")    _a_group = EndGroup("A group")    b_group = BeginGroup("B group")    param3 = FloatItem(u"Foobar 3", default=123)    _b_group = EndGroup("B group")    c_group = BeginGroup("C group")    param4 = FloatItem(u"Foobar 4", default=250)    _c_group = EndGroup("C group")    _t_group = EndTabGroup("T group")    class OtherDataSet(DataSet):    title = StringItem("Title", default="Title")    icon = ChoiceItem("Icon", (("python.png", "Python"),                               ("guidata.svg", "guidata"),                               ("settings.png", "Settings")))    opacity = FloatItem("Opacity", default=1., min=.1, max=1)class MainWindow(QMainWindow):    def __init__(self):        QMainWindow.__init__(self)        self.setWindowIcon(get_icon('python.png'))        self.setWindowTitle("Application example")                # Instantiate dataset-related widgets:        self.groupbox1 = DataSetShowGroupBox("Activable dataset",                                             ExampleDataSet, comment='')        self.groupbox2 = DataSetShowGroupBox("Standard dataset",                                             AnotherDataSet, comment='')        self.groupbox3 = DataSetEditGroupBox("Standard dataset",                                             OtherDataSet, comment='')        self.groupbox4 = DataSetEditGroupBox("Standard dataset",                                             ExampleMultiGroupDataSet, comment='')        self.connect(self.groupbox3, SIGNAL("apply_button_clicked()"),                     self.update_window)        self.update_groupboxes()                splitter = QSplitter(self)        splitter.addWidget(self.groupbox1)        splitter.addWidget(self.groupbox2)        splitter.addWidget(self.groupbox3)        splitter.addWidget(self.groupbox4)        self.setCentralWidget(splitter)        self.setContentsMargins(10, 5, 10, 5)                # File menu        file_menu = self.menuBar().addMenu("File")        quit_action = create_action(self, "Quit",                                    shortcut="Ctrl+Q",                                    icon=get_std_icon("DialogCloseButton"),                                    tip="Quit application",                                    triggered=self.close)        add_actions(file_menu, (quit_action, ))                # Edit menu        edit_menu = self.menuBar().addMenu("Edit")        editparam1_action = create_action(self, "Edit dataset 1",                                          triggered=self.edit_dataset1)        editparam2_action = create_action(self, "Edit dataset 2",                                          triggered=self.edit_dataset2)        editparam4_action = create_action(self, "Edit dataset 4",                                          triggered=self.edit_dataset4)        add_actions(edit_menu, (editparam1_action,                                editparam2_action,                                editparam4_action))            def update_window(self):        dataset = self.groupbox3.dataset        self.setWindowTitle(dataset.title)        self.setWindowIcon(get_icon(dataset.icon))        self.setWindowOpacity(dataset.opacity)            def update_groupboxes(self):        self.groupbox1.dataset.set_readonly() # This is an activable dataset        self.groupbox1.get()        self.groupbox2.get()        self.groupbox4.get()            def edit_dataset1(self):        self.groupbox1.dataset.set_writeable() # This is an activable dataset        if self.groupbox1.dataset.edit():            self.update_groupboxes()        def edit_dataset2(self):        if self.groupbox2.dataset.edit():            self.update_groupboxes()    def edit_dataset4(self):        if self.groupbox4.dataset.edit():            self.update_groupboxes()        if __name__ == '__main__':    from guidata.qt.QtGui import QApplication    import sys    app = QApplication(sys.argv)    window = MainWindow()    window.show()    sys.exit(app.exec_())

Data item groups and group selection

from guidata.dataset.datatypes import DataSet, BeginGroup, EndGroup, ValuePropfrom guidata.dataset.dataitems import BoolItem, FloatItemprop1 = ValueProp(False)prop2 = ValueProp(False)class GroupSelection(DataSet):    u"""    Group selection test    Group selection example:    """    g1 = BeginGroup("group 1")    enable1 = BoolItem(u"Enable parameter set #1",                       help=u"If disabled, the following parameters will be ignored",                       default=False).set_prop("display", store=prop1)    param1_1 = FloatItem(u"Param 1.1",                          default=0, min=0).set_prop("display", active=prop1)    param1_2 = FloatItem(u"Param 1.2",                        default=.93).set_prop("display", active=prop1)    _g1 = EndGroup("group 1")    g2 = BeginGroup("group 2")    enable2 = BoolItem(u"Enable parameter set #2",                       help=u"If disabled, the following parameters will be ignored",                       default=True).set_prop("display", store=prop2)    param2_1 = FloatItem(u"Param 2.1",                          default=0, min=0).set_prop("display", active=prop2)    param2_2 = FloatItem(u"Param 2.2",                         default=.93).set_prop("display", active=prop2)    _g2 = EndGroup("group 2")if __name__ == '__main__':    # Create QApplication    import guidata    _app = guidata.qapplication()        prm = GroupSelection()    prm.edit()    print prm

Activable data sets

from guidata.dataset.datatypes import ActivableDataSetfrom guidata.dataset.dataitems import BoolItem, FloatItem, ChoiceItem, ColorItemclass ExampleDataSet(ActivableDataSet):    u"""    Example    Activable dataset example    """    enable = BoolItem(u"Enable parameter set",                      help=u"If disabled, the following parameters will be ignored",                      default=False)    param0 = ChoiceItem(u"Param 0", ['choice #1', 'choice #2', 'choice #3'])    param1 = FloatItem(u"Param 1", default=0, min=0)    param2 = FloatItem(u"Param 2", default=.93)    color = ColorItem("Color", default="red")ExampleDataSet.active_setup()if __name__ == '__main__':    # Create QApplication    import guidata    _app = guidata.qapplication()        # Editing mode:    prm = ExampleDataSet()    prm.set_writeable()    prm.edit()        # Showing mode:    prm.set_readonly()    prm.view()

Data set groups

from all_features import TestParametersfrom guidata.dataset.datatypes import DataSetGroupif __name__ == "__main__":    # Create QApplication    import guidata    _app = guidata.qapplication()    e1 = TestParameters("DataSet #1")    e2 = TestParameters("DataSet #2")    g = DataSetGroup( [e1,e2], title='Parameters group' )    g.edit()    print e1    g.edit()

Navigation