twisted.conch.client.knownhosts.ConsoleUI

class documentation

class ConsoleUI: (source)

A UI object that can ask true/false questions and post notifications on the console, to be used during key verification.

Method	`__init__`	No summary
Method	`prompt`	Write the given text as a prompt to the console output, then read a result from the console input.
Method	`warn`	Notify the user (non-interactively) of the provided text, by writing it to the console.
Instance Variable	`opener`	Undocumented

def __init__(self, opener: Callable[[], IO[bytes]]): (source) ¶

Parameters
opener:callable taking no arguments and returning a read/write file-like object	A no-argument callable which should open a console binary-mode file-like object to be used for reading and writing. This initializes the `opener` attribute.

def prompt(self, text: bytes) -> Deferred[bool]: (source) ¶

Write the given text as a prompt to the console output, then read a result from the console input.

Parameters
text:`bytes`	Something to present to a user to solicit a yes or no response.
Returns
`Deferred[bool]`	a `Deferred` which fires with `True` when the user answers 'yes' and `False` when the user answers 'no'. It may errback if there were any I/O errors.

def warn(self, text: bytes): (source) ¶

Notify the user (non-interactively) of the provided text, by writing it to the console.

Parameters
text:`bytes`	Some information the user is to be made aware of.

Undocumented