class documentation

class ConsoleUI: (source)

View In Hierarchy

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
Instance Variable opener Undocumented
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.
def __init__(self, opener): (source)
ParametersopenerA 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. (type: callable taking no arguments and returning a read/write file-like object)
opener = (source)

Undocumented

def prompt(self, text): (source)

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

ParameterstextSomething to present to a user to solicit a yes or no response. (type: bytes)
Returnsa 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): (source)

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

ParameterstextSome information the user is to be made aware of. (type: bytes)
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.