eric: comparison src/eric7/UI/CompareDialog.py

-:2fe91fe443dd
+:328f3ec4b77a
 def sbsdiff(a, b, linenumberwidth=4):
 """
 Compare two sequences of lines; generate the delta for display side by
 side.
-@param a first sequence of lines (list of strings)
+@param a first sequence of lines
-@param b second sequence of lines (list of strings)
+@type list of str
-@param linenumberwidth width (in characters) of the linenumbers (integer)
+@param b second sequence of lines
+@type list of str
+@param linenumberwidth width (in characters) of the linenumbers
+@type int
 @yield tuples of differences. Each tuple is composed of strings as follows.
 <ul>
 <li>opcode -- one of e, d, i, r for equal, delete, insert,
 replace</li>
 <li>lineno a -- linenumber of sequence a</li>
 def removeMarkers(line):
 """
 Internal function to remove all diff markers.
-@param line line to work on (string)
+@param line line to work on
-@return line without diff markers (string)
+@type str
+@return line without diff markers
+@rtype str
 """
 return (
 line.replace("\0+", "")
 .replace("\0-", "")
 .replace("\0^", "")
 def __init__(self, files=None, parent=None):
 """
 Constructor
 @param files list of files to compare and their label
-@type list of two tuples of (str, str)
+@type list of tuples of (str, str)
 @param parent parent widget
 @type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 def show(self, filename=None):
 """
 Public slot to show the dialog.
-@param filename name of a file to use as the first file (string)
+@param filename name of a file to use as the first file
+@type str
 """
 if filename:
 self.file1Picker.setText(filename)
 super().show()
 def __appendText(self, pane, linenumber, line, charFormat, interLine=False):
 """
 Private method to append text to the end of the contents pane.
-@param pane text edit widget to append text to (QTextedit)
+@param pane text edit widget to append text to
-@param linenumber number of line to insert (string)
+@type QTextedit
-@param line text to insert (string)
+@param linenumber number of line to insert
-@param charFormat text format to be used (QTextCharFormat)
+@type str
-@param interLine flag indicating interline changes (boolean)
+@param line text to insert
+@type str
+@param charFormat text format to be used
+@type QTextCharFormat
+@param interLine flag indicating interline changes
+@type bool
 """
 tc = pane.textCursor()
 tc.movePosition(QTextCursor.MoveOperation.End)
 pane.setTextCursor(tc)
 pane.setCurrentCharFormat(charFormat)
 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.diffButton:
 self.on_diffButton_clicked()
 @pyqtSlot()
 def compare(self, lines1, lines2, name1="", name2=""):
 """
 Public method to compare two lists of text.
-@param lines1 text to compare against (string or list of strings)
+@param lines1 text to compare against
-@param lines2 text to compare (string or list of strings)
+@type str or list of str
-@param name1 name to be shown for the first text (string)
+@param lines2 text to compare
-@param name2 name to be shown for the second text (string)
+@type str or list of str)
+@param name1 name to be shown for the first text
+@type str
+@param name2 name to be shown for the second text
+@type str
 """
 if name1 == "" or name2 == "":
 self.filesGroup.hide()
 else:
 self.file1Picker.setText(name1)
 def __compare(self, lines1, lines2):
 """
 Private method to compare two lists of text.
-@param lines1 text to compare against (list of strings)
+@param lines1 text to compare against
-@param lines2 text to compare (list of strings)
+@type list of str
+@param lines2 text to compare
+@type list of str
 """
 self.contents_1.clear()
 self.contents_2.clear()
 self.__generateFormats()
 def __scrollBarMoved(self, value):
 """
 Private slot to enable the buttons and set the current diff position
 depending on scrollbar position.
-@param value scrollbar position (integer)
+@param value scrollbar position
+@type int
 """
 tPos = value / self.fontHeight + 1
 bPos = (value + self.vsb1.pageStep()) / self.fontHeight + 1
 self.currentDiffPos = -1
 @pyqtSlot(bool)
 def on_synchronizeCheckBox_toggled(self, sync):
 """
 Private slot to connect or disconnect the scrollbars of the displays.
-@param sync flag indicating synchronisation status (boolean)
+@param sync flag indicating synchronisation status
+@type bool
 """
 if sync:
 self.hsb2.setValue(self.hsb1.value())
 self.hsb1.valueChanged.connect(self.hsb2.setValue)
 self.hsb2.valueChanged.connect(self.hsb1.setValue)
 def __init__(self, files=None, parent=None):
 """
 Constructor
 @param files list of files to compare and their label
-(list of two tuples of two strings)
+@type list of [(str, str), (str, str)]
-@param parent reference to the parent widget (QWidget)
+@param parent reference to the parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setStyle(Preferences.getUI("Style"), Preferences.getUI("StyleSheet"))
 def eventFilter(self, obj, event):
 """
 Public method to filter events.
-@param obj reference to the object the event is meant for (QObject)
+@param obj reference to the object the event is meant for
-@param event reference to the event object (QEvent)
+@type QObject
-@return flag indicating, whether the event was handled (boolean)
+@param event reference to the event object
+@type QEvent
+@return flag indicating, whether the event was handled
+@rtype bool
 """
 if event.type() == QEvent.Type.Close:
 QApplication.exit()
 return True

Mercurial Repositories > eric / file comparison

comparison: src/eric7/UI/CompareDialog.py

src/eric7/UI/CompareDialog.py