pm4py.objects.log.exporter.xes.variants package¶

Submodules¶

pm4py.objects.log.exporter.xes.variants.etree_xes_exp 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.exporter.xes.variants.etree_xes_exp.Parameters[source]¶

Bases: enum.Enum

An enumeration.

COMPRESS = 'compress'¶

ENCODING = 'encoding'¶

SHOW_PROGRESS_BAR = 'show_progress_bar'¶

pm4py.objects.log.exporter.xes.variants.etree_xes_exp.apply(log, output_file_path, parameters=None)[source]¶

pm4py.objects.log.exporter.xes.variants.etree_xes_exp.export_log_as_string(log, parameters=None)[source]¶

Export a log into a string

Parameters:	log (`pm4py.log.log.EventLog`) – PM4PY log parameters – Parameters of the algorithm
Returns:	Log as a string
Return type:	logString

pm4py.objects.log.exporter.xes.variants.etree_xes_exp.export_log_tree(log, parameters=None)[source]¶

Get XES log XML tree from a PM4Py log

Parameters:	log – PM4Py log
Returns:	XML tree
Return type:	tree

pm4py.objects.log.exporter.xes.variants.line_by_line 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.exporter.xes.variants.line_by_line.Parameters[source]¶

Bases: enum.Enum

An enumeration.

COMPRESS = 'compress'¶

ENCODING = 'encoding'¶

SHOW_PROGRESS_BAR = 'show_progress_bar'¶

pm4py.objects.log.exporter.xes.variants.line_by_line.apply(log, output_file_path, parameters=None)[source]¶

Exports a XES log using a non-standard exporter (classifiers, lists, nested attributes, globals, extensions are not supported)

Parameters:	log – Event log output_file_path – Path to the XES file parameters – Parameters

pm4py.objects.log.exporter.xes.variants.line_by_line.escape(stru)[source]¶

XML-escape a string

Parameters:	stru – String to be escaped
Returns:	Escaped string
Return type:	escaped_stru

pm4py.objects.log.exporter.xes.variants.line_by_line.export_attribute(attr_name, attr_value, indent_level)[source]¶

Exports an attribute

Parameters:	attr_name – Name of the attribute attr_value – Value of the attribute indent_level – Level of indentation
Returns:	String representing the content of the attribute
Return type:	stru

pm4py.objects.log.exporter.xes.variants.line_by_line.export_log_as_string(log, parameters=None)[source]¶

Export a log into a string

Parameters:	log (`pm4py.log.log.EventLog`) – PM4PY log parameters – Parameters of the algorithm
Returns:	Log as a string
Return type:	logString

pm4py.objects.log.exporter.xes.variants.line_by_line.export_log_line_by_line(log, fp_obj, encoding, parameters=None)[source]¶

Exports the contents of the log line-by-line to a file object

Parameters:	log – Event log fp_obj – File object encoding – Encoding parameters – Parameters of the algorithm

pm4py.objects.log.exporter.xes.variants.line_by_line.export_trace_line_by_line(trace, fp_obj, encoding)[source]¶

Exports the content of a trace line-by-line to a file object

Parameters:	trace – Trace fp_obj – File object encoding – Encoding

pm4py.objects.log.exporter.xes.variants.line_by_line.get_tab_indent(n)[source]¶

Get the desidered number of indentations as string

Parameters:	n – Number of indentations
Returns:	Desidered number of indentations as string
Return type:	str_tab_indent

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/>.