eric: comparison src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusDialog.py

-:2f70ca07f0af
+:4cd7e5a8b3cf
 def __init__(self, vcs, parent=None):
 """
 Constructor
 @param vcs reference to the vcs object
-@param parent parent widget (QWidget)
+@type Git
+@param parent parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 self.__toBeCommittedColumn = 0
 def closeEvent(self, e):
 """
 Protected slot implementing a close event handler.
-@param e close event (QCloseEvent)
+@param e close event
+@type QCloseEvent
 """
 if (
 self.process is not None
 and self.process.state() != QProcess.ProcessState.NotRunning
 ):
 def __generateItem(self, status, path):
 """
 Private method to generate a status item in the status list.
-@param status status indicator (string)
+@param status status indicator
-@param path path of the file or directory (string)
+@type str
+@param path path of the file or directory
+@type str
 """
 statusWorkText = self.status[status[1]]
 statusIndexText = self.status[status[0]]
 itm = QTreeWidgetItem(
 self.statusList,
 def start(self, fn):
 """
 Public slot to start the git 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()
 self.intercept = False
 self.args = fn
 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()
 @pyqtSlot(int, QProcess.ExitStatus)
 def __procFinished(self, exitCode, exitStatus):
 """
 Private slot connected to the finished signal.
-@param exitCode exit code of the process (integer)
+@param exitCode exit code of the process
-@param exitStatus exit status of the process (QProcess.ExitStatus)
+@type int
+@param exitStatus exit status of the process
+@type QProcess.ExitStatus
 """
 self.__finish()
 def __readStdout(self):
 """
 def on_passwordCheckBox_toggled(self, isOn):
 """
 Private slot to handle the password checkbox toggled.
-@param isOn flag indicating the status of the check box (boolean)
+@param isOn flag indicating the status of the check box
+@type bool
 """
 if isOn:
 self.input.setEchoMode(QLineEdit.EchoMode.Password)
 else:
 self.input.setEchoMode(QLineEdit.EchoMode.Normal)
 def keyPressEvent(self, evt):
 """
 Protected slot to handle a key press event.
-@param evt the key press event (QKeyEvent)
+@param evt the key press event
+@type QKeyEvent
 """
 if self.intercept:
 self.intercept = False
 evt.accept()
 return
 def __commit(self, amend=False):
 """
 Private slot to handle the Commit context menu entry.
-@param amend flag indicating to perform an amend operation (boolean)
+@param amend flag indicating to perform an amend operation
+@type bool
 """
 names = [
 os.path.join(self.dname, itm.text(self.__pathColumn))
 for itm in self.__getCommitableItems()
 ]
 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:
 """
 Private method to retrieve all entries the user may commit but hasn't
 selected.
 @return list of all items, the user has not checked
+@rtype list of QTreeWidgetItem
 """
 items = []
 for index in range(self.statusList.topLevelItemCount()):
 itm = self.statusList.topLevelItem(index)
 if (
 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.__statusWorkColumn) in self.modifiedIndicators
 def __getModifiedOnlyItems(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.__statusWorkColumn) in self.modifiedOnlyIndicators
 """
 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.__statusWorkColumn) in self.unversionedIndicators:
 unversionedItems.append(itm)
 """
 Private method to retrieve all entries, that have a stageable
 status.
 @return list of all items with a stageable status
+@rtype list of QTreeWidgetItem
 """
 stageableItems = []
 for itm in self.statusList.selectedItems():
 if (
 itm.text(self.__statusWorkColumn)
 """
 Private method to retrieve all entries, that have an unstageable
 status.
 @return list of all items with an unstageable status
+@rtype list of QTreeWidgetItem
 """
 unstageableItems = []
 for itm in self.statusList.selectedItems():
 if itm.text(self.__statusIndexColumn) in self.modifiedIndicators:
 unstageableItems.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.__statusWorkColumn) in self.missingIndicators:
 missingItems.append(itm)
 def __getConflictingItems(self):
 """
 Private method to retrieve all entries, that have a conflict status.
 @return list of all items with a conflict status
+@rtype list of QTreeWidgetItem
 """
 conflictingItems = []
 for itm in self.statusList.selectedItems():
 if itm.data(0, self.ConflictRole):
 conflictingItems.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
 def __showLDiffContextMenu(self, coord):
 """
 Private slot to show the context menu of the status list.
-@param coord position of the mouse pointer (QPoint)
+@param coord position of the mouse pointer
+@type QPoint
 """
 if bool(self.lDiffEdit.toPlainText()):
 cursor = self.lDiffEdit.textCursor()
 if cursor.hasSelection():
 self.__stageLinesAct.setEnabled(True)
 def __showRDiffContextMenu(self, coord):
 """
 Private slot to show the context menu of the status list.
-@param coord position of the mouse pointer (QPoint)
+@param coord position of the mouse pointer
+@type QPoint
 """
 if bool(self.rDiffEdit.toPlainText()):
 cursor = self.rDiffEdit.textCursor()
 if cursor.hasSelection():
 self.__unstageLinesAct.setEnabled(True)
 def __selectedLinesIndexes(self, diffEdit):
 """
 Private method to extract the indexes of the selected lines.
-@param diffEdit reference to the edit widget (QTextEdit)
+@param diffEdit reference to the edit widget
-@return tuple of start and end indexes (integer, integer)
+@type QTextEdit
+@return tuple of start and end indexes
+@rtype tuple of (int, int)
 """
 cursor = diffEdit.textCursor()
 selectionStart = cursor.selectionStart()
 selectionEnd = cursor.selectionEnd()
 def __tmpPatchFileName(self):
 """
 Private method to generate a temporary patch file.
-@return name of the temporary file (string)
+@return name of the temporary file
+@rtype str
 """
 prefix = "eric-git-{0}-".format(os.getpid())
 suffix = "-patch"
 fd, path = tempfile.mkstemp(suffix, prefix)
 os.close(fd)

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusDialog.py

src/eric7/Plugins/VcsPlugins/vcsGit/GitStatusDialog.py