h2o-wave 0.26.3__py3-none-win_amd64.whl → 1.0.1__py3-none-win_amd64.whl

h2o_wave/ui.py

@@ -58,7 +58,6 @@ def command(
         icon: Optional[str] = None,
         items: Optional[List[Command]] = None,
         value: Optional[str] = None,
-        data: Optional[str] = None,
 ) -> Command:
     """Create a command.
 
@@ -71,12 +70,9 @@ def command(
         icon: The icon to be displayed for this command.
         items: Sub-commands, if any
         value: Data associated with this command, if any.
-        data: DEPRECATED. Use `value` instead. Data associated with this command, if any.
     Returns:
         A `h2o_wave.types.Command` instance.
     """
-    if data is not None:
-        warnings.warn('The data argument is deprecated.')
     return Command(
         name,
         label,
@@ -84,7 +80,6 @@ def command(
         icon,
         items,
         value,
-        data,
     )
 
 
@@ -1280,7 +1275,7 @@ def markdown_table_cell_type(
 
     Args:
         name: An identifying name for this component.
-        target: Where to display the link. Setting this to '_blank'` opens the link in a new tab or window.
+        target: Where to display the link. An empty string or `'_blank'` opens the link in a new tab. `_self` opens in the current tab.
     Returns:
         A `h2o_wave.types.MarkdownTableCellType` instance.
     """
@@ -1510,7 +1505,7 @@ def link(
         button: True if the link should be rendered as a button.
         width: The width of the link, e.g. '100px'.
         visible: True if the component should be visible. Defaults to True.
-        target: Where to display the link. Setting this to an empty string or `'_blank'` opens the link in a new tab or window.
+        target: Where to display the link. An empty string or `'_blank'` opens the link in a new tab. `_self` opens in the current tab.
         tooltip: An optional tooltip message displayed when a user clicks the help icon to the right of the component.
         name: An identifying name for this component.
     Returns:
@@ -2092,6 +2087,7 @@ def visualization(
         visible: Optional[bool] = None,
         events: Optional[List[str]] = None,
         interactions: Optional[List[str]] = None,
+        animate: Optional[bool] = None,
 ) -> Component:
     """Create a visualization for display inside a form.
 
@@ -2104,6 +2100,7 @@ def visualization(
         visible: True if the component should be visible. Defaults to True.
         events: The events to capture on this visualization. One of 'select_marks'.
         interactions: The interactions to be allowed for this plot. One of 'drag_move' | 'scale_zoom' | 'brush'. Note: `brush` does not raise `select_marks` event.
+        animate: EXPERIMENTAL: True to turn on the chart animations. Defaults to False.
     Returns:
         A `h2o_wave.types.Visualization` instance.
     """
@@ -2116,6 +2113,7 @@ def visualization(
         visible,
         events,
         interactions,
+        animate,
     ))
 
 
@@ -2497,7 +2495,7 @@ def image_annotator(
         trigger: True if the form should be submitted as soon as an annotation is drawn.
         image_height: The card’s image height. The actual image size is used by default.
         allowed_shapes: List of allowed shapes. Available values are 'rect' and 'polygon'. If not set, all shapes are available by default.
-        events: The events to capture on this image annotator. One of `click` or `tool_change`.
+        events: The events to capture on this image annotator. One of `click` | `tool_change`.
     Returns:
         A `h2o_wave.types.ImageAnnotator` instance.
     """
@@ -2514,6 +2512,80 @@ def image_annotator(
     ))
 
 
+def audio_annotator_tag(
+        name: str,
+        label: str,
+        color: str,
+) -> AudioAnnotatorTag:
+    """Create a unique tag type for use in an audio annotator.
+
+    Args:
+        name: An identifying name for this tag.
+        label: Text to be displayed for the annotation.
+        color: Hex or RGB color string to be used as the background color.
+    Returns:
+        A `h2o_wave.types.AudioAnnotatorTag` instance.
+    """
+    return AudioAnnotatorTag(
+        name,
+        label,
+        color,
+    )
+
+
+def audio_annotator_item(
+        start: float,
+        end: float,
+        tag: str,
+) -> AudioAnnotatorItem:
+    """Create an annotator item with initial selected tags or no tags.
+
+    Args:
+        start: The start of the audio annotation in seconds.
+        end: The end of the audio annotation in seconds.
+        tag: The `name` of the audio annotator tag to refer to for the `label` and `color` of this item.
+    Returns:
+        A `h2o_wave.types.AudioAnnotatorItem` instance.
+    """
+    return AudioAnnotatorItem(
+        start,
+        end,
+        tag,
+    )
+
+
+def audio_annotator(
+        name: str,
+        title: str,
+        path: str,
+        tags: List[AudioAnnotatorTag],
+        items: Optional[List[AudioAnnotatorItem]] = None,
+        trigger: Optional[bool] = None,
+) -> Component:
+    """Create an audio annotator component.
+
+    This component allows annotating and labeling parts of audio file.
+
+    Args:
+        name: An identifying name for this component.
+        title: The audio annotator's title.
+        path: The path to the audio file. Use mp3 or wav formats to achieve the best cross-browser support. See https://caniuse.com/?search=audio%20format for other formats.
+        tags: The master list of tags that can be used for annotations.
+        items: Annotations to display on the image, if any.
+        trigger: True if the form should be submitted as soon as an annotation is made.
+    Returns:
+        A `h2o_wave.types.AudioAnnotator` instance.
+    """
+    return Component(audio_annotator=AudioAnnotator(
+        name,
+        title,
+        path,
+        tags,
+        items,
+        trigger,
+    ))
+
+
 def facepile(
         items: List[Component],
         name: Optional[str] = None,
@@ -3701,6 +3773,7 @@ def meta_card(
         script: Optional[InlineScript] = None,
         stylesheet: Optional[InlineStylesheet] = None,
         stylesheets: Optional[List[Stylesheet]] = None,
+        animate: Optional[bool] = None,
         commands: Optional[List[Command]] = None,
 ) -> MetaCard:
     """Represents page-global state.
@@ -3726,6 +3799,7 @@ def meta_card(
         script: Javascript code to execute on this page.
         stylesheet: CSS stylesheet to be applied to this page.
         stylesheets: External CSS files to load into the page.
+        animate: EXPERIMENTAL: True to turn on the card animations. Defaults to False.
         commands: Contextual menu commands for this component.
     Returns:
         A `h2o_wave.types.MetaCard` instance.
@@ -3748,6 +3822,7 @@ def meta_card(
         script,
         stylesheet,
         stylesheets,
+        animate,
         commands,
     )
 
@@ -3834,6 +3909,7 @@ def plot_card(
         plot: Plot,
         events: Optional[List[str]] = None,
         interactions: Optional[List[str]] = None,
+        animate: Optional[bool] = None,
         commands: Optional[List[Command]] = None,
 ) -> PlotCard:
     """Create a card displaying a plot.
@@ -3845,6 +3921,7 @@ def plot_card(
         plot: The plot to be displayed in this card.
         events: The events to capture on this card. One of 'select_marks'.
         interactions: The interactions to be allowed for this card. One of 'drag_move' | 'scale_zoom' | 'brush'. Note: `brush` does not raise `select_marks` event.
+        animate: EXPERIMENTAL: True to turn on the chart animations. Defaults to False.
         commands: Contextual menu commands for this component.
     Returns:
         A `h2o_wave.types.PlotCard` instance.
@@ -3856,6 +3933,7 @@ def plot_card(
         plot,
         events,
         interactions,
+        animate,
         commands,
     )
 
@@ -4532,7 +4610,6 @@ def wide_article_preview_card(
         title: str,
         name: Optional[str] = None,
         aux_value: Optional[str] = None,
-        caption: Optional[str] = None,
         items: Optional[List[Component]] = None,
         content: Optional[str] = None,
         commands: Optional[List[Command]] = None,
@@ -4546,15 +4623,12 @@ def wide_article_preview_card(
         title: The card's title on the right-hand side
         name: An identifying name for this card. Makes the card clickable, similar to a button.
         aux_value: The card's auxiliary text, displayed on the right-hand side of the header.
-        caption: DEPRECATED. Use `content` instead. The card's caption, displayed below the title on the right-hand side.
         items: The card's buttons, displayed under the caption.
         content: The card's markdown content, displayed below the title on the right-hand side.
         commands: Contextual menu commands for this component.
     Returns:
         A `h2o_wave.types.WideArticlePreviewCard` instance.
     """
-    if caption is not None:
-        warnings.warn('The caption argument is deprecated.')
     return WideArticlePreviewCard(
         box,
         persona,
@@ -4562,7 +4636,6 @@ def wide_article_preview_card(
         title,
         name,
         aux_value,
-        caption,
         items,
         content,
         commands,

h2o_wave/version.py

@@ -1 +1 @@
-__version__ = '0.26.2'
+__version__ = '1.0.1'

h2o_wave-1.0.1.data/data/project_templates/chat.py

@@ -0,0 +1,140 @@
+from h2o_wave import main, app, Q, ui, on, run_on, data
+from typing import Optional, List
+
+
+# Use for page cards that should be removed when navigating away.
+# For pages that should be always present on screen use q.page[key] = ...
+def add_card(q, name, card) -> None:
+    q.client.cards.add(name)
+    q.page[name] = card
+
+
+# Remove all the cards related to navigation.
+def clear_cards(q, ignore: Optional[List[str]] = []) -> None:
+    if not q.client.cards:
+        return
+
+    for name in q.client.cards.copy():
+        if name not in ignore:
+            del q.page[name]
+            q.client.cards.remove(name)
+
+
+@on('prompt1')
+async def prompt1(q: Q):
+    q.page['chatbot'].data += ['What is the weather in London?', True]
+    # TODO: Call the model to get the response.
+    q.page['chatbot'].data += ['I am a fake chatbot. Sorry, my author needs to plug me onto a real model.', False]
+
+
+@on('prompt2')
+async def prompt2(q: Q):
+    q.page['chatbot'].data += ['How many people live in New York?', True]
+    # TODO: Call the model to get the response.
+    q.page['chatbot'].data += ['I am a fake chatbot. Sorry, my author needs to plug me onto a real model.', False]
+
+
+@on('prompt3')
+async def prompt3(q: Q):
+    q.page['chatbot'].data += ['What is the population of San Francisco?', True]
+    # TODO: Call the model to get the response.
+    q.page['chatbot'].data += ['I am a fake chatbot. Sorry, my author needs to plug me onto a real model.', False]
+
+
+@on('chatbot')
+async def chatbot(q: Q):
+    del q.page['main-section']
+    q.page['chatbot'].data += [q.args.chatbot, True]
+    # TODO: Call the model to get the response.
+    q.page['chatbot'].data += ['I am a fake chatbot. Sorry, my author needs to plug me onto a real model.', False]
+
+
+@on('#chat')
+async def chat_page(q: Q):
+    q.page['sidebar'].value = '#chat'
+    clear_cards(q)  # When routing, drop all the cards except of the main ones (header, sidebar, meta).
+
+    add_card(q, 'main-section', ui.form_card(box='vertical', items=[
+        ui.text_xl('<center>Ask me anything</center>'),
+        ui.frame(content='<span></span>', height='10px'),
+        ui.text('<center>I am able to answer any question that can be extracted from the uploaded documents. Here are some examples to get you started</center>'),
+        ui.frame(content='<span></span>', height='30px'),
+        ui.inline(items=[
+            ui.button(name='prompt1', caption='What is the weather like in London?'),
+            ui.button(name='prompt2', caption='How many people live in New York?'),
+            ui.button(name='prompt3', caption='What is the population of San Francisco?'),
+        ], justify='around'),
+    ]))
+
+    add_card(q, 'chatbot', ui.chatbot_card(
+        box=ui.box('vertical', size=5),
+        data=data('content from_user', t='list'), name='chatbot')
+    )
+
+
+@on('#upload')
+async def upload_page(q: Q):
+    q.page['sidebar'].value = '#upload'
+    clear_cards(q)  # When routing, drop all the cards except of the main ones (header, sidebar, meta).
+
+    add_card(q, 'form', ui.form_card(box='vertical', items=[
+        ui.file_upload(name='file_upload', label='Upload your documents', multiple=True),
+        ui.table(
+            name='uploaded_files',
+            height='300px',
+            columns=[ui.table_column(name='name', label='File name', min_width='500px', link=False)],
+            rows=[ui.table_row(name=f'row{i}', cells=[file]) for i, file in enumerate(q.client.uploaded_files)]
+        )
+    ]))
+
+
+@on('file_upload')
+async def file_upload(q: Q):
+    # TODO: Upload files to the model if necessary.
+    for f in q.args.file_upload:
+        q.client.uploaded_files.append(f.split('/')[-1])
+    rows = [ui.table_row(name=f'row{i}', cells=[file]) for i, file in enumerate(q.client.uploaded_files)]
+    q.page['form'].uploaded_files.rows = rows
+
+
+async def init(q: Q) -> None:
+    q.page['meta'] = ui.meta_card(box='', layouts=[ui.layout(breakpoint='xs', min_height='100vh', zones=[
+        ui.zone('main', size='1', direction=ui.ZoneDirection.ROW, zones=[
+            ui.zone('sidebar', size='250px'),
+            ui.zone('body', zones=[
+                ui.zone('vertical', size='100vh'),
+            ]),
+        ])
+    ])])
+    q.page['sidebar'] = ui.nav_card(
+        box='sidebar', color='primary', title='My App', subtitle="Let's conquer the world!",
+        value=f'#{q.args["#"]}' if q.args['#'] else '#chat',
+        image='https://wave.h2o.ai/img/h2o-logo.svg', items=[
+            ui.nav_group('Menu', items=[
+                ui.nav_item(name='#chat', label='Chat'),
+                ui.nav_item(name='#upload', label='Upload files'),
+            ]),
+        ],
+        secondary_items=[
+            ui.persona(title='John Doe', subtitle='Developer', size='s',
+                       image='https://images.pexels.com/photos/220453/pexels-photo-220453.jpeg?auto=compress&h=750&w=1260'),
+        ]
+    )
+
+    # If no active hash present, render chat page.
+    if q.args['#'] is None:
+        await chat_page(q)
+
+
+@app('/')
+async def serve(q: Q):
+    # Run only once per client connection.
+    if not q.client.initialized:
+        q.client.cards = set()
+        q.client.uploaded_files = []
+        await init(q)
+        q.client.initialized = True
+
+    # Handle routing.
+    await run_on(q)
+    await q.page.save()

{h2o_wave-0.26.3.data → h2o_wave-1.0.1.data}/data/project_templates/header.py

@@ -1,4 +1,4 @@
-from h2o_wave import main, app, Q, ui, on, handle_on
+from h2o_wave import main, app, Q, ui, on, run_on
 
 
 @app('/')
@@ -9,7 +9,7 @@ async def serve(q: Q):
         q.client.initialized = True
 
     # Other browser interactions
-    await handle_on(q)
+    await run_on(q)
     await q.page.save()
 
 

{h2o_wave-0.26.3.data → h2o_wave-1.0.1.data}/data/project_templates/header_nav.py

@@ -1,4 +1,4 @@
-from h2o_wave import main, app, Q, ui, on, handle_on, data
+from h2o_wave import main, app, Q, ui, on, run_on, data
 from typing import Optional, List
 
 
@@ -112,65 +112,58 @@ async def page3(q: Q):
 
 
 @on('#page4')
-async def handle_page4(q: Q):
+@on('page4_reset')
+async def page4(q: Q):
+    q.page['sidebar'].value = '#page4'
     # When routing, drop all the cards except of the main ones (header, sidebar, meta).
-    # Since this page is interactive, we want to update its card instead of recreating it every time, so ignore 'form' card on drop.
+    # Since this page is interactive, we want to update its card
+    # instead of recreating it every time, so ignore 'form' card on drop.
     clear_cards(q, ['form'])
 
-    if q.args.step1:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1'),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox2', label='Textbox 1'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Next', primary=True),
-            ])
-        ]
-    elif q.args.step2:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1', done=True),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox2', label='Textbox 2'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step1', label='Cancel'),
-                ui.button(name='step3', label='Next', primary=True),
-            ])
-        ]
-    elif q.args.step3:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1', done=True),
-                ui.step(label='Step 2', done=True),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox3', label='Textbox 3'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Cancel'),
-                ui.button(name='submit', label='Next', primary=True),
-            ])
-        ]
-    else:
-        # If first time on this page, create the card.
-        add_card(q, 'form', ui.form_card(box='vertical', items=[
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1'),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox1', label='Textbox 1'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Next', primary=True),
-            ]),
-        ]))
+    # If first time on this page, create the card.
+    add_card(q, 'form', ui.form_card(box='vertical', items=[
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1'),
+            ui.step(label='Step 2'),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox1', label='Textbox 1'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_step2', label='Next', primary=True),
+        ]),
+    ]))
+
+
+@on()
+async def page4_step2(q: Q):
+    # Just update the existing card, do not recreate.
+    q.page['form'].items = [
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1', done=True),
+            ui.step(label='Step 2'),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox2', label='Textbox 2'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_step3', label='Next', primary=True),
+        ])
+    ]
+
+
+@on()
+async def page4_step3(q: Q):
+    # Just update the existing card, do not recreate.
+    q.page['form'].items = [
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1', done=True),
+            ui.step(label='Step 2', done=True),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox3', label='Textbox 3'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_reset', label='Finish', primary=True),
+        ])
+    ]
 
 
 async def init(q: Q) -> None:
@@ -213,6 +206,6 @@ async def serve(q: Q):
         q.client.initialized = True
 
     # Handle routing.
-    await handle_on(q)
+    await run_on(q)
     await q.page.save()
 

{h2o_wave-0.26.3.data → h2o_wave-1.0.1.data}/data/project_templates/header_sidebar_nav.py

@@ -1,5 +1,5 @@
 
-from h2o_wave import main, app, Q, ui, on, handle_on, data
+from h2o_wave import main, app, Q, ui, on, run_on, data
 from typing import Optional, List
 
 
@@ -117,66 +117,58 @@ async def page3(q: Q):
 
 
 @on('#page4')
-async def handle_page4(q: Q):
+@on('page4_reset')
+async def page4(q: Q):
     q.page['sidebar'].value = '#page4'
     # When routing, drop all the cards except of the main ones (header, sidebar, meta).
-    # Since this page is interactive, we want to update its card instead of recreating it every time, so ignore 'form' card on drop.
+    # Since this page is interactive, we want to update its card
+    # instead of recreating it every time, so ignore 'form' card on drop.
     clear_cards(q, ['form'])
 
-    if q.args.step1:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1'),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox2', label='Textbox 1'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Next', primary=True),
-            ])
-        ]
-    elif q.args.step2:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1', done=True),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox2', label='Textbox 2'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step1', label='Cancel'),
-                ui.button(name='step3', label='Next', primary=True),
-            ])
-        ]
-    elif q.args.step3:
-        # Just update the existing card, do not recreate.
-        q.page['form'].items = [
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1', done=True),
-                ui.step(label='Step 2', done=True),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox3', label='Textbox 3'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Cancel'),
-                ui.button(name='submit', label='Next', primary=True),
-            ])
-        ]
-    else:
-        # If first time on this page, create the card.
-        add_card(q, 'form', ui.form_card(box='vertical', items=[
-            ui.stepper(name='stepper', items=[
-                ui.step(label='Step 1'),
-                ui.step(label='Step 2'),
-                ui.step(label='Step 3'),
-            ]),
-            ui.textbox(name='textbox1', label='Textbox 1'),
-            ui.buttons(justify='end', items=[
-                ui.button(name='step2', label='Next', primary=True),
-            ]),
-        ]))
+    # If first time on this page, create the card.
+    add_card(q, 'form', ui.form_card(box='vertical', items=[
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1'),
+            ui.step(label='Step 2'),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox1', label='Textbox 1'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_step2', label='Next', primary=True),
+        ]),
+    ]))
+
+
+@on()
+async def page4_step2(q: Q):
+    # Just update the existing card, do not recreate.
+    q.page['form'].items = [
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1', done=True),
+            ui.step(label='Step 2'),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox2', label='Textbox 2'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_step3', label='Next', primary=True),
+        ])
+    ]
+
+
+@on()
+async def page4_step3(q: Q):
+    # Just update the existing card, do not recreate.
+    q.page['form'].items = [
+        ui.stepper(name='stepper', items=[
+            ui.step(label='Step 1', done=True),
+            ui.step(label='Step 2', done=True),
+            ui.step(label='Step 3'),
+        ]),
+        ui.textbox(name='textbox3', label='Textbox 3'),
+        ui.buttons(justify='end', items=[
+            ui.button(name='page4_reset', label='Finish', primary=True),
+        ])
+    ]
 
 
 async def init(q: Q) -> None:
@@ -227,6 +219,6 @@ async def serve(q: Q):
         q.client.initialized = True
 
     # Handle routing.
-    await handle_on(q)
+    await run_on(q)
     await q.page.save()