module documentation
(source)

An FTP protocol implementation
Interface IFinishableConsumer A Consumer for producers that finish.
Interface IFTPShell An abstraction of the shell commands used by the FTP protocol for a given user account.
Interface IReadFile A file out of which bytes may be read.
Interface IWriteFile A file into which bytes may be written.
Class AnonUserDeniedError Raised when an anonymous user issues a command that will alter the filesystem
Class ASCIIConsumerWrapper Undocumented
Class AuthorizationError Raised when client authentication fails.
Class BadCmdSequenceError Raised when a client sends a series of commands in an illogical sequence.
Class BadResponse Undocumented
Class BaseFTPRealm Base class for simple FTP realms which provides an easy hook for specifying the home directory for each user.
Class CmdArgSyntaxError Raised when a command is called with wrong value or a wrong number of arguments.
Class CmdNotImplementedError Raised when an unimplemented command is given to the server.
Class CmdNotImplementedForArgError Raised when the handling of a parameter for a command is not implemented by the server.
Class CmdSyntaxError Raised when a command syntax is wrong.
Class CommandFailed Undocumented
Class ConnectionLost Undocumented
Class DTP No class docstring; 0/4 instance variable, 0/1 class variable, 2/15 methods documented
Class DTPFactory Client factory for data transfer process protocols.
Class FileConsumer A consumer for FTP input that writes data to a file.
Class FileExistsError Raised when attempted to override an existing resource.
Class FileNotFoundError Raised when trying to access a non existent file or directory.
Class FTP Protocol Interpreter for the File Transfer Protocol
Class FTPAnonymousShell An anonymous implementation of IFTPShell
Class FTPClient FTPClient is a client implementation of the FTP protocol which exposes FTP commands as methods which return Deferreds.
Class FTPClientBasic Foundations of an FTP client.
Class FTPCmdError Generic exception for FTP commands.
Class FTPCommand Undocumented
Class FTPDataPortFactory Factory for data connections that use the PORT command
Class FTPError Undocumented
Class FTPFactory A factory for producing ftp protocol instances
Class FTPFileListProtocol Parser for standard FTP file listings
Class FTPOverflowProtocol FTP mini-protocol for when there are too many connections.
Class FTPRealm
Class FTPShell An authenticated implementation of IFTPShell.
Class InvalidPath Internal exception used to signify an error during parsing a path.
Class IsADirectoryError Raised when DELE is called on a path that is a directory.
Class IsNotADirectoryError Raised when RMD is called on a path that isn't a directory.
Class PermissionDeniedError Raised when access is attempted to a resource to which access is not allowed.
Class PortConnectionError Undocumented
Class ProtocolWrapper Undocumented
Class SenderProtocol No class docstring; 0/2 instance variable, 2/8 methods documented
Class SystemFTPRealm SystemFTPRealm uses system user account information to decide what the home directory for a particular avatarId is.
Class UnexpectedData Undocumented
Class UnexpectedResponse Undocumented
Function debugDeferred Undocumented
Function decodeHostPort Decode an FTP response specifying a host and port.
Function encodeHostPort Undocumented
Function errnoToFailure Map OSError and IOError to standard FTP errors.
Function parsePWDResponse Returns the path from a response to a PWD command.
Function toSegments Normalize a path, as represented by a list of strings each representing one segment of the path.
Variable ANON_USER_DENIED Undocumented
Variable AUTH_FAILURE Undocumented
Variable BAD_CMD_SEQ Undocumented
Variable CANT_OPEN_DATA_CNX Undocumented
Variable CLOSING_DATA_CNX Undocumented
Variable CMD_NOT_IMPLMNTD Undocumented
Variable CMD_NOT_IMPLMNTD_FOR_PARAM Undocumented
Variable CMD_NOT_IMPLMNTD_SUPERFLUOUS Undocumented
Variable CMD_OK Undocumented
Variable CNX_CLOSED_TXFR_ABORTED Undocumented
Variable DATA_CNX_ALREADY_OPEN_START_XFR Undocumented
Variable DATA_CNX_OPEN_NO_XFR_IN_PROGRESS Undocumented
Variable DIR_STATUS Undocumented
Variable ENTERING_EPSV_MODE Undocumented
Variable ENTERING_PASV_MODE Undocumented
Variable ENTERING_PORT_MODE Undocumented
Variable EXCEEDED_STORAGE_ALLOC Undocumented
Variable FEAT_OK Undocumented
Variable FILE_EXISTS Undocumented
Variable FILE_NOT_FOUND Undocumented
Variable FILE_STATUS Undocumented
Variable FILE_STATUS_OK_OPEN_DATA_CNX Undocumented
Variable FILENAME_NOT_ALLOWED Undocumented
Variable GOODBYE_MSG Undocumented
Variable grp Undocumented
Variable GUEST_LOGGED_IN_PROCEED Undocumented
Variable GUEST_NAME_OK_NEED_EMAIL Undocumented
Variable HELP_MSG Undocumented
Variable IS_A_DIR Undocumented
Variable IS_NOT_A_DIR Undocumented
Variable MKD_REPLY Undocumented
Variable NAME_SYS_TYPE Undocumented
Variable NEED_ACCT_FOR_LOGIN Undocumented
Variable NEED_ACCT_FOR_STOR Undocumented
Variable NOT_LOGGED_IN Undocumented
Variable OPTS_NOT_IMPLEMENTED Undocumented
Variable PAGE_TYPE_UNK Undocumented
Variable PERMISSION_DENIED Undocumented
Variable pwd Undocumented
Variable PWD_REPLY Undocumented
Variable REQ_ACTN_ABRTD_FILE_UNAVAIL Undocumented
Variable REQ_ACTN_ABRTD_INSUFF_STORAGE Undocumented
Variable REQ_ACTN_ABRTD_LOCAL_ERR Undocumented
Variable REQ_ACTN_NOT_TAKEN Undocumented
Variable REQ_FILE_ACTN_COMPLETED_OK Undocumented
Variable REQ_FILE_ACTN_PENDING_FURTHER_INFO Undocumented
Variable RESPONSE Undocumented
Variable RESTART_MARKER_REPLY Undocumented
Variable SERVICE_READY_IN_N_MINUTES Undocumented
Variable SVC_CLOSING_CTRL_CNX Undocumented
Variable SVC_NOT_AVAIL_CLOSING_CTRL_CNX Undocumented
Variable SVC_READY_FOR_NEW_USER Undocumented
Variable SYNTAX_ERR Undocumented
Variable SYNTAX_ERR_IN_ARGS Undocumented
Variable SYS_STATUS_OR_HELP_REPLY Undocumented
Variable TOO_MANY_CONNECTIONS Undocumented
Variable TXFR_COMPLETE_OK Undocumented
Variable TYPE_SET_OK Undocumented
Variable USR_LOGGED_IN_PROCEED Undocumented
Variable USR_NAME_OK_NEED_PASS Undocumented
Variable WELCOME_MSG Undocumented
Class _FileReader Undocumented
Class _FileWriter Undocumented
Class _PassiveConnectionFactory Undocumented
Function _getgroups Return the primary and supplementary groups for the given UID.
Function _isGlobbingExpression Helper for checking if a FTPShell `segments` contains a wildcard Unix expression.
Function _testPermissions checks to see if uid has proper permissions to access path with mode
Function _unwrapFirstError Undocumented
Variable _months Undocumented
Variable _testTranslation Undocumented
def debugDeferred(self, *_): (source)

