Robot Framework
robot.model.message.Message Class Reference

A message created during the test execution. More...

Inheritance diagram for robot.model.message.Message:
robot.model.body.BodyItem robot.model.modelobject.ModelObject metaclass robot.result.model.Message

Public Member Functions

def __init__ (self, message='', level='INFO', html=False, timestamp=None, parent=None)
 
def __str__ (self)
 
def visit (self, visitor)
 :mod:Visitor interface <robot.model.visitor> entry-point. More...
 
- Public Member Functions inherited from robot.model.modelobject.ModelObject
def __repr__ (self)
 
def config (self, **attributes)
 Configure model object with given attributes. More...
 
def copy (self, **attributes)
 Return shallow copy of this object. More...
 
def deepcopy (self, **attributes)
 Return deep copy of this object. More...
 

Public Attributes

 html
 
 level
 
 message
 
 parent
 
 timestamp
 

Static Public Attributes

tuple repr_args = ('message', 'level')
 
 type = BodyItem.MESSAGE
 
- Static Public Attributes inherited from robot.model.body.BodyItem
string BREAK = 'BREAK'
 
string CONTINUE = 'CONTINUE'
 
string ELSE = 'ELSE'
 
string ELSE_IF = 'ELSE IF'
 
string EXCEPT = 'EXCEPT'
 
string FINALLY = 'FINALLY'
 
string FOR = 'FOR'
 
string IF = 'IF'
 
string IF_ELSE_ROOT = 'IF/ELSE ROOT'
 
string ITERATION = 'ITERATION'
 
string KEYWORD = 'KEYWORD'
 
string MESSAGE = 'MESSAGE'
 
string RETURN = 'RETURN'
 
string SETUP = 'SETUP'
 
string TEARDOWN = 'TEARDOWN'
 
string TRY = 'TRY'
 
string TRY_EXCEPT_ROOT = 'TRY/EXCEPT ROOT'
 
 type = None
 
string WHILE = 'WHILE'
 
- Static Public Attributes inherited from robot.model.modelobject.ModelObject
tuple repr_args = ()
 

Properties

 html_message = property
 Returns the message content as HTML. More...
 
 id = property
 
- Properties inherited from robot.model.body.BodyItem
 has_setup = property
 
 has_teardown = property
 
 id = property
 Item id in format like s1-t3-k1. More...
 

Private Member Functions

def html_message (self)
 
def id (self)
 

Static Private Attributes

list __slots__ = ['message', 'level', 'html', 'timestamp']
 

Detailed Description

A message created during the test execution.

Can be a log message triggered by a keyword, or a warning or an error
that occurred during parsing or test execution.

Definition at line 27 of file message.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.model.message.Message.__init__ (   self,
  message = '',
  level = 'INFO',
  html = False,
  timestamp = None,
  parent = None 
)

Definition at line 32 of file message.py.

Member Function Documentation

◆ __str__()

def robot.model.message.Message.__str__ (   self)

Definition at line 65 of file message.py.

◆ html_message()

def robot.model.message.Message.html_message (   self)
private

Definition at line 50 of file message.py.

◆ id()

def robot.model.message.Message.id (   self)
private

Reimplemented from robot.model.body.BodyItem.

Definition at line 56 of file message.py.

◆ visit()

def robot.model.message.Message.visit (   self,
  visitor 
)

:mod:Visitor interface <robot.model.visitor> entry-point.

Definition at line 62 of file message.py.

Member Data Documentation

◆ __slots__

list robot.model.message.Message.__slots__ = ['message', 'level', 'html', 'timestamp']
staticprivate

Definition at line 30 of file message.py.

◆ html

robot.model.message.Message.html

Definition at line 40 of file message.py.

◆ level

robot.model.message.Message.level

Definition at line 38 of file message.py.

◆ message

robot.model.message.Message.message

Definition at line 34 of file message.py.

◆ parent

robot.model.message.Message.parent

Definition at line 44 of file message.py.

◆ repr_args

tuple robot.model.message.Message.repr_args = ('message', 'level')
static

Definition at line 29 of file message.py.

◆ timestamp

robot.model.message.Message.timestamp

Definition at line 42 of file message.py.

◆ type

robot.model.message.Message.type = BodyItem.MESSAGE
static

Definition at line 28 of file message.py.

Property Documentation

◆ html_message

robot.model.message.Message.html_message = property
static

Returns the message content as HTML.

Definition at line 48 of file message.py.

◆ id

robot.model.message.Message.id = property
static

Definition at line 54 of file message.py.


The documentation for this class was generated from the following file: