Radon Code Metrics: comparison RadonMetrics/RawMetricsDialog.py

-:9ac53bf21182
+:db25d1d5cc3a
 Module implementing a dialog to show raw code metrics.
 """
 from __future__ import unicode_literals
+try:
+str = unicode       # __IGNORE_EXCEPTION __IGNORE_WARNING__
+except NameError:
+pass
 import os
 import fnmatch
-from PyQt5.QtCore import pyqtSlot, qVersion, Qt, QTimer
+from PyQt5.QtCore import pyqtSlot, qVersion, Qt, QTimer, QLocale
 from PyQt5.QtWidgets import (
-QDialog, QDialogButtonBox, QAbstractButton, QMenu, QHeaderView,
+QDialog, QDialogButtonBox, QAbstractButton, QHeaderView, QTreeWidgetItem,
-QTreeWidgetItem, QApplication
+QApplication
 )
 from .Ui_RawMetricsDialog import Ui_RawMetricsDialog
 from E5Gui.E5Application import e5App
 import Preferences
 import Utilities
-# TODO: add summary table
-# TODO: add column explanations
 class RawMetricsDialog(QDialog, Ui_RawMetricsDialog):
 """
 Class implementing a dialog to show raw code metrics.
 """
 def __init__(self, radonService, parent=None):
 self.setWindowFlags(Qt.Window)
 self.buttonBox.button(QDialogButtonBox.Close).setEnabled(False)
 self.buttonBox.button(QDialogButtonBox.Cancel).setDefault(True)
+self.summaryList.headerItem().setText(
+self.summaryList.columnCount(), "")
+self.summaryList.header().resizeSection(0, 200)
+self.summaryList.header().resizeSection(1, 100)
 self.resultList.headerItem().setText(self.resultList.columnCount(), "")
 self.radonService = radonService
 self.radonService.metricsDone.connect(self.__processResult)
 self.radonService.metricsError.connect(self.__processError)
 self.radonService.batchFinished.connect(self.__batchFinished)
 self.cancelled = False
 self.__project = e5App().getObject("Project")
+self.__locale = QLocale()
-self.__menu = QMenu(self)
-self.__menu.addAction(self.tr("Collapse all"),
-self.__resultCollapse)
-self.__menu.addAction(self.tr("Expand all"), self.__resultExpand)
-self.resultList.setContextMenuPolicy(Qt.CustomContextMenu)
-self.resultList.customContextMenuRequested.connect(
-self.__showContextMenu)
 self.__fileList = []
 self.filterFrame.setVisible(False)
+self.explanationLabel.setText(self.tr(
+"<table>"
+"<tr><td><b>LOC</b></td>"
+"<td>Lines of code (LOC = SLOC + Empty)</td></tr>"
+"<tr><td><b>SLOC</b></td><td>Source lines of code</td></tr>"
+"<tr><td><b>LLOC</b></td><td>Logical lines of code</td></tr>"
+"<tr><td><b>Comments</b></td><td>Comment lines</td></tr>"
+"<tr><td><b>Multi</b></td>"
+"<td>Lines in multi line strings</td></tr>"
+"<tr><td><b>Empty</b></td><td>Blank lines</td></tr>"
+"<tr><td colspan=2><b>Comment Statistics:</b></td</tr>"
+"<tr><td><b>C % L</b></td><td>Comments to lines ratio</td></tr>"
+"<tr><td><b>C % S</b></td>"
+"<td>Comments to source lines ratio</td></tr>"
+"<tr><td><b>C + M % L</b></td>"
+"<td>Comments plus multi line strings to lines ratio</td></tr>"
+"</table>"
+))
 def __resizeResultColumns(self):
 """
 Private method to resize the list columns.
 """
 @type str
 @param values values to be displayed
 @type dict
 """
 data = [self.__project.getRelativePath(filename)]
-for key in ['loc', 'sloc', 'lloc', 'comments', 'multi', 'blank']:
+for value in self.__getValues(values):
 try:
-data.append("{0:5}".format(int(values[key])))
+data.append("{0:5}".format(int(value)))
 except ValueError:
