refactor / adapts Avellaneda config map for pydantic

hummingbot/client/config/config_data_types.py

@@ -0,0 +1,47 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Callable, Optional
+
+from pydantic import BaseModel
+from pydantic.schema import default_ref_template
+
+from hummingbot.client.config.config_helpers import strategy_config_schema_encoder
+
+
+class ClientConfigEnum(Enum):
+    def __str__(self):
+        return self.value
+
+
+@dataclass()
+class ClientFieldData:
+    prompt: Optional[Callable[['BaseClientModel'], str]] = None
+    prompt_on_new: bool = False
+
+
+class BaseClientModel(BaseModel):
+    """
+    Notes on configs:
+    - In nested models, be weary that pydantic will take the first model that fits
+      (see https://pydantic-docs.helpmanual.io/usage/model_config/#smart-union).
+    """
+    @classmethod
+    def schema_json(
+        cls, *, by_alias: bool = True, ref_template: str = default_ref_template, **dumps_kwargs: Any
+    ) -> str:
+        # todo: make it ignore `client_data` all together
+        return cls.__config__.json_dumps(
+            cls.schema(by_alias=by_alias, ref_template=ref_template),
+            default=strategy_config_schema_encoder,
+            **dumps_kwargs
+        )
+
+    def get_client_prompt(self, attr_name: str) -> Optional[str]:
+        prompt = None
+        client_data = self.get_client_data(attr_name)
+        if client_data is not None:
+            prompt = client_data.prompt(self)
+        return prompt
+
+    def get_client_data(self, attr_name: str) -> Optional[ClientFieldData]:
+        return self.__fields__[attr_name].field_info.extra["client_data"]

hummingbot/client/config/config_helpers.py

@@ -1,40 +1,31 @@
+import json
 import logging
+import shutil
+from collections import OrderedDict
 from decimal import Decimal
+from os import listdir, unlink
+from os.path import isfile, join
+from typing import Any, Callable, Dict, List, Optional
+
 import ruamel.yaml
-from os import (
-    unlink
-)
-from os.path import (
-    join,
-    isfile
-)
-from collections import OrderedDict
-import json
-from typing import (
-    Any,
-    Callable,
-    Dict,
-    List,
-    Optional,
-)
-from os import listdir
-import shutil
+from eth_account import Account
+from pydantic import ValidationError
+from pydantic.json import pydantic_encoder
 
+from hummingbot import get_strategy_list
 from hummingbot.client.config.config_var import ConfigVar
-from hummingbot.client.config.global_config_map import global_config_map
 from hummingbot.client.config.fee_overrides_config_map import fee_overrides_config_map
+from hummingbot.client.config.global_config_map import global_config_map
+from hummingbot.client.config.security import Security
 from hummingbot.client.settings import (
-    GLOBAL_CONFIG_PATH,
-    TRADE_FEES_CONFIG_PATH,
-    TEMPLATE_PATH,
+    AllConnectorSettings,
     CONF_FILE_PATH,
     CONF_POSTFIX,
     CONF_PREFIX,
-    AllConnectorSettings,
+    GLOBAL_CONFIG_PATH,
+    TEMPLATE_PATH,
+    TRADE_FEES_CONFIG_PATH,
 )
-from hummingbot.client.config.security import Security
-from hummingbot import get_strategy_list
-from eth_account import Account
 
 # Use ruamel.yaml to preserve order and comments in .yml file
 yaml_parser = ruamel.yaml.YAML()
@@ -456,3 +447,14 @@ def secondary_market_conversion_rate(strategy) -> Decimal:
     else:
         return Decimal("1")
     return quote_rate / base_rate
+
+
+def retrieve_validation_error_msg(e: ValidationError) -> str:
+    return e.errors().pop()["msg"]
+
+
+def strategy_config_schema_encoder(o):
+    if callable(o):
+        return None
+    else:
+        return pydantic_encoder(o)