Merge pull request #9 from bmwant/bmwant/choices-accepts-function

Choices should accept callable to generate options

Author: CITGuru

PyInquirer/prompt.py

@@ -20,16 +20,19 @@ def prompt(questions, answers=None, **kwargs):
     eventloop = kwargs.pop('eventloop', None)
     kbi_msg = kwargs.pop('keyboard_interrupt_msg', 'Cancelled by user')
 
-
     for question in questions:
         # import the question
-        if not 'type' in question:
+        if 'type' not in question:
             raise PromptParameterException('type')
-        if not 'name' in question:
+        if 'name' not in question:
             raise PromptParameterException('name')
-        if not 'message' in question:
+        if 'message' not in question:
             raise PromptParameterException('message')
         try:
+            choices = question.get('choices')
+            if choices is not None and callable(choices):
+                question['choices'] = choices(answers)
+
             _kwargs = {}
             _kwargs.update(kwargs)
             _kwargs.update(question)
@@ -38,6 +41,7 @@ def prompt(questions, answers=None, **kwargs):
             message = _kwargs.pop('message')
             when = _kwargs.pop('when', None)
             filter = _kwargs.pop('filter', None)
+
             if when:
                 # at least a little sanity check!
                 if callable(question['when']):

README.rst

@@ -248,35 +248,35 @@ Question Properties
 
 A question is a dictionary containing question related values:
 
--  type: (String) Type of the prompt. Defaults: input - Possible values:
+-  ``type``: (String) Type of the prompt. Defaults: input - Possible values:
    input, confirm, list, rawlist, expand, checkbox, password, editor
--  name: (String) The name to use when storing the answer in the answers
+-  ``name``: (String) The name to use when storing the answer in the answers
    hash. If the name contains periods, it will define a path in the
    answers hash.
--  message: (String\|Function) The question to print. If defined as a
+-  ``message``: (String\|Function) The question to print. If defined as a
    function, the first parameter will be the current inquirer session
    answers.
--  default: (String\|Number\|Array\|Function) Default value(s) to use if
+-  ``default``: (String\|Number\|Array\|Function) Default value(s) to use if
    nothing is entered, or a function that returns the default value(s).
    If defined as a function, the first parameter will be the current
    inquirer session answers.
--  choices: (Array\|Function) Choices array or a function returning a
+-  ``choices``: (Array\|Function) Choices array or a function returning a
    choices array. If defined as a function, the first parameter will be
    the current inquirer session answers. Array values can be simple
    strings, or objects containing a name (to display in list), a value
    (to save in the answers hash) and a short (to display after
    selection) properties. The choices array can also contain a
    Separator.
--  validate: (Function) Receive the user input and should return true if
+-  ``validate``: (Function) Receive the user input and should return true if
    the value is valid, and an error message (String) otherwise. If false
    is returned, a default error message is provided.
--  filter: (Function) Receive the user input and return the filtered
+-  ``filter``: (Function) Receive the user input and return the filtered
    value to be used inside the program. The value returned will be added
    to the Answers hash.
--  when: (Function, Boolean) Receive the current user answers hash and
+-  ``when``: (Function, Boolean) Receive the current user answers hash and
    should return true or false depending on whether or not this question
    should be asked. The value can also be a simple boolean.
--  pageSize: (Number) Change the number of lines that will be rendered
+-  ``pageSize``: (Number) Change the number of lines that will be rendered
    when using list, rawList, expand or checkbox.
 
 User Interfaces and Styles

examples/list.py

@@ -11,6 +11,14 @@
 from examples import custom_style_2
 
 
+
+def get_delivery_options(answers):
+    options = ['bike', 'car', 'truck']
+    if answers['size'] == 'jumbo':
+        options.append('helicopter')
+    return options
+
+
 questions = [
     {
         'type': 'list',
@@ -34,7 +42,13 @@
         'message': 'What size do you need?',
         'choices': ['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro'],
         'filter': lambda val: val.lower()
-    }
+    },
+    {
+        'type': 'list',
+        'name': 'delivery',
+        'message': 'Which vehicle you want to use for delivery?',
+        'choices': get_delivery_options,
+    },
 ]
 
 answers = prompt(questions, style=custom_style_2)

tests/test_example_list.py

@@ -31,9 +31,13 @@ def test_list(example_app):
     example_app.write(keys.ENTER)
     example_app.expect(textwrap.dedent("""\
         ? What size do you need?  Jumbo
-        {
-            "size": "jumbo",
-            "theme": "Order a pizza"
-        }
-        
+        ? Which vehicle you want to use for delivery?  (Use arrow keys)
+         ❯ bike
+           car
+           truck
+           helicopter"""))
+    example_app.write(keys.ENTER)
+    example_app.expect(textwrap.dedent("""\
+        ? Which vehicle you want to use for delivery?  bike
+        {'delivery': 'bike', 'size': 'jumbo', 'theme': 'Order a pizza'}
         """))