Robot Framework
robot.result.resultbuilder.ExecutionResultBuilder Class Reference

Builds :class:~.executionresult.Result objects based on output files. More...

Public Member Functions

def __init__ (self, source, include_keywords=True, flattened_keywords=None)
 :param source: Path to the XML output file to build :class:~.executionresult.Result objects from. More...
 
def build (self, result)
 

Private Member Functions

def _flatten_keywords (self, context, flattened)
 
def _get_matcher (self, matcher_class, flattened)
 
def _omit_keywords (self, context)
 
def _parse (self, source, start, end)
 

Private Attributes

 _flattened_keywords
 
 _include_keywords
 
 _source
 

Detailed Description

Builds :class:~.executionresult.Result objects based on output files.

Instead of using this builder directly, it is recommended to use the
:func:`ExecutionResult` factory method.

Definition at line 85 of file resultbuilder.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.result.resultbuilder.ExecutionResultBuilder.__init__ (   self,
  source,
  include_keywords = True,
  flattened_keywords = None 
)

:param source: Path to the XML output file to build :class:~.executionresult.Result objects from.

:param include_keywords: Boolean controlling whether to include keyword information in the result or not. Keywords are not needed when generating only report. Although the the option name has word "keyword", it controls also including FOR and IF structures. :param flatten_keywords: List of patterns controlling what keywords to flatten. See the documentation of --flattenkeywords option for more details.

Definition at line 98 of file resultbuilder.py.

Member Function Documentation

◆ _flatten_keywords()

def robot.result.resultbuilder.ExecutionResultBuilder._flatten_keywords (   self,
  context,
  flattened 
)
private

Definition at line 143 of file resultbuilder.py.

◆ _get_matcher()

def robot.result.resultbuilder.ExecutionResultBuilder._get_matcher (   self,
  matcher_class,
  flattened 
)
private

Definition at line 192 of file resultbuilder.py.

◆ _omit_keywords()

def robot.result.resultbuilder.ExecutionResultBuilder._omit_keywords (   self,
  context 
)
private

Definition at line 127 of file resultbuilder.py.

◆ _parse()

def robot.result.resultbuilder.ExecutionResultBuilder._parse (   self,
  source,
  start,
  end 
)
private

Definition at line 114 of file resultbuilder.py.

◆ build()

def robot.result.resultbuilder.ExecutionResultBuilder.build (   self,
  result 
)

Definition at line 104 of file resultbuilder.py.

Member Data Documentation

◆ _flattened_keywords

robot.result.resultbuilder.ExecutionResultBuilder._flattened_keywords
private

Definition at line 102 of file resultbuilder.py.

◆ _include_keywords

robot.result.resultbuilder.ExecutionResultBuilder._include_keywords
private

Definition at line 101 of file resultbuilder.py.

◆ _source

robot.result.resultbuilder.ExecutionResultBuilder._source
private

Definition at line 99 of file resultbuilder.py.


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