twisted.conch.scripts.cftp.StdioClient : API documentation

class documentation

class twisted.conch.scripts.cftp.StdioClient(basic.LineReceiver): (source)

Undocumented

Class Variable	ps	Undocumented
Class Variable	delimiter	Undocumented
Method	__init__	Undocumented
Instance Variable	client	Undocumented
Instance Variable	currentDirectory	Undocumented
Instance Variable	file	Undocumented
Instance Variable	useProgressBar	Undocumented
Method	connectionMade	Called when a connection is made.
Method	lineReceived	Override this for when each line is received.
Instance Variable	ignoreErrors	Undocumented
Method	cmd_CD	Undocumented
Method	cmd_CHGRP	Undocumented
Method	cmd_CHMOD	Undocumented
Method	cmd_CHOWN	Undocumented
Method	cmd_GET	Undocumented
Method	cmd_PUT	Do an upload request for a single local file or a globing expression.
Method	cmd_LCD	Undocumented
Method	cmd_LN	Undocumented
Method	cmd_LS	Undocumented
Method	cmd_MKDIR	Undocumented
Method	cmd_RMDIR	Undocumented
Method	cmd_LMKDIR	Undocumented
Method	cmd_RM	Undocumented
Method	cmd_LLS	Undocumented
Method	cmd_RENAME	Undocumented
Method	cmd_EXIT	Undocumented
Method	cmd_VERSION	Undocumented
Method	cmd_HELP	Undocumented
Method	cmd_PWD	Undocumented
Method	cmd_LPWD	Undocumented
Method	cmd_PROGRESS	Undocumented
Method	cmd_EXEC	Run `rest` using the user's shell (or /bin/sh if they do not have one).
Method	_cbSetCurDir	Undocumented
Method	_writeToTransport	Undocumented
Method	_dispatchCommand	Undocumented
Method	_printFailure	Undocumented
Method	_newLine	Undocumented
Method	_cbCommand	Undocumented
Method	_ebCommand	Undocumented
Method	_cbCd	Undocumented
Method	_cbCurDir	Undocumented
Method	_cbSetUsrGrp	Undocumented
Method	_cbGetMultiple	Undocumented
Method	_cbGetMultipleNext	Undocumented
Method	_ebCloseLf	Undocumented
Method	_cbGetOpenFile	Undocumented
Method	_cbGetFileSize	Undocumented
Method	_getNextChunk	Undocumented
Method	_cbGetRead	Undocumented
Method	_cbGetDone	Undocumented
Method	_putSingleFile	Perform an upload for a single file.
Method	_putMultipleFiles	Perform an upload for a list of local files.
Method	_cbPutMultipleNext	Perform an upload for the next file in the list of local files.
Method	_putRemoteFile	Do an upload request.
Method	_cbPutOpenFile	Undocumented
Method	_cbPutWrite	Undocumented
Method	_cbPutDone	Undocumented
Method	_cbDisplayFiles	Undocumented
Method	_remoteGlob	Undocumented
Method	_cbOpenList	Undocumented
Method	_ebNotADirectory	Undocumented
Method	_cbReadFile	Undocumented
Method	_abbrevSize	Undocumented
Method	_abbrevTime	Undocumented
Method	_printProgressBar	No summary
Method	_getFilename	Parse line received as command line input and return first filename together with the remaining line.

Inherited from LineReceiver:

Class Variable	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.
Instance Variable	line_mode	Undocumented
Method	clearLineBuffer	Clear buffered data.
Method	dataReceived	Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method	setLineMode	Sets the line-mode of this receiver.
Method	setRawMode	Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method	rawDataReceived	Override this for when raw data is received.
Method	sendLine	Sends a line to the other end of the connection.
Method	lineLengthExceeded	Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Instance Variable	_buffer	Undocumented
Instance Variable	_busyReceiving	Undocumented

Inherited from Protocol (via LineReceiver):

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method	connectionLost	Called when the connection is shut down.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.

Inherited from _PauseableMixin (via LineReceiver):

Instance Variable	paused	Undocumented
Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

ps = (source)

Undocumented

(type: str)

delimiter = (source)

overrides twisted.protocols.basic.LineReceiver.delimiter

Undocumented

(type: bytes)

def __init__(self, client, f=None): (source)

Undocumented

client = (source)

Undocumented

currentDirectory = (source)

Undocumented

file = (source)

Undocumented

useProgressBar = (source)

Undocumented

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.connectionMade

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def _cbSetCurDir(self, path): (source)

Undocumented

def _writeToTransport(self, msg): (source)

Undocumented

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters line The line which was received with the delimiter removed. (type: bytes)

ignoreErrors = (source)

Undocumented

(type: int)

def _dispatchCommand(self, line): (source)

Undocumented

def _printFailure(self, f): (source)

Undocumented

def _newLine(self): (source)

Undocumented

def _cbCommand(self, result): (source)

Undocumented

def _ebCommand(self, f): (source)

Undocumented

def cmd_CD(self, path): (source)

Undocumented

