merge branch v5

Author: deeleeramone

.github/workflows/test-unit-platform.yml

@@ -72,28 +72,24 @@ def create_json(path: Path, template: dict | None = None) -> None:
         """Create an empty JSON file."""
         path.write_text(json.dumps(obj=template or {}, indent=4), encoding="utf-8")
 
-    # TODO: Figure out why this works only opposite to what the docs say
-    # https://docs.pydantic.dev/latest/concepts/validators/#model-validators
-    # based on docs first argument should be self, but it works only with cls
-    @model_validator(mode="after")  # type: ignore
-    @classmethod
-    def create_openbb_directory(cls, values: "SystemSettings") -> "SystemSettings":
+    @model_validator(mode="after")
+    def create_openbb_directory(self) -> "SystemSettings":
         """Create the OpenBB directory if it doesn't exist."""
-        obb_dir = Path(values.openbb_directory).resolve()
-        user_settings = Path(values.user_settings_path).resolve()
-        system_settings = Path(values.system_settings_path).resolve()
+        obb_dir = Path(self.openbb_directory).resolve()
+        user_settings = Path(self.user_settings_path).resolve()
+        system_settings = Path(self.system_settings_path).resolve()
         obb_dir.mkdir(parents=True, exist_ok=True)
 
         if not user_settings.exists():
