inquirer-executor 0.1.3

python查询程序执行器

这是对python inquirer的包装。从该项目的自述文件：

因此，查询者应简化向最终用户提出问题、解析、验证答案、管理分层提示和提供错误反馈的过程

这个包通过在其上构建类来扩展这种思想，从而创建提示，这些提示将自动调用一个或多个对应于用户选择的函数，同时保持代码美观、整洁和可读。这是通过将函数的docstring作为这些函数的面向用户的表示来实现的。

如何使用

安装

pip install inquirer-executor

由于整个代码都包含在一个文件中，并且只有一个依赖项（构建在inquirer包上），因此如果您是这样滚动的，也可以手动将其（或其部分）复制/粘贴到项目中。

创建单选题（列表）

frominquirer_executorimportInquirerExecutorListquestion=InquirerExecutorList("Question you want to ask the user?",list_of_functions)

函数的列表可以是由函数类型单独组成的任何iterable。该类将根据您作为第一个参数提供的字符串和作为可选选项提供给用户的函数列表生成问题。这些选项将由给定函数对应的docstring表示。

示例

frominquirer_executorimportInquirerExecutorListdefprint_one():"""One."""print("one")defprint_two():"""Two."""print("two")defprint_three():"""Three."""print("three")question=InquirerExecutorList("Of the given choices, how many puppies is best?",[print_one,print_two,print_three])

这将创建问题的实例。现在您可以使用prompt_user（）和prompt_和_execute（）方法了。一旦您使用了prompt\u user（）方法，并且用户提供了答案，您还可以：

• 使用find_function（）方法将相应的函数返回给用户的答案
• 访问实例答案值以读取用户的答案（他们选择的作为字符串的docstring）
• 使用execute（）方法在以后执行用户选择（函数返回被调用函数的返回值）

不过，现在我们只想使用prompt\u和execute（）立即查看结果：

question.prompt_and_execute()

这给了我们这个输出：

[?] Of the given choices, how many puppies is best?: Three.
   One.
   Two.
 > Three.

three

用户已从表示函数和已执行函数的docstring中选择，并打印"3"。整洁.

创建多项选择题（复选框）

frominquirer_executorimportInquirerExecutorCheckboxquestion=InquirerExecutorCheckbox("Question you want to ask the user?",list_of_functions)

初始化它的工作方式与inquirexecutorlist类的工作方式完全相同。不同之处在于存在execution_stack值，该值是一个包含用户选中的所有选项的列表。所以这个类永远不会返回一个函数，总是一个函数列表。

示例

frominquirer_executorimportInquirerExecutorCheckboxdefprint_puppies():"""Puppies."""print("puppies")defprint_rocks():"""Rocks."""print("rocks")defprint_kittens():"""Kittens."""print("kittens")question2=InquirerExecutorCheckbox("Of the given choices, which ones are furry and cuddly?",[print_puppies,print_rocks,print_kittens])

这将创建问题的实例。同样，现在您可以使用prompt_user（）和prompt_和_execute（）方法。使用prompt_user（）方法生成答案后，您可以：

• 使用find_functions（）（注意复数形式）方法将相应的函数列表返回给用户答案
• 访问实例答案值以读取用户的答案（他们选择的文档字符串列表）
• 使用execute（）方法在以后执行用户的选择（函数本身返回函数返回值的列表）

不过，现在我们再次使用prompt\u和execute（）来获得这个结果：

[?] Of the given choices, which one's are furry and cuddly?: 
   X Puppies.
   o Rocks.
 > X Kittens.

puppies
kittens

用户已选中选项1和选项3，并调用了相应的函数。

请记住，在这种情况下prompt_and_execute（）always返回列表

实例化后对问题进行变异

添加

创建inquirexecutor实例后，有两种方法可以将函数添加到其中。第一个是+运算符，它会将添加的函数附加到与问题相关的选项的末尾。

第二个是insert（index，value）方法，它将在index处插入值（在本例中必须是函数类型）。使用它就像您习惯于从列表中键入一样。

设置

您还可以根据自己的喜好设置新值

instance[0]=new_value

这里，new_value需要是函数类型。

重新排序

inquirexecutor提供了一个重新排序（索引）方法，其中索引是表示新顺序的数字列表，因此当给定[2，0，1]时，原始索引0将移动到索引2，原始索引1移动到0，2移动到1。

您还可以使用reverse（）方法，该方法的工作方式与您习惯于从列表中选择类型一样。

拆卸

inquirexecutor提供了一个remove（value）方法，除了一个函数名为string或一个索引为number作为它的值参数之外。在这两种情况下，匹配功能都会从提供给用户的选项中删除。

传递参数

当然，您可以将您喜欢的任何参数传递给函数。请记住，可能会调用列表中的任何函数，因此所有函数都必须接受相同的参数。为了防止路上可能出现的错误，inquirexecuter在创建时执行此操作，如果函数的接受参数不匹配，则抛出断言错误。

主题化

您可以使用python inquirer内置的主题化选项来实现主题的实例化，这是使用主题之前必须先将主题实例化的关键区别。然后，使用theme关键字将实例传递给prompt_user（）或prompt_and_execute（）方法，而不是主题类。

动态设置docstrings

这个包有时需要动态生成docstring，或者至少更可取。这可以通过在像这样定义函数之后定义docstring来实现：

pip install inquirer-executor

pip install inquirer-executor

pip install inquirer-executor

pip install inquirer-executor