Skip to content

nonebot/noneprompt

Repository files navigation

NonePrompt

Prompt toolkit for console interaction.

Typing is fully supported. Async is also supported!

Installation

pip install noneprompt

Prompt Usage

Input

from noneprompt import InputPrompt InputPrompt("What is your name?", validator=lambda string: True).prompt() await InputPrompt("What is your name?", validator=lambda string: True).prompt_async()

Confirm

from noneprompt import ConfirmPrompt ConfirmPrompt("Are you sure?", default_choice=False).prompt() await ConfirmPrompt("Are you sure?", default_choice=False).prompt_async()

List

from noneprompt import ListPrompt, Choice ListPrompt("What is your favorite color?", choices=[Choice("Red"), Choice("Blue")]).prompt() await ListPrompt("What is your favorite color?", choices=[Choice("Red"), Choice("Blue")]).prompt_async()

Checkbox

from noneprompt import CheckboxPrompt, Choice CheckboxPrompt("Choose your favorite colors", choices=[Choice("Red"), Choice("Blue")]).prompt() await CheckboxPrompt("Choose your favorite colors", choices=[Choice("Red"), Choice("Blue")]).prompt_async()

Choice Data

You can add data to choices. Result type can be inferred from the data type.

from noneprompt import ListPrompt, Choice result: Choice[str] = ListPrompt( "What is your favorite color?", choices=[ Choice("Red", data="#FF0000"), Choice("Blue", data="#0000FF"), ], ).prompt() print(result.data)

Defaults and Cancellation

from noneprompt import InputPrompt result = InputPrompt("Press Ctrl-C to cancel.").prompt(default="Cancelled") assert result == "Cancelled"
from noneprompt import InputPrompt, CancelledError try: InputPrompt("Press Ctrl-C to cancel.").prompt() except CancelledError: # Do something pass

Style Guide

See the docstring of prompt classes for more information.

from noneprompt import InputPrompt from prompt_toolkit.styles import Style InputPrompt("What is your name?").prompt(style=Style([("input": "#ffffff"), ("answer": "bold")]))

Disable ansi colors:

from noneprompt import InputPrompt InputPrompt("What is your name?").prompt(no_ansi=True)

Try from command line

noneprompt -h

About

Prompt toolkit for console interaction (support async, typing)

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Contributors

Languages