eric: comparison src/eric7/Plugins/CheckerPlugins/SyntaxChecker/SyntaxCheckerDialog.py

-:1f39839655ea
+:5a02bdb1dcba
 def __init__(self, parent=None):
 """
 Constructor
-@param parent The parent widget. (QWidget)
+@param parent reference to the parent widget
+@type QWidget
 """
 super().__init__(parent)
 self.setupUi(self)
 self.setWindowFlags(Qt.WindowType.Window)
 self, filename, line, index, error, sourcecode, isWarning=False
 ):
 """
 Private method to create an entry in the result list.
-@param filename file name of file (string)
+@param filename file name of file
-@param line line number of faulty source (integer or string)
+@type str
-@param index index number of fault (integer)
+@param line line number of faulty source
-@param error error text (string)
+@type int or str
-@param sourcecode faulty line of code (string)
+@param index index number of fault
-@param isWarning flag indicating a warning message (boolean)
+@type int
+@param error error text
+@type str
+@param sourcecode faulty line of code
+@type str
+@param isWarning flag indicating a warning message
+@type bool
 """
 if (
 self.__lastFileItem is None
 or self.__lastFileItem.data(0, self.filenameRole) != filename
 ):
 def prepare(self, fileList, project):
 """
 Public method to prepare the dialog with a list of filenames.
-@param fileList list of filenames (list of strings)
+@param fileList list of filenames
-@param project reference to the project object (Project)
+@type list of str
+@param project reference to the project object
+@type Project
 """
 self.__fileList = fileList[:]
 self.__project = project
 self.buttonBox.button(QDialogButtonBox.StandardButton.Close).setEnabled(True)
 self.__data = self.__project.getData("CHECKERSPARMS", "SyntaxChecker")
 if self.__data is None or "ExcludeFiles" not in self.__data:
 self.__data = {"ExcludeFiles": ""}
 self.excludeFilesEdit.setText(self.__data["ExcludeFiles"])
+def startForBrowser(self, fn):
+"""
+Public slot to start the syntax check for the project sources browser.
+@param fn file or list of files or directory to be checked
+@type str or list of str
+"""
+if isinstance(fn, list):
+files = fn
+elif os.path.isdir(fn):
+files = []
+for ext in self.syntaxCheckService.getExtensions():
+files.extend(Utilities.direntries(fn, True, "*{0}".format(ext), 0))
+else:
+files = [fn]
+if files:
+if self.__project is None:
+self.__project = ericApp().getObject("Project")
+self.__fileList = files[:]
+self.filterFrame.setVisible(True)
+self.__data = self.__project.getData("CHECKERSPARMS", "SyntaxChecker")
+if self.__data is None or "ExcludeFiles" not in self.__data:
+self.__data = {"ExcludeFiles": ""}
+self.excludeFilesEdit.setText(self.__data["ExcludeFiles"])
+self.on_startButton_clicked()  # press the start button
 def start(self, fn, codestring=""):
 """
 Public slot to start the syntax check.
 @param fn file or list of files or directory to be checked
-(string or list of strings)
+@type str or list of str
-@param codestring string containing the code to be checked (string).
+@param codestring string containing the code to be checked. If this is given,
-If this is given, fn must be a single file name.
+fn must be a single file name.
+@type str
 """
 self.__batch = False
 if self.syntaxCheckService is not None:
 if self.__project is None:
 """
 Public method to start a check for one file.
 The results are reported to the __processResult slot.
-@param codestring optional sourcestring (str)
+@param codestring optional sourcestring
+@type str
 """
 if self.syntaxCheckService is None or not self.files:
 self.checkProgress.setMaximum(1)
 self.checkProgress.setValue(1)
 self.__finish()
 def __processResult(self, fn, problems):
 """
 Private slot to display the reported messages.
-@param fn filename of the checked file (str)
+@param fn filename of the checked file
+@type str
 @param problems dictionary with the keys 'error' and 'warnings' which
 hold a list containing details about the error/ warnings
 (file name, line number, column, codestring (only at syntax
-errors), the message) (dict)
+errors), the message)
+@type dict
 """
 if self.__finished:
 return
 # Check if it's the requested file, otherwise ignore signal if not
 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):
 if self.__batch:
 def on_resultList_itemActivated(self, itm, col):
 """
 Private slot to handle the activation of an item.
-@param itm reference to the activated item (QTreeWidgetItem)
+@param itm reference to the activated item
-@param col column the item was activated in (integer)
+@type QTreeWidgetItem
+@param col column the item was activated in
+@type int
 """
 if self.noResults:
 return
 vm = ericApp().getObject("ViewManager")
 def __clearErrors(self, files):
 """
 Private method to clear all error and warning markers of
 open editors to be checked.
-@param files list of files to be checked (list of string)
+@param files list of files to be checked
+@type list of str
 """
 vm = ericApp().getObject("ViewManager")
 openFiles = vm.getOpenFilenames()
 for file in [f for f in openFiles if f in files]:
 editor = vm.getOpenEditor(file)

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Plugins/CheckerPlugins/SyntaxChecker/SyntaxCheckerDialog.py

src/eric7/Plugins/CheckerPlugins/SyntaxChecker/SyntaxCheckerDialog.py