class OWReport(OWWidget):
name = "Report"
save_dir = Setting("")
open_dir = Setting("")
def __init__(self):
super().__init__()
self._setup_ui_()
self.report_changed = False
index_file = pkg_resources.resource_filename(__name__, "index.html")
with open(index_file, "r") as f:
self.report_html_template = f.read()
def _setup_ui_(self):
self.table_model = ReportItemModel(0, len(Column.__members__))
self.table = ReportTable(self.controlArea)
self.table.setModel(self.table_model)
self.table.setShowGrid(False)
self.table.setSelectionBehavior(QTableView.SelectRows)
self.table.setSelectionMode(QTableView.SingleSelection)
self.table.setWordWrap(False)
self.table.setMouseTracking(True)
self.table.verticalHeader().setSectionResizeMode(QHeaderView.Fixed)
self.table.verticalHeader().setDefaultSectionSize(20)
self.table.verticalHeader().setVisible(False)
self.table.horizontalHeader().setVisible(False)
self.table.setFixedWidth(250)
self.table.setColumnWidth(Column.item, 200)
self.table.setColumnWidth(Column.remove, 23)
self.table.setColumnWidth(Column.scheme, 25)
self.table.clicked.connect(self._table_clicked)
self.table.selectionModel().selectionChanged.connect(
self._table_selection_changed)
self.controlArea.layout().addWidget(self.table)
self.last_scheme = None
self.scheme_button = gui.button(self.controlArea,
self,
"Back to Last Scheme",
callback=self._show_last_scheme)
box = gui.hBox(self.controlArea)
box.setContentsMargins(-6, 0, -6, 0)
self.save_button = gui.button(box,
self,
"Save",
callback=self.save_report)
self.print_button = gui.button(box,
self,
"Print",
callback=self._print_report)
class PyBridge(QObject):
@pyqtSlot(str)
def _select_item(myself, item_id):
item = self.table_model.get_item_by_id(item_id)
self.table.selectRow(
self.table_model.indexFromItem(item).row())
self._change_selected_item(item)
@pyqtSlot(str, str)
def _add_comment(myself, item_id, value):
item = self.table_model.get_item_by_id(item_id)
item.comment = value
self.report_changed = True
self.report_view = WebviewWidget(self.mainArea, bridge=PyBridge(self))
self.mainArea.layout().addWidget(self.report_view)
@deprecated("Widgets should not be pickled")
def __getstate__(self):
rep_dict = self.__dict__.copy()
for key in ('_OWWidget__env', 'controlArea', 'mainArea', 'report_view',
'table', 'table_model'):
del rep_dict[key]
items_len = self.table_model.rowCount()
return rep_dict, [self.table_model.item(i) for i in range(items_len)]
@deprecated("Widgets should not be pickled")
def __setstate__(self, state):
rep_dict, items = state
self.__dict__.update(rep_dict)
self._setup_ui_()
for i in range(len(items)):
item = items[i]
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme, item.module,
item.icon_name, item.comment))
def _table_clicked(self, index):
if index.column() == Column.remove:
self._remove_item(index.row())
indexes = self.table.selectionModel().selectedIndexes()
if indexes:
item = self.table_model.item(indexes[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
if index.column() == Column.scheme:
self._show_scheme(index.row())
def _table_selection_changed(self, new_selection, _):
if new_selection.indexes():
item = self.table_model.item(new_selection.indexes()[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
def _remove_item(self, row):
self.table_model.removeRow(row)
self.report_changed = True
self._build_html()
def clear(self):
self.table_model.clear()
self.report_changed = True
self._build_html()
def _add_item(self, widget):
name = widget.get_widget_name_extension()
name = "{} - {}".format(widget.name, name) if name else widget.name
item = ReportItem(name, widget.report_html, self._get_scheme(),
widget.__module__, widget.icon)
self.table_model.add_item(item)
self.report_changed = True
return item
def _build_html(self):
html = self.report_html_template
html += "<body>"
for i in range(self.table_model.rowCount()):
item = self.table_model.item(i)
html += "<div id='{}' class='normal' " \
"onClick='pybridge._select_item(this.id)'>{}<div " \
"class='textwrapper'><textarea " \
"placeholder='Write a comment...'" \
"onInput='this.innerHTML = this.value;" \
"pybridge._add_comment(this.parentNode.parentNode.id, this.value);'" \
">{}</textarea></div>" \
"</div>".format(item.id, item.html, item.comment)
html += "</body></html>"
self.report_view.setHtml(html)
def _scroll_to_item(self, item):
self.report_view.evalJS(
"document.getElementById('{}').scrollIntoView();".format(item.id))
def _change_selected_item(self, item):
self.report_view.evalJS(
"var sel_el = document.getElementsByClassName('selected')[0]; "
"if (sel_el.id != {}) "
" sel_el.className = 'normal';".format(item.id))
self.report_view.evalJS(
"document.getElementById('{}').className = 'selected';".format(
item.id))
self.report_changed = True
def make_report(self, widget):
item = self._add_item(widget)
self._build_html()
self._scroll_to_item(item)
self.table.selectRow(self.table_model.rowCount() - 1)
def _get_scheme(self):
canvas = self.get_canvas_instance()
return canvas.get_scheme_xml() if canvas else None
def _show_scheme(self, row):
scheme = self.table_model.item(row).scheme
canvas = self.get_canvas_instance()
if canvas:
document = canvas.current_document()
if document.isModifiedStrict():
self.last_scheme = canvas.get_scheme_xml()
canvas.load_scheme_xml(scheme)
def _show_last_scheme(self):
if self.last_scheme:
canvas = self.get_canvas_instance()
if canvas:
canvas.load_scheme_xml(self.last_scheme)
def save_report(self):
"""Save report"""
filename, _ = QFileDialog.getSaveFileName(
self, "Save Report", self.save_dir,
"HTML (*.html);;PDF (*.pdf);;Report (*.report)")
if not filename:
return QDialog.Rejected
self.save_dir = os.path.dirname(filename)
self.saveSettings()
_, extension = os.path.splitext(filename)
if extension == ".pdf":
printer = QPrinter()
printer.setPageSize(QPrinter.A4)
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName(filename)
self.report_view.print_(printer)
elif extension == ".report":
self.save(filename)
else:
def save_html(contents):
try:
with open(filename, "w", encoding="utf-8") as f:
f.write(contents)
except PermissionError:
self.permission_error(filename)
save_html(self.report_view.html())
self.report_changed = False
return QDialog.Accepted
def _print_report(self):
printer = QPrinter()
print_dialog = QPrintDialog(printer, self)
print_dialog.setWindowTitle("Print report")
if print_dialog.exec_() != QDialog.Accepted:
return
self.report_view.print_(printer)
def open_report(self):
filename, _ = QFileDialog.getOpenFileName(self, "Open Report",
self.open_dir,
"Report (*.report)")
if not filename:
return
self.report_changed = False
self.open_dir = os.path.dirname(filename)
self.saveSettings()
try:
report = self.load(filename)
except (IOError, AttributeError, pickle.UnpicklingError) as e:
message_critical(self.tr("Could not load an Orange Report file"),
title=self.tr("Error"),
informative_text=self.tr(
"Error occurred "
"while loading '{}'.").format(filename),
exc_info=True,
parent=self)
log.error(str(e), exc_info=True)
return
self.set_instance(report)
self = report
self._build_html()
self.table.selectRow(0)
self.show()
self.raise_()
def save(self, filename):
attributes = {}
for key in ('last_scheme', 'open_dir'):
attributes[key] = getattr(self, key, None)
items = [
self.table_model.item(i)
for i in range(self.table_model.rowCount())
]
report = dict(__version__=1, attributes=attributes, items=items)
try:
with open(filename, 'wb') as f:
pickle.dump(report, f)
except PermissionError:
self.permission_error(filename)
@classmethod
def load(cls, filename):
with open(filename, 'rb') as f:
report = pickle.load(f)
if not isinstance(report, dict):
return report
self = cls()
self.__dict__.update(report['attributes'])
for item in report['items']:
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme, item.module,
item.icon_name, item.comment))
return self
def permission_error(self, filename):
message_critical(
self.tr("Permission error when trying to write report."),
title=self.tr("Error"),
informative_text=self.tr("Permission error occurred "
"while saving '{}'.").format(filename),
exc_info=True,
parent=self)
log.error("PermissionError when trying to write report.",
exc_info=True)
def is_empty(self):
return not self.table_model.rowCount()
def is_changed(self):
return self.report_changed
@staticmethod
def set_instance(report):
app_inst = QApplication.instance()
app_inst._report_window = report
@staticmethod
def get_instance():
app_inst = QApplication.instance()
if not hasattr(app_inst, "_report_window"):
report = OWReport()
app_inst._report_window = report
return app_inst._report_window
@staticmethod
def get_canvas_instance():
for widget in QApplication.topLevelWidgets():
if isinstance(widget, CanvasMainWindow):
return widget
class OWReport(OWWidget):
name = "Report"
save_dir = Setting("")
open_dir = Setting("")
def __init__(self):
super().__init__()
self._setup_ui_()
self.report_changed = False
index_file = pkg_resources.resource_filename(__name__, "index.html")
with open(index_file, "r") as f:
self.report_html_template = f.read()
def _setup_ui_(self):
self.table_model = ReportItemModel(0, len(Column.__members__))
self.table = ReportTable(self.controlArea)
self.table.setModel(self.table_model)
self.table.setShowGrid(False)
self.table.setSelectionBehavior(QTableView.SelectRows)
self.table.setSelectionMode(QTableView.SingleSelection)
self.table.setWordWrap(False)
self.table.setMouseTracking(True)
self.table.verticalHeader().setSectionResizeMode(QHeaderView.Fixed)
self.table.verticalHeader().setDefaultSectionSize(20)
self.table.verticalHeader().setVisible(False)
self.table.horizontalHeader().setVisible(False)
self.table.setFixedWidth(250)
self.table.setColumnWidth(Column.item, 200)
self.table.setColumnWidth(Column.remove, 23)
self.table.setColumnWidth(Column.scheme, 25)
self.table.clicked.connect(self._table_clicked)
self.table.selectionModel().selectionChanged.connect(
self._table_selection_changed)
self.controlArea.layout().addWidget(self.table)
self.last_scheme = None
self.scheme_button = gui.button(self.controlArea,
self,
"Back to Last Scheme",
callback=self._show_last_scheme)
box = gui.hBox(self.controlArea)
box.setContentsMargins(-6, 0, -6, 0)
self.save_button = gui.button(box,
self,
"Save",
callback=self.save_report,
disabled=True)
self.print_button = gui.button(box,
self,
"Print",
callback=self._print_report,
disabled=True)
class PyBridge(QObject):
@pyqtSlot(str)
def _select_item(myself, item_id):
item = self.table_model.get_item_by_id(item_id)
self.table.selectRow(
self.table_model.indexFromItem(item).row())
self._change_selected_item(item)
@pyqtSlot(str, str)
def _add_comment(myself, item_id, value):
item = self.table_model.get_item_by_id(item_id)
item.comment = value
self.report_changed = True
self.report_view = WebviewWidget(self.mainArea, bridge=PyBridge(self))
self.mainArea.layout().addWidget(self.report_view)
@deprecated("Widgets should not be pickled")
def __getstate__(self):
rep_dict = self.__dict__.copy()
for key in ('_OWWidget__env', 'controlArea', 'mainArea', 'report_view',
'table', 'table_model'):
del rep_dict[key]
items_len = self.table_model.rowCount()
return rep_dict, [self.table_model.item(i) for i in range(items_len)]
@deprecated("Widgets should not be pickled")
def __setstate__(self, state):
rep_dict, items = state
self.__dict__.update(rep_dict)
self._setup_ui_()
for i in range(len(items)):
item = items[i]
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme, item.module,
item.icon_name, item.comment))
def _table_clicked(self, index):
if index.column() == Column.remove:
self._remove_item(index.row())
indexes = self.table.selectionModel().selectedIndexes()
if indexes:
item = self.table_model.item(indexes[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
if index.column() == Column.scheme:
self._show_scheme(index.row())
def _table_selection_changed(self, new_selection, _):
if new_selection.indexes():
item = self.table_model.item(new_selection.indexes()[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
def _remove_item(self, row):
self.table_model.removeRow(row)
self._empty_report()
self.report_changed = True
self._build_html()
def clear(self):
self.table_model.clear()
self._empty_report()
self.report_changed = True
self._build_html()
def _add_item(self, widget):
name = widget.get_widget_name_extension()
name = "{} - {}".format(widget.name, name) if name else widget.name
item = ReportItem(name, widget.report_html, self._get_scheme(),
widget.__module__, widget.icon)
self.table_model.add_item(item)
self._empty_report()
self.report_changed = True
return item
def _empty_report(self):
# disable save and print if no reports
self.save_button.setEnabled(self.table_model.rowCount())
self.print_button.setEnabled(self.table_model.rowCount())
def _build_html(self):
html = self.report_html_template
html += "<body>"
for i in range(self.table_model.rowCount()):
item = self.table_model.item(i)
html += "<div id='{}' class='normal' " \
"onClick='pybridge._select_item(this.id)'>{}<div " \
"class='textwrapper'><textarea " \
"placeholder='Write a comment...'" \
"onInput='this.innerHTML = this.value;" \
"pybridge._add_comment(this.parentNode.parentNode.id, this.value);'" \
">{}</textarea></div>" \
"</div>".format(item.id, item.html, item.comment)
html += "</body></html>"
self.report_view.setHtml(html)
def _scroll_to_item(self, item):
self.report_view.evalJS(
"document.getElementById('{}').scrollIntoView();".format(item.id))
def _change_selected_item(self, item):
self.report_view.evalJS(
"var sel_el = document.getElementsByClassName('selected')[0]; "
"if (sel_el.id != {}) "
" sel_el.className = 'normal';".format(item.id))
self.report_view.evalJS(
"document.getElementById('{}').className = 'selected';".format(
item.id))
self.report_changed = True
def make_report(self, widget):
item = self._add_item(widget)
self._build_html()
self._scroll_to_item(item)
self.table.selectRow(self.table_model.rowCount() - 1)
def _get_scheme(self):
canvas = self.get_canvas_instance()
return canvas.get_scheme_xml() if canvas else None
def _show_scheme(self, row):
scheme = self.table_model.item(row).scheme
canvas = self.get_canvas_instance()
if canvas:
document = canvas.current_document()
if document.isModifiedStrict():
self.last_scheme = canvas.get_scheme_xml()
self._load_scheme(scheme)
def _show_last_scheme(self):
if self.last_scheme:
self._load_scheme(self.last_scheme)
def _load_scheme(self, contents):
# forcibly load the contents into the associated CanvasMainWindow
# instance if one exists. Preserve `self` as the designated report.
canvas = self.get_canvas_instance()
if canvas is not None:
document = canvas.current_document()
old = document.scheme()
if old.has_report() and old.report_view() is self:
# remove self so it is not closed
old.set_report_view(None)
canvas.load_scheme_xml(contents)
scheme = canvas.current_document().scheme()
scheme.set_report_view(self)
def save_report(self):
"""Save report"""
formats = OrderedDict(
(('HTML (*.html)', '.html'), ('PDF (*.pdf)', '.pdf'),
('Report (*.report)', '.report')))
filename, selected_format = QFileDialog.getSaveFileName(
self, "Save Report", self.save_dir, ';;'.join(formats.keys()))
if not filename:
return QDialog.Rejected
# Set appropriate extension if not set by the user
expect_ext = formats[selected_format]
if not filename.endswith(expect_ext):
filename += expect_ext
self.save_dir = os.path.dirname(filename)
self.saveSettings()
_, extension = os.path.splitext(filename)
if extension == ".pdf":
printer = QPrinter()
printer.setPageSize(QPrinter.A4)
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName(filename)
self._print_to_printer(printer)
elif extension == ".report":
self.save(filename)
else:
def save_html(contents):
try:
with open(filename, "w", encoding="utf-8") as f:
f.write(contents)
except PermissionError:
self.permission_error(filename)
save_html(self.report_view.html())
self.report_changed = False
return QDialog.Accepted
def _print_to_printer(self, printer):
filename = printer.outputFileName()
if filename:
try:
# QtWebEngine
return self.report_view.page().printToPdf(filename)
except AttributeError:
try:
# QtWebKit
return self.report_view.print_(printer)
except AttributeError:
# QtWebEngine 5.6
pass
# Fallback to printing widget as an image
self.report_view.render(printer)
def _print_report(self):
printer = QPrinter()
print_dialog = QPrintDialog(printer, self)
print_dialog.setWindowTitle("Print report")
if print_dialog.exec_() != QDialog.Accepted:
return
self._print_to_printer(printer)
def save(self, filename):
attributes = {}
for key in ('last_scheme', 'open_dir'):
attributes[key] = getattr(self, key, None)
items = [
self.table_model.item(i)
for i in range(self.table_model.rowCount())
]
report = dict(__version__=1, attributes=attributes, items=items)
try:
with open(filename, 'wb') as f:
pickle.dump(report, f)
except PermissionError:
self.permission_error(filename)
@classmethod
def load(cls, filename):
with open(filename, 'rb') as f:
report = pickle.load(f)
if not isinstance(report, dict):
return report
self = cls()
self.__dict__.update(report['attributes'])
for item in report['items']:
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme, item.module,
item.icon_name, item.comment))
return self
def permission_error(self, filename):
message_critical(
self.tr("Permission error when trying to write report."),
title=self.tr("Error"),
informative_text=self.tr("Permission error occurred "
"while saving '{}'.").format(filename),
exc_info=True,
parent=self)
log.error("PermissionError when trying to write report.",
exc_info=True)
def is_empty(self):
return not self.table_model.rowCount()
def is_changed(self):
return self.report_changed
@staticmethod
def set_instance(report):
warnings.warn("OWReport.set_instance is deprecated",
DeprecationWarning,
stacklevel=2)
app_inst = QApplication.instance()
app_inst._report_window = report
@staticmethod
def get_instance():
warnings.warn("OWReport.get_instance is deprecated",
DeprecationWarning,
stacklevel=2)
app_inst = QApplication.instance()
if not hasattr(app_inst, "_report_window"):
report = OWReport()
app_inst._report_window = report
return app_inst._report_window
def get_canvas_instance(self):
# type: () -> Optional[CanvasMainWindow]
"""
Return a CanvasMainWindow instance to which this report is attached.
Return None if not associated with any window.
Returns
-------
window : Optional[CanvasMainWindow]
"""
# Run up the parent/window chain
parent = self.parent()
if parent is not None:
window = parent.window()
if isinstance(window, CanvasMainWindow):
return window
return None
def copy_to_clipboard(self):
self.report_view.triggerPageAction(self.report_view.page().Copy)
class OWReport(OWWidget):
name = "Report"
save_dir = Setting("")
open_dir = Setting("")
def __init__(self):
super().__init__()
self._setup_ui_()
self.report_changed = False
index_file = pkg_resources.resource_filename(__name__, "index.html")
with open(index_file, "r") as f:
self.report_html_template = f.read()
def _setup_ui_(self):
self.table_model = ReportItemModel(0, len(Column.__members__))
self.table = ReportTable(self.controlArea)
self.table.setModel(self.table_model)
self.table.setShowGrid(False)
self.table.setSelectionBehavior(QTableView.SelectRows)
self.table.setSelectionMode(QTableView.SingleSelection)
self.table.setWordWrap(False)
self.table.setMouseTracking(True)
self.table.verticalHeader().setSectionResizeMode(QHeaderView.Fixed)
self.table.verticalHeader().setDefaultSectionSize(20)
self.table.verticalHeader().setVisible(False)
self.table.horizontalHeader().setVisible(False)
self.table.setFixedWidth(250)
self.table.setColumnWidth(Column.item, 200)
self.table.setColumnWidth(Column.remove, 23)
self.table.setColumnWidth(Column.scheme, 25)
self.table.clicked.connect(self._table_clicked)
self.table.selectionModel().selectionChanged.connect(
self._table_selection_changed)
self.controlArea.layout().addWidget(self.table)
self.last_scheme = None
self.scheme_button = gui.button(
self.controlArea, self, "Back to Last Scheme",
callback=self._show_last_scheme
)
box = gui.hBox(self.controlArea)
box.setContentsMargins(-6, 0, -6, 0)
self.save_button = gui.button(
box, self, "Save", callback=self.save_report
)
self.print_button = gui.button(
box, self, "Print", callback=self._print_report
)
class PyBridge(QObject):
@pyqtSlot(str)
def _select_item(myself, item_id):
item = self.table_model.get_item_by_id(item_id)
self.table.selectRow(self.table_model.indexFromItem(item).row())
self._change_selected_item(item)
@pyqtSlot(str, str)
def _add_comment(myself, item_id, value):
item = self.table_model.get_item_by_id(item_id)
item.comment = value
self.report_changed = True
self.report_view = WebviewWidget(self.mainArea, bridge=PyBridge(self))
self.mainArea.layout().addWidget(self.report_view)
@deprecated("Widgets should not be pickled")
def __getstate__(self):
rep_dict = self.__dict__.copy()
for key in ('_OWWidget__env', 'controlArea', 'mainArea',
'report_view', 'table', 'table_model'):
del rep_dict[key]
items_len = self.table_model.rowCount()
return rep_dict, [self.table_model.item(i) for i in range(items_len)]
@deprecated("Widgets should not be pickled")
def __setstate__(self, state):
rep_dict, items = state
self.__dict__.update(rep_dict)
self._setup_ui_()
for i in range(len(items)):
item = items[i]
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme,
item.module, item.icon_name, item.comment)
)
def _table_clicked(self, index):
if index.column() == Column.remove:
self._remove_item(index.row())
indexes = self.table.selectionModel().selectedIndexes()
if indexes:
item = self.table_model.item(indexes[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
if index.column() == Column.scheme:
self._show_scheme(index.row())
def _table_selection_changed(self, new_selection, _):
if new_selection.indexes():
item = self.table_model.item(new_selection.indexes()[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
def _remove_item(self, row):
self.table_model.removeRow(row)
self.report_changed = True
self._build_html()
def clear(self):
self.table_model.clear()
self.report_changed = True
self._build_html()
def _add_item(self, widget):
name = widget.get_widget_name_extension()
name = "{} - {}".format(widget.name, name) if name else widget.name
item = ReportItem(name, widget.report_html, self._get_scheme(),
widget.__module__, widget.icon)
self.table_model.add_item(item)
self.report_changed = True
return item
def _build_html(self):
html = self.report_html_template
html += "<body>"
for i in range(self.table_model.rowCount()):
item = self.table_model.item(i)
html += "<div id='{}' class='normal' " \
"onClick='pybridge._select_item(this.id)'>{}<div " \
"class='textwrapper'><textarea " \
"placeholder='Write a comment...'" \
"onInput='this.innerHTML = this.value;" \
"pybridge._add_comment(this.parentNode.parentNode.id, this.value);'" \
">{}</textarea></div>" \
"</div>".format(item.id, item.html, item.comment)
html += "</body></html>"
self.report_view.setHtml(html)
def _scroll_to_item(self, item):
self.report_view.evalJS(
"document.getElementById('{}').scrollIntoView();".format(item.id)
)
def _change_selected_item(self, item):
self.report_view.evalJS(
"var sel_el = document.getElementsByClassName('selected')[0]; "
"if (sel_el.id != {}) "
" sel_el.className = 'normal';".format(item.id))
self.report_view.evalJS(
"document.getElementById('{}').className = 'selected';"
.format(item.id))
self.report_changed = True
def make_report(self, widget):
item = self._add_item(widget)
self._build_html()
self._scroll_to_item(item)
self.table.selectRow(self.table_model.rowCount() - 1)
def _get_scheme(self):
canvas = self.get_canvas_instance()
return canvas.get_scheme_xml() if canvas else None
def _show_scheme(self, row):
scheme = self.table_model.item(row).scheme
canvas = self.get_canvas_instance()
if canvas:
document = canvas.current_document()
if document.isModifiedStrict():
self.last_scheme = canvas.get_scheme_xml()
canvas.load_scheme_xml(scheme)
def _show_last_scheme(self):
if self.last_scheme:
canvas = self.get_canvas_instance()
if canvas:
canvas.load_scheme_xml(self.last_scheme)
def save_report(self):
"""Save report"""
filename, _ = QFileDialog.getSaveFileName(
self, "Save Report", self.save_dir,
"HTML (*.html);;PDF (*.pdf);;Report (*.report)")
if not filename:
return QDialog.Rejected
self.save_dir = os.path.dirname(filename)
self.saveSettings()
_, extension = os.path.splitext(filename)
if extension == ".pdf":
printer = QPrinter()
printer.setPageSize(QPrinter.A4)
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName(filename)
self.report_view.print_(printer)
elif extension == ".report":
self.save(filename)
else:
def save_html(contents):
try:
with open(filename, "w", encoding="utf-8") as f:
f.write(contents)
except PermissionError:
self.permission_error(filename)
save_html(self.report_view.html())
self.report_changed = False
return QDialog.Accepted
def _print_report(self):
printer = QPrinter()
print_dialog = QPrintDialog(printer, self)
print_dialog.setWindowTitle("Print report")
if print_dialog.exec_() != QDialog.Accepted:
return
self.report_view.print_(printer)
def open_report(self):
filename, _ = QFileDialog.getOpenFileName(
self, "Open Report", self.open_dir, "Report (*.report)")
if not filename:
return
self.report_changed = False
self.open_dir = os.path.dirname(filename)
self.saveSettings()
try:
report = self.load(filename)
except (IOError, AttributeError, pickle.UnpicklingError) as e:
message_critical(
self.tr("Could not load an Orange Report file"),
title=self.tr("Error"),
informative_text=self.tr("Error occurred "
"while loading '{}'.").format(filename),
exc_info=True,
parent=self)
log.error(str(e), exc_info=True)
return
self.set_instance(report)
self = report
self._build_html()
self.table.selectRow(0)
self.show()
self.raise_()
def save(self, filename):
attributes = {}
for key in ('last_scheme', 'open_dir'):
attributes[key] = getattr(self, key, None)
items = [self.table_model.item(i)
for i in range(self.table_model.rowCount())]
report = dict(__version__=1,
attributes=attributes,
items=items)
try:
with open(filename, 'wb') as f:
pickle.dump(report, f)
except PermissionError:
self.permission_error(filename)
@classmethod
def load(cls, filename):
with open(filename, 'rb') as f:
report = pickle.load(f)
if not isinstance(report, dict):
return report
self = cls()
self.__dict__.update(report['attributes'])
for item in report['items']:
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme,
item.module, item.icon_name, item.comment)
)
return self
def permission_error(self, filename):
message_critical(
self.tr("Permission error when trying to write report."),
title=self.tr("Error"),
informative_text=self.tr("Permission error occurred "
"while saving '{}'.").format(filename),
exc_info=True,
parent=self)
log.error("PermissionError when trying to write report.", exc_info=True)
def is_empty(self):
return not self.table_model.rowCount()
def is_changed(self):
return self.report_changed
@staticmethod
def set_instance(report):
app_inst = QApplication.instance()
app_inst._report_window = report
@staticmethod
def get_instance():
app_inst = QApplication.instance()
if not hasattr(app_inst, "_report_window"):
report = OWReport()
app_inst._report_window = report
return app_inst._report_window
@staticmethod
def get_canvas_instance():
for widget in QApplication.topLevelWidgets():
if isinstance(widget, CanvasMainWindow):
return widget
class OWReport(OWWidget):
name = "Report"
save_dir = Setting("")
open_dir = Setting("")
def __init__(self):
super().__init__()
self._setup_ui_()
self.report_changed = False
index_file = pkg_resources.resource_filename(__name__, "index.html")
with open(index_file, "r") as f:
self.report_html_template = f.read()
def _setup_ui_(self):
self.table_model = ReportItemModel(0, len(Column.__members__))
self.table = ReportTable(self.controlArea)
self.table.setModel(self.table_model)
self.table.setShowGrid(False)
self.table.setSelectionBehavior(QTableView.SelectRows)
self.table.setSelectionMode(QTableView.SingleSelection)
self.table.setWordWrap(False)
self.table.setMouseTracking(True)
self.table.verticalHeader().setSectionResizeMode(QHeaderView.Fixed)
self.table.verticalHeader().setDefaultSectionSize(20)
self.table.verticalHeader().setVisible(False)
self.table.horizontalHeader().setVisible(False)
self.table.setFixedWidth(250)
self.table.setColumnWidth(Column.item, 200)
self.table.setColumnWidth(Column.remove, 23)
self.table.setColumnWidth(Column.scheme, 25)
self.table.clicked.connect(self._table_clicked)
self.table.selectionModel().selectionChanged.connect(
self._table_selection_changed)
self.controlArea.layout().addWidget(self.table)
self.last_scheme = None
self.scheme_button = gui.button(
self.controlArea, self, "Back to Last Scheme",
callback=self._show_last_scheme
)
box = gui.hBox(self.controlArea)
box.setContentsMargins(-6, 0, -6, 0)
self.save_button = gui.button(
box, self, "Save", callback=self.save_report, disabled=True
)
self.print_button = gui.button(
box, self, "Print", callback=self._print_report, disabled=True
)
class PyBridge(QObject):
@pyqtSlot(str)
def _select_item(myself, item_id):
item = self.table_model.get_item_by_id(item_id)
self.table.selectRow(self.table_model.indexFromItem(item).row())
self._change_selected_item(item)
@pyqtSlot(str, str)
def _add_comment(myself, item_id, value):
item = self.table_model.get_item_by_id(item_id)
item.comment = value
self.report_changed = True
self.report_view = WebviewWidget(self.mainArea, bridge=PyBridge(self))
self.mainArea.layout().addWidget(self.report_view)
@deprecated("Widgets should not be pickled")
def __getstate__(self):
rep_dict = self.__dict__.copy()
for key in ('_OWWidget__env', 'controlArea', 'mainArea',
'report_view', 'table', 'table_model'):
del rep_dict[key]
items_len = self.table_model.rowCount()
return rep_dict, [self.table_model.item(i) for i in range(items_len)]
@deprecated("Widgets should not be pickled")
def __setstate__(self, state):
rep_dict, items = state
self.__dict__.update(rep_dict)
self._setup_ui_()
for i in range(len(items)):
item = items[i]
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme,
item.module, item.icon_name, item.comment)
)
def _table_clicked(self, index):
if index.column() == Column.remove:
self._remove_item(index.row())
indexes = self.table.selectionModel().selectedIndexes()
if indexes:
item = self.table_model.item(indexes[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
if index.column() == Column.scheme:
self._show_scheme(index.row())
def _table_selection_changed(self, new_selection, _):
if new_selection.indexes():
item = self.table_model.item(new_selection.indexes()[0].row())
self._scroll_to_item(item)
self._change_selected_item(item)
def _remove_item(self, row):
self.table_model.removeRow(row)
self._empty_report()
self.report_changed = True
self._build_html()
def clear(self):
self.table_model.clear()
self._empty_report()
self.report_changed = True
self._build_html()
def _add_item(self, widget):
name = widget.get_widget_name_extension()
name = "{} - {}".format(widget.name, name) if name else widget.name
item = ReportItem(name, widget.report_html, self._get_scheme(),
widget.__module__, widget.icon)
self.table_model.add_item(item)
self._empty_report()
self.report_changed = True
return item
def _empty_report(self):
# disable save and print if no reports
self.save_button.setEnabled(self.table_model.rowCount())
self.print_button.setEnabled(self.table_model.rowCount())
def _build_html(self):
html = self.report_html_template
html += "<body>"
for i in range(self.table_model.rowCount()):
item = self.table_model.item(i)
html += "<div id='{}' class='normal' " \
"onClick='pybridge._select_item(this.id)'>{}<div " \
"class='textwrapper'><textarea " \
"placeholder='Write a comment...'" \
"onInput='this.innerHTML = this.value;" \
"pybridge._add_comment(this.parentNode.parentNode.id, this.value);'" \
">{}</textarea></div>" \
"</div>".format(item.id, item.html, item.comment)
html += "</body></html>"
self.report_view.setHtml(html)
def _scroll_to_item(self, item):
self.report_view.evalJS(
"document.getElementById('{}').scrollIntoView();".format(item.id)
)
def _change_selected_item(self, item):
self.report_view.evalJS(
"var sel_el = document.getElementsByClassName('selected')[0]; "
"if (sel_el.id != {}) "
" sel_el.className = 'normal';".format(item.id))
self.report_view.evalJS(
"document.getElementById('{}').className = 'selected';"
.format(item.id))
self.report_changed = True
def make_report(self, widget):
item = self._add_item(widget)
self._build_html()
self._scroll_to_item(item)
self.table.selectRow(self.table_model.rowCount() - 1)
def _get_scheme(self):
canvas = self.get_canvas_instance()
return canvas.get_scheme_xml() if canvas else None
def _show_scheme(self, row):
scheme = self.table_model.item(row).scheme
canvas = self.get_canvas_instance()
if canvas:
document = canvas.current_document()
if document.isModifiedStrict():
self.last_scheme = canvas.get_scheme_xml()
self._load_scheme(scheme)
def _show_last_scheme(self):
if self.last_scheme:
self._load_scheme(self.last_scheme)
def _load_scheme(self, contents):
# forcibly load the contents into the associated CanvasMainWindow
# instance if one exists. Preserve `self` as the designated report.
canvas = self.get_canvas_instance()
if canvas is not None:
document = canvas.current_document()
old = document.scheme()
if old.has_report() and old.report_view() is self:
# remove self so it is not closed
old.set_report_view(None)
canvas.load_scheme_xml(contents)
scheme = canvas.current_document().scheme()
scheme.set_report_view(self)
def save_report(self):
"""Save report"""
formats = OrderedDict((('HTML (*.html)', '.html'),
('PDF (*.pdf)', '.pdf'),
('Report (*.report)', '.report')))
filename, selected_format = QFileDialog.getSaveFileName(
self, "Save Report", self.save_dir, ';;'.join(formats.keys()))
if not filename:
return QDialog.Rejected
# Set appropriate extension if not set by the user
expect_ext = formats[selected_format]
if not filename.endswith(expect_ext):
filename += expect_ext
self.save_dir = os.path.dirname(filename)
self.saveSettings()
_, extension = os.path.splitext(filename)
if extension == ".pdf":
printer = QPrinter()
printer.setPageSize(QPrinter.A4)
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName(filename)
self._print_to_printer(printer)
elif extension == ".report":
self.save(filename)
else:
def save_html(contents):
try:
with open(filename, "w", encoding="utf-8") as f:
f.write(contents)
except PermissionError:
self.permission_error(filename)
save_html(self.report_view.html())
self.report_changed = False
return QDialog.Accepted
def _print_to_printer(self, printer):
filename = printer.outputFileName()
if filename:
try:
# QtWebEngine
return self.report_view.page().printToPdf(filename)
except AttributeError:
try:
# QtWebKit
return self.report_view.print_(printer)
except AttributeError:
# QtWebEngine 5.6
pass
# Fallback to printing widget as an image
self.report_view.render(printer)
def _print_report(self):
printer = QPrinter()
print_dialog = QPrintDialog(printer, self)
print_dialog.setWindowTitle("Print report")
if print_dialog.exec_() != QDialog.Accepted:
return
self._print_to_printer(printer)
def save(self, filename):
attributes = {}
for key in ('last_scheme', 'open_dir'):
attributes[key] = getattr(self, key, None)
items = [self.table_model.item(i)
for i in range(self.table_model.rowCount())]
report = dict(__version__=1,
attributes=attributes,
items=items)
try:
with open(filename, 'wb') as f:
pickle.dump(report, f)
except PermissionError:
self.permission_error(filename)
@classmethod
def load(cls, filename):
with open(filename, 'rb') as f:
report = pickle.load(f)
if not isinstance(report, dict):
return report
self = cls()
self.__dict__.update(report['attributes'])
for item in report['items']:
self.table_model.add_item(
ReportItem(item.name, item.html, item.scheme,
item.module, item.icon_name, item.comment)
)
return self
def permission_error(self, filename):
message_critical(
self.tr("Permission error when trying to write report."),
title=self.tr("Error"),
informative_text=self.tr("Permission error occurred "
"while saving '{}'.").format(filename),
exc_info=True,
parent=self)
log.error("PermissionError when trying to write report.", exc_info=True)
def is_empty(self):
return not self.table_model.rowCount()
def is_changed(self):
return self.report_changed
@staticmethod
def set_instance(report):
warnings.warn(
"OWReport.set_instance is deprecated",
DeprecationWarning, stacklevel=2
)
app_inst = QApplication.instance()
app_inst._report_window = report
@staticmethod
def get_instance():
warnings.warn(
"OWReport.get_instance is deprecated",
DeprecationWarning, stacklevel=2
)
app_inst = QApplication.instance()
if not hasattr(app_inst, "_report_window"):
report = OWReport()
app_inst._report_window = report
return app_inst._report_window
def get_canvas_instance(self):
# type: () -> Optional[CanvasMainWindow]
"""
Return a CanvasMainWindow instance to which this report is attached.
Return None if not associated with any window.
Returns
-------
window : Optional[CanvasMainWindow]
"""
# Run up the parent/window chain
parent = self.parent()
if parent is not None:
window = parent.window()
if isinstance(window, CanvasMainWindow):
return window
return None
def copy_to_clipboard(self):
self.report_view.triggerPageAction(self.report_view.page().Copy)