Undocumented

def decodeHostPort(line): (source)
Decode an FTP response specifying a host and port.
Returns
a 2-tuple of (host, port).
def encodeHostPort(host, port): (source)

Undocumented

def errnoToFailure(e, path): (source)
Map OSError and IOError to standard FTP errors.
def parsePWDResponse(response): (source)

Returns the path from a response to a PWD command.

Responses typically look like:

    257 "/home/andrew" is current directory.

For this example, I will return '/home/andrew'.

If I can't find the path, I return None.

def toSegments(cwd, path): (source)
Normalize a path, as represented by a list of strings each representing one segment of the path.
ANON_USER_DENIED: str = (source)

Undocumented

AUTH_FAILURE: str = (source)

Undocumented

BAD_CMD_SEQ: str = (source)

Undocumented

CANT_OPEN_DATA_CNX: str = (source)

Undocumented

CLOSING_DATA_CNX: str = (source)

Undocumented

CMD_NOT_IMPLMNTD: str = (source)

Undocumented

CMD_NOT_IMPLMNTD_FOR_PARAM: str = (source)

Undocumented

CMD_NOT_IMPLMNTD_SUPERFLUOUS: str = (source)

Undocumented

CMD_OK: str = (source)

Undocumented

CNX_CLOSED_TXFR_ABORTED: str = (source)

Undocumented

