Rename the background context variable into pdl_context (#126)

Author: mandel

src/pdl/pdl_interpreter.py

@@ -122,7 +122,7 @@ def __init__(
         self.message = message
 
 
-empty_scope: ScopeType = {"context": []}
+empty_scope: ScopeType = {"pdl_context": []}
 
 
 class InterpreterState(BaseModel):
@@ -288,12 +288,12 @@ def step_block(
             yield YieldBackgroundMessage(background)
         if state.yield_result:
             yield YieldResultMessage(result)
-        append_log(state, "Context", background)
+        append_log(state, "pdl_context", background)
     else:
         result, background, scope, trace = yield from step_advanced_block(
             state, scope, block, loc
         )
-    scope = scope | {"context": background}
+    scope = scope | {"pdl_context": background}
     return result, background, scope, trace
 
 
@@ -516,7 +516,7 @@ def step_block_body(
             results = []
             background = []
             iterations_trace: list[BlocksType] = []
-            context_init = scope_init["context"]
+            pdl_context_init = scope_init["pdl_context"]
             iteration_state = state.with_yield_result(
                 state.yield_result and block.join.iteration_type == IterationType.TEXT
             )
@@ -536,7 +536,7 @@ def step_block_body(
                                 [{"role": block.role, "content": join_string}]
                             )
                     scope = scope | {
-                        "context": messages_concat(context_init, background)
+                        "pdl_context": messages_concat(pdl_context_init, background)
                     }
                     (
                         iteration_result,
@@ -569,7 +569,7 @@ def step_block_body(
             results = []
             background = []
             iter_trace: list[BlocksType] = []
-            context_init = scope_init["context"]
+            pdl_context_init = scope_init["pdl_context"]
             items, block = process_expr_of(block, "fors", scope, loc, "for")
             lengths = []
             for idx, lst in items.items():
@@ -613,7 +613,7 @@ def step_block_body(
                                 [{"role": block.role, "content": join_string}]
                             )
                     scope = scope | {
-                        "context": messages_concat(context_init, background)
+                        "pdl_context": messages_concat(pdl_context_init, background)
                     }
                     for k in items.keys():
                         scope = scope | {k: items[k][i]}
@@ -649,7 +649,7 @@ def step_block_body(
             stop = False
             background = []
             iterations_trace = []
-            context_init = scope_init["context"]
+            pdl_context_init = scope_init["pdl_context"]
             iteration_state = state.with_yield_result(
                 state.yield_result and block.join.iteration_type == IterationType.TEXT
             )
@@ -669,7 +669,7 @@ def step_block_body(
                                 [{"role": block.role, "content": join_string}]
                             )
                     scope = scope | {
-                        "context": messages_concat(context_init, background)
+                        "pdl_context": messages_concat(pdl_context_init, background)
                     }
                     (
                         iteration_result,
@@ -806,10 +806,12 @@ def step_blocks(
         new_loc = None
         background = []
         trace = []
-        context_init = scope["context"]
+        pdl_context_init = scope["pdl_context"]
         try:
             for i, block in enumerate(blocks):
-                scope = scope | {"context": messages_concat(context_init, background)}
+                scope = scope | {
+                    "pdl_context": messages_concat(pdl_context_init, background)
+                }
                 new_loc = append(loc, "[" + str(i) + "]")
                 if iteration_type == IterationType.LASTOF and state.yield_result:
                     iteration_state = state.with_yield_result(i + 1 == len(blocks))
@@ -1029,7 +1031,7 @@ def step_call_model(
         else:
             model_input = model_input_result
     else:
-        model_input = scope["context"]
+        model_input = scope["pdl_context"]
         input_trace = None
     concrete_block = concrete_block.model_copy(
         update={
@@ -1294,7 +1296,7 @@ def step_call(
             trace=block.model_copy(),
         )
     f_body = closure.returns
-    f_scope = closure.scope | {"context": scope["context"]} | args
+    f_scope = closure.scope | {"pdl_context": scope["pdl_context"]} | args
     fun_loc = LocationType(
         file=closure.location.file,
         path=closure.location.path + ["return"],

src/pdl/pdl_notebook_ext.py

@@ -31,7 +31,7 @@ def pdl(self, line, cell, local_ns):
         line = line.strip()
         args = parse_argstring(self.pdl, line)
         if args.reset_context:
-            scope = local_ns | {"context": []}
+            scope = local_ns | {"pdl_context": []}
         else:
             scope = local_ns
         try:

src/pdl/pdl_schema_validator.py

@@ -16,12 +16,12 @@ def type_check_args(args: dict[str, Any], params: dict[str, Any], loc) -> list[s
         args_copy = {}
     if params_copy is None:
         params_copy = {}
-    # if "context" not in args_copy:
-    #     args_copy["context"] = "context"
-    # if "context" not in params_copy:
-    if "context" in args_copy:
-        # params_copy["context"] = [{"role": "str?", "content": "str"}]
-        params_copy["context"] = ["obj"]
+    # if "pdl_context" not in args_copy:
+    #     args_copy["pdl_context"] = "pdl_context"
+    # if "pdl_context" not in params_copy:
+    if "pdl_context" in args_copy:
+        # params_copy["pdl_context"] = [{"role": "str?", "content": "str"}]
+        params_copy["pdl_context"] = ["obj"]
     schema = get_json_schema(params_copy)
     if schema is None:
         return ["Error obtaining a valid schema from function parameters definition"]

tests/test_function.py

@@ -53,7 +53,7 @@ def test_function_params():
 hello_stutter = {
     "description": "Repeat the context",
     "text": [
-        {"def": "stutter", "function": None, "return": "${ context[0].content }"},
+        {"def": "stutter", "function": None, "return": "${ pdl_context[0].content }"},
         "Hello World!\n",
         {"call": "stutter"},
     ],
@@ -70,9 +70,12 @@ def test_function_implicit_context():
 hello_bye = {
     "description": "Repeat the context",
     "text": [
-        {"def": "stutter", "function": {}, "return": "${ context[0].content }"},
+        {"def": "stutter", "function": {}, "return": "${ pdl_context[0].content }"},
         "Hello World!\n",
-        {"call": "stutter", "args": {"context": [{"role": None, "content": "Bye!"}]}},
+        {
+            "call": "stutter",
+            "args": {"pdl_context": [{"role": None, "content": "Bye!"}]},
+        },
     ],
 }
 

tests/test_role.py

@@ -15,12 +15,12 @@ def test_role1():
 description: Test role
 text:
 - defs:
-    ctx1: ${context}
+    ctx1: ${pdl_context}
   text: A
   role: A
 - Hi
 - defs:
-    ctx2: ${context}
+    ctx2: ${pdl_context}
   text: B
   role: B
 role: Top

tests/test_var.py

@@ -126,7 +126,7 @@ def test_code_var():
     state = InterpreterState()
     data = Program.model_validate(code_var_data)
     text, _, scope, _ = process_prog(state, empty_scope, data)
-    assert scope == {"context": [{"role": "user", "content": text}], "I": 0}
+    assert scope == {"pdl_context": [{"role": "user", "content": text}], "I": 0}
     assert text == "0"