11.13 telnetlib -- Telnet client
Keywords: lib

# 11.13 `telnetlib` -- Telnet client

The `telnetlib` module provides a `Telnet` class that implements the Telnet protocol. See RFC 854 for details about the protocol. In addition, it provides symbolic constants for the protocol characters (IAC/DONT/DO/WONT/WILL), and for the telnet options. The symbolic names of the telnet options follow the definitions in `arpa/telnet.h`, with the leading `TELOPT_` removed. For symbolic names of options which are traditionally not included in `arpa/telnet.h`, see the module source itself.

class `Telnet`([host[, port]])
  `Telnet` represents a connection to a Telnet server. The instance is initially not connected by default; the `open()` method must be used to establish a connection. Alternatively, the host name and optional port number can be passed to the constructor, to, in which case the connection to the server will be established before the constructor returns.

  Do not reopen an already connected instance.

  This class has many `read_*()` methods. Note that some of them raise `EOFError` when the end of the connection is read, because they can return an empty string for other reasons. See the individual descriptions below.

See Also:

RFC 854, Telnet Protocol Specification
  Definition of the Telnet protocol.

Subsections

- 11.13.1 Telnet Objects
- 11.13.2 Telnet Example