the way "default" is handled currently isnt very intuitive. you need to pass a Choice object to it if you want it to use that choice's value

this PR lets you supply the default as just the "value" of the choice.

as per

https://github.com/tmbo/questionary/issues/124 and https://github.com/tmbo/questionary/issues/57

(sorry not sure how to add tests for it, still noob)

Hi. I'm sorry if this has already been answered before...And thank you for questionary btw.

Is it possible in a select to have a preselected option? I have found the default-settings but it doesn't behave the way I would expect.

Here review is the default, but the marker stays on test. And if the user hits enter he will select test and not review.

In my scenario I will cache the last environment the user worked on and let him hit enter next time, instead of having to select from the list each time.

Dear @tmbo ,

I am trying to test an python application of mine which uses questionary. However, I am lost when trying to test the application.

from click.testing import CliRunner runner = CliRunner() result = runner.invoke(myapplicationfunction, input='\n')

The code above should call myapplicationfunction which opens questionary prompts and then simply enter once, which is equivalent to \n. The same thing works when running echo -e "\n" | python filewhichcallsmyapplicationfunction.py

However, when running it via the runner it does not work. Reason being: it just passes stdin.

The error message is:

E               io.UnsupportedOperation: Stdin is not a terminal.

bla/site-packages/prompt_toolkit/input/vt100.py:57: UnsupportedOperation

How do I test such scripts, which simply open questionary prompts? Do you have a pytest example?

I love questionary! It is certainly the right way forward in the command line dialogs space.

I tried out the rawselect.py example and have problems on simple terminals (TERM=dumb or TERM=unkown) which do not cater for CPRs (cursor position requests). In this case questionary prints out

WARNING: your terminal doesn't support cursor position requests (CPR).

The warning comes from prompt_toolkit I suspect, but is there a way to tell questionary to simplify the prompting so that no CPRs are required? After all the user just will type a number to select an option!

Hallo Questionary, I have been using questionary for a while now, but when I started linking an additional lib, a runtime warning/error gets triggered. (Although it is a warning it leads to immediate failure) In the traceback there is mention of the ask_unsafe function. I wonder, can one from the python.api switch between the multiple ask functions that are available in question.py?

A short test script:

#!/usr/bin/python3
import subprocess
from questionary import prompt, Separator
from datalad import api as datalad

question = [{'type': 'list', 'name': 'choice', 'message': 'Menu', 'choices': ['Red pill','Blue pill']}]
print("You have to take four pills")
for i in range(4):
  answer = prompt(question)
  name =  answer['choice'].replace(' ','_')+str(i)
  print("Create path: "+name)
  ds = datalad.create(name, cfg_proc='text2git')

The trace is

