Radon Code Metrics: comparison PluginMetricsRadon.py

-:32a3c9d62e90
+:22bc345844e7
 className = "RadonMetricsPlugin"
 packageName = "RadonMetrics"
 shortDescription = "Code metrics plugin using radon package"
 longDescription = (
 """This plug-in implements dialogs to show various code metrics. These"""
-""" are determined using the radon code metrics package."""
+""" are determined using the radon code metrics package. 'Raw code"""
+""" metrics', 'Maintainability Index' and 'McCabe Complexity' can be"""
+""" requested through different dialogs for one file or the whole"""
+""" project."""
 )
 needsRestart = False
 pyqtApi = 2
 python2Compatible = True
 # End-Of-Header
 onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy3(
 "mi", fx, lang, fn, msg),
 onBatchDone=lambda fx, lang: self.batchJobDone(
 "mi", fx, lang))
+# cyclomatic complexity
+self.backgroundService.serviceConnect(
+'radon_cc', 'Python2', path, 'CyclomaticComplexityCalculator',
+lambda fn, res: self.metricsCalculationDone("cc", fn, res),
+onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy2(
+"cc", fx, lang, fn, msg),
+onBatchDone=lambda fx, lang: self.batchJobDone(
+"c", fx, lang))
+self.backgroundService.serviceConnect(
+'radon_cc', 'Python3', path, 'CyclomaticComplexityCalculator',
+lambda fn, res: self.metricsCalculationDone("cc", fn, res),
+onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy3(
+"cc", fx, lang, fn, msg),
+onBatchDone=lambda fx, lang: self.batchJobDone(
+"cc", fx, lang))
 self.hasBatch = True
 except TypeError:
 # backward compatibility for eric 6.0
 # raw code metrics calculation
 self.backgroundService.serviceConnect(
 self.backgroundService.serviceConnect(
 'radon_mi', 'Python3', path, 'MaintainabilityIndexCalculator',
 lambda fn, res: self.metricsCalculationDone("mi", fn, res),
 onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy3(
 "mi", fx, lang, fn, msg))
+# cyclomatic complexity
+self.backgroundService.serviceConnect(
+'radon_cc', 'Python2', path, 'CyclomaticComplexityCalculator',
+lambda fn, res: self.metricsCalculationDone("cc", fn, res),
+onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy2(
+"cc", fx, lang, fn, msg))
+self.backgroundService.serviceConnect(
+'radon_cc', 'Python3', path, 'CyclomaticComplexityCalculator',
+lambda fn, res: self.metricsCalculationDone("cc", fn, res),
+onErrorCallback=lambda fx, lang, fn, msg: self.serviceErrorPy3(
+"cc", fx, lang, fn, msg))
 self.hasBatch = False
 self.queuedBatches = {
 "raw": [],
 """
 Private slot to (re)initialize the plugin.
 """
 self.__projectRawMetricsDialog = None
 self.__projectMIDialog = None
+self.__projectCCDialog = None
 self.__projectMetricsActs = []
 self.__projectSeparatorActs = []
 self.__projectBrowserRawMetricsDialog = None
 self.__projectBrowserMIDialog = None
+self.__projectBrowserCCDialog = None
 self.__projectBrowserMenu = None
 self.__projectBrowserMetricsActs = []
 self.__projectBrowserSeparatorActs = []
 self.__editors = []
 self.__editorRawMetricsDialog = None
 self.__editorMIDialog = None
+self.__editorCCDialog = None
 self.__editorMetricsActs = []
 self.__editorSeparatorActs = []
 def rawMetrics(self, lang, filename, source):
 """
 Public method to cancel all batch jobs.
 """
 for lang in ['Python2', 'Python3']:
 self.backgroundService.requestCancel('batch_radon_mi', lang)
+def cyclomaticComplexity(self, lang, filename, source):
+"""
+Public method to prepare cyclomatic complexity calculation on one
+Python source file.
+@param lang language of the file or None to determine by internal
+algorithm
+@type str or None
+@param filename source filename
+@type str
+@param source string containing the code
+@type str
+"""
+if lang is None:
+lang = 'Python{0}'.format(determinePythonVersion(filename, source))
+if lang not in ['Python2', 'Python3']:
+return
+self.backgroundService.enqueueRequest(
+'radon_cc', lang, filename, [source])
+def cyclomaticComplexityBatch(self, argumentsList):
+"""
+Public method to prepare cyclomatic complexity calculation on multiple
+Python source files.
+@param argumentsList list of arguments tuples with each tuple
+containing filename and source
+@type (str, str)
+"""
+data = {
+"Python2": [],
+"Python3": [],
+}
+for filename, source in argumentsList:
+lang = 'Python{0}'.format(determinePythonVersion(filename, source))
+if lang not in ['Python2', 'Python3']:
+continue
+else:
+data[lang].append((filename, source))
+self.queuedBatches["raw"] = []
+for lang in ['Python2', 'Python3']:
+if data[lang]:
+self.queuedBatches["cc"].append(lang)
+self.backgroundService.enqueueRequest('batch_radon_cc', lang,
+"", data[lang])
+self.batchesFinished["cc"] = False
+def cancelComplexityBatch(self):
+"""
+Public method to cancel all batch jobs.
+"""
+for lang in ['Python2', 'Python3']:
+self.backgroundService.requestCancel('batch_radon_cc', lang)
 def activate(self):
 """
 Public method to activate this plug-in.
 @return tuple of None and activation status
 ))
 act.triggered.connect(self.__projectMaintainabilityIndex)
 menu.addAction(act)
 self.__projectMetricsActs.append(act)
+act = E5Action(
+self.tr('Cyclomatic Complexity'),
+self.tr('Cyclomatic &Complexity...'), 0, 0,
+self, 'project_show_radon_cc')
+act.setStatusTip(
+self.tr('Show the cyclomatic complexity for Python files.'))
+act.setWhatsThis(self.tr(
+"""<b>Cyclomatic Complexity...</b>"""
+"""<p>This calculates the cyclomatic complexity of Python"""
+""" files and shows it together with a ranking.</p>"""
+))
+act.triggered.connect(self.__projectCyclomaticComplexity)
+menu.addAction(act)
+self.__projectMetricsActs.append(act)
 act = menu.addSeparator()
 self.__projectSeparatorActs.append(act)
 e5App().getObject("Project").addE5Actions(
 self.__projectMetricsActs[1:])
 act = QAction(self.tr("Radon"), self)
 font = act.font()
 font.setBold(True)
 act.setFont(font)
 act.triggered.connect(self.__showRadonVersion)
-menu.addAction(act)
 self.__editorMetricsActs.append(act)
 act = E5Action(
 self.tr('Code Metrics'),
 self.tr('Code &Metrics...'), 0, 0,
 """<b>Maintainability Index...</b>"""
 """<p>This calculates the maintainability index of Python"""
 """ files and shows it together with a ranking.</p>"""
 ))
 act.triggered.connect(self.__editorMaintainabilityIndex)
+self.__editorMetricsActs.append(act)
+act = E5Action(
+self.tr('Cyclomatic Complexity'),
+self.tr('Cyclomatic &Complexity...'), 0, 0,
+self, '')
+act.setStatusTip(
+self.tr('Show the cyclomatic complexity for Python files.'))
+act.setWhatsThis(self.tr(
+"""<b>Cyclomatic Complexity...</b>"""
+"""<p>This calculates the cyclomatic complexity of Python"""
+""" files and shows it together with a ranking.</p>"""
+))
+act.triggered.connect(self.__editorCyclomaticComplexity)
 self.__editorMetricsActs.append(act)
 e5App().getObject("Project").showMenu.connect(self.__projectShowMenu)
 e5App().getObject("ProjectBrowser").getProjectBrowser("sources")\
 .showMenu.connect(self.__projectBrowserShowMenu)
 self.__projectBrowserMetricsActs.append(act)
 act = E5Action(
 self.tr('Code Metrics'),
 self.tr('Code &Metrics...'), 0, 0,
 self, '')
-act.setStatusTip(
+act.setStatusTip(self.tr(
-self.tr('Show raw code metrics.'))
+'Show raw code metrics.'))
 act.setWhatsThis(self.tr(
 """<b>Code Metrics...</b>"""
 """<p>This calculates raw code metrics of Python files"""
 """ and shows the amount of lines of code, logical lines"""
 """ of code, source lines of code, comment lines,"""
 self.__projectBrowserMetricsActs.append(act)
 act = E5Action(
 self.tr('Maintainability Index'),
 self.tr('Maintainability &Index...'), 0, 0,
-self, 'project_show_radon_mi')
+self, '')
-act.setStatusTip(
+act.setStatusTip(self.tr(
-self.tr('Show the maintainability index for Python'
+'Show the maintainability index for Python files.'))
-' files.'))
 act.setWhatsThis(self.tr(
 """<b>Maintainability Index...</b>"""
 """<p>This calculates the maintainability index of"""
 """ Python files and shows it together with a ranking."""
 """</p>"""
 ))
 act.triggered.connect(
 self.__projectBrowserMaintainabilityIndex)
+menu.addAction(act)
+self.__projectBrowserMetricsActs.append(act)
+act = E5Action(
+self.tr('Cyclomatic Complexity'),
+self.tr('Cyclomatic &Complexity...'), 0, 0,
+self, '')
+act.setStatusTip(self.tr(
+'Show the cyclomatic complexity for Python files.'))
+act.setWhatsThis(self.tr(
+"""<b>Cyclomatic Complexity...</b>"""
+"""<p>This calculates the cyclomatic complexity of"""
+""" Python files and shows it together with a ranking."""
+"""</p>"""
+))
+act.triggered.connect(
+self.__projectBrowserCyclomaticComplexity)
 menu.addAction(act)
 self.__projectBrowserMetricsActs.append(act)
 act = menu.addSeparator()
 self.__projectBrowserSeparatorActs.append(act)
 from RadonMetrics.MaintainabilityIndexDialog import \
 MaintainabilityIndexDialog
 self.__editorMIDialog = MaintainabilityIndexDialog(self)
 self.__editorMIDialog.show()
 self.__editorMIDialog.start(editor.getFileName())
+##################################################################
+## Cyclomatic complexity calculations
+##################################################################
+def __projectCyclomaticComplexity(self):
+"""
+Private slot used to calculate the cyclomatic complexity for the
+project.
+"""
+project = e5App().getObject("Project")
+project.saveAllScripts()
+ppath = project.getProjectPath()
+files = [os.path.join(ppath, file)
+for file in project.pdata["SOURCES"]
+if file.endswith(
+tuple(Preferences.getPython("Python3Extensions")) +
+tuple(Preferences.getPython("PythonExtensions")))]
+if self.__projectCCDialog is None:
+from RadonMetrics.CyclomaticComplexityDialog import \
+CyclomaticComplexityDialog
+self.__projectCCDialog = CyclomaticComplexityDialog(self)
+self.__projectCCDialog.show()
+self.__projectCCDialog.prepare(files, project)
+def __projectBrowserCyclomaticComplexity(self):
+"""
+Private method to handle the cyclomatic complexity context menu action
+of the project sources browser.
+"""
+browser = e5App().getObject("ProjectBrowser").getProjectBrowser(
+"sources")
+if browser.getSelectedItemsCount([ProjectBrowserFileItem]) > 1:
+fn = []
+for itm in browser.getSelectedItems([ProjectBrowserFileItem]):
+fn.append(itm.fileName())
+else:
+itm = browser.model().item(browser.currentIndex())
+try:
+fn = itm.fileName()
+except AttributeError:
+fn = itm.dirName()
+if self.__projectBrowserCCDialog is None:
+from RadonMetrics.CyclomaticComplexityDialog import \
+CyclomaticComplexityDialog
+self.__projectBrowserCCDialog = CyclomaticComplexityDialog(self)
+self.__projectBrowserCCDialog.show()
+self.__projectBrowserCCDialog.start(fn)
+def __editorCyclomaticComplexity(self):
+"""
+Private slot to handle the cyclomatic complexity action of the editor
+show menu.
+"""
+editor = e5App().getObject("ViewManager").activeWindow()
+if editor is not None:
+if editor.checkDirty() and editor.getFileName() is not None:
+if self.__editorCCDialog is None:
+from RadonMetrics.CyclomaticComplexityDialog import \
+CyclomaticComplexityDialog
+self.__editorCCDialog = CyclomaticComplexityDialog(self)
+self.__editorCCDialog.show()
+self.__editorCCDialog.start(editor.getFileName())
+##################################################################
+## Radon info display
+##################################################################
 def __showRadonVersion(self):
 """
 Private slot to show the version number of the used radon library.
 """
 """ Studio)</li>"""
 """<li><b>McCabe's complexity</b>, i.e. cyclomatic"""
 """ complexity</li>"""
 """</ul></p>"""
 ).format(__version__))

Mercurial Repositories > Radon Code Metrics / file comparison

comparison: PluginMetricsRadon.py

PluginMetricsRadon.py