eric: comparison src/eric7/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py

-:2f70ca07f0af
+:4cd7e5a8b3cf
 def closeEvent(self, e):
 """
 Protected slot implementing a close event handler.
-@param e close event (QCloseEvent)
+@param e close event
+@type QCloseEvent
 """
 if self.__hgClient.isExecuting():
 self.__hgClient.cancel()
 self.vcs.getPlugin().setPreferences("LogBrowserGeometry", self.saveGeometry())
 def __branchColor(self, branchName):
 """
 Private method to calculate a color for a given branch name.
-@param branchName name of the branch (string)
+@param branchName name of the branch
-@return name of the color to use (string)
+@type str
+@return name of the color to use
+@rtype str
 """
 if branchName not in self.__branchColors:
 self.__branchColors[branchName] = self.__getColor(len(self.__branchColors))
 return self.__branchColors[branchName]
 def __generateEdges(self, rev, parents):
 """
 Private method to generate edge info for the give data.
-@param rev revision to calculate edge info for (integer)
+@param rev revision to calculate edge info for
-@param parents list of parent revisions (list of integers)
+@type int
+@param parents list of parent revisions
+@type list of int
 @return tuple containing the column and color index for
 the given node and a list of tuples indicating the edges
 between the given node and its parents
-(integer, integer, [(integer, integer, integer), ...])
+@rtype tuple of (int, int, [(int, int, int), ...])
 """
 if rev not in self.__revs:
 # new head
 self.__revs.append(rev)
 self.__revColors[rev] = self.__revColor
 def col2x(col, radius):
 """
 Local function to calculate a x-position for a column.
-@param col column number (integer)
+@param col column number
-@param radius radius of the indicator circle (integer)
+@type int
+@param radius radius of the indicator circle
+@type int
 """
 return int(1.2 * radius) * col + radius // 2 + 3
 textColor = self.logTree.palette().color(QPalette.ColorRole.Text)
 def __getParents(self, rev):
 """
 Private method to get the parents of the currently viewed
 file/directory.
-@param rev revision number to get parents for (string)
+@param rev revision number to get parents for
-@return list of parent revisions (list of integers)
+@type str
+@return list of parent revisions
+@rtype list of int
 """
 errMsg = ""
 parents = [-1]
 if int(rev) > 0:
 def __getLogEntries(self, startRev=None, noEntries=0):
 """
 Private method to retrieve log entries from the repository.
-@param startRev revision number to start from (integer, string)
+@param startRev revision number to start from
-@param noEntries number of entries to get (0 = default) (int)
+@type int or str
+@param noEntries number of entries to get (0 = default)
+@type int
 """
 self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(False)
 self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setEnabled(True)
 self.buttonBox.button(QDialogButtonBox.StandardButton.Cancel).setDefault(True)
 QApplication.processEvents()
 def __modifyForLargeFiles(self, filename):
 """
 Private method to convert the displayed file name for a large file.
-@param filename file name to be processed (string)
+@param filename file name to be processed
-@return processed file name (string)
+@type str
+@return processed file name
+@rtype str
 """
 if filename.startswith((self.LargefilesCacheL, self.LargefilesCacheW)):
 return self.tr("{0} (large file)").format(
 self.PathSeparatorRe.split(filename, 1)[1]
 )
 def __showError(self, out):
 """
 Private slot to show some error.
-@param out error to be shown (string)
+@param out error to be shown
+@type str
 """
 self.errorGroup.show()
 self.errors.insertPlainText(out)
 self.errors.ensureCursorVisible()
 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.cancelled = True
 @pyqtSlot(QTreeWidgetItem, QTreeWidgetItem)
 def on_logTree_currentItemChanged(self, current, previous):
 """
 Private slot called, when the current item of the log tree changes.
-@param current reference to the new current item (QTreeWidgetItem)
+@param current reference to the new current item
-@param previous reference to the old current item (QTreeWidgetItem)
+@type QTreeWidgetItem
+@param previous reference to the old current item
+@type QTreeWidgetItem
 """
 self.__updateToolMenuActions()
 # Highlight the current entry using a bold font
 for col in range(self.logTree.columnCount()):
 @pyqtSlot(QDate)
 def on_fromDate_dateChanged(self, date):
 """
 Private slot called, when the from date changes.
-@param date new date (QDate)
+@param date new date
+@type QDate
 """
 if self.__actionMode() == "filter":
 self.__filterLogs()
 @pyqtSlot(QDate)
 def on_toDate_dateChanged(self, date):
 """
 Private slot called, when the from date changes.
-@param date new date (QDate)
+@param date new date
+@type QDate
 """
 if self.__actionMode() == "filter":
 self.__filterLogs()
 @pyqtSlot(int)
 @pyqtSlot(str)
 def on_rxEdit_textChanged(self, txt):
 """
 Private slot called, when a filter expression is entered.
-@param txt filter expression (string)
+@param txt filter expression
+@type str
 """
 if self.__actionMode() == "filter":
 self.__filterLogs()
 elif self.__actionMode() == "find":
 self.__findItem(self.__findBackwards, interactive=True)
 def __prepareFieldSearch(self):
 """
 Private slot to prepare the filed search data.
 @return tuple of field index, search expression and flag indicating
-that the field index is a data role (integer, string, boolean)
+that the field index is a data role
+@rtype tuple of (int, str, bool)
 """
 indexIsRole = False
 txt = self.fieldCombo.itemData(self.fieldCombo.currentIndex())
 if txt == "author":
 fieldIndex = self.AuthorColumn
 @pyqtSlot(bool)
 def on_stopCheckBox_clicked(self, checked):
 """
 Private slot called, when the stop on copy/move checkbox is clicked.
-@param checked flag indicating the state of the check box (boolean)
+@param checked flag indicating the state of the check box
+@type bool
 """
 self.vcs.getPlugin().setPreferences(
 "StopLogOnCopy", self.stopCheckBox.isChecked()
 )
 self.nextButton.setEnabled(True)
 def __actionMode(self):
 """
 Private method to get the selected action mode.
-@return selected action mode (string, one of filter or find)
+@return selected action mode (one of 'filter' or 'find')
+@rtype str
 """
 return self.modeComboBox.itemData(self.modeComboBox.currentIndex())
 @pyqtSlot(int)
 def on_modeComboBox_currentIndexChanged(self, index):
 """
 Private slot to react on mode changes.
-@param index index of the selected entry (integer)
+@param index index of the selected entry
+@type int
 """
 mode = self.modeComboBox.itemData(index)
 findMode = mode == "find"
 filterMode = mode == "filter"
 def __findItem(self, backwards=False, interactive=False):
 """
 Private slot to find an item matching the entered criteria.
-@param backwards flag indicating to search backwards (boolean)
+@param backwards flag indicating to search backwards
-@param interactive flag indicating an interactive search (boolean)
+@type bool
+@param interactive flag indicating an interactive search
+@type bool
 """
 self.__findBackwards = backwards
 fieldIndex, searchRx, indexIsRole = self.__prepareFieldSearch()
 currentIndex = self.logTree.indexOfTopLevelItem(self.logTree.currentItem())
 @pyqtSlot(QTreeWidgetItem, QTreeWidgetItem)
 def on_filesTree_currentItemChanged(self, current, previous):
 """
 Private slot called, when the current item of the files tree changes.
-@param current reference to the new current item (QTreeWidgetItem)
+@param current reference to the new current item
-@param previous reference to the old current item (QTreeWidgetItem)
+@type QTreeWidgetItem
+@param previous reference to the old current item
+@type QTreeWidgetItem
 """
 if current:
 para = current.data(0, self.__diffFileLineRole)
 if para is not None:
 if para == 0:

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py

src/eric7/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py