diff --git a/openbb_platform/core/openbb_core/app/logs/logging_service.py b/openbb_platform/core/openbb_core/app/logs/logging_service.py index 5d5232548f8..951d501acc9 100644 --- a/openbb_platform/core/openbb_core/app/logs/logging_service.py +++ b/openbb_platform/core/openbb_core/app/logs/logging_service.py @@ -43,19 +43,19 @@ class LoggingService(metaclass=SingletonMeta): __init__(system_settings, user_settings) Logging Manager Constructor. - log(user_settings, system_settings, obbject, route, func, kwargs) + log(user_settings, system_settings, route, func, kwargs, exec_info or None, custom_headers or None) Log command output and relevant information. logging_settings Property to access the current logging settings. - logging_settings.setter + logging_settings.setter(value) Setter method to update the logging settings. _setup_handlers() Setup Logging Handlers. - _log_startup() + _log_startup(route or None, custom_headers or None) Log startup information. """ @@ -103,13 +103,16 @@ class LoggingService(metaclass=SingletonMeta): return self._logging_settings @logging_settings.setter - def logging_settings(self, value: Tuple[SystemSettings, UserSettings]): + def logging_settings(self, value: Tuple[SystemSettings, UserSettings]) -> None: """Define the Setter for updating the logging settings. Parameters ---------- value : Tuple[SystemSettings, UserSettings] Tuple containing updated SystemSettings and UserSettings. + Returns + ------- + None """ system_settings, user_settings = value self._logging_settings = LoggingSettings( @@ -146,7 +149,18 @@ class LoggingService(metaclass=SingletonMeta): route: Optional[str] = None, custom_headers: Optional[Dict[str, Any]] = None, ) -> None: - """Log startup information.""" + """ + Log startup information. + Parameters + ---------- + route : Optional[str] + Route for the command, by default None + custom_headers : Optional[Dict[str, Any]] + Custom headers to include in the log, by default None + Returns + ------- + None + """ def check_credentials_defined(credentials: Dict[str, Any]): class CredentialsDefinition(Enum): @@ -193,7 +207,7 @@ class LoggingService(metaclass=SingletonMeta): Tuple[None, None, None], ], custom_headers: Optional[Dict[str, Any]] = None, - ): + ) -> None: """Log command output and relevant information. Parameters @@ -213,6 +227,11 @@ class LoggingService(metaclass=SingletonMeta): Tuple[None, None, None], ] Exception information, by default None + custom_headers : Optional[Dict[str, Any]] + Custom headers to include in the log, by default None + Returns + ------- + None """ self._user_settings = user_settings self._system_settings = system_settings