Merge pull request #256 from WilliamVenner/feat/other-choice

Add "Other..." option for checkbox & list questions

Author: Cube707

examples/checkbox_other.py

@@ -0,0 +1,23 @@
+import os
+import sys
+from pprint import pprint
+
+
+sys.path.append(os.path.realpath("."))
+import inquirer  # noqa
+
+
+questions = [
+    inquirer.Checkbox(
+        "interests",
+        message="What are you interested in?",
+        choices=["Computers", "Books", "Science", "Nature", "Fantasy", "History"],
+        default=["Computers", "Books"],
+        other=True,
+        carousel=True,
+    ),
+]
+
+answers = inquirer.prompt(questions)
+
+pprint(answers)

examples/list_other.py

@@ -0,0 +1,18 @@
+import os
+import sys
+from pprint import pprint
+
+
+sys.path.append(os.path.realpath("."))
+import inquirer  # noqa
+
+
+questions = [
+    inquirer.List(
+        "size", message="What size do you need?", choices=["Jumbo", "Large", "Standard"], carousel=True, other=True
+    ),
+]
+
+answers = inquirer.prompt(questions)
+
+pprint(answers)

src/inquirer/questions.py

@@ -7,6 +7,7 @@
 import sys
 
 import inquirer.errors as errors
+from inquirer.render.console._other import GLOBAL_OTHER_CHOICE
 
 
 class TaggedValue:
@@ -32,7 +33,17 @@ def __ne__(self, other):
 class Question:
     kind = "base question"
 
-    def __init__(self, name, message="", choices=None, default=None, ignore=False, validate=True, show_default=False):
+    def __init__(
+        self,
+        name,
+        message="",
+        choices=None,
+        default=None,
+        ignore=False,
+        validate=True,
+        show_default=False,
+        other=False,
+    ):
         self.name = name
         self._message = message
         self._choices = choices or []
@@ -41,6 +52,22 @@ def __init__(self, name, message="", choices=None, default=None, ignore=False, v
         self._validate = validate
         self.answers = {}
         self.show_default = show_default
+        self._other = other
+
+        if self._other:
+            self._choices.append(GLOBAL_OTHER_CHOICE)
+
+    def add_choice(self, choice):
+        try:
+            index = self._choices.index(choice)
+            return index
+        except ValueError:
+            if self._other:
+                self._choices.insert(-1, choice)
+                return len(self._choices) - 2
+
+            self._choices.append(choice)
+            return len(self._choices) - 1
 
     @property
     def ignore(self):
@@ -112,18 +139,22 @@ def __init__(self, name, default=False, **kwargs):
 class List(Question):
     kind = "list"
 
-    def __init__(self, name, message="", choices=None, default=None, ignore=False, validate=True, carousel=False):
+    def __init__(
+        self, name, message="", choices=None, default=None, ignore=False, validate=True, carousel=False, other=False
+    ):
 
-        super().__init__(name, message, choices, default, ignore, validate)
+        super().__init__(name, message, choices, default, ignore, validate, other=other)
         self.carousel = carousel
 
 
 class Checkbox(Question):
     kind = "checkbox"
 
-    def __init__(self, name, message="", choices=None, default=None, ignore=False, validate=True, carousel=False):
+    def __init__(
+        self, name, message="", choices=None, default=None, ignore=False, validate=True, carousel=False, other=False
+    ):
 
-        super().__init__(name, message, choices, default, ignore, validate)
+        super().__init__(name, message, choices, default, ignore, validate, other=other)
         self.carousel = carousel
 
 

src/inquirer/render/console/_checkbox.py

@@ -1,6 +1,7 @@
 from readchar import key
 
 from inquirer import errors
+from inquirer.render.console._other import GLOBAL_OTHER_CHOICE
 from inquirer.render.console.base import MAX_OPTIONS_DISPLAYED_AT_ONCE
 from inquirer.render.console.base import BaseConsoleRender
 from inquirer.render.console.base import half_options
@@ -62,6 +63,10 @@ def get_options(self):
 
                 selector = self.theme.Checkbox.selection_icon
                 color = self.theme.Checkbox.selection_color
+
+            if choice == GLOBAL_OTHER_CHOICE:
+                symbol = "+"
+
             yield choice, selector + " " + symbol, color
 
     def process_input(self, pressed):
@@ -79,7 +84,9 @@ def process_input(self, pressed):
                 self.current = min(len(self.question.choices) - 1, self.current + 1)
             return
         elif pressed == key.SPACE:
-            if self.current in self.selection:
+            if self.question.choices[self.current] == GLOBAL_OTHER_CHOICE:
+                self.other_input()
+            elif self.current in self.selection:
                 self.selection.remove(self.current)
             else:
                 self.selection.append(self.current)
@@ -97,3 +104,16 @@ def process_input(self, pressed):
             raise errors.EndOfInput(result)
         elif pressed == key.CTRL_C:
             raise KeyboardInterrupt()
+
+    def other_input(self):
+        other = super().other_input()
+
+        # Clear the print that inquirer.text made
+        print(self.terminal.move_up + self.terminal.clear_eol, end="")
+
+        if not other:
+            return
+
+        index = self.question.add_choice(other)
+        if index not in self.selection:
+            self.selection.append(index)

src/inquirer/render/console/_list.py

@@ -1,6 +1,7 @@
 from readchar import key
 
 from inquirer import errors
+from inquirer.render.console._other import GLOBAL_OTHER_CHOICE
 from inquirer.render.console.base import MAX_OPTIONS_DISPLAYED_AT_ONCE
 from inquirer.render.console.base import BaseConsoleRender
 from inquirer.render.console.base import half_options
@@ -47,7 +48,7 @@ def get_options(self):
             ):
 
                 color = self.theme.List.selection_color
