# Copyright (c) 2013, Combine Control Systems AB
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the Combine Control Systems AB nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.
# IN NO EVENT SHALL COMBINE CONTROL SYSTEMS AB BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from __future__ import (print_function, division, unicode_literals,
absolute_import)
import collections
import csv
import io
import six
from sympathy.api import qt as qt_compat
from sylib.export import table as exporttable
from sympathy.api import node as synode
QtGui = qt_compat.import_module('QtGui')
# We are currently unable to support UTF-16 encodings since this plugin uses
# pythons csv module and from python docs
# (https://docs.python.org/2/library/csv.html#examples):
#
# The csv module doesn't directly support reading and writing Unicode, but
# it is 8-bit-clean save for some problems with ASCII NUL characters. So
# you can write functions or classes that handle the encoding and decoding
# for you as long as you avoid encodings like UTF-16 that use NULs. UTF-8
# is recommended.
#
# So if we ever want to support UTF-16 we would have to use a different
# backend.
CODEC_LANGS = collections.OrderedDict((
('Western (ASCII)', 'ascii'),
('Western (ISO 8859-1)', 'iso8859_1'),
('Western (ISO 8859-15)', 'iso8859_15'),
('Western (Windows 1252)', 'windows-1252'),
('UTF-8', 'utf_8'),
('UTF-8 with signature byte', 'utf_8_sig')
))
def _encode_values(data_row, encoding):
"""
Return a list of encoded strings with the values of the sequence data_row.
The values in the sequences are converted to unicode first so if any values
are already encoded strings, they must be encoded with 'ascii' codec.
"""
return [value.decode(encoding) if isinstance(value, six.binary_type)
else six.text_type(value)
for value in data_row]
def _encode_values_py2(data_row, encoding):
return [value.encode(encoding) if isinstance(value, six.text_type)
else six.text_type(value).encode('ascii')
for value in data_row]
def _python_to_csv(tabledata, fq_outfilename, header, encoding,
delimiter, quotechar):
if six.PY2:
out_file = io.open(fq_outfilename, 'wb')
encode_values = _encode_values_py2
else:
out_file = io.open(fq_outfilename, 'w', encoding=encoding, newline='')
encode_values = _encode_values
csv_writer = csv.writer(out_file,
delimiter=delimiter,
quotechar=quotechar,
doublequote=True,
quoting=csv.QUOTE_MINIMAL)
with out_file:
if header:
csv_writer.writerow(
encode_values(tabledata.column_names(), encoding))
if tabledata is not None:
csv_writer.writerows(encode_values(row, encoding)
for row in tabledata.to_rows())
def _pandas_to_csv(tabledata, fq_outfilename, header, encoding, delimiter,
quotechar):
tabledata.to_dataframe().to_csv(fq_outfilename,
sep=delimiter,
index=False,
quotechar=quotechar,
doublequote=True,
quoting=csv.QUOTE_MINIMAL,
encoding=encoding)
def table2csv(tabledata, fq_outfilename, header, encoding, exporter):
"""Write table to CSV."""
delimiter = ';'
quotechar = '"'
if six.PY2:
delimiter = b';'
quotechar = b'"'
exporter(tabledata, fq_outfilename, header, encoding, delimiter,
quotechar)
class DataExportCSVWidget(QtGui.QWidget):
filename_changed = qt_compat.Signal()
def __init__(self, parameter_root, *args, **kwargs):
super(DataExportCSVWidget, self).__init__(*args, **kwargs)
self._parameter_root = parameter_root
self._init_gui()
def _init_gui(self):
table_names_gui = self._parameter_root['table_names'].gui()
table_names_gui.valueChanged.connect(self._filename_changed)
vlayout = QtGui.QVBoxLayout()
vlayout.addWidget(self._parameter_root['encoding'].gui())
vlayout.addWidget(table_names_gui)
vlayout.addWidget(self._parameter_root['header'].gui())
vlayout.addWidget(self._parameter_root['fast'].gui())
self.setLayout(vlayout)
def _filename_changed(self):
self.filename_changed.emit()
[docs]class DataExportCSV(exporttable.TableDataExporterBase):
"""Exporter for CSV files."""
EXPORTER_NAME = "CSV"
FILENAME_EXTENSION = "csv"
def __init__(self, parameters):
super(DataExportCSV, self).__init__(parameters)
if 'table_names' not in parameters:
parameters.set_boolean(
'table_names', label='Use table names as filenames',
description='Use table names as filenames')
if 'header' not in parameters:
parameters.set_boolean(
'header', value=True, label='Export header',
description='Export column names')
if 'encoding' not in parameters:
parameters.set_list(
'encoding', label='Character encoding',
list=CODEC_LANGS.keys(), value=[4],
description='Character encoding determines how different '
'characters are represented when written to disc, '
'sent over a network, etc.',
editor=synode.Util.combo_editor())
if 'fast' not in parameters:
parameters.set_boolean(
'fast', value=False, label='Use fast exporter',
description=('Fast exporter uses pandas and may produce '
'different results than the default one.'))
def parameter_view(self, node_context_input):
return DataExportCSVWidget(self._parameters)
def export_data(self, in_sytable, fq_outfilename, progress=None):
"""Export Table to CSV."""
header = self._parameters['header'].value
exporter = _python_to_csv
if self._parameters['fast'].value:
exporter = _pandas_to_csv
encoding = CODEC_LANGS[
self._parameters['encoding'].selected]
table2csv(in_sytable, fq_outfilename, header, encoding, exporter)
