pm4py.objects.log.importer.xes package

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

Subpackages

• pm4py.objects.log.importer.xes.variants package
  • Submodules
  • pm4py.objects.log.importer.xes.variants.chunk_regex module
    • Parameters
      • Parameters.DECOMPRESS_SERIALIZATION
      • Parameters.ENCODING
    • apply()
    • import_log_from_file_object()
    • import_log()
    • import_from_string()
  • pm4py.objects.log.importer.xes.variants.iterparse module
    • Parameters
      • Parameters.TIMESTAMP_SORT
      • Parameters.TIMESTAMP_KEY
      • Parameters.REVERSE_SORT
      • Parameters.MAX_TRACES
      • Parameters.SHOW_PROGRESS_BAR
      • Parameters.DECOMPRESS_SERIALIZATION
      • Parameters.ENCODING
    • count_traces()
    • import_from_context()
    • apply()
    • import_log()
    • import_from_string()
  • pm4py.objects.log.importer.xes.variants.iterparse_20 module
    • Parameters
      • Parameters.TIMESTAMP_SORT
      • Parameters.TIMESTAMP_KEY
      • Parameters.REVERSE_SORT
      • Parameters.MAX_TRACES
      • Parameters.SHOW_PROGRESS_BAR
      • Parameters.DECOMPRESS_SERIALIZATION
      • Parameters.ENCODING
    • count_traces()
    • import_from_context()
    • apply()
    • import_log()
    • import_from_string()
  • pm4py.objects.log.importer.xes.variants.iterparse_mem_compressed module
    • Parameters
      • Parameters.TIMESTAMP_SORT
      • Parameters.TIMESTAMP_KEY
      • Parameters.REVERSE_SORT
      • Parameters.MAX_TRACES
      • Parameters.SHOW_PROGRESS_BAR
      • Parameters.DECOMPRESS_SERIALIZATION
      • Parameters.ENCODING
    • count_traces()
    • import_from_context()
    • apply()
    • import_log()
    • import_from_string()
  • pm4py.objects.log.importer.xes.variants.line_by_line module
    • Parameters
      • Parameters.TIMESTAMP_SORT
      • Parameters.TIMESTAMP_KEY
      • Parameters.REVERSE_SORT
      • Parameters.MAX_TRACES
      • Parameters.MAX_BYTES
      • Parameters.SKIP_BYTES
      • Parameters.SET_ATTRIBUTES_TO_READ
      • Parameters.DECOMPRESS_SERIALIZATION
      • Parameters.ENCODING
    • apply()
    • read_attribute_key_value()
    • import_log_from_file_object()
    • import_log()
    • import_from_string()
  • pm4py.objects.log.importer.xes.variants.rustxes module
    • Parameters
      • Parameters.RETURN_LEGACY_LOG_OBJECT
    • apply()

Submodules

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

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

class pm4py.objects.log.importer.xes.importer.Variants(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ITERPARSE = <module 'pm4py.objects.log.importer.xes.variants.iterparse' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\iterparse.py'>

LINE_BY_LINE = <module 'pm4py.objects.log.importer.xes.variants.line_by_line' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\line_by_line.py'>

ITERPARSE_MEM_COMPRESSED = <module 'pm4py.objects.log.importer.xes.variants.iterparse_mem_compressed' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\iterparse_mem_compressed.py'>

ITERPARSE_20 = <module 'pm4py.objects.log.importer.xes.variants.iterparse_20' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\iterparse_20.py'>

CHUNK_REGEX = <module 'pm4py.objects.log.importer.xes.variants.chunk_regex' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\chunk_regex.py'>

RUSTXES = <module 'pm4py.objects.log.importer.xes.variants.rustxes' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\importer\\xes\\variants\\rustxes.py'>

pm4py.objects.log.importer.xes.importer.apply(path, parameters=None, variant='iterparse')

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

log

Trace log object

pm4py.objects.log.importer.xes.importer.deserialize(log_string, parameters=None, variant='iterparse')

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

log

Trace log object