Robot Framework
robot.utils.text Namespace Reference

Functions

def _count_line_lengths (lines)
 
def _count_virtual_line_length (line)
 
def _cut_long_line (line, used, from_end)
 
def _dict_to_str (d)
 
def _get_arg_separator_index_from_name_or_path (name)
 
def _lose_width (text, diff)
 
def _pad_width (text, width)
 
def _prune_excess_lines (lines, lengths, from_end=False)
 
def cut_assign_value (value)
 
def cut_long_message (msg)
 
def format_assign_message (variable, value, cut_long=True)
 
def get_console_length (text)
 
def getdoc (item)
 
def getshortdoc (doc_or_item, linesep='\n')
 
def pad_console_length (text, width)
 
def split_args_from_name_or_path (name)
 Split arguments embedded to name or path like Example:arg1:arg2. More...
 
def split_tags_from_doc (doc)
 

Variables

string _ERROR_CUT_EXPLN
 
int _MAX_ERROR_LINE_LENGTH
 
 _TAGS_RE
 
int MAX_ASSIGN_LENGTH = 200
 
int MAX_ERROR_LINES = 40
 

Function Documentation

◆ _count_line_lengths()

def robot.utils.text._count_line_lengths (   lines)
private

Definition at line 81 of file text.py.

◆ _count_virtual_line_length()

def robot.utils.text._count_virtual_line_length (   line)
private

Definition at line 84 of file text.py.

◆ _cut_long_line()

def robot.utils.text._cut_long_line (   line,
  used,
  from_end 
)
private

Definition at line 71 of file text.py.

◆ _dict_to_str()

def robot.utils.text._dict_to_str (   d)
private

Definition at line 98 of file text.py.

◆ _get_arg_separator_index_from_name_or_path()

def robot.utils.text._get_arg_separator_index_from_name_or_path (   name)
private

Definition at line 154 of file text.py.

◆ _lose_width()

def robot.utils.text._lose_width (   text,
  diff 
)
private

Definition at line 128 of file text.py.

◆ _pad_width()

def robot.utils.text._pad_width (   text,
  width 
)
private

Definition at line 124 of file text.py.

◆ _prune_excess_lines()

def robot.utils.text._prune_excess_lines (   lines,
  lengths,
  from_end = False 
)
private

Definition at line 54 of file text.py.

◆ cut_assign_value()

def robot.utils.text.cut_assign_value (   value)

Definition at line 104 of file text.py.

◆ cut_long_message()

def robot.utils.text.cut_long_message (   msg)

Definition at line 43 of file text.py.

◆ format_assign_message()

def robot.utils.text.format_assign_message (   variable,
  value,
  cut_long = True 
)

Definition at line 91 of file text.py.

◆ get_console_length()

def robot.utils.text.get_console_length (   text)

Definition at line 112 of file text.py.

◆ getdoc()

def robot.utils.text.getdoc (   item)

Definition at line 180 of file text.py.

◆ getshortdoc()

def robot.utils.text.getshortdoc (   doc_or_item,
  linesep = '\n' 
)

Definition at line 184 of file text.py.

◆ pad_console_length()

def robot.utils.text.pad_console_length (   text,
  width 
)

Definition at line 116 of file text.py.

◆ split_args_from_name_or_path()

def robot.utils.text.split_args_from_name_or_path (   name)

Split arguments embedded to name or path like Example:arg1:arg2.

The separator can be either colon ``:`` or semicolon ``;``. If both are used,
the first one is considered to be the separator.

Definition at line 141 of file text.py.

◆ split_tags_from_doc()

def robot.utils.text.split_tags_from_doc (   doc)

Definition at line 167 of file text.py.

Variable Documentation

◆ _ERROR_CUT_EXPLN

robot.utils.text._ERROR_CUT_EXPLN
private

Definition at line 36 of file text.py.

◆ _MAX_ERROR_LINE_LENGTH

robot.utils.text._MAX_ERROR_LINE_LENGTH
private

Definition at line 32 of file text.py.

◆ _TAGS_RE

robot.utils.text._TAGS_RE
private

Definition at line 40 of file text.py.

◆ MAX_ASSIGN_LENGTH

int robot.utils.text.MAX_ASSIGN_LENGTH = 200

Definition at line 28 of file text.py.

◆ MAX_ERROR_LINES

int robot.utils.text.MAX_ERROR_LINES = 40

Definition at line 27 of file text.py.