Merge pull request #336 from Winston-503/main

feat: ${VAR} for API key configuration

Author: codelion

configs/default_config.yaml

@@ -39,6 +39,8 @@ llm:
   # API configuration
   api_base: "https://generativelanguage.googleapis.com/v1beta/openai/"  # Base URL for API (change for non-OpenAI models)
   api_key: null                       # API key (defaults to OPENAI_API_KEY env variable)
+  # or use ${VAR} syntax to specify which environment variable to read from:
+  # api_key: ${GEMINI_API_KEY}        # Reads API key from $GEMINI_API_KEY
 
   # Generation parameters
   temperature: 0.7                    # Temperature for generation (higher = more creative)

openevolve/config.py

@@ -3,6 +3,7 @@
 """
 
 import os
+import re
 from dataclasses import asdict, dataclass, field
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Union
@@ -13,6 +14,38 @@
     from openevolve.llm.base import LLMInterface
 
 
+_ENV_VAR_PATTERN = re.compile(r"^\$\{([^}]+)\}$")  # ${VAR}
+
+
+def _resolve_env_var(value: Optional[str]) -> Optional[str]:
+    """
+    Resolve ${VAR} environment variable reference in a string value.
+    In current implementation pattern must match the entire string (e.g., "${OPENAI_API_KEY}"),
+    not embedded within other text.
+
+    Args:
+        value: The string value that may contain ${VAR} syntax
+
+    Returns:
+        The resolved value with environment variable expanded, or original value if no match
+
+    Raises:
+        ValueError: If the environment variable is referenced but not set
+    """
+    if value is None:
+        return None
+
+    match = _ENV_VAR_PATTERN.match(value)
+    if not match:
+        return value
+
+    var_name = match.group(1)
+    env_value = os.environ.get(var_name)
+    if env_value is None:
+        raise ValueError(f"Environment variable {var_name} is not set")
+    return env_value
+
+
 @dataclass
 class LLMModelConfig:
     """Configuration for a single LLM model"""
@@ -45,6 +78,10 @@ class LLMModelConfig:
     # Reasoning parameters
     reasoning_effort: Optional[str] = None
 
+    def __post_init__(self):
+        """Post-initialization to resolve ${VAR} env var references in api_key"""
+        self.api_key = _resolve_env_var(self.api_key)
+
 
 @dataclass
 class LLMConfig(LLMModelConfig):
@@ -81,6 +118,8 @@ class LLMConfig(LLMModelConfig):
 
     def __post_init__(self):
         """Post-initialization to set up model configurations"""
+        super().__post_init__()  # Resolve ${VAR} in api_key at LLMConfig level
+
         # Handle backward compatibility for primary_model(_weight) and secondary_model(_weight).
         if self.primary_model:
             # Create primary model

tests/test_api_key_from_env.py

@@ -0,0 +1,193 @@
+"""
+Tests for api_key ${VAR} environment variable substitution in configuration.
+"""
+
+import os
+import tempfile
+import unittest
+
+from openevolve.config import Config, LLMModelConfig, _resolve_env_var
+
+
+class TestEnvVarSubstitution(unittest.TestCase):
+    """Tests for ${VAR} environment variable substitution in api_key fields"""
+
+    def setUp(self):
+        """Set up test environment variables"""
+        self.test_env_var = "TEST_OPENEVOLVE_API_KEY"
+        self.test_api_key = "test-secret-key-12345"
+        os.environ[self.test_env_var] = self.test_api_key
+
+    def tearDown(self):
+        """Clean up test environment variables"""
+        if self.test_env_var in os.environ:
+            del os.environ[self.test_env_var]
+
+    def test_resolve_env_var_with_match(self):
+        """Test that _resolve_env_var resolves ${VAR} syntax"""
+        result = _resolve_env_var(f"${{{self.test_env_var}}}")
+        self.assertEqual(result, self.test_api_key)
+
+    def test_resolve_env_var_no_match(self):
+        """Test that strings without ${VAR} are returned unchanged"""
+        result = _resolve_env_var("regular-api-key")
+        self.assertEqual(result, "regular-api-key")
+
+    def test_resolve_env_var_none(self):
+        """Test that None is returned unchanged"""
+        result = _resolve_env_var(None)
+        self.assertIsNone(result)
+
+    def test_resolve_env_var_missing_var(self):
+        """Test that missing environment variable raises ValueError"""
+        with self.assertRaises(ValueError) as context:
+            _resolve_env_var("${NONEXISTENT_ENV_VAR_12345}")
+
+        self.assertIn("NONEXISTENT_ENV_VAR_12345", str(context.exception))
+        self.assertIn("is not set", str(context.exception))
+
+    def test_api_key_env_var_in_model_config(self):
+        """Test that api_key ${VAR} works in LLMModelConfig"""
+        model_config = LLMModelConfig(name="test-model", api_key=f"${{{self.test_env_var}}}")
+
+        self.assertEqual(model_config.api_key, self.test_api_key)
+
+    def test_api_key_direct_value(self):
+        """Test that direct api_key value still works"""
+        direct_key = "direct-api-key-value"
+        model_config = LLMModelConfig(name="test-model", api_key=direct_key)
+
+        self.assertEqual(model_config.api_key, direct_key)
+
+    def test_api_key_none(self):
+        """Test that api_key can be None"""
+        model_config = LLMModelConfig(name="test-model", api_key=None)
+
+        self.assertIsNone(model_config.api_key)
+
+    def test_api_key_env_var_in_llm_config(self):
+        """Test that api_key ${VAR} works at LLM config level"""
+        yaml_config = {
+            "log_level": "INFO",
+            "llm": {
+                "api_base": "https://api.openai.com/v1",
+                "api_key": f"${{{self.test_env_var}}}",
+                "models": [{"name": "test-model", "weight": 1.0}],
+            },
+        }
+
+        config = Config.from_dict(yaml_config)
+
+        self.assertEqual(config.llm.api_key, self.test_api_key)
+        # Models should inherit the resolved api_key
+        self.assertEqual(config.llm.models[0].api_key, self.test_api_key)
+
+    def test_api_key_env_var_per_model(self):
+        """Test that api_key ${VAR} can be specified per model"""
+        # Set up a second env var for testing
+        second_env_var = "TEST_OPENEVOLVE_API_KEY_2"
+        second_api_key = "second-secret-key-67890"
+        os.environ[second_env_var] = second_api_key
+
+        try:
+            yaml_config = {
+                "log_level": "INFO",
+                "llm": {
+                    "api_base": "https://api.openai.com/v1",
+                    "models": [
+                        {
+                            "name": "model-1",
+                            "weight": 1.0,
+                            "api_key": f"${{{self.test_env_var}}}",
+                        },
+                        {
+                            "name": "model-2",
+                            "weight": 0.5,
+                            "api_key": f"${{{second_env_var}}}",
+                        },
+                    ],
+                },
+            }
+
+            config = Config.from_dict(yaml_config)
+
+            self.assertEqual(config.llm.models[0].api_key, self.test_api_key)
+            self.assertEqual(config.llm.models[1].api_key, second_api_key)
+        finally:
+            if second_env_var in os.environ:
+                del os.environ[second_env_var]
+
+    def test_api_key_env_var_in_evaluator_models(self):
+        """Test that api_key ${VAR} works in evaluator_models"""
+        yaml_config = {
+            "log_level": "INFO",
+            "llm": {
+                "api_base": "https://api.openai.com/v1",
+                "models": [{"name": "evolution-model", "weight": 1.0, "api_key": "direct-key"}],
+                "evaluator_models": [
+                    {
+                        "name": "evaluator-model",
+                        "weight": 1.0,
+                        "api_key": f"${{{self.test_env_var}}}",
+                    }
+                ],
+            },
+        }
+
+        config = Config.from_dict(yaml_config)
+
+        self.assertEqual(config.llm.evaluator_models[0].api_key, self.test_api_key)
+
+    def test_yaml_file_loading_with_env_var(self):
+        """Test loading api_key ${VAR} from actual YAML file"""
+        yaml_content = f"""
+log_level: INFO
+llm:
+  api_base: https://api.openai.com/v1
+  api_key: ${{{self.test_env_var}}}
+  models:
+  - name: test-model
+    weight: 1.0
+"""
+
+        with tempfile.NamedTemporaryFile(mode="w", suffix=".yaml", delete=False) as f:
+            f.write(yaml_content)
+            f.flush()
+
+            try:
+                config = Config.from_yaml(f.name)
+                self.assertEqual(config.llm.api_key, self.test_api_key)
+            finally:
+                os.unlink(f.name)
+
+    def test_mixed_api_key_sources(self):
+        """Test mixing direct api_key and ${VAR} in same config"""
+        yaml_config = {
+            "log_level": "INFO",
+            "llm": {
+                "api_base": "https://api.openai.com/v1",
+                "api_key": "llm-level-direct-key",
+                "models": [
+                    {
+                        "name": "model-with-env",
+                        "weight": 1.0,
+                        "api_key": f"${{{self.test_env_var}}}",
+                    },
+                    {
+                        "name": "model-with-direct",
+                        "weight": 0.5,
+                        "api_key": "model-direct-key",
+                    },
+                ],
+            },
+        }
+
+        config = Config.from_dict(yaml_config)
+
+        self.assertEqual(config.llm.api_key, "llm-level-direct-key")
+        self.assertEqual(config.llm.models[0].api_key, self.test_api_key)
+        self.assertEqual(config.llm.models[1].api_key, "model-direct-key")
+
+
+if __name__ == "__main__":
+    unittest.main()