forked from Significant-Gravitas/AutoGPT
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rework plugin config to be file-based (Significant-Gravitas#4673)
- Loading branch information
1 parent
0c8f2cf
commit 49d1a5a
Showing
10 changed files
with
262 additions
and
176 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| from typing import Any | ||
|
|
||
|
|
||
| class PluginConfig: | ||
| """Class for holding configuration of a single plugin""" | ||
|
|
||
| def __init__(self, name: str, enabled: bool = False, config: dict[str, Any] = None): | ||
| self.name = name | ||
| self.enabled = enabled | ||
| # Arbitray config options for this plugin. API keys or plugin-specific options live here. | ||
| self.config = config or {} | ||
|
|
||
| def __repr__(self): | ||
| return f"PluginConfig('{self.name}', {self.enabled}, {str(self.config)}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import os | ||
| from typing import Any, Union | ||
|
|
||
| import yaml | ||
|
|
||
| from autogpt.config.config import Config | ||
| from autogpt.logs import logger | ||
| from autogpt.plugins.plugin_config import PluginConfig | ||
|
|
||
|
|
||
| class PluginsConfig: | ||
| """Class for holding configuration of all plugins""" | ||
|
|
||
| def __init__(self, plugins_config: dict[str, Any]): | ||
| self.plugins = {} | ||
| for name, plugin in plugins_config.items(): | ||
| if type(plugin) == dict: | ||
| self.plugins[name] = PluginConfig( | ||
| name, | ||
| plugin.get("enabled", False), | ||
| plugin.get("config", {}), | ||
| ) | ||
| elif type(plugin) == PluginConfig: | ||
| self.plugins[name] = plugin | ||
| else: | ||
| raise ValueError(f"Invalid plugin config data type: {type(plugin)}") | ||
|
|
||
| def __repr__(self): | ||
| return f"PluginsConfig({self.plugins})" | ||
|
|
||
| def get(self, name: str) -> Union[PluginConfig, None]: | ||
| return self.plugins.get(name) | ||
|
|
||
| def is_enabled(self, name) -> bool: | ||
| plugin_config = self.plugins.get(name) | ||
| return plugin_config and plugin_config.enabled | ||
|
|
||
| @classmethod | ||
| def load_config(cls, global_config: Config) -> "PluginsConfig": | ||
| empty_config = cls({}) | ||
|
|
||
| try: | ||
| config_data = cls.deserialize_config_file(global_config=global_config) | ||
| if type(config_data) != dict: | ||
| logger.error( | ||
| f"Expected plugins config to be a dict, got {type(config_data)}, continuing without plugins" | ||
| ) | ||
| return empty_config | ||
| return cls(config_data) | ||
|
|
||
| except BaseException as e: | ||
| logger.error( | ||
| f"Plugin config is invalid, continuing without plugins. Error: {e}" | ||
| ) | ||
| return empty_config | ||
|
|
||
| @classmethod | ||
| def deserialize_config_file(cls, global_config: Config) -> dict[str, Any]: | ||
| plugins_config_path = global_config.plugins_config_file | ||
| if not os.path.exists(plugins_config_path): | ||
| logger.warn("plugins_config.yaml does not exist, creating base config.") | ||
| cls.create_empty_plugins_config(global_config=global_config) | ||
|
|
||
| with open(plugins_config_path, "r") as f: | ||
| return yaml.load(f, Loader=yaml.FullLoader) | ||
|
|
||
| @staticmethod | ||
| def create_empty_plugins_config(global_config: Config): | ||
| """Create an empty plugins_config.yaml file. Fill it with values from old env variables.""" | ||
| base_config = {} | ||
|
|
||
| # Backwards-compatibility shim | ||
| for plugin_name in global_config.plugins_denylist: | ||
| base_config[plugin_name] = {"enabled": False, "config": {}} | ||
|
|
||
| for plugin_name in global_config.plugins_allowlist: | ||
| base_config[plugin_name] = {"enabled": True, "config": {}} | ||
|
|
||
| with open(global_config.plugins_config_file, "w+") as f: | ||
| f.write(yaml.dump(base_config)) | ||
| return base_config |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.