a oed @sdZddlmZddlmZddlmZddlmZddlmZejZej Z dZ e dd d d Z d$e e e e e ddddZd%e eee eee e ffeeee e ee efdddZd&e ee ee e ee e fdddZd'e e e ee ee e e dddZd(e ee eee ee e ee ee fdddZd)e ee ee e ee e fddd Ze e e e dd!d"d#ZdS)*a$Certbot display. This module (`certbot.display.util`) or its companion `certbot.display.ops` should be used whenever: - Displaying status information to the user on the terminal - Collecting information from the user via prompts Other messages can use the `logging` module. See `log.py`. )List)Optional)Tuple)Union)objHN)msgreturncCstj|dddddS)zMDisplay a basic status message. :param str msg: message to display F)pausedecoratewrapNr get_display notification)rr5C:\Program Files\Certbot\pkgs\certbot\display\util.pynotifysrTF)messager r force_interactiver r cCstj|||||ddS)aDisplays a notification and waits for user acceptance. :param str message: Message to display :param bool pause: Whether or not the program should pause for the user's confirmation :param bool wrap: Whether or not the application should wrap text :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :param bool decorate: Whether to surround the message with a decorated frame )r r rr Nr )rr r rr rrrr&sr)rchoicesdefaultcli_flagrr cCstj|||||dS)aDisplay a menu. .. todo:: This doesn't enable the help label/button (I wasn't sold on any interface I came up with for this). It would be a nice feature. :param str message: title of menu :param choices: Menu lines, len must be > 0 :type choices: list of tuples (tag, item) or list of descriptions (tags will be enumerated) :param default: default value to return, if interaction is not possible :param str cli_flag: option used to set this value with the CLI :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of (`code`, `index`) where `code` - str display exit code `index` - int index of the user's selection :rtype: tuple rrr)rrmenu)rrrrrrrrr8sr)rrrrr cCstj||||dS)aAccept input from the user. :param str message: message to display to the user :param default: default value to return, if interaction is not possible :param str cli_flag: option used to set this value with the CLI :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of (`code`, `input`) where `code` - str display exit code `input` - str of the user's input :rtype: tuple r)rrinputrrrrrrr input_textTsrYesNo)r yes_labelno_labelrrrr cCstj||||||dS)a~Query the user with a yes/no question. Yes and No label must begin with different letters, and must contain at least one letter each. :param str message: question for the user :param str yes_label: Label of the "Yes" parameter :param str no_label: Label of the "No" parameter :param default: default value to return, if interaction is not possible :param str cli_flag: option used to set this value with the CLI :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: True for "Yes", False for "No" :rtype: bool )rr rrr)rryesno)rrr rrrrrrr!hsr!)rtagsrrrr cCstj|||||dS)a'Display a checklist. :param str message: Message to display to user :param list tags: `str` tags to select, len(tags) > 0 :param default: default value to return, if interaction is not possible :param str cli_flag: option used to set this value with the CLI :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of (`code`, `tags`) where `code` - str display exit code `tags` - list of selected tags :rtype: tuple r)rr checklist)rr"rrrrrrr#sr#cCstj||||dS)aDisplay a directory selection screen. :param str message: prompt to give the user :param default: default value to return, if interaction is not possible :param str cli_flag: option used to set this value with the CLI :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of the form (`code`, `string`) where `code` - display exit code `string` - input entered by the user r)rrdirectory_selectrrrrr$sr$)promptrrrr cCs4d|}|r|d|7}|dus0|s0J|dS)a0Verify that provided arguments is a valid display call. :param str prompt: prompt for the user :param default: default answer to prompt :param str cli_flag: command line option for setting an answer to this question :param bool force_interactive: if interactivity is forced z)Invalid display call for this prompt: {0}z7 You can set an answer to this prompt with the {0} flagN)format)r%rrrrrrrassert_valid_calls r')TTFT)NNF)NNF)rrNNF)NNF)NNF)__doc__typingrrrrZcertbot._internal.displayrZOKZCANCELZWIDTHstrrboolrintrrr!r#r$r'rrrrsZ