inquirer package¶

Subpackages¶

inquirer.render package
- Subpackages
  - inquirer.render.console package
- Module contents

Submodules¶

inquirer.errors module¶

exception inquirer.errors.Aborted¶: Bases: inquirer.errors.InquirerError

exception inquirer.errors.EndOfInput(selection, *args, **kwargs)¶: Bases: inquirer.errors.InquirerError

exception inquirer.errors.InquirerError¶: Bases: exceptions.Exception

exception inquirer.errors.ThemeError¶: Bases: exceptions.AttributeError

exception inquirer.errors.UnknownQuestionTypeError¶: Bases: inquirer.errors.InquirerError

exception inquirer.errors.ValidationError(value, *args, **kwargs)¶: Bases: inquirer.errors.InquirerError

inquirer.events module¶

class inquirer.events.Event¶: Bases: object

class inquirer.events.KeyEventGenerator(key_generator=None)¶

Bases: object

next()¶

class inquirer.events.KeyPressed(value)¶: Bases: inquirer.events.Event

class inquirer.events.Repaint¶: Bases: inquirer.events.Event

inquirer.prompt module¶

inquirer.prompt.prompt(questions, render=None, answers=None, theme=<inquirer.themes.Default object>, raise_keyboard_interrupt=False)¶

inquirer.questions module¶

Module that implements the questions types

class inquirer.questions.Checkbox(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'checkbox'¶

class inquirer.questions.Confirm(name, default=False, **kwargs)¶

Bases: inquirer.questions.Question

kind = 'confirm'¶

class inquirer.questions.List(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'list'¶

class inquirer.questions.Password(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'password'¶

class inquirer.questions.Question(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: object

choices¶

choices_generator¶

default¶

ignore¶

kind = 'base question'¶

message¶

validate(current)¶

class inquirer.questions.TaggedValue(label, value)¶: Bases: object

class inquirer.questions.Text(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'text'¶

inquirer.questions.load_from_dict(question_dict)¶: Load one question from a dict. It requires the keys ‘name’ and ‘kind’. :return: The Question object with associated data. :return type: Question

inquirer.questions.load_from_json(question_json)¶

Load Questions from a JSON string. :return: A list of Question objects with associated data if the JSON

contains a list or a Question if the JSON contains a dict.

Return type:	List or Dict

inquirer.questions.load_from_list(question_list)¶: Load a list of questions from a list of dicts. It requires the keys ‘name’ and ‘kind’ for each dict. :return: A list of Question objects with associated data. :return type: List

inquirer.questions.question_factory(kind, *args, **kwargs)¶

Module contents¶

inquirer.prompt(questions, render=None, answers=None, theme=<inquirer.themes.Default object>, raise_keyboard_interrupt=False)¶

class inquirer.Text(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'text'¶

class inquirer.Password(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'password'¶

class inquirer.Confirm(name, default=False, **kwargs)¶

Bases: inquirer.questions.Question

kind = 'confirm'¶

class inquirer.List(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'list'¶

class inquirer.Checkbox(name, message='', choices=None, default=None, ignore=False, validate=True, show_default=False)¶

Bases: inquirer.questions.Question

kind = 'checkbox'¶

inquirer.load_from_dict(question_dict)¶: Load one question from a dict. It requires the keys ‘name’ and ‘kind’. :return: The Question object with associated data. :return type: Question

inquirer.load_from_json(question_json)¶

Load Questions from a JSON string. :return: A list of Question objects with associated data if the JSON

contains a list or a Question if the JSON contains a dict.

Return type:	List or Dict