Selection_List Widget. adding items to list

[hossman-12]

I have a directory /DRAFTS with in that directory there are sub-directories with files that will need reviewed. Once reviewed they will be moved to a PROOFED directory. I'm trying to use the selection_list widget to diplay the list of DRAFT files. that way the user can select the ones that have been proofed and can be moved to the PROOFED path. I can use glob to list the contents of the /DRAFTS directory and get them into a list but I can't figure out how to use that list to populate the Selection_List on loading the APP.

Here is my static list which displays correctly

from textual.app import App, ComposeResult
from textual.widgets import Footer, Header, SelectionList
from textual.widgets.selection_list import Selection


class SelectionListApp(App[None]):
    CSS_PATH = "selection_list.css"

    def compose(self) -> ComposeResult:
        yield Header()
        yield SelectionList[int]( 
          Selection('Article_1/Doc.txt', 0),
          Selection('Article_1/Pic_1.jpg', 1),
          Selection('Article_2/Doc.txt', 2),
          Selection('Article_3/Doc.txt', 3),
          Selection('Article_3/Pic_1.jpg', 4),
          Selection('Article_3/Pic_2.jpg', 5),
          )
        yield TextLog()
        yield Footer()

    def on_mount(self) -> None:
        self.query_one(SelectionList).border_title = "Draft Articles"
          
if __name__ == "__main__":
  SelectionListApp().run()

Using a Static LIST variable

from textual.app import App, ComposeResult
from textual.widgets import Footer, Header, SelectionList
from textual.widgets.selection_list import Selection


class SelectionListApp(App[None]):
    CSS_PATH = "selection_list.css"

    def compose(self) -> ComposeResult:
        LIST = (('Article_1/Doc.txt', 0),('Article_1/Pic_1.jpg', 1),('Article_2/Doc.txt', 2),('Article_3/Doc.txt', 3),('Article_3/Pic_1.jpg', 4),('Article_3/Pic_2.jpg', 5))
        yield Header()
        yield SelectionList[int](
          Selection(LIST),
          )
        yield TextLog()
        yield Footer()

    def on_mount(self) -> None:
        self.query_one(SelectionList).border_title = "Draft Articles"
          
if __name__ == "__main__":
  SelectionListApp().run()

Results of run

