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