-                symbol = self.theme.List.selection_cursor
+                symbol = "+" if choice == GLOBAL_OTHER_CHOICE else self.theme.List.selection_cursor
             else:
                 color = self.theme.List.unselected_color
                 symbol = " "
@@ -69,6 +70,14 @@ def process_input(self, pressed):
             return
         if pressed == key.ENTER:
             value = self.question.choices[self.current]
+
+            if value == GLOBAL_OTHER_CHOICE:
+                value = self.other_input()
+                if not value:
+                    # Clear the print inquirer.text made, since the user didn't enter anything
+                    print(self.terminal.move_up + self.terminal.clear_eol, end="")
+                    return
+
             raise errors.EndOfInput(getattr(value, "value", value))
 
         if pressed == key.CTRL_C:

src/inquirer/render/console/_other.py

@@ -0,0 +1,6 @@
+class OtherChoice:
+    def __str__(self):
+        return "Other"
+
+
+GLOBAL_OTHER_CHOICE = OtherChoice()

src/inquirer/render/console/base.py

@@ -1,5 +1,7 @@
 from blessed import Terminal
 
+import inquirer
+
 
 # Should be odd number as there is always one question selected
 MAX_OPTIONS_DISPLAYED_AT_ONCE = 13
@@ -17,6 +19,10 @@ def __init__(self, question, theme=None, terminal=None, show_default=False, *arg
         self.theme = theme
         self.show_default = show_default
 
+    def other_input(self):
+        other = inquirer.text(self.question.message)
+        return other
+
     def get_header(self):
         return self.question.message
 

tests/acceptance/test_checkbox.py

@@ -82,6 +82,41 @@ def test_out_of_bounds_down(self):
         self.sut.expect(r"{'interests': \['Books'\]}.*", timeout=1)  # noqa
 
 
+@unittest.skipUnless(sys.platform.startswith("lin"), "Linux only")
+class CheckOtherTest(unittest.TestCase):
+    def setUp(self):
+        self.sut = pexpect.spawn("python examples/checkbox_other.py")
+        self.sut.expect("Computers.*", timeout=1)
+
+    def test_other_input(self):
+        self.sut.send(key.UP)
+        self.sut.expect(r"\+ Other.*", timeout=1)
+        self.sut.send(key.SPACE)
+        self.sut.expect(r": ", timeout=1)
+        self.sut.send("Hello world")
+        self.sut.expect(r"Hello world.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r"> X Hello world[\s\S]*\+ Other.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r"{'interests': \['Computers', 'Books', 'Hello world'\]}", timeout=1)  # noqa
+
+    def test_other_blank_input(self):
+        self.sut.send(key.UP)
+        self.sut.expect(r"\+ Other.*", timeout=1)
+        self.sut.send(key.SPACE)
+        self.sut.expect(r": ", timeout=1)
+        self.sut.send(key.ENTER)  # blank input
+        self.sut.expect(r"> \+ Other.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r"{'interests': \['Computers', 'Books'\]}", timeout=1)  # noqa
+
+    def test_other_select_choice(self):
+        self.sut.send(key.SPACE)
+        self.sut.expect(r"[^X] Computers.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r"{'interests': \['Books'\]}", timeout=1)  # noqa
+
+
 @unittest.skipUnless(sys.platform.startswith("lin"), "Linux only")
 class CheckWithTaggedValuesTest(unittest.TestCase):
     def setUp(self):

tests/acceptance/test_list.py

@@ -57,6 +57,41 @@ def test_out_of_bounds_down(self):
         self.sut.expect("{'size': 'Jumbo'}.*", timeout=1)
 
 
+@unittest.skipUnless(sys.platform.startswith("lin"), "Linux only")
+class CheckOtherTest(unittest.TestCase):
+    def setUp(self):
+        self.sut = pexpect.spawn("python examples/list_other.py")
+        self.sut.expect("Standard.*", timeout=1)
+
+    def test_other_input(self):
+        self.sut.send(key.UP)
+        self.sut.expect(r"\+ Other.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r": ", timeout=1)
+        self.sut.send("Hello world")
+        self.sut.expect(r"Hello world", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect("{'size': 'Hello world'}.*", timeout=1)
+
+    def test_other_blank_input(self):
+        self.sut.send(key.UP)
+        self.sut.expect(r"\+ Other.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r": ", timeout=1)
+        self.sut.send(key.ENTER)  # blank input
+        self.sut.expect(r"\+ Other.*", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect(r": ", timeout=1)
+        self.sut.send("Hello world")
+        self.sut.expect(r"Hello world", timeout=1)
+        self.sut.send(key.ENTER)
+        self.sut.expect("{'size': 'Hello world'}.*", timeout=1)
+
+    def test_other_select_choice(self):
+        self.sut.send(key.ENTER)
+        self.sut.expect("{'size': 'Jumbo'}.*", timeout=1)
+
+
 @unittest.skipUnless(sys.platform.startswith("lin"), "Linux only")
 class ListTaggedTest(unittest.TestCase):
     def setUp(self):