twisted.protocols.ftp.FTPClientBasic

class documentation

class FTPClientBasic(basic.LineReceiver): (source)

Known subclasses: twisted.protocols.ftp.FTPClient

View In Hierarchy

Foundations of an FTP client.
Method __init__ Undocumented
Method connection​Lost Called when the connection is shut down.
Method fail Give an error to any queued deferreds.
Method line​Received (Private) Parses the response messages from the FTP server.
Method pop​Command​Queue Return the front element of the command queue, or None if empty.
Method queue​Command Add an FTPCommand object to the queue.
Method queue​Login Login: send the username, send the password.
Method queue​String​Command Queues a string to be issued as an FTP command
Method send​Line Sends a line, unless line is None.
Method send​Next​Command (Private) Processes the next command in the queue.
Class Variable debug Undocumented
Instance Variable action​Queue Undocumented
Instance Variable greeting Undocumented
Instance Variable next​Deferred Undocumented
Instance Variable response Undocumented
Method _cb​_greeting Undocumented
Method _fail Errback all queued deferreds.
Class Variable _encoding Undocumented
Instance Variable _failed Undocumented

Inherited from LineReceiver:

Method clear​Line​Buffer Clear buffered data.
Method data​Received Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method line​Length​Exceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method raw​Data​Received Override this for when raw data is received.
Method set​Line​Mode Sets the line-mode of this receiver.
Method set​Raw​Mode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant MAX​_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable line​_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busy​Receiving Undocumented

Inherited from Protocol (via LineReceiver):

Method log​Prefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method connection​Made Called when a connection is made.
Method make​Connection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented
def __init__(self): (source)
overridden in twisted.protocols.ftp.FTPClient

Undocumented

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parameters
reason:twisted.python.failure.FailureUndocumented
def fail(self, error): (source)
overridden in twisted.protocols.ftp.FTPClient
Give an error to any queued deferreds.
def lineReceived(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.lineReceived
(Private) Parses the response messages from the FTP server.
def popCommandQueue(self): (source)
Return the front element of the command queue, or None if empty.
def queueCommand(self, ftpCommand): (source)

Add an FTPCommand object to the queue.

If it's the only thing in the queue, and we are connected and we aren't waiting for a response of an earlier command, the command will be sent immediately.

Parameters
ftp​Commandan FTPCommand
def queueLogin(self, username, password): (source)
overridden in twisted.protocols.ftp.FTPClient

Login: send the username, send the password.

If the password is None, the PASS command won't be sent. Also, if the response to the USER command has a response code of 230 (User logged in), then PASS won't be sent either.

def queueStringCommand(self, command, public=1): (source)
Queues a string to be issued as an FTP command
Parameters
commandstring of an FTP command to queue
publica flag intended for internal use by FTPClient. Don't change it unless you know what you're doing.
Returns
a Deferred that will be called when the response to the command has been received.
def sendLine(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.sendLine
Sends a line, unless line is None.
Parameters
line:bytes or unicodeLine to send
def sendNextCommand(self): (source)
(Private) Processes the next command in the queue.
debug: bool = (source)

Undocumented

actionQueue: list = (source)

Undocumented

greeting = (source)

Undocumented

nextDeferred = (source)

Undocumented

response: list = (source)

Undocumented

def _cb_greeting(self, greeting): (source)

Undocumented

def _fail(self, error): (source)
Errback all queued deferreds.
_encoding: str = (source)

Undocumented

_failed: int = (source)

Undocumented