a
}|gd
@ s d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ejZej Z dZ
e dd d
d Z d$e e
e
e
e
ddddZd%e eee eee e f f ee ee e
ee ef dddZd&e ee ee e
ee e f dddZd'e e e ee
ee e
e
dddZd(e ee eee ee e
ee ee f d d d Zd)e ee ee e
ee e f dd d 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)objH N)msgreturnc C s t j| dddd dS )zMDisplay a basic status message.
:param str msg: message to display
F)pausedecoratewrapNr get_display notification)r r 8/usr/lib/python3.9/site-packages/certbot/display/util.pynotify s r TF)messager
r force_interactiver r c C s t j| ||||d dS )a Displays 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 r r Nr
)r r
r r r r r r r & s r )r choicesdefaultcli_flagr r c C s t j| ||||dS )a Display 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
r r r )r r menu)r r r r r r r r r 8 s r )r r r r r c C s t j| |||dS )a Accept 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 )r r inputr r r r r r r
input_textT s r YesNo)r yes_labelno_labelr r r r c C s t j| |||||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
)r r r r r )r r yesno)r r r r r r r r r r! h s r! )r tagsr r r r c C s t j| ||||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 )r r checklist)r r" r r r r r r r# s r# c C s t j| |||dS )a Display 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 )r r directory_selectr r r r r$ s r$ )promptr r r r c C s4 d | }|r |d |7 }|dus0|s0J |dS )a0 Verify 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% r r r r r r r assert_valid_call s
r' )TTFT)NNF)NNF)r r NNF)NNF)NNF)__doc__typingr r r r Zcertbot._internal.displayr ZOKZCANCELZWIDTHstrr boolr intr r r! r# r$ r' r r r r sZ