Added function config_escape

[moe.git] / t / moe / config.py

diff --git a/t/moe/config.py b/t/moe/config.py
index e6ce045913797a4ff411ee84357fe543f1ab9a1d..ec057e1cc3bb9edeb347a0ca9fe348fe684e3cfe 100644 (file)
--- a/t/moe/config.py
+++ b/t/moe/config.py
@@ -1,15 +1,6 @@
 """
-Lazy conditional string evaluation module for Moe configuration variables.
+Module for managing and evaluation of Moe configuration variables.
 
-* Each variable has ordered list of operations (definitions), each defining operation either 
-  assigns (SET) or appends (APPEND) value of an expression to the variable. Each operation may be guarded by condition(s). 
-
-* Each condition is a formula (tree consisting of 'AND', 'OR', 'NOT' and '==', '!=' between two expressions.
-
-* Expression is a list of strings and variables to be expanded.
-
-.. note:: If no 'SET' applies, a variable is still undefined even if some 'APPEND' applies. This might change.
-.. note:: All expanded data should be (or is converted to) unicode 
 .. todo:: (OPT) Cleanup of unused undefined variables.
 .. todo:: (OPT) Better variable name checking (no name '.'-structural prefix of another)
 .. todo:: (OPT) Implemet "subtree" listing.
@@ -41,20 +32,26 @@ def check_depth(depth):
 
 
 class ConfigError(MoeError):
+  "Base class for moe.config errors"
   pass
 
 class UndefinedError(ConfigError):
+  "Raised when no **SET** operation applies to evaluated variable."
   pass
 
 class VariableNameError(ConfigError):
+  "Raised on invalid config variable name."
   pass
 
 class VariableFixedError(ConfigError):
+  "Raised when modifying a fixed variable"
   pass
 
 class CyclicConfigError(ConfigError):
+  "Raised when evaluation recursion is too deep"
   pass
 
+
 class ParseProxy(list):
   """Proxy helper class around values returned by `parse` and `parse_file`, 
   useful in "with" constructs."""
@@ -69,9 +66,7 @@ class ParseProxy(list):
 
 class ConfigTree(object):
   """
-  Configuration tree containing all the variables.
-
-  The variables in `self.variables` are referenced directly by the full name.
+  Configuration environment containing the variables.
   """
 
   def __init__(self):
@@ -155,7 +150,7 @@ class ConfigTree(object):
 
 class ConfigElem(object):
   """
-  Base class for cahed config elements - variables and conditions
+  Base class for cached config elements - variables and conditions
   """
 
   def __init__(self, name):
@@ -196,11 +191,11 @@ class ConfigElem(object):
 class ConfigCondition(ConfigElem):
   """
   Condition using equality and logic operators.
-  Clause is a tuple-tree in the following recursive form::
+  Formula is a tuple-tree in the following recursive form::
     
     ('AND', c1, c1), ('OR', c1, c2), ('NOT', c1), ('==', e1, e2), ('!=', e1, e2) 
     
-  where e1, e2 are `ConfigExpression`, c1, c2, `ConfigCondition`.
+  where ``e1``, ``e2`` are :class:`ConfigExpression`, ``c1``, ``c2``, :class:`ConfigCondition`.
   """
 
   def __init__(self, formula, text=None, parent=None):
@@ -278,10 +273,15 @@ class ConfigCondition(ConfigElem):
 
 
 class Operation(object):
-  "Helper class for operation data. Must not be present in more variables or present multiple times."
+  """
+  Helper class for operation data. Must be present at most once in at most one variable.
+
+  ``operation`` is either ``"SET"`` or ``"APPEND"``, ``condition`` is a :class:`ConfigCondition` instance or ``None``,
+  ``expression`` is a :class:`ConfigExpression` instance, ``level`` is the priority of the operation and ``source``
+  is an informative string describing the operation origin.  
+  """
 
   def __init__(self, operation, condition, expression, level=0, source='?'):
-    # operation is currently 'SET' and 'APPEND'
     self.operation = operation
     self.condition = condition
     self.expression = expression
@@ -294,6 +294,7 @@ class Operation(object):
 
 
 class ConfigVar(ConfigElem):
+  "Class representing a single configuration variable"
 
   def __init__(self, name):
     super(ConfigVar, self).__init__(name)
@@ -304,7 +305,7 @@ class ConfigVar(ConfigElem):
     self.fixed_val = None
 
   def variables(self):
-    "Return a set of variables used in the expressions"
+    "Return a set of variables used in the expressions of the operations"
     if not self.operations:
       return set([])
     return set.union(*[ op.expression.variables() for op in self.operations ])