-            cls.create_json(
+            self.create_json(
                 user_settings,
                 {"credentials": {}, "preferences": {}, "defaults": {"commands": {}}},
             )
 
         if not system_settings.exists():
-            cls.create_json(system_settings, {})
+            self.create_json(system_settings, {})
 
-        return values
+        return self
 
     @field_validator("logging_handlers")
     @classmethod

cookiecutter/poetry.lock

@@ -4,17 +4,10 @@
 from pathlib import Path
 
 import pytest
-from pydantic import BaseModel, ConfigDict
 
 from openbb_core.app.model.system_settings import SystemSettings
 
 
-class MockSystemSettings(BaseModel):
-    """Mock SystemSettings."""
-
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-
 def test_system_settings():
     """Test the SystemSettings class."""
     sys = SystemSettings()
@@ -29,74 +22,78 @@ def test_system_settings_repr():
     assert "openbb_directory" in result
 
 
-def test_create_openbb_directory_directory_and_files_not_exist(tmpdir):
+def test_create_openbb_directory_directory_and_files_not_exist(tmpdir, monkeypatch):
     """Test the create_openbb_directory method."""
     # Arrange
-    values = MockSystemSettings(
-        **{
-            "openbb_directory": str(tmpdir.join("openbb")),
-            "user_settings_path": str(tmpdir.join("user_settings.json")),
-            "system_settings_path": str(tmpdir.join("system_settings.json")),
-        }
+    obb_dir = str(tmpdir.join("openbb"))
+    user_settings = str(tmpdir.join("user_settings.json"))
+    system_settings = str(tmpdir.join("system_settings.json"))
+
+    monkeypatch.setenv("OPENBB_DIRECTORY", obb_dir)
+    monkeypatch.setenv("USER_SETTINGS_PATH", user_settings)
+    monkeypatch.setenv("SYSTEM_SETTINGS_PATH", system_settings)
+
+    # Act - The validator runs automatically during instantiation
+    sys = SystemSettings(
+        openbb_directory=obb_dir,
+        user_settings_path=user_settings,
+        system_settings_path=system_settings,
     )
 
-    # Act
-    SystemSettings.create_openbb_directory(values)  # type: ignore[operator]
-
     # Assert
-    assert os.path.exists(values.openbb_directory)  # type: ignore[attr-defined]
-    assert os.path.exists(values.user_settings_path)  # type: ignore[attr-defined]
-    assert os.path.exists(values.system_settings_path)  # type: ignore[attr-defined]
+    assert os.path.exists(sys.openbb_directory)
+    assert os.path.exists(sys.user_settings_path)
+    assert os.path.exists(sys.system_settings_path)
 
 
 def test_create_openbb_directory_directory_exists_user_settings_missing(tmpdir):
     """Test the create_openbb_directory method."""
     # Arrange
-    values = MockSystemSettings(
-        **{
-            "openbb_directory": str(tmpdir.join("openbb")),
-            "user_settings_path": str(tmpdir.join("user_settings.json")),
-            "system_settings_path": str(tmpdir.join("system_settings.json")),
-        }
-    )
+    obb_dir = str(tmpdir.join("openbb"))
+    user_settings = str(tmpdir.join("user_settings.json"))
+    system_settings = str(tmpdir.join("system_settings.json"))
 
     # Create the openbb directory
-    Path(values.openbb_directory).mkdir(parents=True, exist_ok=True)  # type: ignore[attr-defined]
+    Path(obb_dir).mkdir(parents=True, exist_ok=True)
 
-    # Act
-    SystemSettings.create_openbb_directory(values)  # type: ignore[operator]
+    # Act - The validator runs automatically during instantiation
+    sys = SystemSettings(
+        openbb_directory=obb_dir,
+        user_settings_path=user_settings,
+        system_settings_path=system_settings,
+    )
 
     # Assert
-    assert os.path.exists(values.openbb_directory)  # type: ignore[attr-defined]
-    assert os.path.exists(values.user_settings_path)  # type: ignore[attr-defined]
-    assert os.path.exists(values.system_settings_path)  # type: ignore[attr-defined]
+    assert os.path.exists(sys.openbb_directory)
+    assert os.path.exists(sys.user_settings_path)
+    assert os.path.exists(sys.system_settings_path)
 
 
 def test_create_openbb_directory_directory_exists_system_settings_missing(tmpdir):
     """Test the create_openbb_directory method."""
     # Arrange
-    values = MockSystemSettings(
-        **{
-            "openbb_directory": str(tmpdir.join("openbb")),
-            "user_settings_path": str(tmpdir.join("user_settings.json")),
-            "system_settings_path": str(tmpdir.join("system_settings.json")),
-        }
-    )
+    obb_dir = str(tmpdir.join("openbb"))
+    user_settings = str(tmpdir.join("user_settings.json"))
+    system_settings = str(tmpdir.join("system_settings.json"))
 
     # Create the openbb directory
-    Path(values.openbb_directory).mkdir(parents=True, exist_ok=True)  # type: ignore[attr-defined]
+    Path(obb_dir).mkdir(parents=True, exist_ok=True)
 
     # Create the user_settings.json file
-    with open(values.user_settings_path, "w") as f:  # type: ignore[attr-defined]
+    with open(user_settings, "w") as f:
         f.write("{}")
 
-    # Act
-    SystemSettings.create_openbb_directory(values)  # type: ignore[operator]
+    # Act - The validator runs automatically during instantiation
+    sys = SystemSettings(
+        openbb_directory=obb_dir,
+        user_settings_path=user_settings,
+        system_settings_path=system_settings,
+    )
 
     # Assert
-    assert os.path.exists(values.openbb_directory)  # type: ignore[attr-defined]
-    assert os.path.exists(values.user_settings_path)  # type: ignore[attr-defined]
-    assert os.path.exists(values.system_settings_path)  # type: ignore[attr-defined]
+    assert os.path.exists(sys.openbb_directory)
+    assert os.path.exists(sys.user_settings_path)
+    assert os.path.exists(sys.system_settings_path)
 
 
 @pytest.mark.parametrize(

openbb_platform/core/openbb_core/app/model/system_settings.py

@@ -95,7 +95,8 @@ class MyData:
     MyData.__qualname__ = "MyData"
 
     out = DocstringGenerator.get_field_type(
-        Union[list[MyData], None], is_required=False
+        Union[list[MyData], None],  # noqa: UP007 — explicit form is the point
+        is_required=False,
     )
     # Container preserved, dotted prefix stripped.
     assert "list[MyData]" in out