eric: comparison src/eric7/Plugins/VcsPlugins/vcsPySvn/subversion.py

-:2f70ca07f0af
+:4cd7e5a8b3cf
 def __init__(self, plugin, parent=None, name=None):
 """
 Constructor
 @param plugin reference to the plugin object
-@param parent parent widget (QWidget)
+@type VcsSubversionPlugin
-@param name name of this object (string)
+@param parent parent widget
+@type QWidget
+@param name name of this object
+@type str
 """
 VersionControl.__init__(self, parent, name)
 self.defaultOptions = {
 "global": [""],
 "commit": [""],
 def getPlugin(self):
 """
 Public method to get a reference to the plugin object.
-@return reference to the plugin object (VcsPySvnPlugin)
+@return reference to the plugin object
+@rtype VcsPySvnPlugin
 """
 return self.__plugin
 def getClient(self):
 """
 Public method to create and initialize the pysvn client object.
-@return the pysvn client object (pysvn.Client)
+@return the pysvn client object
+@rtype pysvn.Client
 """
 configDir = ""
 authCache = True
 for arg in self.options["global"]:
 if arg.startswith("--config-dir"):
 def vcsExists(self):
 """
 Public method used to test for the presence of the svn executable.
-@return flag indicating the existance (boolean) and an error message
+@return flag indicating the existance and an error message
-(string)
+@rtype tuple of (bool, str)
 """
 self.versionStr = ".".join([str(v) for v in pysvn.svn_version[:-1]])
 self.version = pysvn.svn_version[:-1]
 return True, ""
 The subversion repository has to be initialized from outside eric
 because the respective command always works locally. Therefore we
 always return TRUE without doing anything.
-@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 always TRUE
+@param noDialog flag indicating quiet operations
+@type bool
+@return always True
+@rtype bool
 """
 return True
 def vcsConvertProject(self, vcsDataDict, project, addAll=True):
 """
 Public method used to import the project into the Subversion
 repository.
 @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
 """
 Public method used to check the project out of the Subversion
 repository.
 @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
 """
 noDialog = False
 try:
 tag = vcsDataDict["tag"]
 except KeyError:
 """
 Public method used to export a directory from the Subversion
 repository.
 @param vcsDataDict dictionary of data required for the checkout
-@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
 """
 try:
 tag = vcsDataDict["tag"]
 except KeyError:
 tag = None
 def vcsCommit(self, name, message, noDialog=False):
 """
 Public method used to make the change of a file/directory permanent
 in the Subversion repository.
-@param name file/directory name to be committed (string or
+@param name file/directory name to be committed
-list of strings)
+@type str or list of str
-@param message message for this operation (string)
+@param message message for this operation
+@type str
 @param noDialog flag indicating quiet operations
+@type bool
 """
 from .SvnCommitDialog import SvnCommitDialog
 if not noDialog and not message:
 # call CommitDialog and get message from there
 def vcsUpdate(self, name, noDialog=False):
 """
 Public method used to update a file/directory with the Subversion
 repository.
-@param name file/directory name to be updated (string or list of
+@param name file/directory name to be updated
-strings)
+@type  (str or list of str
-@param noDialog flag indicating quiet operations (boolean)
+@param noDialog flag indicating quiet operations
-@return flag indicating, that the update contained an add
+@type bool
-or delete (boolean)
+@return flag indicating, that the update contained an add or delete
+@rtype bool
 """
 if isinstance(name, list):
 dname, fnames = self.splitPathList(name)
 else:
 dname, fname = self.splitPath(name)
 def vcsAdd(self, name, isDir=False, noDialog=False):
 """
 Public method used to add a file/directory to the Subversion
 repository.
-@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
 """
 if isinstance(name, list):
 if isDir:
 dname, fname = os.path.split(name[0])
 else:
 def vcsAddBinary(self, name, isDir=False):
 """
 Public method used to add a file/directory in binary mode to the
 Subversion repository.
-@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
 """
 self.vcsAdd(name, isDir)
 def vcsAddTree(self, path):
 """
 Public method to add a directory tree rooted at path to the Subversion
 repository.
-@param path root directory of the tree to be added (string or list of
+@param path root directory of the tree to be added
-strings))
+@type str or list of str
 """
 tree = []
 if isinstance(path, list):
 dname, fnames = self.splitPathList(path)
 for n in path:
 Public method used to remove a file/directory from the Subversion
 repository.
 The default operation is to remove the local copy as well.
-@param name file/directory name to be removed (string or list of
+@param name file/directory name to be removed
-strings))
+@type str or list of str
-@param project flag indicating deletion of a project tree (boolean)
+@param project flag indicating deletion of a project tree
-(not needed)
+@type bool
 @param noDialog flag indicating quiet operations
