3
گa&
@ s, d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
ddl Z dd
l m
Z
dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ e
jZe
jZdZdZdZeddddZ d1ee e e e ddddZ d2ee
ee ee eef f ee ee e e ee f d d d Z d3eee ee e e eef d d d!Z!d4eeeee ee e e d$d%d&Z"d5eee eee ee e e eee f d'd(d)Z#d6eee ee e e eef d d*d+Z$eeee dd,d-d.Z%G d/d0 d0Z&eee&ej'e( ej'e(< dS )7a$ 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`.
N)
ModuleType)Any)cast)List)Optional)Tuple)Union)obj) FileDisplay)NoninteractiveDisplay)
SIDE_FRAME)input_with_timeout)separate_list_input)summarize_domain_listH helpesc)msgreturnc C s t j j| dddd dS )zMDisplay a basic status message.
:param str msg: message to display
F)pausedecoratewrapN)r get_display notification)r r /usr/lib/python3.6/util.pynotify4 s r TF)messager r force_interactiver r c C s t j 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 N)r r r )r r r r r r r r r = s r )r choicesdefaultcli_flagr r c C s t j 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" O s r" )r r r! r r c C s t j 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 )r r input)r r r! r r r r
input_textk s r$ YesNo)r yes_labelno_labelr r! r r c C s t j 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) s r) )r tagsr r! r r c C s t j 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 )r r checklist)r r* r r! r r r r r+ s r+ c C s t j 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 )r r directory_select)r r r! r r r r r, s r, )promptr r! r r c C s dj | }|r |dj |7 }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/ c @ sd e Zd ZdZeddddZeedddZeedd d
d Z eddd d
Z
e e dddZ dS ) _DisplayUtilDeprecationModulez
Internal class delegating to a module, and displaying warnings when attributes
related to deprecated attributes in the certbot.display.util module.
N)moduler c C s || j d< d S )N_module)__dict__)selfr1 r r r __init__ s z&_DisplayUtilDeprecationModule.__init__)attrr c
C s* |d
kr t jd
j|td d t| j|S )Nr
r r r
r r WIDTHHELPESCzT{0} attribute in certbot.display.util module is deprecated and will be removed soon. )
stacklevel) r
r r r
r r r7 r8 r9 )warningswarnr. DeprecationWarninggetattrr2 )r4 r6 r r r __getattr__ s
z)_DisplayUtilDeprecationModule.__getattr__)r6 valuer c C s t | j|| d S )N)setattrr2 )r4 r6 rA r r r __setattr__ s z)_DisplayUtilDeprecationModule.__setattr__c C s t | j| d S )N)delattrr2 )r4 r6 r r r __delattr__ s z)_DisplayUtilDeprecationModule.__delattr__)r c C s dgt | j S )Nr2 )dirr2 )r4 r r r __dir__ s z%_DisplayUtilDeprecationModule.__dir__)
__name__
__module__ __qualname____doc__r r5 strr r@ rC rE r rG r r r r r0 s r0 )TTFT)NNF)NNF)r% r& NNF)NNF)NNF))rK systypesr Ztypingr r r r r r r< Zcertbot._internal.displayr Z certbot._internal.display.objr
r r Z certbot._internal.display.utilr
r r ZOKZCANCELr7 r8 r9 rL r boolr intr" r$ r) r+ r, r/ r0 modulesrH r r r r sN B ( $ 6 (