eric: comparison src/eric7/VCS/VersionControl.py

-:c712d09cc839
+:f6881d10e995
 def __init__(self, parent=None, name=None):
 """
 Constructor
-@param parent parent widget (QWidget)
+@param parent parent widget
-@param name name of this object (string)
+@type QWidget
+@param name name of this object
+@type str
 """
 super().__init__(parent)
 if name:
 self.setObjectName(name)
 self.defaultOptions = {
 def vcsExists(self):
 """
 Public method used to test for the presence of the vcs.
-@return tuple of flag indicating the existence and a string
+@return tuple of flag indicating the existence and an error message
-giving an error message in case of failure
+in case of failure
+@rtype tuple of (bool, str)
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsInit(self, vcsDir, noDialog=False):
 """
 Public method used to initialize the vcs.
-@param vcsDir name of the VCS directory (string)
+@param vcsDir name of the VCS directory
-@param noDialog flag indicating quiet operations (boolean)
+@type str
-@return flag indicating success (boolean)
+@param noDialog flag indicating quiet operations
+@type bool
+@return flag indicating success
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 """
 Public method used to import the project into the vcs.
 @param vcsDataDict dictionary of data required for the import
 @type dict
-@param projectDir project directory (string)
+@param projectDir project directory
 @type str
 @param noDialog flag indicating quiet operations
 @type bool
 @param addAll flag indicating to add all files to the repository
 @type bool
 def vcsCheckout(self, vcsDataDict, projectDir, noDialog=False):
 """
 Public method used to check the project out of the vcs.
 @param vcsDataDict dictionary of data required for the checkout
-@param projectDir project directory to create (string)
+@type dict
+@param projectDir project directory to create
+@type str
 @param noDialog flag indicating quiet operations
-@return flag indicating an execution without errors (boolean)
+@type bool
+@return flag indicating an execution without errors
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsExport(self, vcsDataDict, projectDir):
 """
 Public method used to export a directory from the vcs.
 @param vcsDataDict dictionary of data required for the export
-@param projectDir project directory to create (string)
+@type dict
-@return flag indicating an execution without errors (boolean)
+@param projectDir project directory to create
+@type str
+@return flag indicating an execution without errors
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsCommit(self, name, message, noDialog=False):
 """
 Public method used to make the change of a file/directory permanent in
 the vcs.
-@param name file/directory name to be committed (string)
+@param name file/directory name to be committed
-@param message message for this operation (string)
+@type str
-@param noDialog flag indicating quiet operations (boolean)
+@param message message for this operation
-@return flag indicating success (boolean)
+@type str
+@param noDialog flag indicating quiet operations
+@type bool
+@return flag indicating success
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsUpdate(self, name, noDialog=False):
 """
 Public method used to update a file/directory in the vcs.
-@param name file/directory name to be updated (string)
+@param name file/directory name to be updated
-@param noDialog flag indicating quiet operations (boolean)
+@type str
+@param noDialog flag indicating quiet operations
+@type bool
 @return flag indicating, that the update contained an add
-or delete (boolean)
+or delete
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsAdd(self, name, isDir=False, noDialog=False):
 """
 Public method used to add a file/directory in the vcs.
-@param name file/directory name to be added (string)
+@param name file/directory name to be added
-@param isDir flag indicating name is a directory (boolean)
+@type str
-@param noDialog flag indicating quiet operations (boolean)
+@param isDir flag indicating name is a directory
+@type bool
+@param noDialog flag indicating quiet operations
+@type bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsAddBinary(self, name, isDir=False):
 """
 Public method used to add a file/directory in binary mode in the vcs.
-@param name file/directory name to be added (string)
+@param name file/directory name to be added
-@param isDir flag indicating name is a directory (boolean)
+@type str
+@param isDir flag indicating name is a directory
+@type bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsAddTree(self, path):
 """
 Public method to add a directory tree rooted at path in the vcs.
-@param path root directory of the tree to be added (string)
+@param path root directory of the tree to be added
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsRemove(self, name, project=False, noDialog=False):
 """
 Public method used to add a file/directory in the vcs.
-@param name file/directory name to be removed (string)
+@param name file/directory name to be removed
-@param project flag indicating deletion of a project tree (boolean)
+@type str
+@param project flag indicating deletion of a project tree
+@type bool
 @param noDialog flag indicating quiet operations
-@return flag indicating success (boolean)
+@type bool
+@return flag indicating success
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsMove(self, name, project, target=None, noDialog=False):
 """
 Public method used to move a file/directory.
-@param name file/directory name to be moved (string)
+@param name file/directory name to be moved
+@type str
 @param project reference to the project object
-@param target new name of the file/directory (string)
+@type Project
+@param target new name of the file/directory
+@type str
 @param noDialog flag indicating quiet operations
-@return flag indicating successfull operation (boolean)
+@type bool
+@return flag indicating successfull operation
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsLogBrowser(self, name, isFile=False):
 """
 Public method used to view the log of a file/directory in the vcs
 with a log browser dialog.
-@param name file/directory name to show the log for (string)
+@param name file/directory name to show the log for
+@type str
 @param isFile flag indicating log for a file is to be shown
-(boolean)
+@type bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsDiff(self, name):
 """
 Public method used to view the diff of a file/directory in the vcs.
-@param name file/directory name to be diffed (string)
+@param name file/directory name to be diffed
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsStatus(self, name):
 """
 Public method used to view the status of a file/directory in the vcs.
-@param name file/directory name to show the status for (string)
+@param name file/directory name to show the status for
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsTag(self, name):
 """
 Public method used to set the tag of a file/directory in the vcs.
-@param name file/directory name to be tagged (string)
+@param name file/directory name to be tagged
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsSwitch(self, name):
 """
 Public method used to switch a directory to a different tag/branch.
-@param name directory name to be switched (string)
+@param name directory name to be switched
+@type str
 @return flag indicating, that the switch contained an add
-or delete (boolean)
+or delete
+@rtype bool
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsMerge(self, name):
 """
 Public method used to merge a tag/branch into the local project.
-@param name file/directory name to be merged (string)
+@param name file/directory name to be merged
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsRegisteredState(self, name):
 """
 Public method used to get the registered state of a file in the vcs.
-@param name filename to check (string)
+@param name filename to check
+@type str
 @return a combination of canBeCommited and canBeAdded or
 0 in order to signal an error
+@rtype int
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 """
 Public method used to get the registered states of a number of files
 in the vcs.
 @param names dictionary with all filenames to be checked as keys
-@param dname directory to check in (string)
+@type dict
+@param dname directory to check in
+@type str
 @return the received dictionary completed with a combination of
 canBeCommited and canBeAdded or None in order to signal an error
+@rtype dict
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsName(self):
 """
 Public method returning the name of the vcs.
-@return name of the vcs (string)
+@return name of the vcs
+@rtype str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsCleanup(self, name):
 """
 Public method used to cleanup the local copy.
-@param name directory name to be cleaned up (string)
+@param name directory name to be cleaned up
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsCommandLine(self, name):
 """
 Public method used to execute arbitrary vcs commands.
-@param name directory name of the working directory (string)
+@param name directory name of the working directory
+@type str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsOptionsDialog(self, project, archive, editable=False, parent=None):
 """
 Public method to get a dialog to enter repository info.
 @param project reference to the project object
-@param archive name of the project in the repository (string)
+@type Project
+@param archive name of the project in the repository
+@type str
 @param editable flag indicating that the project name is editable
-(boolean)
+@type bool
-@param parent parent widget (QWidget)
+@param parent parent widget
+@type QWidget
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsNewProjectOptionsDialog(self, parent=None):
 """
 Public method to get a dialog to enter repository info for getting a
 new project.
-@param parent parent widget (QWidget)
+@param parent parent widget
+@type QWidget
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsRepositoryInfos(self, ppath):
 """
 Public method to retrieve information about the repository.
-@param ppath local path to get the repository infos (string)
+@param ppath local path to get the repository infos
-@return string with ready formated info for display (string)
+@type str
+@return string with ready formated info for display
+@rtype str
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 """
 Public method to instanciate a helper object for the different
 project browsers.
 @param browser reference to the project browser object
+@type ProjectBaseBrowser
 @param project reference to the project object
+@type Project
 @param isTranslationsBrowser flag indicating, the helper is requested
 for the translations browser (this needs some special treatment)
+@type bool
 @return the project browser helper object
+@rtype VcsProjectBrowserHelper
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 def vcsGetProjectHelper(self, project):
 """
 Public method to instanciate a helper object for the project.
 @param project reference to the project object
+@type Project
 @return the project helper object
+@rtype VcsProjectHelper
 @exception NotImplementedError to indicate that this method must be
 implemented by a subclass
 """
 raise NotImplementedError("Not implemented")
 Public method to initialize the VCS configuration.
 This method could ensure, that certain files or directories are
 exclude from being version controlled.
-@param project reference to the project (Project)
+@param project reference to the project
+@type Project
 """
 pass
 def vcsSupportCommandOptions(self):
 """
 Public method to signal the support of user settable command options.
 @return flag indicating the support  of user settable command options
-(boolean)
+@rtype bool
 """
 return True
 def vcsSetOptions(self, options):
 """
 Public method used to set the options for the vcs.
 @param options a dictionary of option strings with keys as
 defined by the default options
+@type dict
 """
 if self.vcsSupportCommandOptions():
 for key in options:
 with contextlib.suppress(KeyError):
 self.options[key] = options[key]
 """
 Public method used to retrieve the options of the vcs.
 @return a dictionary of option strings that can be passed to
 vcsSetOptions.
+@rtype dict
 """
 if self.vcsSupportCommandOptions():
 return self.options
 else:
 return self.defaultOptions
 def vcsSetOtherData(self, data):
 """
 Public method used to set vcs specific data.
 @param data a dictionary of vcs specific data
+@type dict
 """
 for key in data:
 with contextlib.suppress(KeyError):
 self.otherData[key] = data[key]
 def vcsGetOtherData(self):
 """
 Public method used to retrieve vcs specific data.
 @return a dictionary of vcs specific data
+@rtype dict
 """
 return self.otherData
 def vcsSetData(self, key, value):
 """
 Public method used to set an entry in the otherData dictionary.
-@param key the key of the data (string)
+@param key the key of the data
+@type str
 @param value the value of the data
+@type Any
 """
 if key in self.interestingDataKeys:
 self.otherData[key] = value
 def vcsSetDataFromDict(self, dictionary):
 """
 Public method used to set entries in the otherData dictionary.
 @param dictionary dictionary to pick entries from
+@type dict
 """
 for key in self.interestingDataKeys:
 if key in dictionary:
 self.otherData[key] = dictionary[key]
 Public method to start a synchroneous process.
 This method starts a process and waits
 for its end while still serving the Qt event loop.
-@param proc process to start (QProcess)
+@param proc process to start
-@param program path of the executable to start (string)
+@type QProcess
-@param arguments list of arguments for the process (list of strings)
+@param program path of the executable to start
-@param workingDir working directory for the process (string)
+@type str
-@return flag indicating normal exit (boolean)
+@param arguments list of arguments for the process
+@type list of str
+@param workingDir working directory for the process
+@type str
+@return flag indicating normal exit
+@rtype bool
 """
 if proc is None:
 return False
 if workingDir:
 def splitPath(self, name):
 """
 Public method splitting name into a directory part and a file part.
-@param name path name (string)
+@param name path name
-@return a tuple of 2 strings (dirname, filename).
+@type str
+@return tuple containing the directory name and the file name
+@rtype tuple of (str, str)
 """
 if os.path.isdir(name):
 dn = os.path.abspath(name)
 fn = "."
 else:
 def splitPathList(self, names):
 """
 Public method splitting the list of names into a common directory part
 and a file list.
-@param names list of paths (list of strings)
+@param names list of paths
-@return a tuple of string and list of strings (dirname, filenamelist)
+@type list of str
+@return tuple containing the directory name and the file name list
+@rtype tuple of (str, list of str)
 """
 dname = os.path.commonprefix(names)
 if dname:
 if not dname.endswith(os.sep):
 dname = os.path.dirname(dname) + os.sep
 def addArguments(self, args, argslist):
 """
 Public method to add an argument list to the already present
 arguments.
-@param args current arguments list (list of strings)
+@param args current arguments list
-@param argslist list of arguments (list of strings)
+@type list of str
+@param argslist list of arguments
+@type list of str
 """
 for arg in argslist:
 if arg != "":
 args.append(arg)
 def startStatusMonitor(self, project):
 """
 Public method to start the VCS status monitor thread.
 @param project reference to the project object
-@return reference to the monitor thread (QThread)
+@type Project
+@return reference to the monitor thread
+@rtype QThread
 """
 vcsStatusMonitorInterval = (
 project.pudata["VCSSTATUSMONITORINTERVAL"]
 if project.pudata["VCSSTATUSMONITORINTERVAL"]
 else Preferences.getVCS("StatusMonitorInterval")
 def setStatusMonitorInterval(self, interval, project):
 """
 Public method to change the monitor interval.
-@param interval new interval in seconds (integer)
+@param interval new interval in seconds
+@type int
 @param project reference to the project object
+@type Project
 """
 if self.statusMonitorThread is not None:
 if interval == 0:
 self.stopStatusMonitor()
 else:
 def getStatusMonitorInterval(self):
 """
 Public method to get the monitor interval.
-@return interval in seconds (integer)
+@return interval in seconds
+@rtype int
 """
 if self.statusMonitorThread is not None:
 return self.statusMonitorThread.getInterval()
 else:
 return 0
 def setStatusMonitorAutoUpdate(self, auto):
 """
 Public method to enable the auto update function.
-@param auto status of the auto update function (boolean)
+@param auto status of the auto update function
+@type bool
 """
 if self.statusMonitorThread is not None:
 self.statusMonitorThread.setAutoUpdate(auto)
 def getStatusMonitorAutoUpdate(self):
 """
 Public method to retrieve the status of the auto update function.
-@return status of the auto update function (boolean)
+@return status of the auto update function
+@rtype bool
 """
 if self.statusMonitorThread is not None:
 return self.statusMonitorThread.getAutoUpdate()
 else:
 return False
 def clearStatusMonitorCachedState(self, name):
 """
 Public method to clear the cached VCS state of a file/directory.
-@param name name of the entry to be cleared (string)
+@param name name of the entry to be cleared
+@type str
 """
 if self.statusMonitorThread is not None:
 self.statusMonitorThread.clearCachedState(name)
 def _createStatusMonitorThread(self, interval, project):  # noqa: U100
 Note: This method should be overwritten in subclasses in order to
 support VCS status monitoring.
 @param interval check interval for the monitor thread in seconds
-(integer)
+@type int
 @param project reference to the project object
-@return reference to the monitor thread (QThread)
+@type Project
+@return reference to the monitor thread
+@rtype QThread
 """
 return None  # __IGNORE_WARNING_M831__

Mercurial Repositories > eric / file comparison

comparison: src/eric7/VCS/VersionControl.py

src/eric7/VCS/VersionControl.py