twisted.conch.recvline.RecvLine

class documentation

class RecvLine(insults.TerminalProtocol): (source)

Known subclasses: twisted.conch.recvline.HistoricRecvLine

View In Hierarchy

TerminalProtocol which adds line editing features.

Clients will be prompted for lines of input with all the usual features: character echoing, left and right arrow support for moving the cursor to different areas of the line buffer, backspace and delete for removing characters, and insert for toggling between typeover and insert mode. Tabs will be expanded to enough spaces to move the cursor to the next tabstop (every four characters by default). Enter causes the line buffer to be cleared and the line to be passed to the lineReceived() method which, by default, does nothing. Subclasses are responsible for redrawing the input prompt (this will probably change).

Method character​Received Undocumented
Method connection​Made Called after a connection has been established.
Method current​Line​Buffer Undocumented
Method draw​Input​Line Write a line containing the current input prompt and the current line buffer at the current cursor position.
Method handle_​BACKSPACE Undocumented
Method handle_​DELETE Undocumented
Method handle_​END Undocumented
Method handle_​HOME Undocumented
Method handle_​INSERT Undocumented
Method handle_​LEFT Undocumented
Method handle_​RETURN Undocumented
Method handle_​RIGHT Undocumented
Method handle_​TAB Undocumented
Method initialize​Screen Undocumented
Method keystroke​Received A keystroke was received.
Method line​Received Undocumented
Method set​Insert​Mode Undocumented
Method set​Typeover​Mode Undocumented
Method terminal​Size Called to indicate the size of the terminal.
Method unhandled​Control​Sequence Called when an unsupported control sequence is received.
Constant TABSTOP Undocumented
Class Variable pn Undocumented
Class Variable ps Undocumented
Instance Variable height Undocumented
Instance Variable key​Handlers Undocumented
Instance Variable line​Buffer Undocumented
Instance Variable line​Buffer​Index Undocumented
Instance Variable mode Undocumented
Instance Variable width Undocumented
Class Variable _log Undocumented
Class Variable _printable​Chars Undocumented

Inherited from TerminalProtocol:

Method connection​Lost Called when the connection has been lost.
Method make​Connection Called with an ITerminalTransport when a connection is established.
Instance Variable terminal Undocumented
def characterReceived(self, ch, moreCharactersComing): (source)
overridden in twisted.conch.manhole.ColoredManhole

Undocumented

def connectionMade(self): (source)
overrides twisted.conch.insults.insults.TerminalProtocol.connectionMade
overridden in twisted.conch.recvline.HistoricRecvLine
Called after a connection has been established.
def currentLineBuffer(self): (source)

Undocumented

def drawInputLine(self): (source)
Write a line containing the current input prompt and the current line buffer at the current cursor position.
def handle_BACKSPACE(self): (source)

Undocumented

def handle_DELETE(self): (source)

Undocumented

def handle_END(self): (source)

Undocumented

def handle_HOME(self): (source)

Undocumented

def handle_INSERT(self): (source)

Undocumented

def handle_LEFT(self): (source)

Undocumented

def handle_RETURN(self): (source)
overridden in twisted.conch.recvline.HistoricRecvLine

Undocumented

def handle_RIGHT(self): (source)

Undocumented

def handle_TAB(self): (source)

Undocumented

def initializeScreen(self): (source)

Undocumented

def keystrokeReceived(self, keyID, modifier): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overrides twisted.conch.insults.insults.TerminalProtocol.keystrokeReceived

A keystroke was received.

Each keystroke corresponds to one invocation of this method. keyID is a string identifier for that key. Printable characters are represented by themselves. Control keys, such as arrows and function keys, are represented with symbolic constants on ServerProtocol.

def lineReceived(self, line): (source)
overridden in twisted.conch.manhole.Manhole

Undocumented

def setInsertMode(self): (source)

Undocumented

def setTypeoverMode(self): (source)

Undocumented

def terminalSize(self, width, height): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overrides twisted.conch.insults.insults.TerminalProtocol.terminalSize

Called to indicate the size of the terminal.

A terminal of 80x24 should be assumed if this method is not called. This method might not be called for real terminals.

def unhandledControlSequence(self, seq): (source)
from twisted.conch.insults.insults.ITerminalProtocol
overrides twisted.conch.insults.insults.TerminalProtocol.unhandledControlSequence
Called when an unsupported control sequence is received.
Parameters
seq:strThe whole control sequence which could not be interpreted.
TABSTOP: int = (source)

Undocumented

Value
4
pn: int = (source)
overridden in twisted.conch.manhole.Manhole

Undocumented

ps: tuple[bytes, ...] = (source)

Undocumented

height = (source)

Undocumented

keyHandlers = (source)

Undocumented

lineBuffer: list = (source)
overridden in twisted.conch.recvline.HistoricRecvLine

Undocumented

lineBufferIndex: int = (source)
overridden in twisted.conch.manhole.Manhole

Undocumented

mode: str = (source)

Undocumented

width = (source)

Undocumented

_log = (source)

Undocumented

_printableChars = (source)

Undocumented