pm4py.objects.log.exporter.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.exporter.xes.util package
  • Submodules
  • pm4py.objects.log.exporter.xes.util.compression module
    • compress()
• pm4py.objects.log.exporter.xes.variants package
  • Submodules
  • pm4py.objects.log.exporter.xes.variants.etree_xes_exp module
    • Parameters
      • Parameters.COMPRESS
      • Parameters.SHOW_PROGRESS_BAR
      • Parameters.ENCODING
    • export_log_tree()
    • export_log_as_string()
    • apply()
  • pm4py.objects.log.exporter.xes.variants.line_by_line module
    • Parameters
      • Parameters.COMPRESS
      • Parameters.SHOW_PROGRESS_BAR
      • Parameters.ENCODING
    • get_tab_indent()
    • escape()
    • export_attribute()
    • export_trace_line_by_line()
    • export_log_line_by_line()
    • apply()
    • export_log_as_string()

Submodules

pm4py.objects.log.exporter.xes.exporter 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.exporter.xes.exporter.Variants(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ETREE = <module 'pm4py.objects.log.exporter.xes.variants.etree_xes_exp' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\objects\\log\\exporter\\xes\\variants\\etree_xes_exp.py'>

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

pm4py.objects.log.exporter.xes.exporter.apply(log, output_file_path, variant=Variants.LINE_BY_LINE, parameters=None)

Method to export a XES from a log

Parameters

log

Trace log

output_file_path

Output file path

variant

Selected variant of the algorithm

parameters

Parameters of the algorithm:

Parameters.COMPRESS -> Indicates that the XES file must be compressed

pm4py.objects.log.exporter.xes.exporter.serialize(log, variant=Variants.LINE_BY_LINE, parameters=None)

Serialize a log into a binary string containing the XES of the log

Parameters

log

Trace log

variant

Selected variant of the algorithm

parameters

Parameters of the algorithm

Returns

string

String describing the XES