hD d Z ddlZ ddlmZ ddlZddlZ G d dej Z
ddZ ddZ y# e$ r ddlmZ Y 3w xY w) 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 e Zd ZdZy)_ExportDialect
N)__name__
__module__ __qualname__lineterminator `/var/www/betterdocs.net/sherlock_api/venv/lib/python3.12/site-packages/stem/descriptor/export.pyr r s .r r c T 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_fieldsheader
output_buffers r
export_csvr # s+ $ *--oPVW !!r c
t |t j j r|f}|syt |d }|j
}t
| }t t |d j }|r.|D ]( }||vst |d|ddj | n!|D cg c] } | j d r| }} |D ] } |j | t j | |t! d }
|r.t j" j% s|
j' |D ] } t | t j j s!t d t | j
z |t | k7 rt d
|d t | d |
j) t | yc c} w # t $ r Y w xY w)
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 z does not have a 'z ' attribute, valid fields are: z, _ignore)dialect extrasactionz?Unable to export a descriptor CSV since %s is not a descriptor.zcTo export a descriptor CSV all of the descriptors must be of the same type. First descriptor was a z but we later got a .)
isinstancestem
descriptor
Descriptortyper listsortedvarskeys
ValueErrorjoin
startswithremovecsv
DictWriterr prereq
_is_python_26 writeheaderwriterow) output_filer r r r descriptor_typedescriptor_type_label desc_attrfieldattrwriterdescs r
r r : s " T__ 7 78 .K
Q (/)22 )/ T+a.)..01) K i Vkmrtxt}t} H uI J K KK )2N 9MtNON e U# >>+.BRai j& DKK--/
d dDOO 6 6 7 X[_`d[e[n[nn oo DJ & Zo qu vz q{ |
} }
OODJ
O
s )G G G GG)r r T)
__doc__r* cStringIOr ImportErroriostem.descriptorr stem.prereqexcelr r r r r r
r? sN SYY ".9 E s 4 AA