-@return flag indicating successfull operation (boolean)
+@type bool
+@return flag indicating successfull operation
+@rtype bool
 """
 if not isinstance(name, list):
 name = [name]
 opts = self.options["global"] + self.options["remove"]
 force = "--force" in opts or noDialog
 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
 """
 from .SvnCopyDialog import SvnCopyDialog
 rx_prot = re.compile("(file:|svn:|svn+ssh:|http:|https:).+")
 opts = self.options["global"]
 If name is a directory and is the project directory, all project files
 are saved first. If name is a file (or list of files), which is/are
 being edited and has unsaved modification, they can be saved or the
 operation may be aborted.
-@param name file/directory name to be diffed (string)
+@param name file/directory name to be diffed
+@type str
 """
 from .SvnDiffDialog import SvnDiffDialog
 names = name[:] if isinstance(name, list) else [name]
 for nam in names:
 """
 Public method used to view the status of files/directories in the
 Subversion repository.
 @param name file/directory name(s) to show the status of
-(string or list of strings)
+@type str or list of str
 """
 from .SvnStatusDialog import SvnStatusDialog
 if self.status is None:
 self.status = SvnStatusDialog(self)
 def vcsTag(self, name):
 """
 Public method used to set the tag of a file/directory in the
 Subversion repository.
-@param name file/directory name to be tagged (string)
+@param name file/directory name to be tagged
+@type str
 """
 from .SvnTagDialog import SvnTagDialog
 dname, fname = self.splitPath(name)
 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
-@return flag indicating, that the switch contained an add
+@type str
-or delete (boolean)
+@return flag indicating, that the switch contained an add or delete
+@rtype bool
 """
 from .SvnSwitchDialog import SvnSwitchDialog
 dname, fname = self.splitPath(name)
 def vcsMerge(self, name):
 """
 Public method used to merge a URL/revision into the local project.
-@param name file/directory name to be merged (string)
+@param name file/directory name to be merged
+@type str
 """
 from .SvnMergeDialog import SvnMergeDialog
 dname, fname = self.splitPath(name)
 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
-@return a combination of canBeCommited and canBeAdded
+@type str
+@return registered state (one of canBeCommited and canBeAdded)
+@rtype int
 """
 if self.__wcng:
 return self.__vcsRegisteredState_wcng(name)
 else:
 return self.__vcsRegisteredState_wc(name)
 Private method used to get the registered state of a file in the vcs.
 This is the variant for subversion installations using the new
 working copy meta-data format.
-@param name filename to check (string)
+@param name filename to check
-@return a combination of canBeCommited and canBeAdded
+@type str
+@return registered state (one of canBeCommited and canBeAdded)
+@rtype int
 """
 if name.endswith(os.sep):
 name = name[:-1]
 name = os.path.normcase(name)
 dname, fname = self.splitPath(name)
 Private method used to get the registered state of a file in the vcs.
 This is the variant for subversion installations using the old working
 copy meta-data format.
