b.u.CannedInputUIFactory(SilentUIFactory) : class documentation

Part of bzrlib.ui View In Hierarchy

A silent UI that return canned input.
Method __init__ Undocumented
Method __repr__ Undocumented
Method confirm_action Seek user confirmation for an action.
Method get_boolean Get a boolean question answered from the user.
Method get_integer Get an integer from the user.
Method get_password Prompt the user for a password.
Method get_username Undocumented
Method assert_all_input_consumed Undocumented

Inherited from SilentUIFactory:

Method note Undocumented
Method show_error Show an error message (not an exception) to the user.
Method show_message Show a message to the user.
Method show_warning Show a warning to the user.
Method _make_output_stream_explicit Undocumented

Inherited from UIFactory (via SilentUIFactory, NoninteractiveUIFactory):

Method __enter__ Context manager entry support.
Method __exit__ Context manager exit support.
Method be_quiet Tell the UI to be more quiet, or not.
Method is_quiet Undocumented
Method make_output_stream Get a stream for sending out bulk text data.
Method nested_progress_bar Return a nested progress bar.
Method clear_term Prepare the terminal for output.
Method format_user_warning Undocumented
Method choose Prompt the user for a list of alternatives.
Method make_progress_view Construct a new ProgressView object for this UI.
Method recommend_upgrade Recommend the user upgrade a control directory.
Method report_transport_activity Called by transports as they do IO.
Method log_transport_activity Write out whatever transport activity has been measured.
Method show_user_warning Show a warning to the user.
Method _progress_finished Called by the ProgressTask when it finishes
Method _progress_all_finished Called when the top-level progress task finished
Method _progress_updated Called by the ProgressTask when it changes.
def __init__(self, responses):
Undocumented
def __repr__(self):
Undocumented
def confirm_action(self, prompt, confirmation_id, args):
Seek user confirmation for an action.

If the UI is noninteractive, or the user does not want to be asked about this action, True is returned, indicating bzr should just proceed.

The confirmation id allows the user to configure certain actions to always be confirmed or always denied, and for UIs to specialize the display of particular confirmations.

ParameterspromptSuggested text to display to the user.
prompt_kwargsA dictionary of arguments that can be string-interpolated into the prompt.
confirmation_idUnique string identifier for the confirmation.
def get_boolean(self, prompt):
Get a boolean question answered from the user.
Parametersprompta message to prompt the user with. Should be a single line without terminating n.
ReturnsTrue or False for y/yes or n/no.
def get_integer(self, prompt):
Get an integer from the user.
Parametersprompta message to prompt the user with. Could be a multi-line prompt but without a terminating n.
ReturnsA signed integer.
def get_password(self, prompt=u'', **kwargs):
Prompt the user for a password.
ParameterspromptThe prompt to present the user (must be unicode)
kwargsArguments which will be expanded into the prompt. This lets front ends display different things if they so choose.
ReturnsThe password string, return None if the user canceled the request. Note that we do not touch the encoding, users may have whatever they see fit and the password should be transported as is.
def get_username(self, prompt, **kwargs):
Undocumented
def assert_all_input_consumed(self):
Undocumented
API Documentation for Bazaar, generated by pydoctor at 2019-08-25 00:28:39.