telnetlib
index
/usr/lib/python2.2/telnetlib.py

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
')
>>> 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

 
Modules
            
select
socket
sys
 
Classes
            
Telnet
 
class Telnet
      Telnet interface class.
 
An instance of this class represents a connection to a telnet
server.  The instance is initially not connected; the open()
method must be used to establish a connection.  Alternatively, the
host name and optional port number can be passed to the
constructor, too.
 
Don't try to 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 doc strings.
 
read_until(expected, [timeout])
    Read until the expected string has been seen, or a timeout is
    hit (default is no timeout); may block.
 
read_all()
    Read all data until EOF; may block.
 
read_some()
    Read at least one byte or EOF; may block.
 
read_very_eager()
    Read all data available already queued or on the socket,
    without blocking.
 
read_eager()
    Read either data already queued or some data available on the
    socket, without blocking.
 
read_lazy()
    Read all data in the raw queue (processing it first), without
    doing any socket I/O.
 
read_very_lazy()
    Reads all data in the cooked queue, without doing any socket
    I/O.
 
set_option_negotiation_callback(callback)
    Each time a telnet option is read on the input flow, this callback
    (if set) is called with the following parameters :
    callback(telnet socket, command (DO/DONT/WILL/WONT), option)
    No other action is done afterwards by telnetlib.
 
   Methods defined here:
__del__(self)
Destructor -- close the connection.
__init__(self, host=None, port=0)
Constructor.
 
When called without arguments, create an unconnected instance.
With a hostname argument, it connects the instance; a port
number is optional.
close(self)
Close the connection.
expect(self, list, timeout=None)
Read until one from a list of a regular expressions matches.
 
The first argument is a list of regular expressions, either
compiled (re.RegexObject instances) or uncompiled (strings).
The optional second argument is a timeout, in seconds; default
is no timeout.
 
Return a tuple of three items: the index in the list of the
first regular expression that matches; the match object
returned; and the text read up till and including the match.
 
If EOF is read and no text was read, raise EOFError.
Otherwise, when nothing matches, return (-1, None, text) where
text is the text received so far (may be the empty string if a
timeout happened).
 
If a regular expression ends with a greedy match (e.g. '.*')
or if more than one expression can match the same input, the
results are undeterministic, and may depend on the I/O timing.
fileno(self)
Return the fileno() of the socket object used internally.
fill_rawq(self)
Fill raw queue from exactly one recv() system call.
 
Block if no data is immediately available.  Set self.eof when
connection is closed.
get_socket(self)
Return the socket object used internally.
interact(self)
Interaction function, emulates a very dumb telnet client.
listener(self)
Helper for mt_interact() -- this executes in the other thread.
msg(self, msg, *args)
Print a debug message, when the debug level is > 0.
 
If extra arguments are present, they are substituted in the
message using the standard string formatting operator.
mt_interact(self)
Multithreaded version of interact().
open(self, host, port=0)
Connect to a host.
 
The optional second argument is the port number, which
defaults to the standard telnet port (23).
 
Don't try to reopen an already connected instance.
process_rawq(self)
Transfer from raw queue to cooked queue.
 
Set self.eof when connection is closed.  Don't block unless in
the midst of an IAC sequence.
rawq_getchar(self)
Get next char from raw queue.
 
Block if no data is immediately available.  Raise EOFError
when connection is closed.
read_all(self)
Read all data until EOF; block until connection closed.
read_eager(self)
Read readily available data.
 
Raise EOFError if connection closed and no cooked data
available.  Return '' if no cooked data available otherwise.
Don't block unless in the midst of an IAC sequence.
read_lazy(self)
Process and return data that's already in the queues (lazy).
 
Raise EOFError if connection closed and no data available.
Return '' if no cooked data available otherwise.  Don't block
unless in the midst of an IAC sequence.
read_some(self)
Read at least one byte of cooked data unless EOF is hit.
 
Return '' if EOF is hit.  Block if no data is immediately
available.
read_until(self, match, timeout=None)
Read until a given string is encountered or until timeout.
 
When no match is found, return whatever is available instead,
possibly the empty string.  Raise EOFError if the connection
is closed and no cooked data is available.
read_very_eager(self)
Read everything that's possible without blocking in I/O (eager).
 
Raise EOFError if connection closed and no cooked data
available.  Return '' if no cooked data available otherwise.
Don't block unless in the midst of an IAC sequence.
read_very_lazy(self)
Return any data available in the cooked queue (very lazy).
 
Raise EOFError if connection closed and no data available.
Return '' if no cooked data available otherwise.  Don't block.
set_debuglevel(self, debuglevel)
Set the debug level.
 
The higher it is, the more debug output you get (on sys.stdout).
set_option_negotiation_callback(self, callback)
Provide a callback function called after each receipt of a telnet option.
sock_avail(self)
Test whether data is available on the socket.
write(self, buffer)
Write a string to the socket, doubling any IAC characters.
 
Can block if the connection is blocked.  May raise
socket.error if the connection is closed.

Data and non-method functions defined here:
__doc__ = 'Telnet interface class.\n\n An instance of t... action is done afterwards by telnetlib.\n\n '
__module__ = 'telnetlib'
 
Functions
            
test()
Test program for telnetlib.
 
Usage: python telnetlib.py [-d] ... [host [port]]
 
Default host is localhost; default port is 23.
 
Data
             AUTHENTICATION = '%'
BINARY = '\x00'
BM = '\x13'
CHARSET = '*'
COM_PORT_OPTION = ','
DEBUGLEVEL = 0
DET = '\x14'
DO = '\xfd'
DONT = '\xfe'
ECHO = '\x01'
ENCRYPT = '&'
EOR = '\x19'
EXOPL = '\xff'
FORWARD_X = '1'
IAC = '\xff'
KERMIT = '/'
LFLOW = '!'
LINEMODE = '"'
LOGOUT = '\x12'
NAMS = '\x04'
NAOCRD = '\n'
NAOFFD = '\r'
NAOHTD = '\x0c'
NAOHTS = '\x0b'
NAOL = '\x08'
NAOLFD = '\x10'
NAOP = '\t'
NAOVTD = '\x0f'
NAOVTS = '\x0e'
NAWS = '\x1f'
NEW_ENVIRON = "'"
OLD_ENVIRON = '$'
OUTMRK = '\x1b'
PRAGMA_HEARTBEAT = '\x8c'
PRAGMA_LOGON = '\x8a'
RCP = '\x02'
RCTE = '\x07'
RSP = '+'
SEND_URL = '0'
SGA = '\x03'
SNDLOC = '\x17'
SSPI_LOGON = '\x8b'
STATUS = '\x05'
SUPDUP = '\x15'
SUPDUPOUTPUT = '\x16'
SUPPRESS_LOCAL_ECHO = '-'
TELNET_PORT = 23
TLS = '.'
TM = '\x06'
TN3270E = '('
TSPEED = ' '
TTYLOC = '\x1c'
TTYPE = '\x18'
TUID = '\x1a'
VT3270REGIME = '\x1d'
WILL = '\xfb'
WONT = '\xfc'
X3PAD = '\x1e'
XASCII = '\x11'
XAUTH = ')'
XDISPLOC = '#'
__all__ = ['Telnet']
__file__ = '/usr/lib/python2.2/telnetlib.pyc'
__name__ = 'telnetlib'
theNULL = '\x00'