Merge pull request #444 from irgolic/resolve-string-formatting-deprecation

base_prompt: Stop warning on unsupported variables notation

Author: zsimjee

guardrails/prompt/base_prompt.py

@@ -1,6 +1,5 @@
 """Class for representing a prompt entry."""
 import re
-import warnings
 from string import Template
 from typing import Optional
 
@@ -49,13 +48,6 @@ def substitute_constants(self, text):
         """Substitute constants in the prompt."""
         # Substitute constants by reading the constants file.
         # Regex to extract all occurrences of ${gr.<constant_name>}
-        if self.uses_old_constant_schema(text):
-            warnings.warn(
-                "It appears that you are using an old schema for gaurdrails variables, "
-                "follow the new namespaced convention "
-                "documented here: https://docs.guardrailsai.com/0-2-migration/"
-            )
-
         matches = re.findall(r"\${gr\.(\w+)}", text)
 
         # Substitute all occurrences of ${gr.<constant_name>}
@@ -67,13 +59,6 @@ def substitute_constants(self, text):
 
         return text
 
-    def uses_old_constant_schema(self, text) -> bool:
-        matches = re.findall(r"@(\w+)", text)
-        if len(matches) == 0:
-            return False
-        else:
-            return True
-
     def get_prompt_variables(self):
         return self.variable_names
 

guardrails/prompt/instructions.py

@@ -1,6 +1,5 @@
 """Instructions to the LLM, to be passed in the prompt."""
 from string import Template
-from warnings import warn
 
 from guardrails.utils.parsing_utils import get_template_variables
 
@@ -30,12 +29,6 @@ def format(self, **kwargs):
         # Only use the keyword arguments that are present in the prompt.
         vars = get_template_variables(self.source)
         filtered_kwargs = {k: v for k, v in kwargs.items() if k in vars}
-        if len(filtered_kwargs) == 0:
-            warn(
-                "Instructions do not have any variables, "
-                "if you are migrating follow the new variable convention "
-                "documented here: https://docs.guardrailsai.com/0-2-migration/"
-            )
 
         # Return another instance of the class with the formatted prompt.
         formatted_instructions = Template(self.source).safe_substitute(

guardrails/prompt/prompt.py

@@ -1,5 +1,4 @@
 """The LLM prompt."""
-import warnings
 from string import Template
 
 from guardrails.utils.parsing_utils import get_template_variables
@@ -21,12 +20,6 @@ def format(self, **kwargs):
         # Only use the keyword arguments that are present in the prompt.
         vars = get_template_variables(self.source)
         filtered_kwargs = {k: v for k, v in kwargs.items() if k in vars}
-        if len(filtered_kwargs) == 0:
-            warnings.warn(
-                "Prompt does not have any variables, "
-                "if you are migrating follow the new variable convention "
-                "documented here: https://docs.guardrailsai.com/0-2-migration/"
-            )
 
         # Return another instance of the class with the formatted prompt.
         formatted_prompt = Template(self.source).safe_substitute(**filtered_kwargs)

tests/unit_tests/test_prompt.py

@@ -1,7 +1,6 @@
 """Unit tests for prompt and instructions parsing."""
 
 from string import Template
-from unittest import mock
 
 import pytest
 from pydantic import BaseModel, Field
@@ -232,31 +231,6 @@ def test_substitute_constants(prompt_str, final_prompt):
     assert prompt.source == final_prompt
 
 
-# TODO: Deprecate when we can confirm migration off the old, non-namespaced standard
-@pytest.mark.parametrize(
-    "text, is_old_schema",
-    [
-        (RAIL_WITH_OLD_CONSTANT_SCHEMA, True),  # Test with a single match
-        (
-            RAIL_WITH_FORMAT_INSTRUCTIONS,
-            False,
-        ),  # Test with no matches/correct namespacing
-    ],
-)
-def test_uses_old_constant_schema(text, is_old_schema):
-    with mock.patch("warnings.warn") as warn_mock:
-        guard = gd.Guard.from_rail_string(text)
-        assert guard.prompt.uses_old_constant_schema(text) == is_old_schema
-        if is_old_schema:
-            # we only check for the warning when we have an older schema
-            warn_mock.assert_called_once_with(
-                """It appears that you are using an old schema for gaurdrails\
- variables, follow the new namespaced convention documented here:\
- https://docs.guardrailsai.com/0-2-migration/\
-"""
-            )
-
-
 class TestResponse(BaseModel):
     grade: int = Field(description="The grade of the response")