Source code for pm4py.objects.petri_net.importer.importer

'''
    PM4Py – A Process Mining Library for Python
Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see this software project's root or 
visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions
Contact: info@processintelligence.solutions
'''
from enum import Enum

from pm4py.objects.petri_net.importer.variants import pnml
from pm4py.util import exec_utils




class Variants(Enum):
    PNML = pnml



PNML = Variants.PNML




def apply(input_file_path, variant=PNML, parameters=None):
    """
    Import a Petri net from a PNML file

    Parameters
    ------------
    input_file_path
        Input file path
    parameters
        Other parameters of the importer
    variant
        Variant of the algorithm to use, possible values:
            - Variants.PNML
    """
    return exec_utils.get_variant(variant).import_net(
        input_file_path, parameters=parameters
    )





def deserialize(petri_string, variant=PNML, parameters=None):
    """
    Deserialize a text/binary string representing a Petri net in the PNML format

    Parameters
    ----------
    petri_string
        Petri net expressed as PNML string
    variant
        Variant of the algorithm to use, possible values:
            - Variants.PNML
    parameters
        Other parameters of the algorithm
    """
    return exec_utils.get_variant(variant).import_net_from_string(
        petri_string, parameters=parameters
    )