Package paramiko :: Class ChannelFile
[show private | hide private]
[frames | no frames]

Type ChannelFile

  object --+    
           |    
BufferedFile --+
               |
              ChannelFile

Known Subclasses:
ChannelStderrFile

A file-like wrapper around Channel. A ChannelFile is created by calling Channel.makefile.

Bug: To correctly emulate the file object created from a socket's makefile method, a Channel and its ChannelFile should be able to be closed or garbage-collected independently. Currently, closing the ChannelFile does nothing but flush the buffer.

Method Summary
  __init__(self, channel, mode, bufsize)
str __repr__(self)
Returns a string representation of this object, for debugging.
  _read(self, size)
(subclass override) Read data from the stream.
  _write(self, data)
(subclass override) Write data into the stream.
    Inherited from BufferedFile
  __del__(self)
iterator __iter__(self)
Returns an iterator that can be used to iterate over the lines in this file.
  close(self)
Close the file.
  flush(self)
Write out any data in the write buffer.
str next(self)
Returns the next line from the input, or raises StopIteration when EOF is hit.
str read(self, size)
Read at most size bytes from the file (less if we hit the end of the file first).
str readline(self, size)
Read one entire line from the file.
list readlines(self, sizehint)
Read all remaining lines using readline and return them as a list.
  seek(self, offset, whence)
Set the file's current position, like stdio's fseek.
int tell(self)
Return the file's current position.
  write(self, data)
Write data to the file.
  writelines(self, sequence)
Write a sequence of strings to the file.
iterator xreadlines(self)
Identical to iter(f).
  _get_size(self)
(subclass override) Return the size of the file.
  _record_newline(self, newline)
  _set_mode(self, mode, bufsize)
Subclasses call this method to initialize the BufferedFile.
  _write_all(self, data)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
    Inherited from BufferedFile
int SEEK_CUR = 1                                                                     
int SEEK_END = 2                                                                     
int SEEK_SET = 0                                                                     
int _DEFAULT_BUFSIZE = 8192                                                                  

Method Details

__repr__(self)
(Representation operator)

Returns a string representation of this object, for debugging.
Returns:
str
Overrides:
__builtin__.object.__repr__

_read(self, size)

(subclass override) Read data from the stream. Return None or raise EOFError to indicate EOF.
Overrides:
paramiko.BufferedFile._read (inherited documentation)

_write(self, data)

(subclass override) Write data into the stream.
Overrides:
paramiko.BufferedFile._write (inherited documentation)

Generated by Epydoc 2.1 on Wed Aug 16 14:35:04 2006 http://epydoc.sf.net