EnvConfig.Variable.VariableProcessor Class Reference
Inheritance diagram for EnvConfig.Variable.VariableProcessor:
Collaboration diagram for EnvConfig.Variable.VariableProcessor:

Public Member Functions

def __init__ (self, env)
 
def isTarget (self, variable)
 
def process (self, variable, value)
 
def __call__ (self, variable, value)
 

Private Attributes

 _env
 

Detailed Description

Base class for the objects used to process the variables.

Definition at line 12 of file Variable.py.

Constructor & Destructor Documentation

def EnvConfig.Variable.VariableProcessor.__init__ (   self,
  env 
)
@param env: dictionary with the reference environment to use

Definition at line 16 of file Variable.py.

16  def __init__(self, env):
17  '''
18  @param env: dictionary with the reference environment to use
19  '''
20  if env is None:
21  env = {}
22  self._env = env
23 

Member Function Documentation

def EnvConfig.Variable.VariableProcessor.__call__ (   self,
  variable,
  value 
)

Definition at line 40 of file Variable.py.

40  def __call__(self, variable, value):
41  return self.process(variable, value)
42 
def process(self, variable, value)
Definition: Variable.py:30
def __call__(self, variable, value)
Definition: Variable.py:40
def EnvConfig.Variable.VariableProcessor.isTarget (   self,
  variable 
)
Return True if this processor can operate on the given variable.

Definition at line 24 of file Variable.py.

24  def isTarget(self, variable):
25  '''
26  Return True if this processor can operate on the given variable.
27  '''
28  return True
29 
def isTarget(self, variable)
Definition: Variable.py:24
def EnvConfig.Variable.VariableProcessor.process (   self,
  variable,
  value 
)
Process the variable.

@param value: the content of the variable to be processed
@return: the processed value

Definition at line 30 of file Variable.py.

30  def process(self, variable, value):
31  '''
32  Process the variable.
33 
34  @param value: the content of the variable to be processed
35  @return: the processed value
36  '''
37  # by default do nothing
38  return value
39 
def process(self, variable, value)
Definition: Variable.py:30

Member Data Documentation

EnvConfig.Variable.VariableProcessor._env
private

Definition at line 22 of file Variable.py.


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