telnetlib Namespace Reference

Data Structures
class	Telnet

Functions
def	test

Variables
list	__all__ = ["Telnet"]
int	DEBUGLEVEL = 0
int	TELNET_PORT = 23
tuple	IAC = chr(255)
tuple	DONT = chr(254)
tuple	DO = chr(253)
tuple	WONT = chr(252)
tuple	WILL = chr(251)
tuple	theNULL = chr(0)
tuple	BINARY = chr(0)
tuple	ECHO = chr(1)
tuple	RCP = chr(2)
tuple	SGA = chr(3)
tuple	NAMS = chr(4)
tuple	STATUS = chr(5)
tuple	TM = chr(6)
tuple	RCTE = chr(7)
tuple	NAOL = chr(8)
tuple	NAOP = chr(9)
tuple	NAOCRD = chr(10)
tuple	NAOHTS = chr(11)
tuple	NAOHTD = chr(12)
tuple	NAOFFD = chr(13)
tuple	NAOVTS = chr(14)
tuple	NAOVTD = chr(15)
tuple	NAOLFD = chr(16)
tuple	XASCII = chr(17)
tuple	LOGOUT = chr(18)
tuple	BM = chr(19)
tuple	DET = chr(20)
tuple	SUPDUP = chr(21)
tuple	SUPDUPOUTPUT = chr(22)
tuple	SNDLOC = chr(23)
tuple	TTYPE = chr(24)
tuple	EOR = chr(25)
tuple	TUID = chr(26)
tuple	OUTMRK = chr(27)
tuple	TTYLOC = chr(28)
tuple	VT3270REGIME = chr(29)
tuple	X3PAD = chr(30)
tuple	NAWS = chr(31)
tuple	TSPEED = chr(32)
tuple	LFLOW = chr(33)
tuple	LINEMODE = chr(34)
tuple	XDISPLOC = chr(35)
tuple	OLD_ENVIRON = chr(36)
tuple	AUTHENTICATION = chr(37)
tuple	ENCRYPT = chr(38)
tuple	NEW_ENVIRON = chr(39)
tuple	TN3270E = chr(40)
tuple	XAUTH = chr(41)
tuple	CHARSET = chr(42)
tuple	RSP = chr(43)
tuple	COM_PORT_OPTION = chr(44)
tuple	SUPPRESS_LOCAL_ECHO = chr(45)
tuple	TLS = chr(46)
tuple	KERMIT = chr(47)
tuple	SEND_URL = chr(48)
tuple	FORWARD_X = chr(49)
tuple	PRAGMA_LOGON = chr(138)
tuple	SSPI_LOGON = chr(139)
tuple	PRAGMA_HEARTBEAT = chr(140)
tuple	EXOPL = chr(255)

Detailed Description

TELNET client class.

Based on RFC 854: TELNET Protocol Specification, by J. Postel and
J. Reynolds

Example:

>>> from telnetlib import Telnet
>>> tn = Telnet('www.python.org', 79)   # connect to finger port
>>> tn.write('guido\r\n')
>>> print tn.read_all()
Login       Name               TTY         Idle    When    Where
guido    Guido van Rossum      pts/2        <Dec  2 11:10> snag.cnri.reston..

>>>

Note that read_all() won't read until eof -- it just reads some data
-- but it guarantees to read at least one byte unless EOF is hit.

It is possible to pass a Telnet object to select.select() in order to
wait until more data is available.  Note that in this case,
read_eager() may return '' even if there was data on the socket,
because the protocol negotiation may have eaten the data.  This is why
EOFError is needed in some cases to distinguish between "no data" and
"connection closed" (since the socket also appears ready for reading
when it is closed).

Bugs:
- may hang when connection is slow in the middle of an IAC sequence

To do:
- option negotiation
- timeout should be intrinsic to the connection object instead of an
  option on one of the read calls only

Function Documentation

def telnetlib.test

(

)

Test program for telnetlib.

Usage: python telnetlib.py [-d] ... [host [port]]

Default host is localhost; default port is 23.

Definition at line 564 of file telnetlib.py.

def test():
    """Test program for telnetlib.

    Usage: python telnetlib.py [-d] ... [host [port]]

    Default host is localhost; default port is 23.

    """
    debuglevel = 0
    while sys.argv[1:] and sys.argv[1] == '-d':
        debuglevel = debuglevel+1
        del sys.argv[1]
    host = 'localhost'
    if sys.argv[1:]:
        host = sys.argv[1]
    port = 0
    if sys.argv[2:]:
        portstr = sys.argv[2]
        try:
            port = int(portstr)
        except ValueError:
            port = socket.getservbyname(portstr, 'tcp')
    tn = Telnet()
    tn.set_debuglevel(debuglevel)
    tn.open(host, port)
    tn.interact()
    tn.close()