openstef 3.4.67__py3-none-any.whl → 3.4.68__py3-none-any.whl

openstef/app_settings.py

@@ -5,6 +5,8 @@
 from pydantic import Field
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
+from openstef.logging.logger_factory import LoggerType
+
 
 class AppSettings(BaseSettings):
     """Global app settings."""
@@ -13,6 +15,11 @@ class AppSettings(BaseSettings):
         env_prefix="openstef_", env_file=".env", extra="ignore"
     )
 
+    logger_type: LoggerType = Field(
+        LoggerType.STRUCTLOG,
+        description="The type of logger to use.",
+    )
+
     post_teams_messages: bool = True
 
     # Logging settings.

openstef/feature_engineering/apply_features.py

@@ -15,13 +15,18 @@ import pandas as pd
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
 from openstef.enums import BiddingZone
+from openstef.feature_engineering.bidding_zone_to_country_mapping import (
+    BIDDING_ZONE_TO_COUNTRY_CODE_MAPPING,
+)
+from openstef.feature_engineering.cyclic_features import (
+    add_daylight_terrestrial_feature,
+    add_seasonal_cyclic_features,
+    add_time_cyclic_features,
+)
 from openstef.feature_engineering.holiday_features import (
     generate_holiday_feature_functions,
 )
 from openstef.feature_engineering.lag_features import generate_lag_feature_functions
