eric7/DataViews/PyCoverageHtmlReportDialog.py

Thu, 19 May 2022 14:37:01 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 19 May 2022 14:37:01 +0200
branch
unittest
changeset 9078
44d1d68096b6
permissions
-rw-r--r--

Dataview Coverage
- added support to write coverage reports as HTML, JSON or LCOV files
- removed the support for writing annotated sources (deprecated in coverage.py)

9078
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 # Copyright (c) 2022 Detlev Offenbach <detlev@die-offenbachs.de>
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 #
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 Module implementing a dialog to enter the parameters for a coverage HTML
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 report.
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 from PyQt6.QtCore import pyqtSlot
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 from PyQt6.QtWidgets import QDialog, QDialogButtonBox
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 from EricWidgets.EricPathPicker import EricPathPickerModes
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 from .Ui_PyCoverageHtmlReportDialog import Ui_PyCoverageHtmlReportDialog
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 class PyCoverageHtmlReportDialog(QDialog, Ui_PyCoverageHtmlReportDialog):
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 Class implementing a dialog to enter the parameters for a coverage HTML
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 report.
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 def __init__(self, defaultDirectory, parent=None):
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Constructor
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 @param defaultDirectory default directory for selecting the output
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 directory
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 @type str
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 @param parent reference to the parent widget (defaults to None)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 @type QWidget (optional)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 super().__init__(parent)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 self.setupUi(self)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 self.outputDirectoryPicker.setMode(
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 EricPathPickerModes.DIRECTORY_SHOW_FILES_MODE)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 self.outputDirectoryPicker.setDefaultDirectory(defaultDirectory)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 self.extraCssPicker.setMode(
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 EricPathPickerModes.OPEN_FILE_MODE)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 self.buttonBox.button(
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 QDialogButtonBox.StandardButton.Ok).setEnabled(False)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 msh = self.minimumSizeHint()
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 self.resize(max(self.width(), msh.width()), msh.height())
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 @pyqtSlot(str)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 def on_outputDirectoryPicker_textChanged(self, directory):
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 Private slot handling a change of the output directory.
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 @param directory current text of the directory picker
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 @type str
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 self.buttonBox.button(
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 QDialogButtonBox.StandardButton.Ok).setEnabled(bool(directory))
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 def getData(self):
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 Public method to get the entered data.
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 @return tuple containing the report title, the output directory, the
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 path of a file containing extra CSS and a flag indicating to open
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 the generated report in a browser
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 @rtype tuple of (str, str, str, bool)
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 """
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 title = self.titleEdit.text()
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 return (
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 title if bool(title) else None,
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 self.outputDirectoryPicker.currentText(),
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 self.extraCssPicker.currentText(),
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 self.openReportCheckBox.isChecked(),
44d1d68096b6 Dataview Coverage
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 )

eric ide

mercurial