twisted.protocols.ftp

module documentation
(source)

An FTP protocol implementation

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

Undocumented

grp = (source)

Undocumented

RESTART_MARKER_REPLY = (source)

Undocumented

(type: str)
SERVICE_READY_IN_N_MINUTES = (source)

Undocumented

(type: str)
DATA_CNX_ALREADY_OPEN_START_XFR = (source)

Undocumented

(type: str)
FILE_STATUS_OK_OPEN_DATA_CNX = (source)

Undocumented

(type: str)
CMD_OK = (source)

Undocumented

(type: str)
TYPE_SET_OK = (source)

Undocumented

(type: str)
ENTERING_PORT_MODE = (source)

Undocumented

(type: str)
CMD_NOT_IMPLMNTD_SUPERFLUOUS = (source)

Undocumented

(type: str)
SYS_STATUS_OR_HELP_REPLY = (source)

Undocumented

(type: str)
FEAT_OK = (source)

Undocumented

(type: str)
DIR_STATUS = (source)

Undocumented

(type: str)
FILE_STATUS = (source)

Undocumented

(type: str)
HELP_MSG = (source)

Undocumented

(type: str)
NAME_SYS_TYPE = (source)

Undocumented

(type: str)
SVC_READY_FOR_NEW_USER = (source)

Undocumented

(type: str)
WELCOME_MSG = (source)

Undocumented

(type: str)
SVC_CLOSING_CTRL_CNX = (source)

Undocumented

(type: str)
GOODBYE_MSG = (source)

Undocumented

(type: str)
DATA_CNX_OPEN_NO_XFR_IN_PROGRESS = (source)

Undocumented

(type: str)
CLOSING_DATA_CNX = (source)

Undocumented

(type: str)
TXFR_COMPLETE_OK = (source)

Undocumented

(type: str)
ENTERING_PASV_MODE = (source)

Undocumented

(type: str)
ENTERING_EPSV_MODE = (source)

Undocumented

(type: str)
USR_LOGGED_IN_PROCEED = (source)

Undocumented

(type: str)
GUEST_LOGGED_IN_PROCEED = (source)

Undocumented

(type: str)
REQ_FILE_ACTN_COMPLETED_OK = (source)

Undocumented

(type: str)
PWD_REPLY = (source)

Undocumented

(type: str)
MKD_REPLY = (source)

Undocumented

(type: str)
USR_NAME_OK_NEED_PASS = (source)

Undocumented

(type: str)
GUEST_NAME_OK_NEED_EMAIL = (source)

Undocumented

(type: str)
NEED_ACCT_FOR_LOGIN = (source)

Undocumented

(type: str)
REQ_FILE_ACTN_PENDING_FURTHER_INFO = (source)

Undocumented

(type: str)
SVC_NOT_AVAIL_CLOSING_CTRL_CNX = (source)

Undocumented

(type: str)
TOO_MANY_CONNECTIONS = (source)

Undocumented

(type: str)
CANT_OPEN_DATA_CNX = (source)

Undocumented

(type: str)
CNX_CLOSED_TXFR_ABORTED = (source)

Undocumented

(type: str)
REQ_ACTN_ABRTD_FILE_UNAVAIL = (source)

Undocumented

(type: str)
REQ_ACTN_ABRTD_LOCAL_ERR = (source)

Undocumented

(type: str)
REQ_ACTN_ABRTD_INSUFF_STORAGE = (source)

Undocumented

(type: str)
SYNTAX_ERR = (source)

Undocumented

(type: str)
SYNTAX_ERR_IN_ARGS = (source)

Undocumented

(type: str)
CMD_NOT_IMPLMNTD = (source)

Undocumented

(type: str)
OPTS_NOT_IMPLEMENTED = (source)

Undocumented

(type: str)
BAD_CMD_SEQ = (source)

Undocumented

(type: str)
CMD_NOT_IMPLMNTD_FOR_PARAM = (source)

Undocumented

(type: str)
NOT_LOGGED_IN = (source)

Undocumented

(type: str)
AUTH_FAILURE = (source)

Undocumented

(type: str)
NEED_ACCT_FOR_STOR = (source)

Undocumented

(type: str)
FILE_NOT_FOUND = (source)

Undocumented

(type: str)
PERMISSION_DENIED = (source)

Undocumented

(type: str)
ANON_USER_DENIED = (source)

Undocumented

(type: str)
IS_NOT_A_DIR = (source)

Undocumented

(type: str)
REQ_ACTN_NOT_TAKEN = (source)

Undocumented

(type: str)
FILE_EXISTS = (source)

Undocumented

(type: str)
IS_A_DIR = (source)

Undocumented

(type: str)
PAGE_TYPE_UNK = (source)

Undocumented

(type: str)
EXCEEDED_STORAGE_ALLOC = (source)

Undocumented

(type: str)
FILENAME_NOT_ALLOWED = (source)

Undocumented

(type: str)
RESPONSE = (source)

Undocumented

def toSegments(cwd, path): (source)

Normalize a path, as represented by a list of strings each representing one segment of the path.

def errnoToFailure(e, path): (source)

Map OSError and IOError to standard FTP errors.

_testTranslation = (source)

Undocumented

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`.

ParameterssegmentsList of path elements as used by the FTP server protocol. (type: list)
ReturnsTrue if `segments` contains a globbing expression. (type: Boolean)
def debugDeferred(self, *_): (source)

Undocumented

_months = (source)

Undocumented

(type: list)
def _getgroups(uid): (source)

Return the primary and supplementary groups for the given UID.

ParametersuidUndocumented (type: int)
def _testPermissions(uid, gid, spath, mode='r'): (source)

checks to see if uid has proper permissions to access path with mode

Parametersuidnumeric user id (type: int)
gidnumeric group id (type: int)
spaththe path on the server to test (type: str)
mode'r' or 'w' (read or write) (type: str)
ReturnsTrue if the given credentials have the specified form of access to the given path (type: bool)
def decodeHostPort(line): (source)

Decode an FTP response specifying a host and port.

Returnsa 2-tuple of (host, port).
def encodeHostPort(host, port): (source)

Undocumented

def _unwrapFirstError(failure): (source)

Undocumented

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.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.