-@param name filename to check (string)
+@param name filename to check
-@return a combination of canBeCommited and canBeAdded
+@type str
+@return registered state (one of canBeCommited and canBeAdded)
+@rtype int
 """
 dname, fname = self.splitPath(name)
 if fname == ".":
 if os.path.isdir(os.path.join(dname, self.adminDir)):
 <b>Note:</b> If a shortcut is to be taken, the code will only check,
 if the named directory has been scanned already. If so, it is assumed,
 that the states for all files has been populated by the previous run.
 @param names dictionary with all filenames to be checked as keys
-@param dname directory to check in (string)
+@type dict
-@param shortcut flag indicating a shortcut should be taken (boolean)
+@param dname directory to check in
+@type str
+@param shortcut flag indicating a shortcut should be taken
+@type bool
 @return the received dictionary completed with a combination of
 canBeCommited and canBeAdded or None in order to signal an error
+@rtype dict
 """
 if self.__wcng:
 return self.__vcsAllRegisteredStates_wcng(names, dname, shortcut)
 else:
 return self.__vcsAllRegisteredStates_wc(names, dname, shortcut)
 <b>Note:</b> If a shortcut is to be taken, the code will only check,
 if the named directory has been scanned already. If so, it is assumed,
 that the states for all files has been populated by the previous run.
 @param names dictionary with all filenames to be checked as keys
-@param dname directory to check in (string)
+@type dict
-@param shortcut flag indicating a shortcut should be taken (boolean)
+@param dname directory to check in
+@type str
+@param shortcut flag indicating a shortcut should be taken
+@type bool
 @return the received dictionary completed with a combination of
 canBeCommited and canBeAdded or None in order to signal an error