╭─────────────────────────────────────────────────────────────────────────────────────────────────── Traceback (most recent call last) ───────────────────────────────────────────────────────────────────────────────────────────────────╮
│  .local/lib/python3.10/site-packages/textual/app.py:2013 in _on_compose                                                                                                                                                                 │
│                                                                                                                                                                                                                                         │
│   2010 │                                                                                        ╭───────────────────────────────── locals ──────────────────────────────────╮                                                           │
│   2011 │   async def _on_compose(self) -> None:                                                 │ self = SelectionListApp(title='SelectionListApp', classes={'-dark-mode'}) │                                                           │
│   2012 │   │   try:                                                                             ╰───────────────────────────────────────────────────────────────────────────╯                                                           │
│ ❱ 2013 │   │   │   widgets = [*self.screen._nodes, *compose(self)]                                                                                                                                                                      │
│   2014 │   │   except TypeError as error:                                                                                                                                                                                               │
│   2015 │   │   │   raise TypeError(                                                                                                                                                                                                     │
│   2016 │   │   │   │   f"{self!r} compose() method returned an invalid result; {error}"                                                                                                                                                 │
│                                                                                                                                                                                                                                         │
│  .local/lib/python3.10/site-packages/textual/_compose.py:26 in compose                                                                                                                                                                  │
│                                                                                                                                                                                                                                         │
│   23 │   app._compose_stacks.append(compose_stack)                                            ╭────────────────────────────────────── locals ──────────────────────────────────────╮                                                    │
│   24 │   app._composed.append(composed)                                                       │           app = SelectionListApp(title='SelectionListApp', classes={'-dark-mode'}) │                                                    │
│   25 │   try:                                                                                 │         child = Header()                                                           │                                                    │
│ ❱ 26 │   │   for child in node.compose():                                                     │ compose_stack = []                                                                 │                                                    │
│   27 │   │   │   if composed:                                                                 │      composed = []                                                                 │                                                    │
│   28 │   │   │   │   nodes.extend(composed)                                                   │          node = SelectionListApp(title='SelectionListApp', classes={'-dark-mode'}) │                                                    │
│   29 │   │   │   │   composed.clear()                                                         │         nodes = [Header()]                                                         │                                                    │
│                                                                                               ╰────────────────────────────────────────────────────────────────────────────────────╯                                                    │
│                                                                                                                                                                                                                                         │
│ ./selection_list_tuples.py:27 in compose                                                                                                                                                                                                │
│                                                                                                                                                                                                                                         │
│   24 │   │   LIST = (('Article_1/Doc.txt', 0),('Article_1/Pic_1.jpg', 1),('Article_2/Doc.txt'                                                                                                                                           │
│   25 │   │   yield Header()                                                                                                                                                                                                             │
│   26 │   │   yield SelectionList[int](                                                                                                                                                                                                  │
│ ❱ 27 │   │     Selection(LIST),                                                                                                                                                                                                         │
│   28 │   │     )                                                                                                                                                                                                                        │
│   29 │   │                                                                                                                                                                                                                              │
│                                                                                                                                                                                                                                         │
│ ╭────────────────────────────────────────────────────────────────────────────────────── locals ──────────────────────────────────────────────────────────────────────────────────────╮                                                  │
│ │          LIST = (('Article_1/Doc.txt', 0), ('Article_1/Pic_1.jpg', 1), ('Article_2/Doc.txt', 2), ('Article_3/Doc.txt', 3), ('Article_3/Pic_1.jpg', 4), ('Article_3/Pic_2.jpg', 5)) │                                                  │
│ │          self = SelectionListApp(title='SelectionListApp', classes={'-dark-mode'})                                                                                                 │                                                  │
│ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯                                                  │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
TypeError: Selection.__init__() missing 1 required positional argument: 'value'

The above exception was the direct cause of the following exception:

╭─────────────────────────────────────────────────────────────────────────────────────────────────── Traceback (most recent call last) ───────────────────────────────────────────────────────────────────────────────────────────────────╮
│ .local/lib/python3.10/site-packages/textual/app.py:2015 in _on_compose                                                                                                                                                                  │
│                                                                                                                                                                                                                                         │
│   2012 │   │   try:                                                                             ╭───────────────────────────────── locals ──────────────────────────────────╮                                                           │
│   2013 │   │   │   widgets = [*self.screen._nodes, *compose(self)]                              │ self = SelectionListApp(title='SelectionListApp', classes={'-dark-mode'}) │                                                           │
│   2014 │   │   except TypeError as error:                                                       ╰───────────────────────────────────────────────────────────────────────────╯                                                           │
│ ❱ 2015 │   │   │   raise TypeError(                                                                                                                                                                                                     │
│   2016 │   │   │   │   f"{self!r} compose() method returned an invalid result; {error}"                                                                                                                                                 │
│   2017 │   │   │   ) from error                                                                                                                                                                                                         │
│   2018                                                                                                                                                                                                                                  │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
TypeError: SelectionListApp(title='SelectionListApp', classes={'-dark-mode'}) compose() method returned an invalid result; Selection.__init__() missing 1 required positional argument: 'value'

[davep]

SelectionList takes the selections as positional arguments; so to do what you want you'll want to use the usual Python thing of "unrolling" the list with *. Assuming you'd want to turn them into actual Selection instances too, you'll want something like this:

yield SelectionList[int](*[Selection(file_name, file_no) for file_name, file_no in LIST])

(do double-check, I typed that off the top of my had and it's late on in the afternoon....)

You can see this in passing in the documentation for SelectionList, in the typing section.

[hossman-12]

That works. Thank you