Go to the latest version of this document.
t.p.f.FTPFileListProtocol(basic.LineReceiver) : class documentation
Part of twisted.protocols.ftp
View In Hierarchy
Parser for standard FTP file listings
This is the evil required to match:
-rw-r--r-- 1 root other 531 Jan 29 03:26 README
If you need different evil for a wacky FTP server, you can override
It populates the instance attribute self.files, which is a list
containing dicts with the following keys (examples from the above
filetype: e.g. 'd' for directories, or '-' for an ordinary file
perms: e.g. 'rw-r--r--'
nlinks: e.g. 1
owner: e.g. 'root'
group: e.g. 'other'
size: e.g. 531
date: e.g. 'Jan 29 03:26'
filename: e.g. 'README'
linktarget: e.g. 'some/file'
Note that the 'date' value will be formatted differently depending on
the date. Check http://cr.yp.to/ftp.html if you really want to try to
||list of dicts describing the files in this listing
||Override this for when each line is received.
||Return a dictionary of fields, or None if line cannot be parsed.
||Append file information dictionary to the list of known files.
||Deal with received lines which could not be parsed as file
Inherited from LineReceiver:
||The line-ending delimiter to use. By default this is '\r\n'.
||The maximum length of a line to allow (If a sent line is longer than this,
the connection is dropped). Default is 16384.
||Clear buffered data.
||Protocol.dataReceived. Translates bytes into lines, and calls
lineReceived (or rawDataReceived, depending on mode.)
||Sets the line-mode of this receiver.
||Sets the raw mode of this receiver. Further data received will be sent
to rawDataReceived rather than lineReceived.
||Override this for when raw data is received.
||Sends a line to the other end of the connection.
||Called when the maximum line length has been reached. Override if it
needs to be dealt with in some special way.
Inherited from Protocol (via LineReceiver):
||Return a prefix matching the class name, to identify log messages
related to this protocol instance.
||Called when the connection is shut down.
Inherited from BaseProtocol (via LineReceiver, Protocol):
Inherited from _PauseableMixin (via LineReceiver):
list of dicts describing the files in this listing
Override this for when each line is received.
|Parameters||line||The line which was received with the delimiter removed. (type: |
Return a dictionary of fields, or None if line cannot be parsed.
|Parameters||line||line of text expected to contain a directory entry (type: str)|
Append file information dictionary to the list of known files.
Subclasses can override or extend this method to handle file information
differently without affecting the parsing of data from the server.
|Parameters||info||dictionary containing the parsed representation of the file information (type: dict)|
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.
Deal with received lines which could not be parsed as file
Subclasses can override this to perform any special processing
|Parameters||line||unparsable line as received (type: str)|