def _cbCd(self, directory): (source)

Undocumented

def _cbCurDir(self, path): (source)

Undocumented

def cmd_CHGRP(self, rest): (source)

Undocumented

def cmd_CHMOD(self, rest): (source)

Undocumented

def cmd_CHOWN(self, rest): (source)

Undocumented

def _cbSetUsrGrp(self, attrs, path, usr=None, grp=None): (source)

Undocumented

def cmd_GET(self, rest): (source)

Undocumented

def _cbGetMultiple(self, files, local): (source)

Undocumented

def _cbGetMultipleNext(self, res, files, local): (source)

Undocumented

def _ebCloseLf(self, f, lf): (source)

Undocumented

def _cbGetOpenFile(self, rf, lf): (source)

Undocumented

def _cbGetFileSize(self, attrs, rf, lf): (source)

Undocumented

def _getNextChunk(self, chunks): (source)

Undocumented

def _cbGetRead(self, data, rf, lf, chunks, start, size, startTime): (source)

Undocumented

def _cbGetDone(self, ignored, rf, lf): (source)

Undocumented

def cmd_PUT(self, rest): (source)

Do an upload request for a single local file or a globing expression.

Parameters	rest	Requested command line for the PUT command. (type: `str`)
Returns	A deferred which fires with `None` when transfer is done. (type: `defer.Deferred`)

def _putSingleFile(self, local, remote): (source)

Perform an upload for a single file.

Parameters	local	Path to local file. (type: `str`.)
	remote	Remote path for the request relative to current working directory. (type: `str`)
Returns	A deferred which fires when transfer is done.

def _putMultipleFiles(self, files, remote): (source)

Perform an upload for a list of local files.

Parameters	files	List of local files. (type: `list` of `str`.)
	remote	Remote path for the request relative to current working directory. (type: `str`)
Returns	A deferred which fires when transfer is done.

def _cbPutMultipleNext(self, previousResult, files, remotePath, single=False): (source)

Perform an upload for the next file in the list of local files.

Parameters	previousResult	Result form previous file form the list. (type: `str`)
	files	List of local files. (type: `list` of `str`)
	remotePath	Remote path for the request relative to current working directory. (type: `str`)
	single	A flag which signals if this is a transfer for a single file in which case we use the exact remote path (type: `bool`)
Returns	A deferred which fires when transfer is done.

def _putRemoteFile(self, localStream, remotePath): (source)

Do an upload request.

Parameters	localStream	Local stream from where data is read. (type: File like object.)
	remotePath	Remote path for the request relative to current working directory. (type: `str`)
Returns	A deferred which fires when transfer is done.

def _cbPutOpenFile(self, rf, lf): (source)

Undocumented

def _cbPutWrite(self, ignored, rf, lf, chunks, startTime): (source)

Undocumented

def _cbPutDone(self, ignored, rf, lf): (source)

Undocumented

def cmd_LCD(self, path): (source)

Undocumented

def cmd_LN(self, rest): (source)

Undocumented

def cmd_LS(self, rest): (source)

Undocumented

def _cbDisplayFiles(self, files, options): (source)

Undocumented

def cmd_MKDIR(self, path): (source)

Undocumented

def cmd_RMDIR(self, path): (source)

Undocumented

def cmd_LMKDIR(self, path): (source)

Undocumented

def cmd_RM(self, path): (source)

Undocumented

def cmd_LLS(self, rest): (source)

Undocumented

def cmd_RENAME(self, rest): (source)

Undocumented

def cmd_EXIT(self, ignored): (source)

Undocumented

def cmd_VERSION(self, ignored): (source)

Undocumented

def cmd_HELP(self, ignored): (source)

Undocumented

def cmd_PWD(self, ignored): (source)

Undocumented

def cmd_LPWD(self, ignored): (source)

Undocumented

def cmd_PROGRESS(self, ignored): (source)

Undocumented

def cmd_EXEC(self, rest): (source)

Run rest using the user's shell (or /bin/sh if they do not have one).

def _remoteGlob(self, fullPath): (source)

Undocumented

def _cbOpenList(self, directory, glob): (source)

Undocumented

def _ebNotADirectory(self, reason, path, glob): (source)

Undocumented

def _cbReadFile(self, files, matchedFiles, directory, glob): (source)

Undocumented

def _abbrevSize(self, size): (source)

Undocumented

def _abbrevTime(self, t): (source)

Undocumented

def _printProgressBar(self, f, startTime): (source)

Update a console progress bar on this StdioClient's transport, based on the difference between the start time of the operation and the current time according to the reactor, and appropriate to the size of the console window.

Parameters	f	a wrapper around the file which is being written or read (type: `FileWrapper`)
	startTime	The time at which the operation being tracked began. (type: `float`)

def _getFilename(self, line): (source)

Parse line received as command line input and return first filename together with the remaining line.

Parameters	line	Arguments received from command line input. (type: `str`)
Returns	Tupple with filename and rest. Return empty values when no path was not found. (type: `tupple`)

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