-from openstef.feature_engineering.bidding_zone_to_country_mapping import (
-    BIDDING_ZONE_TO_COUNTRY_CODE_MAPPING,
-)
 from openstef.feature_engineering.rolling_features import add_rolling_aggregate_features
 from openstef.feature_engineering.weather_features import (
     add_additional_solar_features,
@@ -29,12 +34,6 @@ from openstef.feature_engineering.weather_features import (
     add_humidity_features,
 )
 
-from openstef.feature_engineering.cyclic_features import (
-    add_seasonal_cyclic_features,
-    add_time_cyclic_features,
-    add_daylight_terrestrial_feature,
-)
-
 
 def apply_features(
     data: pd.DataFrame,

openstef/feature_engineering/cyclic_features.py

@@ -9,19 +9,10 @@
 import numpy as np
 import pandas as pd
 
-import structlog
-import logging
-
-from openstef.settings import Settings
 from openstef import PROJECT_ROOT
+from openstef.logging.logger_factory import get_logger
 
-
-structlog.configure(
-    wrapper_class=structlog.make_filtering_bound_logger(
-        logging.getLevelName(Settings.log_level)
-    )
-)
-logger = structlog.get_logger(__name__)
+logger = get_logger(__name__)
 
 TERRESTRIAL_RADIATION_CSV_PATH: str = (
     PROJECT_ROOT / "openstef" / "data" / "NL_terrestrial_radiation.csv"

openstef/feature_engineering/data_preparation.py

@@ -1,13 +1,11 @@
 # SPDX-FileCopyrightText: 2017-2023 Alliander N.V. <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-import logging
 from abc import ABC, abstractmethod
 from datetime import timedelta
 from typing import Optional
 
 import pandas as pd
-import structlog
 
 from openstef.data_classes.model_specifications import ModelSpecificationDataClass
 from openstef.data_classes.prediction_job import PredictionJobDataClass
@@ -19,9 +17,9 @@ from openstef.feature_engineering.general import (
     enforce_feature_order,
     remove_non_requested_feature_columns,
 )
+from openstef.logging.logger_factory import get_logger
 from openstef.model.regressors.regressor import OpenstfRegressor
 from openstef.pipeline.utils import generate_forecast_datetime_range
-from openstef.settings import Settings
 
 
 class AbstractDataPreparation(ABC):
@@ -122,12 +120,7 @@ class ARDataPreparation(AbstractDataPreparation):
     def prepare_forecast_data(
         self, data: pd.DataFrame
     ) -> tuple[pd.DataFrame, pd.DataFrame]:
-        structlog.configure(
-            wrapper_class=structlog.make_filtering_bound_logger(
-                logging.getLevelName(Settings.log_level)
-            )
-        )
-        logger = structlog.get_logger(__name__)
+        logger = get_logger(__name__)
         self.check_model()
         # Prep forecast input by selecting only the forecast datetime interval (this is much smaller than the input range)
         # Also drop the load column

openstef/feature_engineering/general.py

@@ -3,12 +3,10 @@
 # SPDX-License-Identifier: MPL-2.0
 """This modelu contains various helper functions."""
 
-import logging
-
 import numpy as np
 import pandas as pd
-import structlog
 
+from openstef.logging.logger_factory import get_logger
 from openstef.settings import Settings
 
 
@@ -34,12 +32,7 @@ def add_missing_feature_columns(
         Input dataframe with missing columns filled with ``np.N=nan``.
 
     """
-    structlog.configure(
-        wrapper_class=structlog.make_filtering_bound_logger(
-            logging.getLevelName(Settings.log_level)
-        )
-    )
-    logger = structlog.get_logger(__name__)
+    logger = get_logger(__name__)
 
     if features is None:
         features = []
@@ -70,12 +63,7 @@ def remove_non_requested_feature_columns(
         Model input data with features.
 
     """
-    structlog.configure(
-        wrapper_class=structlog.make_filtering_bound_logger(
-            logging.getLevelName(Settings.log_level)
-        )
-    )
-    logger = structlog.get_logger(__name__)
+    logger = get_logger(__name__)
 
     if requested_features is None:
         requested_features = []

openstef/feature_engineering/missing_values_transformer.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-from typing import Union, List, Optional
+from typing import List, Optional, Union
 
 import numpy as np
 import pandas as pd

openstef/feature_engineering/rolling_features.py

@@ -4,9 +4,9 @@
 from datetime import timedelta
 
 import pandas as pd
+from pydantic import TypeAdapter
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
-from pydantic import TypeAdapter
 
 
 def convert_timedelta_to_isoformat(td: timedelta) -> str:

openstef/feature_engineering/weather_features.py

@@ -3,24 +3,17 @@
 # SPDX-License-Identifier: MPL-2.0
 
 """This module contains all wheather related functions used for feature engineering."""
-import logging
 from typing import Union
 
 import numpy as np
 import pandas as pd
 import pvlib
-import structlog
 from pvlib.location import Location
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
-from openstef.settings import Settings
+from openstef.logging.logger_factory import get_logger
 
-structlog.configure(
-    wrapper_class=structlog.make_filtering_bound_logger(
-        logging.getLevelName(Settings.log_level)
-    )
-)
-logger = structlog.get_logger(__name__)
+logger = get_logger(__name__)
 
 
 # Set some (nameless) constants for the Antoine equation:

openstef/logging/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0

openstef/logging/base_logger.py

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class BaseLogger(ABC):
+    """Abstract Base Logger Interface"""
+
+    @abstractmethod
+    def debug(self, message: str, **kwargs: Any) -> None:
+        pass
+
+    @abstractmethod
+    def info(self, message: str, **kwargs: Any) -> None:
+        pass
+
+    @abstractmethod
+    def warning(self, message: str, **kwargs: Any) -> None:
+        pass
+
+    @abstractmethod
+    def error(self, message: str, **kwargs: Any) -> None:
+        pass
+
+    @abstractmethod
+    def exception(self, message: str, **kwargs: Any) -> None:
+        pass
+
+    @abstractmethod
+    def bind(self, **kwargs: Any) -> "BaseLogger":
+        pass

openstef/logging/logger_factory.py

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+from openstef.logging.logger_types import LoggerType
+from openstef.logging.standard_logger import StandardLogger
+from openstef.logging.structlog_logger import StructlogLogger
+from openstef.settings import Settings
+
+
+def get_logger(name: str, logger_type: str = Settings.logger_type):
+    if logger_type == LoggerType.STANDARD:
+        return StandardLogger(name)
+    elif logger_type == LoggerType.STRUCTLOG:
+        return StructlogLogger(name)
+    else:
+        raise ValueError(f"Unknown logger type: {logger_type}")

openstef/logging/logger_types.py

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+from enum import StrEnum
+
+
+class LoggerType(StrEnum):
+    STANDARD = "logging"
+    STRUCTLOG = "structlog"

openstef/logging/standard_logger.py

@@ -0,0 +1,33 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+import logging
+
+from openstef.logging.base_logger import BaseLogger
+from openstef.settings import Settings
+
+
+class StandardLogger(BaseLogger):
+    def __init__(self, name: str):
+        self.logger = logging.getLogger(name)
+        logging.basicConfig(level=Settings.log_level)
+
+    def debug(self, message: str, **kwargs):
+        self.logger.debug(message, extra=kwargs)
+
+    def info(self, message: str, **kwargs):
+        self.logger.info(message, extra=kwargs)
+
+    def warning(self, message: str, **kwargs):
+        self.logger.warning(message, extra=kwargs)
+
+    def error(self, message: str, **kwargs):
+        self.logger.error(message, extra=kwargs)
+
+    def exception(self, message: str, **kwargs):
+        self.logger.exception(message, extra=kwargs)
+
+    def bind(self, **kwargs):
+        """Not implemented for StandardLogger"""
+        return self

openstef/logging/structlog_logger.py

@@ -0,0 +1,38 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+import logging
+
+import structlog
+
+from openstef.logging.base_logger import BaseLogger
+from openstef.settings import Settings
+
+
+class StructlogLogger(BaseLogger):
+    def __init__(self, name: str):
+        structlog.configure(
+            wrapper_class=structlog.make_filtering_bound_logger(
+                logging.getLevelName(Settings.log_level)
+            )
+        )
+        self.logger = structlog.get_logger(name)
+
+    def debug(self, message: str, **kwargs):
+        self.logger.debug(message, **kwargs)
+
+    def info(self, message: str, **kwargs):
+        self.logger.info(message, **kwargs)
+
+    def warning(self, message: str, **kwargs):
+        self.logger.warning(message, **kwargs)
+
+    def error(self, message: str, **kwargs):
+        self.logger.error(message, **kwargs)
+
+    def exception(self, message: str, **kwargs):
+        self.logger.exception(message, **kwargs)
+
+    def bind(self, **kwargs):
+        return self.logger.bind(**kwargs)

openstef/metrics/reporter.py

@@ -2,7 +2,6 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 """Defines reporter class."""
-import logging
 import os
 import warnings
 from dataclasses import dataclass
@@ -10,14 +9,13 @@ from dataclasses import dataclass
 import numpy as np
 import pandas as pd
 import sklearn
-import structlog
 from mlflow.models import ModelSignature, infer_signature
 from plotly.graph_objects import Figure
 
+from openstef.logging.logger_factory import get_logger
 from openstef.metrics import figure
 from openstef.metrics.metrics import bias, mae, nsme, r_mae, rmse
 from openstef.model.regressors.regressor import OpenstfRegressor
-from openstef.settings import Settings
 
 
 @dataclass
@@ -169,12 +167,7 @@ class Reporter:
     def write_report_to_disk(report: Report, report_folder: str):
         """Write report to disk; e.g. for viewing report of latest models using grafana."""
         # Initialize logger and serializer
-        structlog.configure(
-            wrapper_class=structlog.make_filtering_bound_logger(
-                logging.getLevelName(Settings.log_level)
-            )
-        )
-        logger = structlog.get_logger(__name__)
+        logger = get_logger(__name__)
         if report_folder:
             # create path if does not exist
             if not os.path.exists(report_folder):

openstef/model/confidence_interval_applicator.py

@@ -1,30 +1,23 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-import logging
 from datetime import datetime
 
 import numpy as np
 import pandas as pd
-import structlog
 from scipy import stats
 from sklearn.base import RegressorMixin
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
 from openstef.exceptions import ModelWithoutStDev
-from openstef.settings import Settings
+from openstef.logging.logger_factory import get_logger
 
 
 class ConfidenceIntervalApplicator:
     def __init__(self, model: RegressorMixin, forecast_input_data: pd.DataFrame):
         self.model = model
         self.forecast_input_data = forecast_input_data
-        structlog.configure(
-            wrapper_class=structlog.make_filtering_bound_logger(
-                logging.getLevelName(Settings.log_level)
-            )
-        )
-        self.logger = structlog.get_logger(self.__class__.__name__)
+        self.logger = get_logger(self.__class__.__name__)
 
     def add_confidence_interval(
         self,

openstef/model/fallback.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-from datetime import datetime, UTC
+from datetime import UTC, datetime
 
 import pandas as pd
 

openstef/model/metamodels/feature_clipper.py

@@ -1,9 +1,10 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-from sklearn.base import BaseEstimator, TransformerMixin
+from typing import Dict, List, Optional, Tuple
+
 import pandas as pd
-from typing import List, Dict, Tuple, Optional
+from sklearn.base import BaseEstimator, TransformerMixin
 
 
 class FeatureClipper(BaseEstimator, TransformerMixin):

openstef/model/model_creator.py

@@ -1,33 +1,25 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-import logging
 from typing import Union
 
-import structlog
-
 from openstef.enums import ModelType
+from openstef.logging.logger_factory import get_logger
 from openstef.model.regressors.arima import ARIMAOpenstfRegressor
 from openstef.model.regressors.custom_regressor import is_custom_type, load_custom_model
+from openstef.model.regressors.flatliner import FlatlinerRegressor
 from openstef.model.regressors.gblinear_quantile import GBLinearQuantileOpenstfRegressor
 from openstef.model.regressors.lgbm import LGBMOpenstfRegressor
 from openstef.model.regressors.linear import LinearOpenstfRegressor
 from openstef.model.regressors.linear_quantile import LinearQuantileOpenstfRegressor
 from openstef.model.regressors.regressor import OpenstfRegressor
-from openstef.model.regressors.flatliner import FlatlinerRegressor
 from openstef.model.regressors.xgb import XGBOpenstfRegressor
-from openstef.model.regressors.xgb_quantile import XGBQuantileOpenstfRegressor
 from openstef.model.regressors.xgb_multioutput_quantile import (
     XGBMultiOutputQuantileOpenstfRegressor,
 )
-from openstef.settings import Settings
+from openstef.model.regressors.xgb_quantile import XGBQuantileOpenstfRegressor
 
-structlog.configure(
-    wrapper_class=structlog.make_filtering_bound_logger(
-        logging.getLevelName(Settings.log_level)
-    )
-)
-logger = structlog.get_logger(__name__)
+logger = get_logger(__name__)
 
 valid_model_kwargs = {
     ModelType.XGB: [

openstef/model/objective_creator.py

@@ -10,9 +10,9 @@ from openstef.model.objective import (
     LGBRegressorObjective,
     LinearRegressorObjective,
     RegressorObjective,
+    XGBMultioutputQuantileRegressorObjective,
     XGBQuantileRegressorObjective,
     XGBRegressorObjective,
-    XGBMultioutputQuantileRegressorObjective,
 )
 from openstef.model.regressors.custom_regressor import (
     create_custom_objective,

openstef/model/regressors/gblinear_quantile.py

@@ -3,12 +3,12 @@
 # SPDX-License-Identifier: MPL-2.0
 import math
 import re
-from typing import Union, Optional, List
+from typing import List, Optional, Union
 
 import numpy as np
 import pandas as pd
-from sklearn.model_selection import train_test_split
 import xgboost as xgb
+from sklearn.model_selection import train_test_split
 from sklearn.preprocessing import StandardScaler
 from sklearn.utils.validation import check_is_fitted
 

openstef/model/regressors/linear_quantile.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 import re
-from typing import Dict, Union, Set, Optional, List
+from typing import Dict, List, Optional, Set, Union
 
 import numpy as np
 import pandas as pd

openstef/model/regressors/xgb.py

@@ -5,7 +5,6 @@ from typing import Optional
 
 import numpy as np
 from sklearn.base import RegressorMixin
-
 from xgboost import XGBRegressor
 
 from openstef.model.regressors.regressor import OpenstfRegressor

openstef/model/serializer.py

@@ -5,7 +5,7 @@ import json
 import logging
 import os
 import shutil
-from datetime import datetime, UTC
+from datetime import UTC, datetime
 from json import JSONDecodeError
 from typing import Optional, Union
 from urllib.parse import unquote, urlparse
@@ -13,12 +13,12 @@ from urllib.parse import unquote, urlparse
 import mlflow
 import numpy as np
 import pandas as pd
-import structlog
 from mlflow.exceptions import MlflowException
 from mlflow.store.artifact.artifact_repository_registry import get_artifact_repository
 from xgboost import XGBModel  # Temporary for backward compatibility
 
 from openstef.data_classes.model_specifications import ModelSpecificationDataClass
+from openstef.logging.logger_factory import get_logger
 from openstef.metrics.reporter import Report
 from openstef.model.regressors.regressor import OpenstfRegressor
 from openstef.settings import Settings
@@ -26,12 +26,7 @@ from openstef.settings import Settings
 
 class MLflowSerializer:
     def __init__(self, mlflow_tracking_uri: str):
-        structlog.configure(
-            wrapper_class=structlog.make_filtering_bound_logger(
-                logging.getLevelName(Settings.log_level)
-            )
-        )
-        self.logger = structlog.get_logger(self.__class__.__name__)
+        self.logger = get_logger(self.__class__.__name__)
         mlflow.set_tracking_uri(mlflow_tracking_uri)
         self.logger.debug(f"MLflow tracking uri at init= {mlflow_tracking_uri}")
         self.experiment_name_prefix = (

openstef/monitoring/teams.py

@@ -1,14 +1,13 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-import logging
 from typing import Union
 
 import pandas as pd
 import pymsteams
-import structlog
 from pymsteams import cardsection
 
+from openstef.logging.logger_factory import get_logger
 from openstef.settings import Settings
 
 
@@ -44,12 +43,7 @@ def post_teams(
     if not Settings.post_teams_messages:
         return
 
-    structlog.configure(
-        wrapper_class=structlog.make_filtering_bound_logger(
-            logging.getLevelName(Settings.log_level)
-        )
-    )
-    logger = structlog.get_logger(__name__)
+    logger = get_logger(__name__)
     # If no url is passed, give warning and don't send teams message
     if url is None:
         logger.warning("Can't post Teams message, no url given.")

openstef/pipeline/create_basecase_forecast.py

@@ -1,17 +1,16 @@
 # SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501>
 #
 # SPDX-License-Identifier: MPL-2.0
-import logging
 from pathlib import Path
 
 import pandas as pd
-import structlog
 
 from openstef.data_classes.prediction_job import PredictionJobDataClass
 from openstef.exceptions import NoRealisedLoadError
 from openstef.feature_engineering.feature_applicator import (
     OperationalPredictFeatureApplicator,
 )
+from openstef.logging.logger_factory import get_logger
 from openstef.model.basecase import BaseCaseModel
 from openstef.model.confidence_interval_applicator import ConfidenceIntervalApplicator
 from openstef.pipeline.utils import generate_forecast_datetime_range
@@ -19,7 +18,6 @@ from openstef.postprocessing.postprocessing import (
     add_components_base_case_forecast,
     add_prediction_job_properties_to_forecast,
 )
-from openstef.settings import Settings
 from openstef.validation import validation
 
 MODEL_LOCATION = Path(".")
@@ -44,13 +42,7 @@ def create_basecase_forecast_pipeline(
         NoRealisedLoadError: When no realised load for given datetime range.
 
     """
-    structlog.configure(
-        wrapper_class=structlog.make_filtering_bound_logger(
-            logging.getLevelName(Settings.log_level)
-        )
-    )
-    logger = structlog.get_logger(__name__)
-
+    logger = get_logger(__name__)
     logger.info("Preprocessing data for basecase forecast")
 
     forecast_start, forecast_end = generate_forecast_datetime_range(input_data)