Merge branch 'feature/vault' into 'mgx_ops'

feat: Implement Chapter 2.4.2.4.2 智能体加载环境变量配置 of RFC216

See merge request pub/MetaGPT!62

metagpt/tools/libs/__init__.py

@@ -16,13 +16,8 @@ from metagpt.tools.libs import (
     browser,
     deployer,
 )
+from metagpt.tools.libs.env import get_env, set_get_env_entry, default_get_env, get_env_description
 from metagpt.tools.libs.software_development import (
-    write_prd,
-    write_design,
-    write_project_plan,
-    write_codes,
-    run_qa_test,
-    fix_bug,
     git_archive,
 )
 
@@ -33,15 +28,13 @@ _ = (
     gpt_v_generator,
     web_scraping,
     email_login,
-    write_prd,
-    write_design,
-    write_project_plan,
-    write_codes,
-    run_qa_test,
-    fix_bug,
     git_archive,
     terminal,
     file_manager,
     browser,
     deployer,
+    get_env,
+    get_env_description,
+    set_get_env_entry,
+    default_get_env,
 )  # Avoid pre-commit error

metagpt/tools/libs/env.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@Time    : 2024/4/25
+@Author  : mashenquan
+@File    : env.py
+@Desc: Implement `get_env`. RFC 216 2.4.2.4.2.
+"""
+import os
+from typing import Dict
+
+
+class EnvKeyNotFoundError(Exception):
+    def __init__(self, info):
+        super().__init__(info)
+
+
+async def default_get_env(key: str, app_name: str = None) -> str:
+    if key in os.environ:
+        return os.environ[key]
+
+    from metagpt.context import Context
+
+    context = Context()
+    val = context.kwargs.get(key, None)
+    if val is not None:
+        return val
+
+    raise EnvKeyNotFoundError(f"EnvKeyNotFoundError: {key}, app_name:{app_name or ''}")
+
+
+async def default_get_env_description() -> Dict[str, str]:
+    result = {}
+    for k in os.environ.keys():
+        call = f'await get_env(key="{k}", app_name="")'
+        result[call] = f"Return the value of environment variable `{k}`."
+
+    from metagpt.context import Context
+
+    context = Context()
+    for k in context.kwargs.__dict__.keys():
+        call = f'await get_env(key="{k}", app_name="")'
+        result[call] = f"Get the value of environment variable `{k}`."
+    return result
+
+
+_get_env_entry = default_get_env
+_get_env_description_entry = default_get_env_description
+
+
+async def get_env(key: str, app_name: str = None) -> str:
+    """
+    Retrieve the value of the environment variable for the specified key.
+
+    Args:
+        key (str): The key of the environment variable.
+        app_name (str, optional): The name of the application. Defaults to None.
+
+    Returns:
+        str: The value corresponding to the given key in the environment variables.
+             If no value is found for the given key, an empty string is returned.
+
+    Example:
+        This function can be used to retrieve environment variables asynchronously.
+        It should be called using `await`.
+
+        >>> from metagpt.tools.libs.env import get_env
+        >>> api_key = await get_env("API_KEY")
+        >>> print(api_key)
+        <API_KEY>
+
+        >>> from metagpt.tools.libs.env import get_env
+        >>> api_key = await get_env(key="API_KEY", app_name="GITHUB")
+        >>> print(api_key)
+        <API_KEY>
+
+    Note:
+        This is an asynchronous function and must be called using `await`.
+    """
+    global _get_env_entry
+    if _get_env_entry:
+        return await _get_env_entry(key=key, app_name=app_name)
+
+    return await default_get_env(key=key, app_name=app_name)
+
+
+async def get_env_description() -> Dict[str, str]:
+    global _get_env_description_entry
+
+    if _get_env_description_entry:
+        return await _get_env_description_entry()
+
+    return await default_get_env_description()
+
+
+def set_get_env_entry(value, description):
+    """Modify `get_env` entry and `get_description` entry.
+
+    Args:
+        value (function): New function entry.
+        description (str): Description of the function.
+
+    This function modifies the `get_env` entry by updating the function
+    to the provided `value` and its description to the provided `description`.
+    """
+    global _get_env_entry
+    global _get_env_description_entry
+    _get_env_entry = value
+    _get_env_description_entry = description