Renamed to prompt_choice.

Author: jonathanslenders

examples/input_selection/color.py renamed to examples/choice-prompts/color.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from prompt_toolkit.formatted_text import HTML
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 from prompt_toolkit.styles import Style
 
 
@@ -15,7 +15,7 @@ def main() -> None:
         }
     )
 
-    result = select_input(
+    result = prompt_choice(
         message=HTML("<u>Please select a dish</u>:"),
         options=[
             ("pizza", "Pizza with mushrooms"),

examples/input_selection/default.py renamed to examples/choice-prompts/default.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
 from prompt_toolkit.formatted_text import HTML
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 
 
 def main() -> None:
-    result = select_input(
+    result = prompt_choice(
         message=HTML("<u>Please select a dish</u>:"),
         options=[
             ("pizza", "Pizza with mushrooms"),

examples/input_selection/gray-frame-on-accept.py renamed to examples/choice-prompts/gray-frame-on-accept.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from prompt_toolkit.formatted_text import HTML
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 from prompt_toolkit.styles import Style
 
 
@@ -14,7 +14,7 @@ def main() -> None:
         }
     )
 
-    result = select_input(
+    result = prompt_choice(
         message=HTML("<u>Please select a dish</u>:"),
         options=[
             ("pizza", "Pizza with mushrooms"),

examples/input_selection/many-options.py renamed to examples/choice-prompts/many-options.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 
 
 def main() -> None:
-    result = select_input(
+    result = prompt_choice(
         message="Please select an option:",
         options=[(i, f"Option {i}") for i in range(1, 100)],
     )

examples/input_selection/mouse-support.py renamed to examples/choice-prompts/mouse-support.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
 from prompt_toolkit.formatted_text import HTML
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 
 
 def main() -> None:
-    result = select_input(
+    result = prompt_choice(
         message=HTML("<u>Please select a dish</u>:"),
         options=[
             ("pizza", "Pizza with mushrooms"),

examples/input_selection/simple-selection.py renamed to examples/choice-prompts/simple-selection.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 
 
 def main() -> None:
-    result = select_input(
+    result = prompt_choice(
         message="Please select a dish:",
         options=[
             ("pizza", "Pizza with mushrooms"),

examples/input_selection/with-frame.py renamed to examples/choice-prompts/with-frame.py

@@ -2,7 +2,7 @@
 
 from prompt_toolkit.filters import is_done
 from prompt_toolkit.formatted_text import HTML
-from prompt_toolkit.shortcuts import select_input
+from prompt_toolkit.shortcuts import prompt_choice
 from prompt_toolkit.styles import Style
 
 
@@ -14,7 +14,7 @@ def main() -> None:
         }
     )
 
-    result = select_input(
+    result = prompt_choice(
         message=HTML("<u>Please select a dish</u>:"),
         options=[
             ("pizza", "Pizza with mushrooms"),

src/prompt_toolkit/shortcuts/__init__.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from .choice import prompt_choice
 from .dialogs import (
     button_dialog,
     checkboxlist_dialog,
@@ -9,7 +10,6 @@
     radiolist_dialog,
     yes_no_dialog,
 )
-from .input_selection import select_input
 from .progress_bar import ProgressBar, ProgressBarCounter
 from .prompt import (
     CompleteStyle,
@@ -38,8 +38,8 @@
     # Progress bars.
     "ProgressBar",
     "ProgressBarCounter",
-    # Input selection.
-    "select_input",
+    # Choice selection.
+    "prompt_choice",
     # Utils.
     "clear",
     "clear_title",

src/prompt_toolkit/shortcuts/input_selection.py renamed to src/prompt_toolkit/shortcuts/choice.py

@@ -13,8 +13,8 @@
 from prompt_toolkit.widgets import Box, Frame, Label, RadioList
 
 __all__ = [
-    "InputSelection",
-    "select_input",
+    "ChoiceInput",
+    "prompt_choice",
 ]
 
 _T = TypeVar("_T")
@@ -30,13 +30,13 @@ def create_default_input_selection_style() -> BaseStyle:
     )
 
 
-class InputSelection(Generic[_T]):
+class ChoiceInput(Generic[_T]):
     """
     Input selection prompt. Ask the user to choose among a set of options.
 
     Example usage::
 
-        input_selection = InputSelection(
+        input_selection = ChoiceInput(
             message="Please select a dish:",
             options=[
                 ("pizza", "Pizza with mushrooms"),
@@ -176,7 +176,7 @@ async def prompt_async(self) -> _T:
         return await self._create_application().run_async()
 
 
-def select_input(
+def prompt_choice(
     message: AnyFormattedText,
     options: Sequence[tuple[_T, AnyFormattedText]],
     default: _T | None = None,
@@ -189,11 +189,11 @@ def select_input(
     interrupt_exception: type[BaseException] = KeyboardInterrupt,
 ) -> _T:
     """
-    Input selection prompt. Ask the user to choose among a set of options.
+    Choice selection prompt. Ask the user to choose among a set of options.
 
     Example usage::
 
-        result= select_input(
+        result= prompt_choice(
             message="Please select a dish:",
             options=[
                 ("pizza", "Pizza with mushrooms"),
@@ -211,7 +211,7 @@ def select_input(
     :param style: :class:`.Style` instance for the color scheme.
     """
 
-    return InputSelection[_T](
+    return ChoiceInput[_T](
         message=message,
         options=options,
         default=default,