Robot Framework
robot.variables.scopes.VariableScopes Class Reference

Public Member Functions

def __contains__ (self, name)
 
def __getitem__ (self, name)
 
def __init__ (self, settings)
 
def __setitem__ (self, name, value)
 
def as_dict (self, decoration=True)
 
def end_keyword (self)
 
def end_suite (self)
 
def end_test (self)
 
def replace_list (self, items, replace_until=None, ignore_errors=False)
 
def replace_scalar (self, items, ignore_errors=False)
 
def replace_string (self, string, custom_unescaper=None, ignore_errors=False)
 
def resolve_delayed (self)
 
def set_from_file (self, path, args, overwrite=False)
 
def set_from_variable_table (self, variables, overwrite=False)
 
def set_global (self, name, value)
 
def set_keyword (self, name, value)
 
def set_local_variable (self, name, value)
 
def set_suite (self, name, value, top=False, children=False)
 
def set_test (self, name, value)
 
def start_keyword (self)
 
def start_suite (self)
 
def start_test (self)
 

Properties

 _all_scopes = property
 
 _scopes_until_suite = property
 
 _scopes_until_test = property
 
 current = property
 

Private Member Functions

def _all_scopes (self)
 
def _scopes_until_suite (self)
 
def _scopes_until_test (self)
 
def _set_global_suite_or_test (self, scope, name, value)
 
def current (self)
 

Private Attributes

 _global
 
 _scopes
 
 _suite
 
 _test
 
 _variables_set
 

Detailed Description

Definition at line 28 of file scopes.py.

Constructor & Destructor Documentation

◆ __init__()

def robot.variables.scopes.VariableScopes.__init__ (   self,
  settings 
)

Definition at line 30 of file scopes.py.

Member Function Documentation

◆ __contains__()

def robot.variables.scopes.VariableScopes.__contains__ (   self,
  name 
)

Definition at line 104 of file scopes.py.

◆ __getitem__()

def robot.variables.scopes.VariableScopes.__getitem__ (   self,
  name 
)

Definition at line 98 of file scopes.py.

◆ __setitem__()

def robot.variables.scopes.VariableScopes.__setitem__ (   self,
  name,
  value 
)

Definition at line 101 of file scopes.py.

◆ _all_scopes()

def robot.variables.scopes.VariableScopes._all_scopes (   self)
private

Definition at line 46 of file scopes.py.

◆ _scopes_until_suite()

def robot.variables.scopes.VariableScopes._scopes_until_suite (   self)
private

Definition at line 52 of file scopes.py.

◆ _scopes_until_test()

def robot.variables.scopes.VariableScopes._scopes_until_test (   self)
private

Definition at line 61 of file scopes.py.

◆ _set_global_suite_or_test()

def robot.variables.scopes.VariableScopes._set_global_suite_or_test (   self,
  scope,
  name,
  value 
)
private

Definition at line 137 of file scopes.py.

◆ as_dict()

def robot.variables.scopes.VariableScopes.as_dict (   self,
  decoration = True 
)

Definition at line 168 of file scopes.py.

◆ current()

def robot.variables.scopes.VariableScopes.current (   self)
private

Definition at line 40 of file scopes.py.

◆ end_keyword()

def robot.variables.scopes.VariableScopes.end_keyword (   self)

Definition at line 94 of file scopes.py.

◆ end_suite()

def robot.variables.scopes.VariableScopes.end_suite (   self)

Definition at line 73 of file scopes.py.

◆ end_test()

def robot.variables.scopes.VariableScopes.end_test (   self)

Definition at line 83 of file scopes.py.

◆ replace_list()

def robot.variables.scopes.VariableScopes.replace_list (   self,
  items,
  replace_until = None,
  ignore_errors = False 
)

Definition at line 107 of file scopes.py.

◆ replace_scalar()

def robot.variables.scopes.VariableScopes.replace_scalar (   self,
  items,
  ignore_errors = False 
)

Definition at line 110 of file scopes.py.

◆ replace_string()

def robot.variables.scopes.VariableScopes.replace_string (   self,
  string,
  custom_unescaper = None,
  ignore_errors = False 
)

Definition at line 113 of file scopes.py.

◆ resolve_delayed()

def robot.variables.scopes.VariableScopes.resolve_delayed (   self)

Definition at line 128 of file scopes.py.

◆ set_from_file()

def robot.variables.scopes.VariableScopes.set_from_file (   self,
  path,
  args,
  overwrite = False 
)

Definition at line 116 of file scopes.py.

◆ set_from_variable_table()

def robot.variables.scopes.VariableScopes.set_from_variable_table (   self,
  variables,
  overwrite = False 
)

Definition at line 124 of file scopes.py.

◆ set_global()

def robot.variables.scopes.VariableScopes.set_global (   self,
  name,
  value 
)

Definition at line 132 of file scopes.py.

◆ set_keyword()

def robot.variables.scopes.VariableScopes.set_keyword (   self,
  name,
  value 
)

Definition at line 161 of file scopes.py.

◆ set_local_variable()

def robot.variables.scopes.VariableScopes.set_local_variable (   self,
  name,
  value 
)

Definition at line 165 of file scopes.py.

◆ set_suite()

def robot.variables.scopes.VariableScopes.set_suite (   self,
  name,
  value,
  top = False,
  children = False 
)

Definition at line 145 of file scopes.py.

◆ set_test()

def robot.variables.scopes.VariableScopes.set_test (   self,
  name,
  value 
)

Definition at line 154 of file scopes.py.

◆ start_keyword()

def robot.variables.scopes.VariableScopes.start_keyword (   self)

Definition at line 88 of file scopes.py.

◆ start_suite()

def robot.variables.scopes.VariableScopes.start_suite (   self)

Definition at line 67 of file scopes.py.

◆ start_test()

def robot.variables.scopes.VariableScopes.start_test (   self)

Definition at line 78 of file scopes.py.

Member Data Documentation

◆ _global

robot.variables.scopes.VariableScopes._global
private

Definition at line 31 of file scopes.py.

◆ _scopes

robot.variables.scopes.VariableScopes._scopes
private

Definition at line 34 of file scopes.py.

◆ _suite

robot.variables.scopes.VariableScopes._suite
private

Definition at line 32 of file scopes.py.

◆ _test

robot.variables.scopes.VariableScopes._test
private

Definition at line 33 of file scopes.py.

◆ _variables_set

robot.variables.scopes.VariableScopes._variables_set
private

Definition at line 35 of file scopes.py.

Property Documentation

◆ _all_scopes

robot.variables.scopes.VariableScopes._all_scopes = property
staticprivate

Definition at line 44 of file scopes.py.

◆ _scopes_until_suite

robot.variables.scopes.VariableScopes._scopes_until_suite = property
staticprivate

Definition at line 50 of file scopes.py.

◆ _scopes_until_test

robot.variables.scopes.VariableScopes._scopes_until_test = property
staticprivate

Definition at line 59 of file scopes.py.

◆ current

robot.variables.scopes.VariableScopes.current = property
static

Definition at line 38 of file scopes.py.


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