Add from_file class methods to CFG and JsonSchema

Author: RobinPicard

outlines/types/dsl.py

@@ -190,6 +190,24 @@ def _display_node(self) -> str:
     def __repr__(self):
         return f"CFG(definition='{self.definition}')"
 
+    def __eq__(self, other):
+        if not isinstance(other, CFG):
+            return False
+        return self.definition == other.definition
+
+    @classmethod
+    def from_file(cls, path: str):
+        """Create a CFG instance from a file containing a CFG definition.
+
+        Parameters
+        ----------
+        path : str
+            The path to the file containing the CFG definition.
+        """
+        with open(path, "r") as f:
+            definition = f.read()
+        return cls(definition)
+
 
 @dataclass
 class FSM(Term):
@@ -247,6 +265,20 @@ def __eq__(self, other):
         except json.JSONDecodeError:
             return self.schema == other.schema
 
+    @classmethod
+    def from_file(cls, path: str):
+        """Create a JsonSchema instance from a .json file containing a JSON
+        schema.
+
+        Parameters
+        ----------
+        path : str
+            The path to the file containing the JSON schema.
+        """
+        with open(path, "r") as f:
+            schema = json.load(f)
+        return cls(schema)
+
 
 @dataclass
 class KleeneStar(Term):

tests/types/test_dsl.py

@@ -1,6 +1,8 @@
 import datetime
 import json
+import os
 import sys
+import tempfile
 from dataclasses import dataclass
 from enum import Enum
 from typing import (
@@ -33,6 +35,7 @@
     Sequence,
     String,
     Term,
+    CFG,
     _handle_dict,
     _handle_list,
     _handle_literal,
@@ -285,6 +288,40 @@ def test_dsl_display():
     )
 
 
+def test_dsl_cfg_from_file():
+    grammar_content = """
+    ?start: expression
+    ?expression: term (("+" | "-") term)*
+    ?term: factor (("*" | "/") factor)*
+    ?factor: NUMBER
+    """
+    with tempfile.NamedTemporaryFile(mode='w', suffix='.txt', delete=True) as temp_file:
+        temp_file.write(grammar_content)
+        temp_file.flush()
+        temp_file_path = temp_file.name
+        cfg = CFG.from_file(temp_file_path)
+        assert cfg == CFG(grammar_content)
+
+
+def test_dsl_json_schema_from_file():
+    schema_content = """
+    {
+        "type": "object",
+        "properties": {
+            "name": {
+                "type": "string"
+            }
+        }
+    }
+    """
+    with tempfile.NamedTemporaryFile(mode='w', suffix='.json', delete=True) as temp_file:
+        temp_file.write(schema_content)
+        temp_file.flush()
+        temp_file_path = temp_file.name
+        schema = JsonSchema.from_file(temp_file_path)
+        assert schema == JsonSchema(schema_content)
+
+
 def test_dsl_python_types_to_terms():
     with pytest.raises(RecursionError):
         python_types_to_terms(None, 11)