#!/usr/bin/env python3
#
# Copyright (c) 2010 - 2026, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# We kindly request you to use one or more of the following phrases to refer to
# foxBMS in your hardware, software, documentation or advertising materials:
#
# - "This product uses parts of foxBMS®"
# - "This product includes parts of foxBMS®"
# - "This product is derived from foxBMS®"
"""Implementation of the DataHandlerFactory class to create a CSVHandler object and return it."""
import sys
from pathlib import Path
from yaml import YAMLError
from ...helpers.click_helpers import recho
from ...helpers.config import read_config
from .csv_handler import CSVHandler
from .data_handler_factory_interface import DataHandlerFactoryInterface
from .data_source_types import DataSourceTypes
from .parquet_handler import PARQUETHandler
class DataHandlerFactory(DataHandlerFactoryInterface): # pylint: disable=too-few-public-methods
"""A factory creating the needed data handler objects."""
def get_object(
self, handler: DataSourceTypes, config: Path | None
) -> CSVHandler | PARQUETHandler:
"""Creates a DataHandler object if handler_type is 'CSV' or 'PARQUET'"""
match handler:
case DataSourceTypes.CSV:
try:
if config is None:
err_msg = "No data configuration provided."
raise FileNotFoundError(err_msg)
csv_config = read_config(config)
except (
UnicodeDecodeError,
YAMLError,
FileNotFoundError,
TypeError,
OSError,
) as err:
recho(f"Problematic configuration file {config}: {err}")
sys.exit(1)
CSVHandler.validate_config(csv_config)
return CSVHandler(csv_config["columns"], **csv_config["general"])
case DataSourceTypes.PARQUET:
return PARQUETHandler()
case _:
recho("Data source type not known")
sys.exit(1)