message.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.
 
from robot.utils import html_escape
 
from .body import BodyItem
from .itemlist import ItemList
 
 
 
class Message(BodyItem):
    type = BodyItem.MESSAGE
    repr_args = ('message', 'level')
    __slots__ = ['message', 'level', 'html', 'timestamp']
 
    def __init__(self, message='', level='INFO', html=False, timestamp=None, parent=None):
        #: The message content as a string.
        self.messagemessage = message
        #: Severity of the message. Either ``TRACE``, ``DEBUG``, ``INFO``,
        #: ``WARN``, ``ERROR``, ``FAIL`` or ``SKIP`. The last two are only used
        #: with keyword failure messages.
        self.levellevel = level
        #: ``True`` if the content is in HTML, ``False`` otherwise.
        self.htmlhtml = html
        #: Timestamp in format ``%Y%m%d %H:%M:%S.%f``.
        self.timestamptimestamp = timestamp
        #: The object this message was triggered by.
        self.parentparent = parent
 
    @property
    
    html_message = property
    
    def html_message(self):
        return self.messagemessage if self.htmlhtml else html_escape(self.messagemessage)
 
    @property
    id = property
    
    def id(self):
        if not self.parentparent:
            return 'm1'
        return '%s-m%d' % (self.parentparent.id, self.parentparent.messages.index(self) + 1)
 
    
    def visit(self, visitor):
        visitor.visit_message(self)
 
    def __str__(self):
        return self.messagemessage
 
 
class Messages(ItemList):
    __slots__ = []
 
    def __init__(self, message_class=Message, parent=None, messages=None):
        ItemList.__init__(self, message_class, {'parent': parent}, messages)