twisted.vfs.adapters.sftp.AdaptFileSystemUserToISFTP : API documentation

Method	__init__	Undocumented
Method	gotVersion	Called when the client sends their version info.
Method	openFile	Called when the clients asks to open a file.
Method	removeFile	Remove the given file.
Method	renameFile	Rename `oldpath` to `newpath`.
Method	makeDirectory	Make a directory.
Method	removeDirectory	Remove a directory (non-recursively)
Method	openDirectory	Open a directory for scanning.
Method	getAttrs	Return the attributes for the given path.
Method	setAttrs	Set the attributes for the path.
Method	readLink	Find the root of a set of symbolic links.
Method	makeLink	Create a symbolic link.
Method	realPath	Convert any path to an absolute path.
Method	_setAttrs	NOTE: this function assumes it runs as the logged-in user: i.e. under _runAsUser()

def __init__(self, avatar): (source)

Undocumented

def _setAttrs(self, path, attrs): (source)

NOTE: this function assumes it runs as the logged-in user: i.e. under _runAsUser()

def gotVersion(self, otherVersion, extData): (source)

from twisted.conch.interfaces.ISFTPServer

Called when the client sends their version info.

otherVersion is an integer representing the version of the SFTP protocol they are claiming. extData is a dictionary of extended_name : extended_data items. These items are sent by the client to indicate additional features.

This method should return a dictionary of extended_name : extended_data items. These items are the additional features (if any) supported by the server.

def openFile(self, filename, flags, attrs): (source)

from twisted.conch.interfaces.ISFTPServer

Called when the clients asks to open a file.

Parameters filename a string representing the file to open.

flags an integer of the flags to open the file with, ORed together. The flags and their values are listed at the bottom of this file.

attrs

a list of attributes to open the file with. It is a dictionary, consisting of 0 or more keys. The possible keys are:

   size: the size of the file in bytes
   uid: the user ID of the file as an integer
   gid: the group ID of the file as an integer
   permissions: the permissions of the file with as an integer.
   the bit representation of this field is defined by POSIX.
   atime: the access time of the file as seconds since the epoch.
   mtime: the modification time of the file as seconds since the epoch.
   ext_*: extended attributes.  The server is not required to
   understand this, but it may.

NOTE: there is no way to indicate text or binary files. it is up to the SFTP client to deal with this.

This method returns an object that meets the ISFTPFile interface. Alternatively, it can return a Deferred that will be called back with the object.

def removeFile(self, filename): (source)

from twisted.conch.interfaces.ISFTPServer

Remove the given file.

This method returns when the remove succeeds, or a Deferred that is called back when it succeeds.

Parameters filename the name of the file as a string.

def renameFile(self, oldpath, newpath): (source)

from twisted.conch.interfaces.ISFTPServer

Rename oldpath to newpath.

See twisted.conch.interfaces.ISFTPServer.renameFile.

def makeDirectory(self, path, attrs): (source)

from twisted.conch.interfaces.ISFTPServer

Make a directory.

This method returns when the directory is created, or a Deferred that is called back when it is created.

Parameters	path	the name of the directory to create as a string.
	attrs	a dictionary of attributes to create the directory with. Its meaning is the same as the attrs in the `openFile` method.

def removeDirectory(self, path): (source)

from twisted.conch.interfaces.ISFTPServer

Remove a directory (non-recursively)

It is an error to remove a directory that has files or directories in it.

This method returns when the directory is removed, or a Deferred that is called back when it is removed.

Parameters path the directory to remove.

def openDirectory(self, path): (source)

from twisted.conch.interfaces.ISFTPServer

Open a directory for scanning.

This method returns an iterable object that has a close() method, or a Deferred that is called back with same.

The close() method is called when the client is finished reading from the directory. At this point, the iterable will no longer be used.

The iterable should return triples of the form (filename, longname, attrs) or Deferreds that return the same. The sequence must support __getitem__, but otherwise may be any 'sequence-like' object.

filename is the name of the file relative to the directory. logname is an expanded format of the filename. The recommended format is: -rwxr-xr-x 1 mjos staff 348911 Mar 25 14:29 t-filexfer 1234567890 123 12345678 12345678 12345678 123456789012

The first line is sample output, the second is the length of the field. The fields are: permissions, link count, user owner, group owner, size in bytes, modification time.

attrs is a dictionary in the format of the attrs argument to openFile.

Parameters path the directory to open.

def getAttrs(self, path, followLinks): (source)

from twisted.conch.interfaces.ISFTPServer

Return the attributes for the given path.

This method returns a dictionary in the same format as the attrs argument to openFile or a Deferred that is called back with same.

Parameters	path	the path to return attributes for as a string.
	followLinks	a boolean. If it is True, follow symbolic links and return attributes for the real path at the base. If it is False, return attributes for the specified path.

def setAttrs(self, path, attrs): (source)

from twisted.conch.interfaces.ISFTPServer

Set the attributes for the path.

This method returns when the attributes are set or a Deferred that is called back when they are.

Parameters	path	the path to set attributes for as a string.
	attrs	a dictionary in the same format as the attrs argument to `openFile`.

def readLink(self, path): (source)

from twisted.conch.interfaces.ISFTPServer

Find the root of a set of symbolic links.

This method returns the target of the link, or a Deferred that returns the same.

Parameters path the path of the symlink to read.

def makeLink(self, linkPath, targetPath): (source)

from twisted.conch.interfaces.ISFTPServer

Create a symbolic link.

This method returns when the link is made, or a Deferred that returns the same.

Parameters	linkPath	the pathname of the symlink as a string.
	targetPath	the path of the target of the link as a string.

def realPath(self, path): (source)

from twisted.conch.interfaces.ISFTPServer

Convert any path to an absolute path.

This method returns the absolute path as a string, or a Deferred that returns the same.

Parameters path the path to convert as a string.

t.v.a.s.AdaptFileSystemUserToISFTP : class documentation