Switch to using attribute instead of variable to track indentation

Author: slundberg

guidance/library/__init__.py

@@ -17,6 +17,7 @@
 from ._format import monospace
 from ._silent import silent
 from ._set_var import set_var
+from ._set_attribute import set_attribute
 # from ..models._model import context_free
 
 # stateless library functions

guidance/library/_role.py

@@ -1,6 +1,6 @@
 import guidance
 from ._block import block
-from ._set_var import set_var
+from ._set_attribute import set_attribute
 
 nodisp_start = "<||_#NODISP_||>"
 nodisp_end = "<||_/NODISP_||>"
@@ -10,7 +10,7 @@
 
 @guidance
 def role_opener(lm, role_name, **kwargs):
-    indent = lm.get("__role_indent", True)
+    indent = getattr(lm, "indent_roles", True)
     if not hasattr(lm, "get_role_start"):
         raise Exception(
             f"You need to use a chat model in order the use role blocks like `with {role_name}():`! Perhaps you meant to use the {type(lm).__name__}Chat class?"
@@ -39,7 +39,7 @@ def role_opener(lm, role_name, **kwargs):
 
 @guidance
 def role_closer(lm, role_name, **kwargs):
-    indent = lm.get("__role_indent", True)
+    indent = getattr(lm, "indent_roles", True)
     # Start of either debug or HTML no disp block
     if indent:
         lm += nodisp_start
@@ -92,4 +92,4 @@ def instruction(text=None, **kwargs):
     return role("instruction", text, **kwargs)
 
 def indent_roles(indent=True):
-    return set_var("__role_indent", indent)
+    return set_attribute("indent_roles", indent)

guidance/library/_set_attribute.py

@@ -0,0 +1,21 @@
+import guidance
+from ._block import block
+
+@guidance
+def set_attr_opener(lm, name, value):
+    if hasattr(lm, name):
+        lm = lm.setattr("__save" + name, getattr(lm, name))
+    return lm.setattr(name, value)
+
+@guidance
+def set_attr_closer(lm, name):
+    if hasattr(lm, "__save" + name):
+        return lm.setattr(name, lm["__save" + name]).delattr("__save" + name)
+    else:
+        return lm.delattr(name)
+
+def set_attribute(name, value=True):
+    return block(
+        opener=set_attr_opener(name, value),
+        closer=set_attr_closer(name),
+    )

guidance/models/_model.py

@@ -380,6 +380,32 @@ def get(self, key, default=None):
             The value to return if the variable is not current set.
         '''
         return self._variables.get(key, default)
+    
+    def setattr(self, key, value):
+        '''Return a new model with the given model attribute set.
+        
+        Parameters
+        ----------
+        key : str
+            The name of the attribute to be set.
+        value : any
+            The value to set the attribute to.
+        '''
+        copy = self.copy()
+        setattr(copy, key, value)
+        return copy
+    
+    def delattr(self, key):
+        '''Return a new model with the given attribute deleted.
+        
+        Parameters
+        ----------
+        key : str
+            The attribute name to remove.
+        '''
+        copy = self.copy()
+        delattr(copy, key)
+        return copy
 
     def set(self, key, value):
         '''Return a new model with the given variable value set.

notebooks/tutorials/adding_new_models.ipynb

@@ -81,7 +81,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "5698dac461ba479ba684d12328f7947c",
+       "model_id": "3e2eb7c444ba4d92a5f29593faa919e9",
        "version_major": 2,
        "version_minor": 0
       },