Adding descriptions for each option

.gitignore

@@ -13,3 +13,4 @@ __pycache__/
 # due to using tox and pytest
 .tox
 .cache
+.idea/

example/basic.py

@@ -3,4 +3,4 @@
 title = "Please choose your favorite programming language: "
 options = ["Java", "JavaScript", "Python", "PHP", "C++", "Erlang", "Haskell"]
 option, index = pick(options, title, indicator="=>", default_index=2)
-print(f"You choosed {option} at index {index}")
+print(f"You chose {option} at index {index}")

example/description_dict.py

@@ -0,0 +1,14 @@
+from pick import pick
+
+title = "Please choose your favorite programming language: "
+options = {
+    "Java": "Java is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible. It is a general-purpose programming language intended to let programmers write once, run anywhere (WORA), meaning that compiled Java code can run on all platforms that support Java without the need to recompile.",
+    "JavaScript": "JavaScript, often abbreviated as JS, is a programming language and core technology of the Web, alongside HTML and CSS. Almost every website uses JavaScript on the client side for webpage behavior.",
+    "Python": "Python is a high-level, general-purpose programming language. Its design philosophy emphasizes code readability with the use of significant indentation.",
+    "PHP": "PHP is a general-purpose scripting language geared towards web development.",
+    "C++": "C++ is a high-level, general-purpose programming language created by Danish computer scientist Bjarne Stroustrup, first released in 1985 as an extension of the C programming language.",
+    "Erlang": "",
+    "Haskell": "",
+}
+option, index = pick(options, title, indicator="=>")
+print(f"You chose {option} at index {index}")

example/option.py

@@ -2,9 +2,11 @@
 
 title = "Please choose your favorite programming language: "
 options = [
-    Option("Java", ".java"),
-    Option("Python", ".py"),
+    Option("Python", ".py", "Python is a high-level, general-purpose programming language. Its design philosophy emphasizes code readability with the use of significant indentation."),
+    Option("Java", description="Java is a high-level, class-based, object-oriented programming language that is designed to have as few implementation dependencies as possible. It is a general-purpose programming language intended to let programmers write once, run anywhere (WORA), meaning that compiled Java code can run on all platforms that support Java without the need to recompile."),
     Option("JavaScript", ".js"),
+    Option("C++"),
+    "PHP"
 ]
-option, index = pick(options, title)
-print(f"You choosed {option} at index {index}")
+option, index = pick(options, title, indicator="=>")
+print(f"You chose {option} at index {index}")

src/pick/__init__.py

@@ -1,14 +1,15 @@
 import curses
 from dataclasses import dataclass, field
-from typing import Any, List, Optional, Sequence, Tuple, TypeVar, Union, Generic
+from typing import Any, Generic, List, Optional, Tuple, TypeVar, Union
 
 __all__ = ["Picker", "pick", "Option"]
 
 
 @dataclass
 class Option:
     label: str
-    value: Any
+    value: Any = None
+    description: Optional[str] = None
 
 
 KEYS_ENTER = (curses.KEY_ENTER, ord("\n"), ord("\r"))
@@ -19,13 +20,12 @@ class Option:
 SYMBOL_CIRCLE_FILLED = "(x)"
 SYMBOL_CIRCLE_EMPTY = "( )"
 
-OPTION_T = TypeVar("OPTION_T", str, Option)
+OPTION_T = TypeVar('OPTION_T', str, Option)
 PICK_RETURN_T = Tuple[OPTION_T, int]
 
-
 @dataclass
 class Picker(Generic[OPTION_T]):
-    options: Sequence[OPTION_T]
+    options: Any
     title: Optional[str] = None
     indicator: str = "*"
     default_index: int = 0
@@ -36,6 +36,8 @@ class Picker(Generic[OPTION_T]):
     screen: Optional["curses._CursesWindow"] = None
 
     def __post_init__(self) -> None:
