1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
"""The OpenBB Platform System Settings."""
import json
import platform as pl # I do this so that the import doesn't conflict with the variable name
from pathlib import Path
from typing import List, Literal, Optional
from pydantic import ConfigDict, Field, field_validator, model_validator
from openbb_core.app.constants import (
HOME_DIRECTORY,
OPENBB_DIRECTORY,
SYSTEM_SETTINGS_PATH,
USER_SETTINGS_PATH,
)
from openbb_core.app.model.abstract.tagged import Tagged
from openbb_core.app.model.fast_api_settings import FastAPISettings
from openbb_core.app.version import CORE_VERSION, VERSION
class SystemSettings(Tagged):
"""System settings model."""
# System section
os: str = str(pl.system())
python_version: str = str(pl.python_version())
platform: str = str(pl.platform())
# OpenBB section
version: str = VERSION
core: str = CORE_VERSION
home_directory: str = str(HOME_DIRECTORY)
openbb_directory: str = str(OPENBB_DIRECTORY)
user_settings_path: str = str(USER_SETTINGS_PATH)
system_settings_path: str = str(SYSTEM_SETTINGS_PATH)
# Logging section
logging_app_name: Literal["platform"] = "platform"
logging_commit_hash: Optional[str] = None
logging_frequency: Literal["D", "H", "M", "S"] = "H"
logging_handlers: List[str] = Field(default_factory=lambda: ["file"])
logging_rolling_clock: bool = False
logging_verbosity: int = 20
logging_sub_app: Literal["python", "api", "pro"] = "python"
logging_suppress: bool = False
log_collect: bool = True
# API section
api_settings: FastAPISettings = Field(default_factory=FastAPISettings)
# Others
debug_mode: bool = False
test_mode: bool = False
headless: bool = False
model_config = ConfigDict(validate_assignment=True, frozen=True)
def __repr__(self) -> str:
"""Return a string representation of the model."""
return f"{self.__class__.__name__}\n\n" + "\n".join(
f"{k}: {v}" for k, v in self.model_dump().items()
)
@staticmethod
def create_empty_json(path: Path) -> None:
"""Create an empty JSON file."""
path.write_text(json.dumps({}), 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":
"""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.mkdir(parents=True, exist_ok=True)
for path in [user_settings, system_settings]:
if not path.exists():
cls.create_empty_json(path)
return values
@model_validator(mode="after") # type: ignore
@classmethod
def validate_posthog_handler(cls, values: "SystemSettings") -> "SystemSettings":
"""If the user has enabled log collection, then we need to add the Posthog."""
if (
not any([values.test_mode, values.debug_mode, values.logging_suppress])
and values.log_collect
and "posthog" not in values.logging_handlers
):
values.logging_handlers.append("posthog")
return values
@field_validator("logging_handlers")
@classmethod
def validate_logging_handlers(cls, v):
"""Validate the logging handlers."""
for value in v:
if value not in ["stdout", "stderr", "noop", "file", "posthog"]:
raise ValueError("Invalid logging handler")
return v
|
