In [1]:

# %run ../src/ipyautoui/_dev_sys_path_append.py
%run __init__.py
%load_ext lab_black

AutoUi¶

With ipyautoui we can create ipywidgets from either a json-schema or a pydantic model. This makes it quick and easy to whip up a user interface when required.

In [2]:

from ipyautoui import demo

demo()

DemoReel(children=(VBox(children=(HTML(value='⬇️ -- <b>Select demo pydantic model / generated AutoUi</b> -- ⬇️…

In [3]:

from ipyautoui import AutoUi
import json
from pydantic import BaseModel, Field
from ipyautoui.constants import DIR_MODULE
from ipyautoui._utils import display_pydantic_json
import ipyautoui
import ipywidgets as w

In [4]:

from pydantic import BaseModel, Field
from ipyautoui.custom.fileupload import AutoUploadPaths
from ipyautoui.autoipywidget import AutoObject

class Test(BaseModel):
    paths: list[pathlib.Path] = Field(autoui="ipyautoui.custom.fileupload.AutoUploadPaths")
    a: str

    class Config:
        schema_extra = {
            'nested_widgets': ['ipyautoui.custom.fileupload.AutoUploadPaths']
        }
aui = AutoObject(Test)  # , nested_widgets=[AutoUploadPaths]
aui

Out[4]:

AutoObject(children=(SaveButtonBar(children=(ToggleButton(value=False, button_style='success', disabled=True, …

In [5]:

aui.show_nested()

Out[5]:

{'title': 'Test',
 'type': 'object',
 'properties': {'paths': {'title': 'Paths',
   'autoui': 'ipyautoui.custom.fileupload.AutoUploadPaths',
   'type': 'array',
   'items': {'type': 'string', 'format': 'path'}},
  'a': {'title': 'A', 'type': 'string'}},
 'required': ['paths', 'a'],
 'nested_widgets': ['ipyautoui.custom.fileupload.AutoUploadPaths']}

In [6]:

from ipyautoui.test_schema import (
    TestAutoLogic,
    TestAutoLogicSimple,
)  # the schema shown in the file above

So let's create a simple pydantic class. Here we have one text field.

In [8]:

# create a pydantic model (or a json-schema) defining the fields of interest
from pydantic import BaseModel, Field


class AutoUiExample(BaseModel):
    text: str = Field(default="Test", description="This description is very important")


data = {"text": "this is a value"}
ui = AutoUi(schema=AutoUiExample, path=pathlib.Path("test.ui.json"), show_savebuttonbar=False)
display(ui)

AutoUi(children=(SaveButtonBar(children=(ToggleButton(value=False, button_style='success', disabled=True, icon…

In [9]:

from ipyautoui.basemodel import file

file(AutoUiExample(), pathlib.Path("test.json"))

In [10]:

# """extending default pydantic BaseModel. NOT IN USE."""
# import pathlib
# from pydantic import BaseModel
# from typing import Type


# def file(self: Type[BaseModel], path: pathlib.Path, **json_kwargs):
#     """
#     this is a method that is added to the pydantic BaseModel within AutoUi using
#     "setattr".

#     Example:
#         ```setattr(model, 'file', file)```

#     Args:
#         self (pydantic.BaseModel): instance
#         path (pathlib.Path): to write file to
#     """
#     if "indent" not in json_kwargs.keys():
#         json_kwargs.update({"indent": 4})
#     path.write_text(self.json(**json_kwargs), encoding="utf-8")


# aui = AutoUiExample()
# aui.__slots__ = ('file',)
# setattr(aui, "file", file)


# #object.__setattr__(aui, "file", file)
# aui.file(pathlib.Path('test.json'))

Writing to JSON¶

Let's define the save location.

In [11]:

import pathlib

save_path = pathlib.Path(".") / "test.simpleaui.json"
print(f"Save Location is: {save_path}")

Save Location is: test.simpleaui.json

In [12]:

ui.file(path=save_path)
AutoUiRenderer = AutoUi.create_autoui_renderer(schema=AutoUiExample)

ui_simple = AutoUiRenderer(path=save_path)


def test_action():
    print("done")


ui_simple.savebuttonbar.fns_onsave_add_action(test_action)
ui_simple.show_savebuttonbar = True
display(ui_simple)

AutoRenderer(children=(SaveButtonBar(children=(ToggleButton(value=False, button_style='success', disabled=True…

In [13]:

import ipywidgets as w

# ui_simple.autowidget.insert_rows = {0: w.Button()}

In [14]:

import typing as ty


class DataFrameCols(BaseModel):
    string: str = Field("string", aui_column_width=100)
    integer: int = Field(1, aui_column_width=80)
    floater: float = Field(3.1415, aui_column_width=70, global_decimal_places=3)
    something_else: float = Field(324, aui_column_width=100)


class TestDataFrame(BaseModel):
    """a description of TestDataFrame"""

    dataframe: ty.List[DataFrameCols] = Field(format="dataframe")

In [15]:

auto_grid = AutoUi(schema=TestDataFrame)
display(auto_grid)

AutoUi(children=(SaveButtonBar(children=(ToggleButton(value=False, button_style='success', disabled=True, icon…

In [14]:

auto_grid.value = {
    "dataframe": [
        {
            "string": "important string",
            "integer": 1,
            "floater": 3.14,
            "something_else": 324,
        },
        {"string": "update", "integer": 4, "floater": 3.12344, "something_else": 123},
        {"string": "evening", "integer": 5, "floater": 3.14, "something_else": 235},
        {"string": "morning", "integer": 5, "floater": 3.14, "something_else": 12},
        {"string": "number", "integer": 3, "floater": 3.14, "something_else": 123},
    ]
}

AutoUi¶

Creating Simple Widget¶

Writing to JSON¶