eric: comparison src/eric7/RemoteServerInterface/EricServerFileSystemInterface.py

-:b6f5e27daeb5
+:bb0149571d94
 from eric7 import Utilities
 from eric7.RemoteServer.EricRequestCategory import EricRequestCategory
 from eric7.SystemUtilities import FileSystemUtilities
+class EricServerNotConnectedError(OSError):
+"""
+Class defining a special OSError indicating a missing server connection.
+"""
+def __init__(self):
+"""
+Constructor
+"""
+super().__init("Not connected to an 'eric-ide' server.")
 class EricServerFileSystemInterface(QObject):
 """
 Class implementing the file system interface to the eric-ide server.
 """
 _MagicCheck = re.compile("([*?[])")
+NotConnectedMessage = "Not connected to an 'eric-ide' server."
 def __init__(self, serverInterface):
 """
 Constructor
 @param serverInterface reference to the eric-ide server interface
 callback=callback,
 )
 loop.exec()
-return cwd
+return FileSystemUtilities.remoteFileName(cwd)
 def chdir(self, directory):
 """
 Public method to change the current working directory of the eric-ide server.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def listdir(self, directory=""):
 """
 Public method to get a directory listing.
 @param directory directory to be listed. An empty directory means to list
 the eric-ide server current directory. (defaults to "")
 @type str (optional)
-@return tuple containing the listed directory, the path separartor and the
+@return tuple containing the listed directory, the path separator and the
 directory listing. Each directory listing entry contains a dictionary
 with the relevant data.
 @rtype tuple of (str, str, dict)
 @exception OSError raised in case the server reported an issue
 """
 loop.exec()
 if not ok:
 raise OSError(error)
-return result
+return [FileSystemUtilities.remoteFileName(r) for r in result]
 def glob(self, pathname, recursive=False, includeHidden=False):
 """
 Public method to get a list of of all files matching a given pattern
 like 'glob.glob()'.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def makedirs(self, directory, exist_ok=False):
 """
 Public method to create a new directory on the eric-ide serverincluding all
 intermediate-level directories.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def rmdir(self, directory):
 """
 Public method to delete a directory on the eric-ide server.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def replace(self, oldName, newName):
 """
 Public method to rename a file or directory.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def remove(self, filename):
 """
 Public method to delete a file on the eric-ide server.
 loop.exec()
 return ok, error
 else:
-return False, "Not connected to an 'eric-ide' server."
+return False, EricServerFileSystemInterface.NotConnectedMessage
 def expanduser(self, name):
 """
 Public method to expand an initial '~' or '~user' component.
 @return path separator
 @rtype str
 """
 return self.__serverPathSep
+def isabs(self, p):
+"""
+Public method to chack a path for being an absolute path.
+@param p path to be checked
+@type str
+@return flag indicating an absolute path
+@rtype bool
+"""
+if self.__serverInterface.isServerConnected():
+if self.__serverPathSep == "\\":
+s = FileSystemUtilities.plainFileName(p)[:3].replace("/", "\\")
+return s.startswith("\\)") or s.startswith(":\\", 1)
+else:
+return FileSystemUtilities.plainFileName(p).startswith("/")
+else:
+return os.path.isabs(p)
+def abspath(self, p):
+"""
+Public method to convert the given path to an absolute path.
+@param p path to be converted
+@type str
+@return absolute path
+@rtype str
+"""
+if self.__serverInterface.isServerConnected():
+p = FileSystemUtilities.plainFileName(p)
+if not self.isabs(p):
+p = self.join(self.getcwd(), p)
+return FileSystemUtilities.remoteFileName(p)
+else:
+return os.path.abspath(p)
 def join(self, a, *p):
 """
 Public method to join two or more path name components using the path separator
 of the server side.
 @param create flag indicating to create an empty file, if it does not exist
 (defaults to False)
 @type bool (optional)
 @return bytes data read from the eric-ide server
 @rtype bytes
+@exception EricServerNotConnectedError raised to indicate a missing server
+connection
 @exception OSError raised in case the server reported an issue
 """
 loop = QEventLoop()
 ok = False
 error = ""
 else:
 error = params["error"]
 loop.quit()
 if not self.__serverInterface.isServerConnected():
-raise OSError("Not connected to an 'eric-ide' server.")
+raise EricServerNotConnectedError()
 else:
 self.__serverInterface.sendJson(
 category=EricRequestCategory.FileSystem,
 request="ReadFile",
 @param data data to be written
 @type bytes
 @param withBackup flag indicating to create a backup file first
 (defaults to False)
 @type bool (optional)
+@exception EricServerNotConnectedError raised to indicate a missing server
+connection
 @exception OSError raised in case the server reported an issue
 """
 loop = QEventLoop()
 ok = False
 error = ""
 with contextlib.suppress(KeyError):
 error = params["error"]
 loop.quit()
 if not self.__serverInterface.isServerConnected():
