pm4py.objects.log.importer.xes package

Submodules

pm4py.objects.log.importer.xes.importer module

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.objects.log.importer.xes.importer.Variants[source]

Bases: enum.Enum

An enumeration.

CHUNK_REGEX = <module 'pm4py.objects.log.importer.xes.variants.chunk_regex' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/chunk_regex.py'>
ITERPARSE = <module 'pm4py.objects.log.importer.xes.variants.iterparse' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/iterparse.py'>
ITERPARSE_20 = <module 'pm4py.objects.log.importer.xes.variants.iterparse_20' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/iterparse_20.py'>
ITERPARSE_MEM_COMPRESSED = <module 'pm4py.objects.log.importer.xes.variants.iterparse_mem_compressed' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/iterparse_mem_compressed.py'>
LINE_BY_LINE = <module 'pm4py.objects.log.importer.xes.variants.line_by_line' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/line_by_line.py'>
pm4py.objects.log.importer.xes.importer.apply(path, parameters=None, variant=<Variants.ITERPARSE: <module 'pm4py.objects.log.importer.xes.variants.iterparse' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/iterparse.py'>>)[source]

Import a XES log into a EventLog object

Parameters:

  • path – Log path

  • parameters –

    Parameters of the algorithm, including

    Parameters.TIMESTAMP_SORT -> Specify if we should sort log by timestamp Parameters.TIMESTAMP_KEY -> If sort is enabled, then sort the log by using this key Parameters.REVERSE_SORT -> Specify in which direction the log should be sorted Parameters.INSERT_TRACE_INDICES -> Specify if trace indexes should be added as event attribute for each event Parameters.MAX_TRACES -> Specify the maximum number of traces to import from the log (read in order in the XML file)

  • variant –

    Variant of the algorithm to use, including:
    • Variants.ITERPARSE
    • Variants.LINE_BY_LINE
Returns:

Trace log object
Return type:

log
pm4py.objects.log.importer.xes.importer.deserialize(log_string, parameters=None, variant=<Variants.ITERPARSE: <module 'pm4py.objects.log.importer.xes.variants.iterparse' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/objects/log/importer/xes/variants/iterparse.py'>>)[source]

Deserialize a text/binary string representing a XES log

Parameters:

  • log_string – String that contains the XES

  • parameters –

    Parameters of the algorithm, including

    Parameters.TIMESTAMP_SORT -> Specify if we should sort log by timestamp Parameters.TIMESTAMP_KEY -> If sort is enabled, then sort the log by using this key Parameters.REVERSE_SORT -> Specify in which direction the log should be sorted Parameters.INSERT_TRACE_INDICES -> Specify if trace indexes should be added as event attribute for each event Parameters.MAX_TRACES -> Specify the maximum number of traces to import from the log (read in order in the XML file)

  • variant –

    Variant of the algorithm to use, including:
    • Variants.ITERPARSE
    • Variants.LINE_BY_LINE
Returns:

Trace log object
Return type:

log

Module contents

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.