certbot.display.util module

certbot.display.util.OK= ‘ok’
显示退出代码，指示用户接受。

certbot.display.util.CANCEL= ‘cancel’
用户退出显示的显示退出代码。

certbot.display.util.HELP= ‘help’
当用户请求更多帮助时显示退出代码。（没用过）

certbot.display.util.ESC= ‘esc’
当用户点击Escape（UNUSED）时显示退出代码

certbot.display.util.SIDE_FRAME= ‘- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -‘
获取带有超时的用户输入。
与six.moves.input相同，但是，如果用户在超时秒后未回答，则会引发错误。选择默认超时值是为了让用户遵循我们的建议并每天运行Certbot不到12小时。
Parameters:

• prompt (str)–提示提供输入
• timeout (float)- 等待输入的最大秒数
  Returns: 用户回应
  Return type: str

class certbot.display.util.FileDisplay(outfile, force_interactive)source
Bases: object
基于文件的显示。
notification(message, pause=True, wrap=True, force_interactive=False)[source]
显示通知并等待用户接受。
Parameters:

• message（str）–显示的消息
• * pause** (bool*)–程序是否应暂停以供用户确认
• wrap（bool）–应用程序是否应该包装文本
• force_interactive（bool）–如果可以安全提示用户，则为true，因为它不会导致任何工作流程退化
  menu(message, choices, ok_label=None, cancel_label=None, help_label=None, default=None, cli_flag=None, force_interactive=False, **unused_kwargs)[source]
  显示菜单。
  Parameters:
• message (str) – 菜单标题
• choices (list of tuples** (tag, item) or list of descriptions (tags will be enumerated)) – 菜单行，len必须> 0
• default – 返回的默认值（如果存在）
• cli_flag (str) – 用于通过CLI设置此值的选项
• force_interactive (bool) –如果可以安全提示用户，则为true，因为它不会导致任何工作流程退化
  Returns: 元组(code, index) 其中 code -str显示退出代码 index-用户选择的int索引
  Return type: tuple
  input(message, default=None, cli_flag=None, force_interactive=False, **unused_kwargs)[source]
  接受来自用户的输入。
  Parameters:
  • message (str）– 显示给用户的消息
  • default – 返回默认值
  • cli_flag (str) –用于通过CLI设置此值的选项
  • force_interactive (bool) – 如果可以安全提示用户，则为true，因为它不会导致任何工作流程退化
    Returns: tuple of (code, input) where code- str display exit code input - 用户输入的str
    Return type: tuple
    yesno(message, yes_label=’Yes’, no_label=’No’, default=None, cli_flag=None, force_interactive=False, unused_kwargs)[source]
    向用户询问是/否问题。
    是和否标签必须以不同的字母开头，并且每个标签必须至少包含一个字母。
    checklist(message, tags, default=None, cli_flag=None, force_interactive=False, *unused_kwargs*)[source]
    Parameters:
• message (str）–显示给用户的消息
• tags (list) – str要选择的标签，len（标签）> 0
• default – –返回的默认值（如果存在）
• cli_flag (str) – 用于通过CLI设置此值的选项
• force_interactive (bool) – 如果可以安全提示用户，则为true，因为它不会导致任何工作流程退化
  Returns: tuple of (code, tags) 其中 code-str显示退出代码 tags-选定标签的列表
  Return type: tuple
  directory_select(message, default=None, cli_flag=None, **unused_kwargs)[source]
  显示目录选择画面。
  Parameters:
• message (str) -提示用户
• default –返回的默认值（如果存在）
• cli_flag (str) -用于通过CLI设置此值的选项
  Returns:格式（code，string）的元组，其中 code-int显示退出代码 string-用户输入、

certbot.display.util.separate_list_input(input_)source
用逗号或空格分隔列表。
Parameters: input (str) – 用户输入
Returns : strings
Return type : list