robot.variables.variables.Variables Class Reference

Represents a set of variables. More...

Inheritance diagram for robot.variables.variables.Variables:

Public Member Functions
def	__contains__ (self, name)
def	__getitem__ (self, name)
def	__init__ (self)
def	__setitem__ (self, name, value)
def	as_dict (self, decoration=True)
def	clear (self)
def	copy (self)
def	replace_list (self, items, replace_until=None, ignore_errors=False)
def	replace_scalar (self, item, ignore_errors=False)
def	replace_string (self, item, custom_unescaper=None, ignore_errors=False)
def	resolve_delayed (self)
def	set_from_file (self, path_or_variables, args=None, overwrite=False)
def	set_from_variable_table (self, variables, overwrite=False)
def	update (self, variables)

Public Attributes
	store

Private Attributes
	_replacer

Detailed Description

Represents a set of variables.

Contains methods for replacing variables from list, scalars, and strings.
On top of ${scalar}, @{list} and &{dict} variables, these methods handle
also %{environment} variables.

Definition at line 30 of file variables.py.

Constructor & Destructor Documentation

__init__()

def robot.variables.variables.Variables.__init__

(

self

)

Definition at line 32 of file variables.py.

Member Function Documentation

__contains__()

def robot.variables.variables.Variables.__contains__	(		self,
			name
	)

Definition at line 42 of file variables.py.

__getitem__()

def robot.variables.variables.Variables.__getitem__	(		self,
			name
	)

Definition at line 39 of file variables.py.

__setitem__()

def robot.variables.variables.Variables.__setitem__	(		self,
			name,
			value
	)

Definition at line 36 of file variables.py.

as_dict()

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

Definition at line 79 of file variables.py.

clear()

def robot.variables.variables.Variables.clear

(

self

)

Definition at line 68 of file variables.py.

copy()

def robot.variables.variables.Variables.copy

(

self

)

Definition at line 71 of file variables.py.

replace_list()

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

Definition at line 48 of file variables.py.

replace_scalar()

def robot.variables.variables.Variables.replace_scalar	(		self,
			item,
			ignore_errors = False
	)

Definition at line 54 of file variables.py.

replace_string()

def robot.variables.variables.Variables.replace_string	(		self,
			item,
			custom_unescaper = None,
			ignore_errors = False
	)

Definition at line 57 of file variables.py.

resolve_delayed()

def robot.variables.variables.Variables.resolve_delayed

(

self

)

Definition at line 45 of file variables.py.

set_from_file()

def robot.variables.variables.Variables.set_from_file	(		self,
			path_or_variables,
			args = None,
			overwrite = False
	)

Definition at line 60 of file variables.py.

set_from_variable_table()

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

Definition at line 64 of file variables.py.

update()

def robot.variables.variables.Variables.update	(		self,
			variables
	)

Definition at line 76 of file variables.py.

Member Data Documentation

_replacer

robot.variables.variables.Variables._replacer

private

Definition at line 34 of file variables.py.

store

robot.variables.variables.Variables.store

Definition at line 33 of file variables.py.

---

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

• src/robot/variables/variables.py