3
K^D @ s d Z ddlZyddlmZ W n ek
r< ddlmZ Y nX ddlZddlZG dd dej Z
f f dfddZ f f dfd d
Z dS ) ag
Toolkit for exporting descriptors to other formats.
**Module Overview:**
::
export_csv - Exports descriptors to a CSV
export_csv_file - Writes exported CSV output to a file
.. deprecated:: 1.7.0
This module will likely be removed in Stem 2.0 due to lack of usage. If you
use this modle please `let me know `_.
N)StringIOc @ s e Zd ZdZdS )_ExportDialect
N)__name__
__module__ __qualname__lineterminator r r :/tmp/pip-unpacked-wheel-1_ii6739/stem/descriptor/export.pyr s r Tc C s t }t|| ||| |j S )a\
Provides a newline separated CSV for one or more descriptors. If simply
provided with descriptors then the CSV contains all of its attributes,
labeled with a header row. Either 'included_fields' or 'excluded_fields' can
be used for more granular control over its attributes and the order.
:param Descriptor,list descriptors: either a
:class:`~stem.descriptor.Descriptor` or list of descriptors to be exported
:param list included_fields: attributes to include in the csv
:param list excluded_fields: attributes to exclude from the csv
:param bool header: if **True** then the first line will be a comma separated
list of the attribute names (**only supported in python 2.7 and higher**)
:returns: **str** of the CSV for the descriptors, one per line
:raises: **ValueError** if descriptors contain more than one descriptor type
)r export_csv_filegetvalue) descriptorsincluded_fieldsexcluded_fieldsheaderZ
output_bufferr r r
export_csv# s r c C sP t |tjjr|f}|s dS t|d }|j}t|}tt|d j }|r~x<|D ]$}||krTt
d||dj |f qTW ndd |D }x0|D ](}y|j | W q t
k
r Y qX qW t
j| |t dd} |rtjj r| j x`|D ]X}
t |
tjjst
d t|
j n"|t|
kr:t
d
|t|
f | jt|
qW dS ) a
Similar to :func:`stem.descriptor.export.export_csv`, except that the CSV is
written directly to a file.
:param file output_file: file to be written to
:param Descriptor,list descriptors: either a
:class:`~stem.descriptor.Descriptor` or list of descriptors to be exported
:param list included_fields: attributes to include in the csv
:param list excluded_fields: attributes to exclude from the csv
:param bool header: if **True** then the first line will be a comma separated
list of the attribute names (**only supported in python 2.7 and higher**)
:returns: **str** of the CSV for the descriptors, one per line
:raises: **ValueError** if descriptors contain more than one descriptor type
Nr z7%s does not have a '%s' attribute, valid fields are: %sz, c S s g | ]}|j d s|qS )_)
startswith).0attrr r r
` s z#export_csv_file..ignore)dialect extrasactionz?Unable to export a descriptor CSV since %s is not a descriptor.z|To export a descriptor CSV all of the descriptors must be of the same type. First descriptor was a %s but we later got a %s.)
isinstancestemZ
descriptorZ
Descriptortyper listsortedvarskeys
ValueErrorjoinremovecsv
DictWriterr ZprereqZ
_is_python_26 writeheaderwriterow) Z output_filer
r r r Zdescriptor_typeZdescriptor_type_labelZ desc_attrfieldwriterdescr r r
r : s6
r )
__doc__r$ cStringIOr ImportErrorioZstem.descriptorr Z stem.prereqexcelr r r r r r r
s