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

PM4Py – A Process Mining Library for Python Copyright (C) 2026 Process Intelligence Solutions GmbH

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

class pm4py.objects.log.importer.xes.importer.Variants(*values)[source]#

Bases: Enum

ITERPARSE = <module 'pm4py.objects.log.importer.xes.variants.iterparse' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/iterparse.py'>#
LINE_BY_LINE = <module 'pm4py.objects.log.importer.xes.variants.line_by_line' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/line_by_line.py'>#
ITERPARSE_MEM_COMPRESSED = <module 'pm4py.objects.log.importer.xes.variants.iterparse_mem_compressed' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/iterparse_mem_compressed.py'>#
ITERPARSE_20 = <module 'pm4py.objects.log.importer.xes.variants.iterparse_20' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/iterparse_20.py'>#
CHUNK_REGEX = <module 'pm4py.objects.log.importer.xes.variants.chunk_regex' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/chunk_regex.py'>#
RUSTXES = <module 'pm4py.objects.log.importer.xes.variants.rustxes' from '/home/javert/ALE/pm4py/pm4py/objects/log/importer/xes/variants/rustxes.py'>#
pm4py.objects.log.importer.xes.importer.apply(path, parameters=None, variant='iterparse')[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='iterparse')[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