+        self.parse_options()
+
         if len(self.options) == 0:
             raise ValueError("options should not be an empty list")
 
@@ -49,6 +51,19 @@ def __post_init__(self) -> None:
 
         self.index = self.default_index
 
+
+    def parse_options(self) -> None:
+        if not isinstance(self.options, dict):
+            return
+
+        options: List[Option] = []
+        for option, description in self.options.items():
+            if description == "":
+                options.append(Option(option))
+            else:
+                options.append(Option(option, description=description))
+        self.options = options
+
     def move_up(self) -> None:
         self.index -= 1
         if self.index < 0:
@@ -104,13 +119,32 @@ def get_option_lines(self) -> List[str]:
 
         return lines
 
-    def get_lines(self) -> Tuple[List, int]:
+    def get_lines(self) -> Tuple[List[str], int]:
         title_lines = self.get_title_lines()
         option_lines = self.get_option_lines()
         lines = title_lines + option_lines
         current_line = self.index + len(title_lines) + 1
         return lines, current_line
 
+    def get_description_lines(self, description: str, length: int) -> List[str]:
+        description_words = description.split(" ")
+        description_lines: List[str] = []
+
+        line = ""
+        for i, word in enumerate(description_words):
+            if len(line + " " + word) <= length:
+                if i == 0:
+                    line += word
+                else:
+                    line += " " + word
+            else:
+                description_lines.append(line)
+                line = word
+
+        description_lines.append(line)
+
+        return description_lines
+
     def draw(self, screen: "curses._CursesWindow") -> None:
         """draw the curses ui on the screen, handle scroll if needed"""
         screen.clear()
@@ -129,9 +163,16 @@ def draw(self, screen: "curses._CursesWindow") -> None:
         lines_to_draw = lines[scroll_top : scroll_top + max_rows]
 
         for line in lines_to_draw:
-            screen.addnstr(y, x, line, max_x - 2)
+            screen.addnstr(y, x, line, max_x // 2 - 2)
             y += 1
 
+        option = self.options[self.index]
+        if isinstance(option, Option) and option.description is not None:
+            description_lines = self.get_description_lines(option.description, max_x // 2)
+
+            for i, line in enumerate(description_lines):
+                screen.addstr(i + 3, max_x // 2, line, 2 * max_x // 2 - 2)
+
         screen.refresh()
 
     def run_loop(
@@ -181,7 +222,7 @@ def start(self):
 
 
 def pick(
-    options: Sequence[OPTION_T],
+    options: Any,
     title: Optional[str] = None,
     indicator: str = "*",
     default_index: int = 0,

tests/test_pick.py

@@ -48,10 +48,34 @@ def test_multi_select():
 
 
 def test_option():
-    options = [Option("option1", 101), Option("option2", 102), Option("option3", 103)]
+    options = [Option("option1", 101, "description1"), Option("option2", 102),
+               Option("option3", description="description3"), Option("option4"), "option5"]
+    picker = Picker(options, multiselect=True)
+    for _ in range(4):
+        picker.mark_index()
+        picker.move_down()
+    selected_options = picker.get_selected()
+    for option in selected_options:
+        assert isinstance(option[0], Option)
+    option = selected_options[0]
+    assert option[0].label == "option1"
+    assert option[0].value == 101
+    assert option[0].description == "description1"
+    picker.mark_index()
+    selected_options = picker.get_selected()
+    option = selected_options[-1]
+    assert isinstance(option, tuple)
+    assert isinstance(option[0], str)
+    assert option[0] == "option5"
+
+
+def test_parse_options():
+    options = {"option1": "description1", "option2": ""}
     picker = Picker(options)
+    option, _ = picker.get_selected()
+    assert isinstance(option, Option)
+    assert option.description == "description1"
     picker.move_down()
     option, index = picker.get_selected()
     assert index == 1
     assert isinstance(option, Option)
-    assert option.value == 102