Traceback (most recent call last):
  File "short.py", line 9, in <module>
    answer = prompt(question)
  File "/usr/local/lib/python3.8/dist-packages/questionary/prompt.py", line 97, in prompt
    answer = question.unsafe_ask(patch_stdout)
  File "/usr/local/lib/python3.8/dist-packages/questionary/question.py", line 59, in unsafe_ask
    return self.application.run()
  File "/usr/local/lib/python3.8/dist-packages/prompt_toolkit/application/application.py", line 816, in run
    return loop.run_until_complete(
  File "/usr/lib/python3.8/asyncio/base_events.py", line 591, in run_until_complete
    self._check_closed()
  File "/usr/lib/python3.8/asyncio/base_events.py", line 508, in _check_closed
    raise RuntimeError('Event loop is closed')
RuntimeError: Event loop is closed
sys:1: RuntimeWarning: coroutine 'Application.run_async' was never awaited

Hello, Is there a way to run synchronous questionary calls in an async function? I need to make something like this work:

import asyncio
import questionary

async def main() -> None:
    questionary.select(
        "What do you want to do?",
        choices=[
            "Order a pizza",
            "Make a reservation",
            "Ask for opening hours",
        ],
    ).ask()

asyncio.run(main())

In my application I'm not calling questionary directly (the test above is an oversimplified example): I need to support different toolkits, so I created a wrapper around questionary. I know questionary has an async API, but I'd need to expose it in the wrapper and add await to every call, without any real need for an async API: only to make it work.

Thank you, cheers

For devs, this feature, that was already working, is now documented.

For users, a default instruction text appears when using multiline mode.

Fix #54.

Describe the problem

With version 1.10.0 when I want to use both prompt with dictionary and print question type, I need to call several prompts and to merge answers:

from pprint import pprint
from questionary import Separator, prompt
from questionary import print as qprint


def ask_dictstyle(**kwargs):
    questions = [
        {
            "type": "text",
            "name": "first",
            "message": "Your first message:",
        },
        {
            "type": "text",
            "name": "second",
            "message": "Your second message",
        },
    ]

    answers = prompt(questions)
    qprint("Oh! I need to give somme fancy explanations about what’s next!🦄", style="bold italic fg:darkred")
    questions = [
        {
            "type": "select",
            "name": "third",
            "message": "Select item",
            "choices": ["item1", "item2", Separator(), "other"],
        },
    ]
    answers.update(prompt(questions))
    return answers


if __name__ == "__main__":
    pprint(ask_dictstyle())

Describe the solution

Adding print type to prompt dictionary would resolve the issue:

from pprint import pprint
from questionary import Separator, prompt


def ask_dictstyle(**kwargs):
    questions = [
        {
            "type": "text",
            "name": "first",
            "message": "Your first message:",
        },
        {
            "type": "text",
            "name": "second",
            "message": "Your second message",
        },
        {
            "type": "print",
            "name": "help", #  Do I need a name?
            "message": "Oh! I need to give somme fancy explanations about what’s next!🦄",
            "style": "bold italic fg:darkred",
        },
        {
            "type": "select",
            "name": "third",
            "message": "Select item",
            "choices": ["item1", "item2", Separator(), "other"],
        },
    ]
    return prompt(questions)


if __name__ == "__main__":
    pprint(ask_dictstyle())

Alternatives considered

No response

Using this new version specifier is equivalent to >=3.6,<4.0.0, which allows other projects using this same specifier work with yours.

I have this in my project, and when trying to add the master commit from questionary, poetry fails (correctly) with:

  SolverProblemError

  The current project's Python requirement (>=3.6.1,<4.0.0) is not compatible with some of the required packages Python requirement:
    - questionary requires Python >=3.6,<3.9, so it will not be satisfied for Python >=3.9,<4.0.0

  Because copier depends on questionary (1.6.0 git rev text-custom-lexer) which requires Python >=3.6,<3.9, version solving failed.

  at ~/.local/pipx/venvs/poetry/lib64/python3.8/site-packages/poetry/puzzle/solver.py:241 in _solve
      237│             packages = result.packages
      238│         except OverrideNeeded as e:
      239│             return self.solve_in_compatibility_mode(e.overrides, use_latest=use_latest)
      240│         except SolveFailure as e:
    → 241│             raise SolverProblemError(e)
      242│
      243│         results = dict(
      244│             depth_first_search(
      245│                 PackageNode(self._package, packages), aggregate_package_nodes

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties

    For questionary, a possible solution would be to set the `python` property to ">=3.6.1,<3.9"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

Unless there's a strong reason to block python 3.9, I would advise to use this easier version specifier.

It's a matter of opinion of course, you're not forced to accept this.

This PR adds a several new methods of styling the select and checkbox prompts

• Add flag to disable drawing of the pointer character
• Add highlighted token to style the choice being pointed to
  • This style will only be applied when use_pointer is False
• Add text token to style ordinary text
• Add disabled token to style disabled choices
• Disabled value is no longer displayed if it is a bool
• Choice titles can now be a list of token tuples to support custom styling
  • The answer displayed after the prompt is closed will use the answer token
  • This type of styling means that selected and highlighted tokens will have no effect

I originally thought that use_indicator would serve the same purpose as use_pointer in this PR, but for select it turns on the checkbox style checkbox symbol. I suggest removing this option from the select prompt as well, but I wanted to discuss before making that change. https://github.com/tmbo/questionary/blob/da7a2f9687d09e1eb7abbfb5500ff028634b3c4b/questionary/prompts/select.py#L53-L55

This PR supersedes #12 and #13

I understand questionary as a growing up Python-equivalent of inquirerer.js. Since the landscape of available CLI modules seems to be somewhat scattered around unresolved dependency updates (e.g. like with whaaaaat, pyinquirer ...), I pretty much like what questionary aims at. However, one of the features I currently miss in general is input validation since I would like to prevent the user from proceeding to the next question if the input of the last question is invalid.

Bumps Gr1N/setup-poetry from 7 to 8.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps pre-commit from 2.20.0 to 2.21.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps certifi from 2021.10.8 to 2022.12.7.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Question

Tried this one:

import questionary

questionary.select(
    "What do you want to do?",
    choices=[
        'Order a pizza',
        'Make a reservation',
        'Ask for opening hours'
    ]).ask()  # returns value of selection

When executing this happened:

============ RESTART: /Users/ewust/Documents/Python Code/question.py ===========
[?2004h[?1l[?25l[?7l? What do you want to do? (Use arrow keys)[?7h[?25l[?7l? What do you want to do? (Use arrow keys)
[?7h[?12l[?25h[?2004lTraceback (most recent call last):
  File "/Users/ewust/Documents/Python Code/question.py", line 9, in <module>
    ]).ask()  # returns value of selection
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/questionary/question.py", line 70, in ask
    return self.unsafe_ask(patch_stdout)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/questionary/question.py", line 92, in unsafe_ask
    return self.application.run()
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/prompt_toolkit/application/application.py", line 978, in run
    return loop.run_until_complete(
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/asyncio/base_events.py", line 650, in run_until_complete
    return future.result()
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/prompt_toolkit/application/application.py", line 885, in run_async
    return await _run_async(f)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/prompt_toolkit/application/application.py", line 750, in _run_async
    result = await f
EOFError

What have you already tried?

Already switched back to Python 3.9. Same result. Working on Mac OS 12.6

Active Python at the moment:

Python 3.11.0 (v3.11.0:deaf509e8f, Oct 24 2022, 14:43:23) [Clang 13.0.0 (clang-1300.0.29.30)] on darwin
Type "help", "copyright", "credits" or "license()" for more information.

Can you tell me what i am doing wrong.

Thanks in advance,

Eugène Wüst Amsterdam

Read the documentation

• [X] I have checked to ensure that my question is not answered by the documentation.

Bumps sphinx-rtd-theme from 1.0.0 to 1.1.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps sphinx from 5.1.1 to 5.3.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.