-data.append(values[key])
+data.append(value)
-except KeyError:
-data.append("")
 data.append("{0:3.0%}".format(
 values["comments"] / (float(values["loc"]) or 1)))
 data.append("{0:3.0%}".format(
 values["comments"] / (float(values["sloc"]) or 1)))
 data.append("{0:3.0%}".format(
 @param filename name of the file
 @type str
 @param message error message
 @type str
 """
-# TODO: implement this
+itm = QTreeWidgetItem(self.resultList, [
+"{0} ({1})".format(self.__project.getRelativePath(filename),
+message)])
+itm.setFirstColumnSpanned(True)
+font = itm.font(0)
+font.setItalic(True)
+itm.setFont(0, font)
 def prepare(self, fileList, project):
 """
 Public method to prepare the dialog with a list of filenames.
 # check for missing files
 for f in self.files[:]:
 if not os.path.exists(f):
 self.files.remove(f)
+self.__summary = {"files": 0}
+for key in ['loc', 'sloc', 'lloc', 'comments', 'multi', 'blank']:
+self.__summary[key] = 0
 if len(self.files) > 0:
 # disable updates of the list for speed
 self.resultList.setUpdatesEnabled(False)
 self.resultList.setSortingEnabled(False)
 try:
 self.source = Utilities.readEncodedFile(self.filename)[0]
 self.source = Utilities.normalizeCode(self.source)
 except (UnicodeError, IOError) as msg:
-# TODO: adjust this
+self.__createErrorItem(self.filename, str(msg).rstrip())
-self.__createResultItem(
-self.filename, 1,
-"Error: {0}".format(str(msg)).rstrip())
 self.progress += 1
 # Continue with next file
 self.rawMetrics()
 return
 try:
 source = Utilities.readEncodedFile(filename)[0]
 source = Utilities.normalizeCode(source)
 except (UnicodeError, IOError) as msg:
-# TODO: adjust this
+self.__createErrorItem(filename, str(msg).rstrip())
-self.__createResultItem(
-filename, 1,
-"Error: {0}".format(str(msg)).rstrip())
 continue
 argumentsList.append((filename, source))
 # reset the progress bar to the checked files
 self.checkProgress.setMaximum(1)
 self.checkProgress.setValue(1)
 self.__finish()
 def __processError(self, fn, msg):
-# TODO: implement this
+"""
-print("Error", fn, msg)
+Private slot to process an error indication from the service.
+@param fn filename of the file
+@type str
+@param msg error message
+@type str
+"""
+self.__createErrorItem(fn, msg)
 def __processResult(self, fn, result):
 """
 Private slot called after perfoming a code metrics calculation on one
 file.
 self.checkProgressLabel.setPath(fn)
 QApplication.processEvents()
 if not self.__batch:
 self.rawMetrics()
+def __getValues(self, result):
+"""
+Private method to extract the code metric values.
+@param result result dict
+@type dict
+@return list of values suitable for display
+@rtype list of str
+"""
+v = []
+for key in ['loc', 'sloc', 'lloc', 'comments', 'multi', 'blank']:
+val = result.get(key, 0)
+if val:
+v.append(self.__locale.toString(val))
+else:
+v.append('')
+self.__summary[key] += int(val)
+self.__summary["files"] += 1
+return v
 def __finish(self):
 """
 Private slot called when the action or the user pressed the button.
 """
 if not self.__finished:
 self.__finished = True
 # reenable updates of the list
 self.resultList.setSortingEnabled(True)
 self.resultList.setUpdatesEnabled(True)
+self.__createSummary()
 self.cancelled = True
 self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
 self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
 self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
 else:
 self.resultList.header().setResizeMode(QHeaderView.Interactive)
 self.checkProgress.setVisible(False)
 self.checkProgressLabel.setVisible(False)
+def __createSummary(self):
+"""
+Private method to create the code metrics summary.
+"""
+self.__createSummaryItem(
+self.tr("Files"), self.__locale.toString(self.__summary["files"]))
+self.__createSummaryItem(
+self.tr("LOC"), self.__locale.toString(self.__summary["loc"]))
+self.__createSummaryItem(
+self.tr("SLOC"), self.__locale.toString(self.__summary["sloc"]))
+self.__createSummaryItem(
+self.tr("LLOC"), self.__locale.toString(self.__summary["lloc"]))
+self.__createSummaryItem(
+self.tr("Comments"),
+self.__locale.toString(self.__summary["comments"]))
+self.__createSummaryItem(
+self.tr("Multi"), self.__locale.toString(self.__summary["multi"]))
+self.__createSummaryItem(
+self.tr("Empty"), self.__locale.toString(self.__summary["blank"]))
+self.summaryList.header().resizeSections(QHeaderView.ResizeToContents)
+self.summaryList.header().setStretchLastSection(True)
+def __createSummaryItem(self, col0, col1):
+"""
+Private slot to create a new item in the summary list.
+@param col0 string for column 0 (string)
+@param col1 string for column 1 (string)
+"""
+itm = QTreeWidgetItem(self.summaryList, [col0, col1])
+itm.setTextAlignment(1, Qt.Alignment(Qt.AlignRight))
 @pyqtSlot(QAbstractButton)
 def on_buttonBox_clicked(self, button):
 """
 Private slot called by a button of the button box clicked.
 [f for f in fileList if not fnmatch.fnmatch(f, filter)]
 self.resultList.clear()
 self.cancelled = False
 self.start(fileList)
-def __showContextMenu(self, coord):
-"""
-Private slot to show the context menu of the result list.
-@param coord position of the mouse pointer
-@type QPoint
-"""
-if self.resultList.topLevelItemCount() > 0:
-self.__menu.popup(self.mapToGlobal(coord))
-def __resultCollapse(self):
-"""
-Private slot to collapse all entries of the result list.
-"""
-for index in range(self.resultList.topLevelItemCount()):
-self.resultList.topLevelItem(index).setExpanded(False)
-def __resultExpand(self):
-"""
-Private slot to expand all entries of the result list.
-"""
-for index in range(self.resultList.topLevelItemCount()):
-self.resultList.topLevelItem(index).setExpanded(True)

Mercurial Repositories > Radon Code Metrics / file comparison

comparison: RadonMetrics/RawMetricsDialog.py

RadonMetrics/RawMetricsDialog.py