logger.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import re
import sys
 
import wx
 
from ..publish import RideParserLogMessage
from ..widgets import RIDEDialog
 
 
class Logger():
    empty_suite_init_file_warn = re.compile("Test suite directory initialization "
                                            "file '.*' contains no test data.")
 
    def __init__(self):
        self._messages_messages = []
 
    def report_parsing_errors(self):
        errors = [m[0] for m in self._messages_messages]
        if errors:
            errors = set(errors)
            msg = '\n'.join(self._format_parsing_error_line_format_parsing_error_line(line) for line in errors)
            # print("DEBUG: logger: %s" % msg)
            self._messages_messages = []
            RideParserLogMessage(msg, level='PARSER').publish()
            # Warnings from robot.variables.Variables.set_from_variable_tablems
            # are present multiple times, issue 486.
            """
            errors = set(errors)
            dlg = ParsingErrorDialog('\n'.join(self._format_parsing_error_line(line)
                                               for line in errors))
            dlg.ShowModal()
            dlg.Destroy()
            """
        self._messages_messages = []
 
    def _format_parsing_error_line(self, line):
        if ':' not in line:
            return line
        index = line.index(':') + 1
        return line[:index] + '\n\t' + line[index:]
 
    def warn(self, msg=''):
        self._write_write(msg, 'WARN')
 
    def error(self, msg=''):
        self._write_write(msg, 'ERROR')
 
    def message(self, msg):
        message, level = msg.message, msg.level.upper()
        if self._is_logged_is_logged(level):
            self._messages_messages.append((message, level))
 
    def _write(self, msg, level):
        level = level.upper()
        if self._is_logged_is_logged(level) and not self._is_ignored_warning_is_ignored_warning(msg):
            self._show_message_show_message(msg, level)
 
    def _is_logged(self, level):
        return level.upper() in ['ERROR', 'WARN']
 
    def _is_ignored_warning(self, msg):
        return self.empty_suite_init_file_warnempty_suite_init_file_warn.search(msg)
 
    def _show_message(self, msg, level):
        try:
            icon = level == 'ERROR' and wx.ICON_ERROR or wx.ICON_WARNING
            wx.MessageBox(msg, level, icon)
        except wx.PyNoAppError:
            sys.stderr.write('%s: %s\n' % (level, msg))
 
 
class ParsingErrorDialog(RIDEDialog):
 
    def __init__(self, message):
        RIDEDialog.__init__(self, title='Parsing errors', size=(700, 400),
                            style=wx.DEFAULT_FRAME_STYLE)
        # set Left to Right direction (while we don't have localization)
        self.SetLayoutDirection(wx.Layout_LeftToRight)
        area = wx.TextCtrl(self, size=(700,400), style=wx.TE_MULTILINE|wx.TE_DONTWRAP|wx.TE_READONLY|wx.TE_NOHIDESEL)
        area.SetValue(message)