-raise OSError("Not connected to an 'eric-ide' server.")
+raise EricServerNotConnectedError
 else:
 self.__serverInterface.sendJson(
 category=EricRequestCategory.FileSystem,
 request="WriteFile",
 #######################################################################
 ## Methods implementing some 'shutil' like functionality.
 #######################################################################
 def shutilCopy(self, srcName, dstName):
+"""
+Public method to copy a source file to a given destination file or directory.
+@param srcName name of the source file
+@type str
+@param dstName name of the destination file or directory
+@type str
+@return name of the destination file
+@rtype str
+@exception EricServerNotConnectedError raised to indicate a missing server
+connection
+@exception OSError raised to indicate an issue
+"""
 loop = QEventLoop()
 ok = False
 error = ""
 dst = ""
 else:
 error = params["error"]
 loop.quit()
 if not self.__serverInterface.isServerConnected():
-raise OSError("Not connected to an 'eric-ide' server.")
+raise EricServerNotConnectedError
 else:
 self.__serverInterface.sendJson(
 category=EricRequestCategory.FileSystem,
 request="ShutilCopy",
 loop.exec()
 if not ok:
 raise OSError(error)
 return dst
+def shutilRmtree(self, pathname, ignore_errors=False):
+"""
+Public method to delete an entire directory tree.
+@param pathname name of the directory to be deleted
+@type str
+@param ignore_errors flag indicating to ignore error resulting from failed
+removals (defaults to False)
+@type bool (optional)
+@exception EricServerNotConnectedError raised to indicate a missing server
+connection
+@exception OSError raised to indicate an issue
+"""
+loop = QEventLoop()
+ok = False
+error = ""
+def callback(reply, params):
+"""
+Function to handle the server reply
+@param reply name of the server reply
+@type str
+@param params dictionary containing the reply data
+@type dict
+"""
+nonlocal ok, error
+if reply == "ShutilRmtree":
+ok = params["ok"]
+if not ok:
+error = params["error"]
+loop.quit()
+if not self.__serverInterface.isServerConnected():
+raise EricServerNotConnectedError
+else:
+self.__serverInterface.sendJson(
+category=EricRequestCategory.FileSystem,
+request="ShutilRmtree",
+params={
+"name": FileSystemUtilities.plainFileName(pathname),
+"ignore_errors": ignore_errors,
+},
+callback=callback,
+)
+loop.exec()
+if not ok:
+raise OSError(error)
+#######################################################################
+## Utility methods.
+#######################################################################
+def compactPath(self, longPath, width, measure=len):
+"""
+Public method to return a compacted path fitting inside the given width.
+@param longPath path to be compacted
+@type str
+@param width width for the compacted path
+@type int
+@param measure reference to a function used to measure the length of the
+string (defaults to len)
+@type function (optional)
+@return compacted path
+@rtype str
+"""
+if measure(longPath) <= width:
+return longPath
+ellipsis = "..."
+head, tail = self.split(longPath)
+mid = len(head) // 2
+head1 = head[:mid]
+head2 = head[mid:]
+while head1:
+# head1 is same size as head2 or one shorter
+cpath = self.join(f"{head1}{ellipsis}{head2}", tail)
+if measure(cpath) <= width:
+return cpath
+head1 = head1[:-1]
+head2 = head2[1:]
+cpath = self.join(ellipsis, tail)
+if measure(cpath) <= width:
+return cpath
+remoteMarker = FileSystemUtilities.remoteFileName("")
+if width <= len(remoteMarker):
+return f"{remoteMarker}{ellipsis}{tail}"
+while tail:
+cpath = f"{remoteMarker}{ellipsis}{tail}"
+if measure(cpath) <= width:
+return cpath
+tail = tail[1:]
+return ""

Mercurial Repositories > eric / file comparison

comparison: src/eric7/RemoteServerInterface/EricServerFileSystemInterface.py

src/eric7/RemoteServerInterface/EricServerFileSystemInterface.py