Skip to content

trading_agent.terminal.widgets.page_picker

The list of pages, opened with F2, standing in for the web page's sidebar.

It returns the chosen page's command, or None when the user presses Escape.

Typical usage example:

app.push_screen(PagePicker(), on_chosen)

PagePicker 

PagePicker()

Bases: ModalScreen[str | None]

The page list.

Creates the list.

Source code in src/trading_agent/terminal/widgets/page_picker.py 
29
30
31
32
def __init__(self):
    """Creates the list."""
    super().__init__(classes='picker-screen')
    self._pages = page_catalogue.PageCatalogue().pages()

compose 

compose()

Builds the list.

Yields:

Type Description
Widget

The title, the pages and the hint.
Source code in src/trading_agent/terminal/widgets/page_picker.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def compose(self):
    """Builds the list.

    Yields:
        Widget: The title, the pages and the hint.
    """
    with containers.Vertical(classes='picker'):
        yield widgets.Static('[b]Go to[/b]', classes='picker-title')
        options = []
        for page in self._pages:
            options.append(
                option_list.Option(
                    Content.from_markup(
                        '[b]$title[/b]  [dim]$command · $description[/dim]',
                        title=page.title,
                        command=page.command,
                        description=page.description,
                    )
                )
            )
        yield widgets.OptionList(*options, id='page-options')
        yield widgets.Static(
            '[dim]↑↓ to move · enter to open · esc to close[/dim]',
            classes='picker-hint',
        )

on_mount 

on_mount()

Focuses the list.

Source code in src/trading_agent/terminal/widgets/page_picker.py 
60
61
62
def on_mount(self) -> None:
    """Focuses the list."""
    self.query_one('#page-options', widgets.OptionList).focus()

on_option_list_option_selected 

on_option_list_option_selected(event)

Returns the chosen page's command.

Parameters:

Name Type Description Default
event OptionSelected

The choice.

 required
Source code in src/trading_agent/terminal/widgets/page_picker.py 
64
65
66
67
68
69
70
71
72
def on_option_list_option_selected(
    self, event: widgets.OptionList.OptionSelected
) -> None:
    """Returns the chosen page's command.

    Args:
        event (widgets.OptionList.OptionSelected): The choice.
    """
    self.dismiss(self._pages[event.option_index].command)

action_cancel 

action_cancel()

Closes the list without a choice.

Source code in src/trading_agent/terminal/widgets/page_picker.py 
74
75
76
def action_cancel(self) -> None:
    """Closes the list without a choice."""
    self.dismiss(None)