Adds BaseModel and SystemModel

generate_sdk.py

@@ -45,16 +45,17 @@ def __init__(self) -> None:
         self.__check_initialize_logging()
 
     def __check_initialize_logging(self):
-        if not cfg.LOGGING_SUPPRESS:
+        if not get_current_system().LOGGING_SUPPRESS:
             self.__initialize_logging()
 
     @staticmethod
     def __initialize_logging() -> None:
         # pylint: disable=C0415
+        from openbb_terminal.config_terminal import setup_logging_sub_app
         from openbb_terminal.core.log.generation.settings_logger import log_all_settings
         from openbb_terminal.loggers import setup_logging
 
-        cfg.LOGGING_SUB_APP = "sdk"
+        setup_logging_sub_app(sub_app="sdk")
         setup_logging()
         log_all_settings()
 
@@ -240,7 +241,7 @@ def write_class_attr_docs(
         if module:
             f.write("    def __init__(self):\r        super().__init__()\r")
         elif sdk_root:
-            f.write("    __version__ = cfg.VERSION\r\r")
+            f.write("    __version__ = get_current_system().VERSION\r\r")
             f.write("    def __init__(self):\r        SDKLogger()\r")
 
     def write_class_attributes(

openbb_terminal/config_terminal.py

@@ -1,96 +1,115 @@
 # IMPORTATION STANDARD
-import os
+import dataclasses
+from pathlib import Path
 
 # IMPORTATION THIRDPARTY
+from typing import Optional
+
 import i18n
 
 # IMPORTATION INTERNAL
 from openbb_terminal.base_helpers import load_env_files, load_env_vars, strtobool
-from openbb_terminal.core.config.paths import MISCELLANEOUS_DIRECTORY
+from openbb_terminal.core.config.paths import I18N_DICT_LOCATION
 from openbb_terminal.core.config.paths_helper import init_userdata
 from openbb_terminal.core.plots.backend import plots_backend
+from openbb_terminal.core.session.current_system import (
+    get_current_system,
+    set_current_system,
+)
 from openbb_terminal.core.session.current_user import get_current_user
 
 from .helper_classes import TerminalStyle as _TerminalStyle
 
-# Terminal UX section
-current_user = get_current_user()
-theme = _TerminalStyle(
-    current_user.preferences.MPL_STYLE,
-    current_user.preferences.PMF_STYLE,
-    current_user.preferences.RICH_STYLE,
-)
-
 
-# Start the plots backend
 def start_plot_backend():
     """Starts the plot backend"""
     plots_backend().start(load_env_vars("DEBUG_MODE", strtobool, False))
 
 
-def start_required_configurations():
-    """Starts the required configurations for the terminal to work"""
+def change_logging_suppress(new_value: bool):
+    """Change the logging suppress value"""
+    current_system = get_current_system()
+    updated_system = dataclasses.replace(current_system, LOGGING_SUPPRESS=new_value)  # type: ignore
+    set_current_system(updated_system)
+
+
+def setup_i18n(i18n_path: Path = I18N_DICT_LOCATION):
+    """Select the terminal translation language."""
+
+    i18n.load_path.append(i18n_path)
+    i18n.set("locale", get_current_user().preferences.USE_LANGUAGE)
+    i18n.set("filename_format", "{locale}.{format}")
+
+
+def setup_version():
+    """Setup the version of the terminal"""
+
+    def try_get_version_from_dist() -> Optional[str]:
+        def check_using_git():
+            try:
+                __import__("git")
+            except ImportError:
+                return False
+            return True
+
+        if not check_using_git():
+            try:
+                import pkg_resources  # pylint:disable=import-outside-toplevel
+
+                return pkg_resources.get_distribution("OpenBB").version
+
+            except Exception:
+                pass
+
+        return None
+
+    version = try_get_version_from_dist()
+
+    if version:
+        current_system = get_current_system()
+        updated_system = dataclasses.replace(current_system, VERSION=version)  # type: ignore
+        set_current_system(updated_system)
+
+
+def setup_logging_app_name():
+    """
+    Setup the logging app name of the terminal
+
+    - if there's a LOGGING_APP_NAME in the environment => use it
+    - if "site-packages" in __file__ => use "gst_packaged_pypi" (will override environment variable)
+    - if none of the above => use "gst" (which is the default value on the SystemModel)
+    """
+
+    if "site-packages" in __file__:
+        current_system = get_current_system()
+        updated_system = dataclasses.replace(
+            current_system, LOGGING_APP_NAME="gst_packaged_pypi"
+        )  # type: ignore
+        set_current_system(updated_system)
+
+
+def setup_logging_sub_app(sub_app: str):
+    """Setup the logging sub app"""
+
+    current_system = get_current_system()
+    updated_system = dataclasses.replace(current_system, LOGGING_SUB_APP=sub_app)  # type: ignore
+    set_current_system(updated_system)
+
+
+def setup_config_terminal():
+    """Setup the config terminal"""
     load_env_files()
     init_userdata()
+    start_plot_backend()
+    setup_i18n()
+    setup_version()
+    setup_logging_app_name()
 
 
-# Logging section
-
-# USE IN LOG LINES + FOR FOLDER NAME INSIDE S3 BUCKET
-LOGGING_APP_NAME = (
-    "gst_packaged_pypi"
-    if "site-packages" in __file__
-    else os.getenv("OPENBB_LOGGING_APP_NAME") or "gst"
-)
-# AWS KEYS
-LOGGING_AWS_ACCESS_KEY_ID = (
-    os.getenv("OPENBB_LOGGING_AWS_ACCESS_KEY_ID") or "REPLACE_ME"
-)
-LOGGING_AWS_SECRET_ACCESS_KEY = (
-    os.getenv("OPENBB_LOGGING_AWS_SECRET_ACCESS_KEY") or "REPLACE_ME"
+# Terminal UX section
+current_user = get_current_user()
+theme = _TerminalStyle(
+    current_user.preferences.MPL_STYLE,
+    current_user.preferences.PMF_STYLE,
+    current_user.preferences.RICH_STYLE,
 )
-LOGGING_COMMIT_HASH = str(os.getenv("OPENBB_LOGGING_COMMIT_HASH", "REPLACE_ME"))
-# D | H | M | S
-LOGGING_FREQUENCY = os.getenv("OPENBB_LOGGING_FREQUENCY") or "H"
-# stdout,stderr,noop,file
-LOGGING_HANDLERS = os.getenv("OPENBB_LOGGING_HANDLERS") or "file"
-LOGGING_ROLLING_CLOCK = load_env_vars("OPENBB_LOGGING_ROLLING_CLOCK", strtobool, False)
-# CRITICAL = 50
-# FATAL = CRITICAL
-# ERROR = 40
-# WARNING = 30
-# WARN = WARNING
-# INFO = 20
-# DEBUG = 10
-# NOTSET = 0
-LOGGING_VERBOSITY = load_env_vars("OPENBB_LOGGING_VERBOSITY", int, 20)
-# LOGGING SUB APP
-LOGGING_SUB_APP = os.getenv("OPENBB_LOGGING_SUB_APP") or "terminal"
-LOGGING_SUPPRESS = False
-
-# pylint: disable=no-member,c-extension-no-member
-
-try:
-    __import__("git")
-except ImportError:
-    WITH_GIT = False
-else:
-    WITH_GIT = True
-
-
-try:
-    if not WITH_GIT:
-        import pkg_resources
-
-        version = pkg_resources.get_distribution("OpenBB").version
-    else:
-        raise Exception("Using git")
-except Exception:
-    version = "2.5.1"
-VERSION = str(os.getenv("OPENBB_VERSION", version))
-
-# # Select the terminal translation language
-i18n_dict_location = MISCELLANEOUS_DIRECTORY / "i18n"
-i18n.load_path.append(i18n_dict_location)
-i18n.set("locale", get_current_user().preferences.USE_LANGUAGE)
-i18n.set("filename_format", "{locale}.{format}")

openbb_terminal/core/config/paths.py

@@ -14,3 +14,6 @@
 SETTINGS_DIRECTORY = HOME_DIRECTORY / ".openbb_terminal"
 SETTINGS_ENV_FILE = SETTINGS_DIRECTORY / ".env"
 HIST_FILE_PATH = SETTINGS_DIRECTORY / ".openbb_terminal.his"
+
+# i18n_dict_location
+I18N_DICT_LOCATION = MISCELLANEOUS_DIRECTORY / "i18n"

openbb_terminal/core/models/__init__.py

@@ -1,11 +1,15 @@
+from openbb_terminal.core.models.base_model import BaseModel
 from openbb_terminal.core.models.credentials_model import CredentialsModel
 from openbb_terminal.core.models.preferences_model import PreferencesModel
 from openbb_terminal.core.models.profile_model import ProfileModel
+from openbb_terminal.core.models.system_model import SystemModel
 from openbb_terminal.core.models.user_model import UserModel
 
 __all__ = [
+    "BaseModel",
     "CredentialsModel",
     "PreferencesModel",
     "ProfileModel",
+    "SystemModel",
     "UserModel",
 ]

openbb_terminal/core/models/base_model.py

@@ -0,0 +1,29 @@
+from typing import Any, Optional
+
+from pydantic.dataclasses import dataclass
+
+# pylint: disable=too-many-instance-attributes, disable=no-member
+
+
+@dataclass
+class BaseModel:
+    def __repr__(self) -> str:
+        """Return string representation of model."""
+        dataclass_repr = ""
+        for key, value in self.__dict__.items():
+            if key.startswith("_"):
+                continue
+            dataclass_repr += f"    {key}='{value}', \n"
+
+        return f"{self.__class__.__name__}(\n{dataclass_repr[:-2]}\n)"
+
+    @classmethod
+    def get_fields(cls) -> dict[str, Any]:
+        """Get dict of fields."""
+        return cls.__dataclass_fields__  # type: ignore
+
+    def get_field_value(self, field: str) -> Optional[str]:
+        """Get field value."""
+        if hasattr(self, field):
+            return getattr(self, field)
+        return None

openbb_terminal/core/models/credentials_model.py

@@ -1,12 +1,14 @@
-from typing import Any, Optional
+from typing import Optional
 
 from pydantic.dataclasses import dataclass
 
+from openbb_terminal.core.models import BaseModel
+
 # pylint: disable=too-many-instance-attributes, disable=no-member
 
 
-@dataclass(config=dict(validate_assignment=True))
-class CredentialsModel:
+@dataclass(config=dict(validate_assignment=True, frozen=True))
+class CredentialsModel(BaseModel):
     """Model for credentials."""
 
     # Data providers
@@ -64,23 +66,8 @@ class CredentialsModel:
     API_COINBASE_SECRET: str = "REPLACE_ME"
     API_COINBASE_PASS_PHRASE: str = "REPLACE_ME"
 
-    def __repr__(self) -> str:
-        """Return string representation of model."""
-        dataclass_repr = ""
-        for key, value in self.__dict__.items():
-            if key.startswith("_"):
-                continue
-            dataclass_repr += f"    {key}='{value}', \n"
-
-        return f"{self.__class__.__name__}(\n{dataclass_repr[:-2]}\n)"
-
-    @classmethod
-    def get_fields(cls) -> dict[str, Any]:
-        """Get dict of fields."""
-        return cls.__dataclass_fields__  # type: ignore
+    # Others
+    OPENBB_PERSONAL_ACCESS_TOKEN: str = "REPLACE_ME"
 
-    def get_field_value(self, field: str) -> Optional[str]:
-        """Get field value."""
-        if hasattr(self, field):
-            return getattr(self, field)
-        return None
+    def __repr__(self) -> str:  # pylint: disable=useless-super-delegation
+        return super().__repr__()

openbb_terminal/core/models/preferences_model.py

@@ -1,5 +1,5 @@
 import os
-from typing import Any, Optional
+from typing import Optional
 
 from pydantic import NonNegativeInt, PositiveFloat, PositiveInt
 from pydantic.dataclasses import dataclass
@@ -8,12 +8,13 @@
     HOME_DIRECTORY,
     USER_DATA_SOURCES_DEFAULT_FILE,
 )
+from openbb_terminal.core.models import BaseModel
 
 # pylint: disable=too-many-instance-attributes, disable=no-member
 
 
 @dataclass(config=dict(validate_assignment=True, frozen=True))
-class PreferencesModel:
+class PreferencesModel(BaseModel):
     """Data model for preferences."""
 
     # PLOT
@@ -97,23 +98,5 @@ class PreferencesModel:
     USER_FORECAST_MODELS_DIRECTORY = USER_DATA_DIRECTORY / "exports" / "forecast_models"
     USER_FORECAST_WHISPER_DIRECTORY = USER_DATA_DIRECTORY / "exports" / "whisper"
 
-    def __repr__(self) -> str:
-        """Return string representation of model."""
-        dataclass_repr = ""
-        for key, value in self.__dict__.items():
-            if key.startswith("_"):
-                continue
-            dataclass_repr += f"    {key}='{value}', \n"
-
-        return f"{self.__class__.__name__}(\n{dataclass_repr[:-2]}\n)"
-
-    @classmethod
-    def get_fields(cls) -> dict[str, Any]:
-        """Get dict of fields."""
-        return cls.__dataclass_fields__  # type: ignore
-
-    def get_field_value(self, field: str) -> Optional[str]:
-        """Get field value."""
-        if hasattr(self, field):
-            return getattr(self, field)
-        return None
+    def __repr__(self) -> str:  # pylint: disable=useless-super-delegation
+        return super().__repr__()

openbb_terminal/core/models/profile_model.py

@@ -2,9 +2,11 @@
 
 from pydantic.dataclasses import dataclass
 
+from openbb_terminal.core.models import BaseModel
+
 
 @dataclass(config=dict(validate_assignment=True, frozen=True))
-class ProfileModel:
+class ProfileModel(BaseModel):
     """Data model for profile."""
 
     token_type: str = ""
@@ -72,3 +74,6 @@ def get_auth_header(self) -> str:
             The auth header, e.g. "Bearer <token>".
         """
         return f"{self.token_type.title()} {self.token}"
+
+    def __repr__(self) -> str:  # pylint: disable=useless-super-delegation
+        return super().__repr__()