# -*- coding: utf-8 -*-
"""Navigator Exceptions and Exception handling module."""
from __future__ import annotations
__all__ = ['CustomMessageException', 'exception_handler']
import html
import os
import tempfile
import traceback
import typing
import urllib.request
import webbrowser
class CustomMessageException(Exception):
"""
Exception with custom error message.
:param message: Message to be displayed.
Should be a pre-formatted HTML content.
"""
def __init__(self, message: str) -> None:
"""Initialize new :class:`~CustomMessageException` instance."""
super().__init__(message)
self.__message: typing.Final[str] = message
@property
def message(self) -> str:
"""Content to display on qt error box or html page"""
return self.__message
def form_default_html_message(error: Exception, trace: str) -> str:
"""Form message when we do not get it in CustomMessageException instance."""
return f'''
Navigator Error
An unexpected error occurred on Navigator start-up
Report
Please report this issue in the anaconda
issue tracker
Main Error
{html.escape(str(error))}
Traceback
{html.escape(str(trace))}'''
def display_qt_error_box(message):
"""Display a Qt styled error message box."""
# pylint: disable=import-outside-toplevel,cyclic-import
from anaconda_navigator.app import start
from anaconda_navigator.widgets.dialogs import MessageBoxError
if not hasattr(start, 'app'):
raise AttributeError('Qt application is not initialized')
msg_box = MessageBoxError(
title='Navigator Start Error',
text=message,
report=False, # Disable reporting on github
learn_more=None,
)
msg_box.setFixedWidth(600)
return msg_box.exec_()
def display_browser_error_box(message: str) -> None:
"""
Display a new browser tab with an error description.
:param message: HTML content to show on web page.
"""
content: str = f'''
Navigator Error
{message}
'''
file_descriptor: int
file_path: str
file_descriptor, file_path = tempfile.mkstemp(suffix='.html')
file_stream: typing.TextIO
with os.fdopen(file_descriptor, 'wt', encoding='utf-8') as file_stream:
file_stream.write(content)
webbrowser.open_new_tab(f'file://{urllib.request.pathname2url(os.path.abspath(file_path))}')
def exception_handler(
func: typing.Callable[..., typing.Any],
*args: typing.Any,
**kwargs: typing.Any,
) -> typing.Optional[int]:
"""Handle global application exceptions and display information."""
try:
return_value = func(*args, **kwargs)
if isinstance(return_value, int):
return return_value
except Exception as exception: # pylint: disable=broad-except
handle_exception(exception)
return None
def handle_exception(error: Exception) -> None:
"""This will provide a dialog for the user with the error found."""
# pylint: disable=import-outside-toplevel,cyclic-import
from anaconda_navigator.utils.logs import logger
logger.critical(error, exc_info=True)
message: str
if isinstance(error, CustomMessageException):
message = error.message
else:
message = form_default_html_message(error, traceback.format_exc())
try:
display_qt_error_box(message)
except Exception as exception: # pylint: disable=broad-except
logger.exception(exception)
display_browser_error_box(message)