DATA_CNX_ALREADY_OPEN_START_XFR: str = (source)

Undocumented

DATA_CNX_OPEN_NO_XFR_IN_PROGRESS: str = (source)

Undocumented

DIR_STATUS: str = (source)

Undocumented

ENTERING_EPSV_MODE: str = (source)

Undocumented

ENTERING_PASV_MODE: str = (source)

Undocumented

ENTERING_PORT_MODE: str = (source)

Undocumented

EXCEEDED_STORAGE_ALLOC: str = (source)

Undocumented

FEAT_OK: str = (source)

Undocumented

FILE_EXISTS: str = (source)

Undocumented

FILE_NOT_FOUND: str = (source)

Undocumented

FILE_STATUS: str = (source)

Undocumented

FILE_STATUS_OK_OPEN_DATA_CNX: str = (source)

Undocumented

FILENAME_NOT_ALLOWED: str = (source)

Undocumented

GOODBYE_MSG: str = (source)

Undocumented

Undocumented

GUEST_LOGGED_IN_PROCEED: str = (source)

Undocumented

GUEST_NAME_OK_NEED_EMAIL: str = (source)

Undocumented

HELP_MSG: str = (source)

Undocumented

IS_A_DIR: str = (source)

Undocumented

IS_NOT_A_DIR: str = (source)

Undocumented

MKD_REPLY: str = (source)

Undocumented

NAME_SYS_TYPE: str = (source)

Undocumented

NEED_ACCT_FOR_LOGIN: str = (source)

Undocumented

NEED_ACCT_FOR_STOR: str = (source)

Undocumented

NOT_LOGGED_IN: str = (source)

Undocumented

OPTS_NOT_IMPLEMENTED: str = (source)

Undocumented

PAGE_TYPE_UNK: str = (source)

Undocumented

PERMISSION_DENIED: str = (source)

Undocumented

Undocumented

PWD_REPLY: str = (source)

Undocumented

REQ_ACTN_ABRTD_FILE_UNAVAIL: str = (source)

Undocumented

REQ_ACTN_ABRTD_INSUFF_STORAGE: str = (source)

Undocumented

REQ_ACTN_ABRTD_LOCAL_ERR: str = (source)

Undocumented

REQ_ACTN_NOT_TAKEN: str = (source)

Undocumented

REQ_FILE_ACTN_COMPLETED_OK: str = (source)

Undocumented

REQ_FILE_ACTN_PENDING_FURTHER_INFO: str = (source)

Undocumented

RESPONSE = (source)

Undocumented

RESTART_MARKER_REPLY: str = (source)

Undocumented

SERVICE_READY_IN_N_MINUTES: str = (source)

Undocumented

SVC_CLOSING_CTRL_CNX: str = (source)

Undocumented

SVC_NOT_AVAIL_CLOSING_CTRL_CNX: str = (source)

Undocumented

SVC_READY_FOR_NEW_USER: str = (source)

Undocumented

SYNTAX_ERR: str = (source)

Undocumented

SYNTAX_ERR_IN_ARGS: str = (source)

Undocumented

SYS_STATUS_OR_HELP_REPLY: str = (source)

Undocumented

TOO_MANY_CONNECTIONS: str = (source)

Undocumented

TXFR_COMPLETE_OK: str = (source)

Undocumented

TYPE_SET_OK: str = (source)

Undocumented

USR_LOGGED_IN_PROCEED: str = (source)

Undocumented

USR_NAME_OK_NEED_PASS: str = (source)

Undocumented

WELCOME_MSG: str = (source)

Undocumented

def _getgroups(uid): (source)
Return the primary and supplementary groups for the given UID.
Parameters
uid:intUndocumented
def _isGlobbingExpression(segments=None): (source)

Helper for checking if a FTPShell `segments` contains a wildcard Unix expression.

Only filename globbing is supported. This means that wildcards can only be presents in the last element of `segments`.

Parameters
segments:listList of path elements as used by the FTP server protocol.
Returns
BooleanTrue if `segments` contains a globbing expression.
def _testPermissions(uid, gid, spath, mode='r'): (source)
checks to see if uid has proper permissions to access path with mode
Parameters
uid:intnumeric user id
gid:intnumeric group id
spath:strthe path on the server to test
mode:str'r' or 'w' (read or write)
Returns
boolTrue if the given credentials have the specified form of access to the given path
def _unwrapFirstError(failure): (source)

Undocumented

_months: list = (source)

Undocumented

_testTranslation = (source)

Undocumented