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

-:2f70ca07f0af
+:4cd7e5a8b3cf
 def __init__(self, vcs, parent=None):
 """
 Constructor
 @param vcs reference to the vcs object
-@param parent parent widget (QWidget)
+@type Subversion
+@param parent parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 SvnDialogMixin.__init__(self)
 path,
 ):
 """
 Private method to generate a status item in the status list.
-@param changelist name of the changelist (string)
+@param changelist name of the changelist
-@param status text status (pysvn.wc_status_kind)
+@type str
-@param propStatus property status (pysvn.wc_status_kind)
+@param status text status
-@param locked locked flag (boolean)
+@type pysvn.wc_status_kind
-@param history history flag (boolean)
+@param propStatus property status
-@param switched switched flag (boolean)
+@type pysvn.wc_status_kind
-@param lockinfo lock indicator (string)
+@param locked locked flag
-@param uptodate up to date flag (boolean)
+@type bool
-@param revision revision (integer)
+@param history history flag
-@param change revision of last change (integer)
+@type bool
-@param author author of the last change (string)
+@param switched switched flag
-@param path path of the file or directory (string)
+@type bool
+@param lockinfo lock indicator
+@type str
+@param uptodate up to date flag
+@type bool
+@param revision revision
+@type int
+@param change revision of last change
+@type int
+@param author author of the last change
+@type str
+@param path path of the file or directory
+@type str
 """
 statusText = self.tr(svnStatusMap[status])
 itm = QTreeWidgetItem(self.statusList)
 itm.setData(0, Qt.ItemDataRole.DisplayRole, "")
 itm.setData(1, Qt.ItemDataRole.DisplayRole, changelist)
 def start(self, fn):
 """
 Public slot to start the svn status command.
 @param fn filename(s)/directoryname(s) to show the status of
-(string or list of strings)
+@type str or list of str
 """
 self.errorGroup.hide()
 for act in self.menuactions:
 act.setEnabled(False)
 cwd = os.getcwd()
 os.chdir(self.dname)
 try:
 with EricMutexLocker(self.vcs.vcsExecutionMutex):
 for name in fnames:
-# step 1: determine changelists and their files
+# step 1: determine change lists and their files
 changelistsDict = {}
 if hasattr(self.client, "get_changelist"):
 if recurse:
 depth = pysvn.depth.infinity
 else:
 def on_buttonBox_clicked(self, button):
 """
 Private slot called by a button of the button box clicked.
-@param button button that was clicked (QAbstractButton)
+@param button button that was clicked
+@type QAbstractButton
 """
 if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close):
 self.close()
 elif button == self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel):
 self.__finish()
 def __showError(self, msg):
 """
 Private slot to show an error message.
-@param msg error message to show (string)
+@param msg error message to show
+@type str
 """
 self.errorGroup.show()
 self.errors.insertPlainText(msg)
 self.errors.ensureCursorVisible()
 @pyqtSlot(QTreeWidgetItem, int)
 def on_statusList_itemChanged(self, item, column):
 """
 Private slot to act upon item changes.
-@param item reference to the changed item (QTreeWidgetItem)
+@param item reference to the changed item
-@param column index of column that changed (integer)
+@type QTreeWidgetItem
+@param column index of column that changed
+@type int
 """
 if column == self.__toBeCommittedColumn:
 self.__updateCommitButton()
 @pyqtSlot()
 def __showContextMenu(self, coord):
 """
 Private slot to show the context menu of the status list.
-@param coord the position of the mouse pointer (QPoint)
+@param coord the position of the mouse pointer
+@type QPoint
 """
 self.menu.popup(self.statusList.mapToGlobal(coord))
 def __commit(self):
 """
 self.vcs.svnAddToChangelist(names)
 self.on_refreshButton_clicked()
 def __removeFromChangelist(self):
 """
-Private slot to remove entries from their changelists.
+Private slot to remove entries from their change lists.
 """
 names = [
 os.path.join(self.dname, itm.text(self.__pathColumn))
 for itm in self.__getChangelistItems()
 ]
 def __getCommitableItems(self):
 """
 Private method to retrieve all entries the user wants to commit.
 @return list of all items, the user has checked
+@rtype list of QTreeWidgetItem
 """
 commitableItems = []
 for index in range(self.statusList.topLevelItemCount()):
 itm = self.statusList.topLevelItem(index)
 if itm.checkState(self.__toBeCommittedColumn) == Qt.CheckState.Checked:
 def __getModifiedItems(self):
 """
 Private method to retrieve all entries, that have a modified status.
 @return list of all items with a modified status
+@rtype list of QTreeWidgetItem
 """
 modifiedItems = []
 for itm in self.statusList.selectedItems():
 if (
 itm.text(self.__statusColumn) in self.modifiedIndicators
 """
 Private method to retrieve all entries, that have an
 unversioned status.
 @return list of all items with an unversioned status
+@rtype list of QTreeWidgetItem
 """
 unversionedItems = []
 for itm in self.statusList.selectedItems():
 if itm.text(self.__statusColumn) in self.unversionedIndicators:
 unversionedItems.append(itm)
 def __getMissingItems(self):
 """
 Private method to retrieve all entries, that have a missing status.
 @return list of all items with a missing status
+@rtype list of QTreeWidgetItem
 """
 missingItems = []
 for itm in self.statusList.selectedItems():
 if itm.text(self.__statusColumn) in self.missingIndicators:
 missingItems.append(itm)
 def __getLockActionItems(self, indicators):
 """
 Private method to retrieve all entries, that have a locked status.
-@param indicators list of indicators to check against (list of strings)
+@param indicators list of indicators to check against
+@type list of str
 @return list of all items with a locked status
+@rtype list of QTreeWidgetItem
 """
 lockitems = []
 for itm in self.statusList.selectedItems():
 if itm.text(self.__lockinfoColumn) in indicators:
 lockitems.append(itm)
 """
 Private method to retrieve all entries, that are members of
 a changelist.
 @return list of all items belonging to a changelist
+@rtype list of QTreeWidgetItem
 """
 clitems = []
 for itm in self.statusList.selectedItems():
 if itm.text(self.__changelistColumn):
 clitems.append(itm)
 """
 Private method to retrieve all entries, that are not members of
 a changelist.
 @return list of all items not belonging to a changelist
+@rtype list of QTreeWidgetItem
 """
 clitems = []
 for itm in self.statusList.selectedItems():
 if not itm.text(self.__changelistColumn):
 clitems.append(itm)
 def __commitSelect(self, selected):
 """
 Private slot to select or deselect all entries.
-@param selected commit selection state to be set (boolean)
+@param selected commit selection state to be set
+@type bool
 """
 for index in range(self.statusList.topLevelItemCount()):
 itm = self.statusList.topLevelItem(index)
 if (
 itm.flags() & Qt.ItemFlag.ItemIsUserCheckable

Mercurial Repositories > eric / file comparison

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

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