Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`manhole`.`Manhole``

class documentation

`class Manhole(recvline.HistoricRecvLine): (source)`

Known subclasses: `twisted.conch.manhole.ColoredManhole`

View In Hierarchy

Mediator between a fancy line source and an interactive interpreter.

This accepts lines from its transport and passes them on to a `ManholeInterpreter`. Control commands (^C, ^D, ^\) are also handled with something approximating their normal terminal-mode behavior. It can optionally be constructed with a dict which will be used as the local namespace for any code executed.

Method | `__init__` | Undocumented
Method | `addOutput` | Undocumented
Method | `connectionMade` | Called after a connection has been established.
Method | `handle_EOF` | Undocumented
Method | `handle_FF` | Handle a 'form feed' byte - generally used to request a screen refresh/redraw.
Method | `handle_INT` | Handle ^C as an interrupt keystroke by resetting the current input variables to their initial state.
Method | `handle_QUIT` | Undocumented
Method | `lineReceived` | Undocumented
Instance Variable | `interpreter` | Undocumented
Instance Variable | `lineBuffer` | Undocumented
Instance Variable | `lineBufferIndex` | Undocumented
Instance Variable | `namespace` | Undocumented
Instance Variable | `pn` | Undocumented
Method | `_needsNewline` | Undocumented

Inherited from `HistoricRecvLine`:

Method | `currentHistoryBuffer` | Undocumented
Method | `handle_DOWN` | Undocumented
Method | `handle_RETURN` | Undocumented
Method | `handle_UP` | Undocumented
Instance Variable | `historyLines` | Undocumented
Instance Variable | `historyPosition` | Undocumented
Method | `_deliverBuffer` | Undocumented

Inherited from `RecvLine` (via `HistoricRecvLine`):

Method | `characterReceived` | Undocumented
Method | `currentLineBuffer` | Undocumented
Method | `drawInputLine` | 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_RIGHT` | Undocumented
Method | `handle_TAB` | Undocumented
Method | `initializeScreen` | Undocumented
Method | `keystrokeReceived` | A keystroke was received.
Method | `setInsertMode` | Undocumented
Method | `setTypeoverMode` | Undocumented
Method | `terminalSize` | Called to indicate the size of the terminal.
Method | `unhandledControlSequence` | Called when an unsupported control sequence is received.
Constant | `TABSTOP` | Undocumented
Class Variable | `ps` | Undocumented
Instance Variable | `height` | Undocumented
Instance Variable | `keyHandlers` | Undocumented
Instance Variable | `mode` | Undocumented
Instance Variable | `width` | Undocumented
Class Variable | `_log` | Undocumented
Class Variable | `_printableChars` | Undocumented

Inherited from `TerminalProtocol` (via `HistoricRecvLine`, `RecvLine`):

Method | `connectionLost` | Called when the connection has been lost.
Method | `makeConnection` | Called with an `ITerminalTransport` when a connection is established.
Instance Variable | `terminal` | Undocumented

def __init__(self, namespace=None): (source)

Undocumented

def addOutput(self, data, isAsync=None, **kwargs): (source)

Undocumented

def connectionMade(self): (source)
overrides `twisted.conch.recvline.HistoricRecvLine.connectionMade`

Called after a connection has been established.

def handle_EOF(self): (source)

Undocumented

def handle_FF(self): (source)

Handle a 'form feed' byte - generally used to request a screen refresh/redraw.

def handle_INT(self): (source)

Handle ^C as an interrupt keystroke by resetting the current input variables to their initial state.

def handle_QUIT(self): (source)

Undocumented

def lineReceived(self, line): (source)
overrides `twisted.conch.recvline.RecvLine.lineReceived`

Undocumented

interpreter = (source)

Undocumented

lineBuffer: `list` = (source)
overrides `twisted.conch.recvline.HistoricRecvLine.lineBuffer`

Undocumented

lineBufferIndex: `int` = (source)
overrides `twisted.conch.recvline.RecvLine.lineBufferIndex`

Undocumented

namespace = (source)

Undocumented

pn = (source)
overrides `twisted.conch.recvline.RecvLine.pn`

Undocumented

def _needsNewline(self): (source)

Undocumented