Source code for pain001.xml.generate_updated_xml_file_path

# Copyright (C) 2023-2026 Sebastien Rousseau.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Standard library imports
import os

# Generate the path to the updated XML file based on the path to the
# original XML file




def generate_updated_xml_file_path(
    xml_file_path: str, payment_initiation_message_type: str
) -> str:
    """Generates the file path for an updated XML file.

    Given the original XML file path and payment message type, this function
    constructs the file path for an updated version of the XML file with
    the provided message type in the filename.

    Args:
        xml_file_path (str): The path to the original XML file.
        payment_initiation_message_type (str): The payment message type
            (e.g. 'pain.001.001.04').

    Returns:
        str: The file path to the updated XML file.

    """

    base_directory = os.path.dirname(xml_file_path)

    # Construct new file path
    new_file_name = payment_initiation_message_type + ".xml"
    new_file_path = os.path.join(base_directory, new_file_name)

    return new_file_path