+@rtype dict
 """
 from .SvnDialogMixin import SvnDialogMixin
 if dname.endswith(os.sep):
 dname = dname[:-1]
 <b>Note:</b> If a shortcut is to be taken, the code will only check,
 if the named directory has been scanned already. If so, it is assumed,
 that the states for all files has been populated by the previous run.
 @param names dictionary with all filenames to be checked as keys
-@param dname directory to check in (string)
+@type dict
-@param shortcut flag indicating a shortcut should be taken (boolean)
+@param dname directory to check in
+@type str
+@param shortcut flag indicating a shortcut should be taken
+@type bool
 @return the received dictionary completed with a combination of
 canBeCommited and canBeAdded or None in order to signal an error
+@rtype dict
 """
 from .SvnDialogMixin import SvnDialogMixin
 if not os.path.isdir(os.path.join(dname, self.adminDir)):
 # not under version control -> do nothing
 def __isVersioned(self, status):
 """
 Private method to check, if the given status indicates a
 versioned state.
-@param status status object to check (pysvn.PysvnStatus)
+@param status status object to check
-@return flag indicating a versioned state (boolean)
+@type pysvn.PysvnStatus
+@return flag indicating a versioned state
+@rtype bool
 """
 return status["text_status"] in [
 pysvn.wc_status_kind.normal,
 pysvn.wc_status_kind.added,
 pysvn.wc_status_kind.missing,
 Public method to initialize the VCS configuration.
 This method ensures, that eric specific files and directories are
 ignored.
-@param project reference to the project (Project)
+@param project reference to the project
+@type Project
 """
 configPath = getConfigPath()
 if os.path.exists(configPath):
 amendConfig()
 else:
 def vcsName(self):
 """
 Public method returning the name of the vcs.
-@return always 'Subversion' (string)
+@return always 'Subversion'
+@rtype str
 """
 return "Subversion"
 def vcsCleanup(self, name):
 """
 Public method used to cleanup the working copy.
-@param name directory name to be cleaned up (string)
+@param name directory name to be cleaned up
+@type str
 """
 client = self.getClient()
 dlg = SvnDialog(
 self.tr("Cleaning up {0}").format(name), "cleanup {0}".format(name), client
 )
 def vcsCommandLine(self, name):
 """
 Public method used to execute arbitrary subversion commands.
-@param name directory name of the working directory (string)
+@param name directory name of the working directory
+@type str
 """
 from eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog import (
 SvnDialog as SvnProcessDialog,
 )
 ):
 """
 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
-@return reference to the instantiated options dialog (SvnOptionsDialog)
+@type QWidget
+@return reference to the instantiated options dialog
+@rtype SvnOptionsDialog
 """
 from .SvnOptionsDialog import SvnOptionsDialog
 return SvnOptionsDialog(self, project, parent)
 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
 @return reference to the instantiated options dialog
-(SvnNewProjectOptionsDialog)
+@rtype SvnNewProjectOptionsDialog
 """
 from .SvnNewProjectOptionsDialog import SvnNewProjectOptionsDialog
 return SvnNewProjectOptionsDialog(self, parent)
 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
 """
 try:
 entry = self.getClient().info(ppath)
 except pysvn.ClientError as e:
 return e.args[0]
 def svnGetReposName(self, path):
 """
 Public method used to retrieve the URL of the subversion repository
 path.
-@param path local path to get the svn repository path for (string)
+@param path local path to get the svn repository path for
+@type str
 @return string with the repository path URL
+@rtype str
 """
 client = pysvn.Client()
 try:
 with EricMutexLocker(self.vcsExecutionMutex):
 entry = client.info(path)
 def vcsResolved(self, name):
 """
 Public method used to resolve conflicts of a file/directory.
-@param name file/directory name to be resolved (string)
+@param name file/directory name to be resolved
+@type str
 """
 if isinstance(name, list):
 dname, fnames = self.splitPathList(name)
 else:
 dname, fname = self.splitPath(name)
 def svnCopy(self, name, project):
 """
 Public method used to copy a file/directory.
-@param name file/directory name to be copied (string)
+@param name file/directory name to be copied
+@type str
 @param project reference to the project object
-@return flag indicating successfull operation (boolean)
+@type Project
+@return flag indicating successfull operation
+@rtype bool
 """
 from .SvnCopyDialog import SvnCopyDialog
 rx_prot = re.compile("(file:|svn:|svn+ssh:|http:|https:).+")
 dlg = SvnCopyDialog(name)
 def svnListProps(self, name, recursive=False):
 """
 Public method used to list the properties of a file/directory.
-@param name file/directory name (string or list of strings)
+@param name file/directory name
+@type str or list of str
 @param recursive flag indicating a recursive list is requested
+@type bool
 """
 from .SvnPropListDialog import SvnPropListDialog
 if self.propList is None:
 self.propList = SvnPropListDialog(self)
 def svnSetProp(self, name, recursive=False):
 """
 Public method used to add a property to a file/directory.
-@param name file/directory name (string or list of strings)
+@param name file/directory name
+@type str or list of str
 @param recursive flag indicating a recursive set is requested
+@type bool
 """
 from .SvnPropSetDialog import SvnPropSetDialog
 dlg = SvnPropSetDialog(recursive)
 if dlg.exec() == QDialog.DialogCode.Accepted:
 def svnDelProp(self, name, recursive=False):
 """
 Public method used to delete a property of a file/directory.
-@param name file/directory name (string or list of strings)
+@param name file/directory name
+@type str or list of str
 @param recursive flag indicating a recursive list is requested
+@type bool
 """
 from .SvnPropDelDialog import SvnPropDelDialog
 dlg = SvnPropDelDialog(recursive)
 if dlg.exec() == QDialog.DialogCode.Accepted:
 def svnListTagBranch(self, path, tags=True):
 """
 Public method used to list the available tags or branches.
-@param path directory name of the project (string)
+@param path directory name of the project
+@type str
 @param tags flag indicating listing of branches or tags
 (False = branches, True = tags)
+@type bool
 """
 from .SvnTagBranchListDialog import SvnTagBranchListDialog
 if self.tagbranchList is None:
 self.tagbranchList = SvnTagBranchListDialog(self)
 def svnBlame(self, name):
 """
 Public method to show the output of the svn blame command.
-@param name file name to show the blame for (string)
+@param name file name to show the blame for
+@type str
 """
 from .SvnBlameDialog import SvnBlameDialog
 if self.blame is None:
 self.blame = SvnBlameDialog(self)
 being edited and has unsaved modification, they can be saved or the
 operation may be aborted.
 This method gives the chance to enter the revisions to be compared.
-@param name file/directory name to be diffed (string)
+@param name file/directory name to be diffed
+@type str
 """
 from .SvnDiffDialog import SvnDiffDialog
 from .SvnRevisionSelectionDialog import SvnRevisionSelectionDialog
 names = name[:] if isinstance(name, list) else [name]
 being edited and has unsaved modification, they can be saved or the
 operation may be aborted.
 This method gives the chance to enter the revisions to be compared.
-@param name file/directory name to be diffed (string)
+@param name file/directory name to be diffed
+@type str
 """
 from .SvnDiffDialog import SvnDiffDialog
 from .SvnUrlSelectionDialog import SvnUrlSelectionDialog
 names = name[:] if isinstance(name, list) else [name]
 def __svnGetFileForRevision(self, name, rev=""):
 """
 Private method to get a file for a specific revision from the
 repository.
-@param name file name to get from the repository (string)
+@param name file name to get from the repository
-@param rev revision to retrieve (integer or string)
+@type str
-@return contents of the file (string) and an error message (string)
+@param rev revision to retrieve
+@type int or str
+@return contents of the file (string) and an error message
+@rtype str
 """
 output = ""
 error = ""
 client = self.getClient()
 def vcsSbsDiff(self, name, extended=False, revisions=None):
 """
 Public method used to view the difference of a file to the Mercurial
 repository side-by-side.
-@param name file name to be diffed (string)
+@param name file name to be diffed
-@param extended flag indicating the extended variant (boolean)
+@type str
-@param revisions tuple of two revisions (tuple of strings)
+@param extended flag indicating the extended variant
+@type bool
+@param revisions tuple of two revisions
+@type tuple of (str, str)
 @exception ValueError raised to indicate an invalid name parameter type
 """
 from eric7.UI.CompareDialog import CompareDialog
 from .SvnRevisionSelectionDialog import SvnRevisionSelectionDialog
 def vcsLogBrowser(self, name, isFile=False):
 """
 Public method used to browse the log of a file/directory from the
 Subversion repository.
-@param name file/directory name to show the log of (string)
+@param name file/directory name to show the log of
-@param isFile flag indicating log for a file is to be shown (boolean)
+@type str
+@param isFile flag indicating log for a file is to be shown
+@type bool
 """
 from .SvnLogBrowserDialog import SvnLogBrowserDialog
 if self.logBrowser is None:
 self.logBrowser = SvnLogBrowserDialog(self)
 def svnLock(self, name, stealIt=False, parent=None):
 """
 Public method used to lock a file in the Subversion repository.
-@param name file/directory name to be locked (string or list of
+@param name file/directory name to be locked
-strings)
+@type str or list of str
-@param stealIt flag indicating a forced operation (boolean)
+@param stealIt flag indicating a forced operation
+@type bool
 @param parent reference to the parent object of the subversion dialog
-(QWidget)
+@type QWidget
 """
 comment, ok = QInputDialog.getText(
 None,
 self.tr("Subversion Lock"),
 self.tr("Enter lock comment"),
 def svnUnlock(self, name, breakIt=False, parent=None):
 """
 Public method used to unlock a file in the Subversion repository.
-@param name file/directory name to be unlocked (string or list of
+@param name file/directory name to be unlocked
-strings)
+@type str or list of str
-@param breakIt flag indicating a forced operation (boolean)
+@param breakIt flag indicating a forced operation
+@type bool
 @param parent reference to the parent object of the subversion dialog
-(QWidget)
+@type QWidget
 """
 if isinstance(name, list):
 dname, fnames = self.splitPathList(name)
 else:
 dname, fname = self.splitPath(name)
 def svnInfo(self, projectPath, name):
 """
 Public method to show repository information about a file or directory.
-@param projectPath path name of the project (string)
+@param projectPath path name of the project
-@param name file/directory name relative to the project (string)
+@type str
+@param name file/directory name relative to the project
+@type str
 """
 from .SvnInfoDialog import SvnInfoDialog
 dlg = SvnInfoDialog(self)
 dlg.start(projectPath, name)
 def svnRelocate(self, projectPath):
 """
 Public method to relocate the working copy to a new repository URL.
-@param projectPath path name of the project (string)
+@param projectPath path name of the project
+@type str
 """
 from .SvnRelocateDialog import SvnRelocateDialog
 currUrl = self.svnGetReposName(projectPath)
 dlg = SvnRelocateDialog(currUrl)
 def svnRepoBrowser(self, projectPath=None):
 """
 Public method to open the repository browser.
-@param projectPath path name of the project (string)
+@param projectPath path name of the project
+@type str
 """
 from .SvnRepoBrowserDialog import SvnRepoBrowserDialog
 url = self.svnGetReposName(projectPath) if projectPath else None
 if url is None:
 Public method to remove a file or directory from its changelist.
 Note: Directories will be removed recursively.
 @param names name or list of names of file or directory to remove
-(string)
+@type str or list of str
 """
 if not isinstance(names, list):
 names = [names]
 client = self.getClient()
 dlg = SvnDialog(
 Public method to add a file or directory to a changelist.
 Note: Directories will be added recursively.
 @param names name or list of names of file or directory to add
-(string)
+@type str or list of str
 """
 if not isinstance(names, list):
 names = [names]
 clname, ok = QInputDialog.getItem(
 def svnShowChangelists(self, path):
 """
 Public method used to inspect the change lists defined for the project.
-@param path directory name to show change lists for (string)
+@param path directory name to show change lists for
+@type str
 """
 from .SvnChangeListsDialog import SvnChangeListsDialog
 self.changeLists = SvnChangeListsDialog(self)
 self.changeLists.show()
 def svnGetChangelists(self):
 """
 Public method to get a list of all defined change lists.
-@return list of defined change list names (list of strings)
+@return list of defined change list names
+@rtype list of str
 """
 changelists = []
 client = self.getClient()
 if hasattr(client, "get_changelist"):
 ppath = ericApp().getObject("Project").getProjectPath()
 def svnUpgrade(self, path):
 """
 Public method to upgrade the working copy format.
-@param path directory name to show change lists for (string)
+@param path directory name to show change lists for
+@type str
 """
 client = self.getClient()
 dlg = SvnDialog(self.tr("Upgrade"), "upgrade {0}".format(path), client)
 QApplication.processEvents()
 try:
 def __svnURL(self, url):
 """
 Private method to format a url for subversion.
-@param url unformatted url string (string)
+@param url unformatted url string
-@return properly formated url for subversion (string)
+@type str
+@return properly formated url for subversion
+@rtype str
 """
 url = self.svnNormalizeURL(url)
 url = url.split(":", 2)
 if len(url) == 3:
 scheme = url[0]
 def svnNormalizeURL(self, url):
 """
 Public method to normalize a url for subversion.
-@param url url string (string)
+@param url url string
-@return properly normalized url for subversion (string)
+@type str
+@return properly normalized url for subversion
+@rtype str
 """
 protocol, url = url.split("://", 1)
 if url.startswith("\\\\"):
 url = url[2:]
 if protocol == "file":
 """
 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 SvnProjectBrowserHelper
 """
 from .ProjectBrowserHelper import SvnProjectBrowserHelper
 return SvnProjectBrowserHelper(self, browser, project, isTranslationsBrowser)
 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 PySvnProjectHelper
 """
 helper = self.__plugin.getProjectHelper()
 helper.setObjects(self, project)
 self.__wcng = (
 os.path.exists(os.path.join(project.getProjectPath(), ".svn", "format"))
 """
 Protected method to create an instance of the VCS status monitor
 thread.
 @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 SvnStatusMonitorThread
 """
 from .SvnStatusMonitorThread import SvnStatusMonitorThread
 return SvnStatusMonitorThread(interval, project, self)

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/VcsPlugins/vcsPySvn/subversion.py

src/eric7/Plugins/VcsPlugins/vcsPySvn/subversion.py