lR\@sTdZddlmZddlmZddlmZddlmZmZdZ dZ dZ d Z d Z d Zd ZGd ddeZGdddeZGdddeZddZdddZdddZGdddeZGdddeZGdddeZGd d!d!eZGd"d#d#eZdS)$z tablib.core ~~~~~~~~~~~ This module implements the central Tablib objects. :copyright: (c) 2016 by Kenneth Reitz. :license: MIT, see LICENSE for more details. )copy) itemgetter)formats) OrderedDictunicodetablibz0.12.1iz Kenneth ReitzMITzCopyright 2017 Kenneth ReitzZrestructuredtextc@seZdZdZddgZeeddZddZdd Zd d Z d d Z ddZ ddZ ddZ ddZddZddZddZddZddZd d!Zed"d#Zed$d%Zd&d'Zd(S))Rowz/Internal Row object. Mainly used for filtering._rowtagscCs"t||_t||_dS)N)listr r )selfrowr r@/var/www/dbchiro/venv/lib/python3.4/site-packages/tablib/core.py__init__"sz Row.__init__cCsdd|jDS)Ncss|] }|VqdS)Nr).0colrrr 'szRow.__iter__..)r )r rrr__iter__&sz Row.__iter__cCs t|jS)N)lenr )r rrr__len__)sz Row.__len__cCs t|jS)N)reprr )r rrr__repr__,sz Row.__repr__cCs|j||S)N)r )r ijrrr __getslice__/szRow.__getslice__cCs |j|S)N)r )r rrrr __getitem__2szRow.__getitem__cCs||j|Z%ed?d@Z&edAdBZ'e(dCdDZ)e(dEdFZ*e(dGdHZ+e(dIdJZ,e(dKdLZ-dMdNZ.dOdPZ/dQdRZ0dddSdTZ1ddUdVZ2ddWdXZ3dYdZd[Z4dYd\d]Z5dd^d_Z6d`daZ7dbdcZ8dddeZ9ddfdgZ:dhdiZ;djdkZ<dldmZ=dndoZ>dpdqZ?dddrdsZ@dS)tDatasetaThe :class:`Dataset` object is the heart of Tablib. It provides all core functionality. Usually you create a :class:`Dataset` instance in your main module, and append rows as you collect data. :: data = tablib.Dataset() data.headers = ('name', 'age') for (name, age) in some_collector(): data.append((name, age)) Setting columns is similar. The column data length must equal the current height of the data and headers must be set :: data = tablib.Dataset() data.headers = ('first_name', 'last_name') data.append(('John', 'Adams')) data.append(('George', 'Washington')) data.append_col((90, 67), header='age') You can also set rows and headers upon instantiation. This is useful if dealing with dozens or hundreds of :class:`Dataset` objects. :: headers = ('first_name', 'last_name') data = [('John', 'Adams'), ('George', 'Washington')] data = tablib.Dataset(*data, headers=headers) :param \*args: (optional) list of rows to populate Dataset :param headers: (optional) list strings for Dataset header row :param title: (optional) string to use as title of the Dataset .. admonition:: Format Attributes Definition If you look at the code, the various output/import formats are not defined within the :class:`Dataset` object. To add support for a new format, see :ref:`Adding New Formats `. cOsitdd|D|_d|_g|_g|_|jd|_|jd|_|jdS)Ncss|]}t|VqdS)N)r )rargrrrrsz#Dataset.__init__..headerstitle) r _data_Dataset__headers _separators _formattersgetrBrC_register_formats)r argskwargsrrrrs   zDataset.__init__cCs|jS)N)height)r rrrrszDataset.__len__cst|tst|trb||jkrY|jj|fdd|jDStn4|j|}t|tr|jSdd|DSdS)Ncsg|]}|qSrr)rr)posrr s z'Dataset.__getitem__..cSsg|]}|jqSr)r4)rresultrrrrNs ) r5r6rrBr1rDKeyErrorr r4)r keyZ_resultsr)rMrrs  zDataset.__getitem__cCs$|j|t||j|z)rClowerAttributeError)r rrrrs zDataset.__repr__csg}|jr/|jdd|jDn|jdd|jDdd|D}tttt|}|jr|jddd|Dndj d dt |Dd j fd d|DS) NcSsg|]}t|qSr)r)rhrrrrNs z'Dataset.__unicode__..css$|]}ttt|VqdS)N)r mapr)rrrrrrsz&Dataset.__unicode__..cSs%g|]}ttt|qSr)r rWr)rrrrrrNs cSsg|]}d|qS)-r)rlengthrrrrNs |css|]}d|VqdS)z{%s:%s}Nr)rr2rrrrs c3s|]}j|VqdS)N)format)rr) format_stringrrrs) rEr0extendrDr rWmaxzipr-joinrS)r rOZlensZ field_lensr)r^r __unicode__s    "zDataset.__unicode__cCs |jS)N)rc)r rrr__str__szDataset.__str__cCsxtjD] }yyvt||jt|j|jt|d|j|jt|d|j|j|j|jf|j|jAssures size of every row in dataset is of proper proportions.TrXc3s$|]}t|jkVqdS)N)rwidth)rx)r rrrsz$Dataset._validate..FN)rkrrLallrDInvalidDimensions)r rrZsafetyZis_validr)r rrRs' '" zDataset._validateTc sBtj}|rtntjrxt|D]\}}xjD]\}}y\|dkrxIt|D] \}} || |||tjgt|} ndd|D} | S)z=Packages Dataset into lists of dictionaries for transmission.Ncs.g|]$}ttj|qSr)r rarB)rdata_row) dict_packr rrrN=s z$Dataset._package..cSsg|]}t|qSr)r )rrrrrrNAs ) r rDrr!rGrS IndexErrorInvalidDatasetIndexrB) r ZdictsorderedrDZrow_irrcallbackrcdatar)rpr r_package"s(     zDataset._packagecCs|jS)zAn *optional* list of strings to be used for header rows and attribute names. This must be set manually. The given list length must equal :class:`Dataset.width`. )rE)r rrr _get_headersGszDataset._get_headersc CsQ|j||rDyt||_WqMtk r@tYqMXn d|_dS)zValidating headers setter.N)rRr rE TypeError)r Z collectionrrr _set_headersPs  zDataset._set_headerscCs |jS)aA native Python representation of the :class:`Dataset` object. If headers have been set, a list of Python dictionaries will be returned. If no headers have been set, a list of tuples (rows) will be returned instead. A dataset object can also be imported by setting the `Dataset.dict` attribute: :: data = tablib.Dataset() data.dict = [{'age': 90, 'first_name': 'Kenneth', 'last_name': 'Reitz'}] )rw)r rrr _get_dict^s zDataset._get_dictcCst|sdSt|dtrT|jx|D]}|jt|q4Wnot|dtr|jt|dj|_x6|D]%}|jtt|j qWnt dS)aA native Python representation of the Dataset object. If headers have been set, a list of Python dictionaries will be returned. If no headers have been set, a list of tuples (rows) will be returned instead. A dataset object can also be imported by setting the :class:`Dataset.dict` attribute. :: data = tablib.Dataset() data.dict = [{'age': 90, 'first_name': 'Kenneth', 'last_name': 'Reitz'}] Nr) rr5r wiper0r r!keysrBvaluesUnsupportedFormat)r picklerrrr _set_dictls     &zDataset._set_dictcCst|}|jr*|jdg}ng}t|dkrtt|ddrttt|d|j}nt||}|S)z,Prepares the given column for insert/append.rrX__call__)r rBpoprhasattrrWrDr4)r rheaderrrr _clean_cols  %zDataset._clean_colcCs t|jS)zfThe number of rows currently in the :class:`Dataset`. Cannot be directly modified. )rrD)r rrrrLszDataset.heightcCsXyt|jdSWn<tk rSyt|jSWntk rNdSYnXYnXdS)ziThe number of columns currently in the :class:`Dataset`. Cannot be directly modified. rN)rrDrqrBry)r rrrrks  z Dataset.widthcKsb|st|}n|jj|d\}}|sNtdj|n|||||S)z Import `in_stream` to the :class:`Dataset` object using the `format`. :param \*\*kwargs: (optional) custom configuration to the format `import_set`. NzFormat {0} cannot be imported.)NN) detect_formatrhrHrr])r in_streamr]rKrfrgrrrloadsz Dataset.loadcKsF|jj|d\}}|s9tdj|n|||S)z Export :class:`Dataset` object to `format`. :param \*\*kwargs: (optional) custom configuration to the format `export_set`. NzFormat {0} cannot be exported.)NN)rhrHrr])r r]rKrfrgrrrexportszDataset.exportcCsdS)aA Legacy Excel Spreadsheet representation of the :class:`Dataset` object, with :ref:`separators`. Cannot be set. .. note:: XLS files are limited to a maximum of 65,000 rows. Use :class:`Dataset.xlsx` to avoid this limitation. .. admonition:: Binary Warning :class:`Dataset.xls` contains binary data, so make sure to write in binary mode:: with open('output.xls', 'wb') as f: f.write(data.xls) Nrrrrrxlssz Dataset.xlscCsdS)a_An Excel '07+ Spreadsheet representation of the :class:`Dataset` object, with :ref:`separators`. Cannot be set. .. admonition:: Binary Warning :class:`Dataset.xlsx` contains binary data, so make sure to write in binary mode:: with open('output.xlsx', 'wb') as f: f.write(data.xlsx) Nrrrrrxlsxs z Dataset.xlsxcCsdS)a^An OpenDocument Spreadsheet representation of the :class:`Dataset` object, with :ref:`separators`. Cannot be set. .. admonition:: Binary Warning :class:`Dataset.ods` contains binary data, so make sure to write in binary mode:: with open('output.ods', 'wb') as f: f.write(data.ods) Nrrrrrodss z Dataset.odscCsdS)acA CSV representation of the :class:`Dataset` object. The top row will contain headers, if they have been set. Otherwise, the top row will contain the first row of the dataset. A dataset object can also be imported by setting the :class:`Dataset.csv` attribute. :: data = tablib.Dataset() data.csv = 'age, first_name, last_name\n90, John, Adams' Import assumes (for now) that headers exist. .. admonition:: Binary Warning :class:`Dataset.csv` uses \r\n line endings by default, so make sure to write in binary mode:: with open('output.csv', 'wb') as f: f.write(data.csv) If you do not do this, and you export the file on Windows, your CSV file will open in Excel with a blank line between each row. Nrrrrrcsvsz Dataset.csvcCsdS)aA TSV representation of the :class:`Dataset` object. The top row will contain headers, if they have been set. Otherwise, the top row will contain the first row of the dataset. A dataset object can also be imported by setting the :class:`Dataset.tsv` attribute. :: data = tablib.Dataset() data.tsv = 'age first_name last_name\n90 John Adams' Import assumes (for now) that headers exist. Nrrrrrtsvs z Dataset.tsvcCsdS)aA YAML representation of the :class:`Dataset` object. If headers have been set, a YAML list of objects will be returned. If no headers have been set, a YAML list of lists (rows) will be returned instead. A dataset object can also be imported by setting the :class:`Dataset.yaml` attribute: :: data = tablib.Dataset() data.yaml = '- {age: 90, first_name: John, last_name: Adams}' Import assumes (for now) that headers exist. Nrrrrryaml.s z Dataset.yamlcCsdS)a4A DataFrame representation of the :class:`Dataset` object. A dataset object can also be imported by setting the :class:`Dataset.df` attribute: :: data = tablib.Dataset() data.df = DataFrame(np.random.randn(6,4)) Import assumes (for now) that headers exist. Nrrrrrdf=s z Dataset.dfcCsdS)aA JSON representation of the :class:`Dataset` object. If headers have been set, a JSON list of objects will be returned. If no headers have been set, a JSON list of lists (rows) will be returned instead. A dataset object can also be imported by setting the :class:`Dataset.json` attribute: :: data = tablib.Dataset() data.json = '[{"age": 90, "first_name": "John", "last_name": "Adams"}]' Import assumes (for now) that headers exist. NrrrrrjsonJs z Dataset.jsoncCsdS)zA HTML table representation of the :class:`Dataset` object. If headers have been set, they will be used as table headers. ..notice:: This method can be used for export only. NrrrrrhtmlYsz Dataset.htmlcCsdS)aA dBASE representation of the :class:`Dataset` object. A dataset object can also be imported by setting the :class:`Dataset.dbf` attribute. :: # To import data from an existing DBF file: data = tablib.Dataset() data.dbf = open('existing_table.dbf').read() # to import data from an ASCII-encoded bytestring: data = tablib.Dataset() data.dbf = '' .. admonition:: Binary Warning :class:`Dataset.dbf` contains binary data, so make sure to write in binary mode:: with open('output.dbf', 'wb') as f: f.write(data.dbf) Nrrrrrdbfbsz Dataset.dbfcCsdS)zA LaTeX booktabs representation of the :class:`Dataset` object. If a title has been set, it will be exported as the table caption. .. note:: This method can be used for export only. Nrrrrrlatex{sz Dataset.latexcCs0|j||jj|t|d|dS)zInserts a row to the :class:`Dataset` at the given index. Rows inserted must be the correct size (height or width). The default behaviour is to insert the given row to the :class:`Dataset` object at the given index. r N)rRrDr-r )r r1rr rrrr-s zDataset.insertcCs |j|jd|d|dS)zyAdds a row to the end of the :class:`Dataset`. See :class:`Dataset.insert` for additional documentation. rr N)r-rL)r rr rrrr.sz Dataset.rpushcCs|jdd|d|dS)zyAdds a row to the top of the :class:`Dataset`. See :class:`Dataset.insert` for additional documentation. rrr N)r-)r rr rrrr/sz Dataset.lpushcCs|j||dS)znAdds a row to the :class:`Dataset`. See :class:`Dataset.insert` for additional documentation. N)r.)r rr rrrr0szDataset.appendcCs%x|D]}|j||qWdS)zZAdds a list of rows to the :class:`Dataset` using :class:`Dataset.append` N)r0)r rowsr rrrrr_s zDataset.extendcCs|d}|d=|S)z:Removes and returns the first row of the :class:`Dataset`.rr)r cacherrrlpops z Dataset.lpopcCs|d}|d=|S)z9Removes and returns the last row of the :class:`Dataset`.rXrr)r rrrrrpops z Dataset.rpopcCs |jS)z9Removes and returns the last row of the :class:`Dataset`.)r)r rrrrsz Dataset.popcCs)|dkrg}nt|dr?tt||j}n|j|}|jd||jr|sytn*|r|jdkrt |rt n|jj ||n|jr|j rxWt |jD]-\}}|j |||||j|` to the row you are inserting. This gives you the ability to :class:`filter ` your :class:`Dataset` later. NrrrcSsg|]}t|gqSr)r )rrrrrrN s z&Dataset.insert_col..)rr rWrDrrRrB HeadersNeededrLrrnr-rkrS)r r1rrrrrrr insert_cols"    ! zDataset.insert_colcCs|j|j|d|dS)z|Adds a column to the end of the :class:`Dataset`. See :class:`Dataset.insert` for additional documentation. rN)rrk)r rrrrr rpush_colszDataset.rpush_colcCs|jd|d|dS)z|Adds a column to the top of the :class:`Dataset`. See :class:`Dataset.insert` for additional documentation. rrN)r)r rrrrr lpush_colszDataset.lpush_colrYcCs ||f}|jj|dS)z4Adds a separator to :class:`Dataset` at given index.N)rFr0)r r1textseprrrinsert_separator s zDataset.insert_separatorcCsT|js$|jr|jnd}n|jr:|jdnd}|j||dS)z=Adds a :ref:`separator ` to the :class:`Dataset`.rrXN)rBrLr)r rr1rrrappend_separator's zDataset.append_separatorcCs|j||dS)zuAdds a column to the :class:`Dataset`. See :class:`Dataset.insert_col` for additional documentation. N)r)r rrrrr append_col3szDataset.append_colcsfdd|jDS)z@Returns the column from the :class:`Dataset` at the given index.csg|]}|qSrr)rr)r1rrrN>s z#Dataset.get_col..)rD)r r1r)r1rget_col;szDataset.get_colcCsnt|tr<||jkr3|jj|}q<tn||jksd|jj||fntdS)aAdds a :ref:`formatter` to the :class:`Dataset`. .. versionadded:: 0.9.5 :param col: column to. Accepts index int or header str. :param handler: reference to callback function to execute against each cell value. T) r5r6rBr1rPrkrGr0rr)r rhandlerrrr add_formatterEs  zDataset.add_formattercs/t|}fdd|jD|_|S)zReturns a new instance of the :class:`Dataset`, excluding any rows that do not contain the given :ref:`tags `. cs%g|]}|jr|qSr)r:)rr)r9rrrNas z"Dataset.filter..)rrD)r r9_dsetr)r9rfilter\s zDataset.filtercsTt|tst|tr|js0tnt|jdt|d|}td|jd|j }x|D]2fdd|jD}|j d|qsWn|jr|j|}nt|jdt|d|}td|jd|j }xL|D]D|jr6fdd|jD}n}|j d|qW|S) aSort a :class:`Dataset` by a specific column, given string (for header) or integer (for column index). The order can be reversed by setting ``reverse`` to ``True``. Returns a new :class:`Dataset` instance where columns have been sorted. rQreverserBrCcsg|]}|qSrr)rrQ)r2rrrNxs z Dataset.sort..rcsg|]}|qSrr)rrQ)r2rrrNs ) r5r6rrBrsortedr!rr@rCr0)r rrZ_sortedrrr)r2rsortfs$   !  !  z Dataset.sortcCs|s dSt}|jdg||jd}||_xht|jD]W\}}||jdkrpqKn|g|j|}t|}|jd|qKW|S)zTranspose a :class:`Dataset`, turning rows into columns and vice versa, returning a new ``Dataset`` instance. The first row of the original instance becomes the new header row.Nrr)r@rBrSrr r0)r r new_headersr1columnZrow_datarrr transposes   zDataset.transposecCst|tsdS|j|jkr.tnt|}dd|jD}dd|jD}|j|||_|S)zStack two :class:`Dataset` instances together by joining at the row level, and return new combined ``Dataset`` instance.NcSsg|] }|qSrr)rrrrrrNs z!Dataset.stack..cSsg|] }|qSrr)rrrrrrNs )r5r@rkrnrrDr_)r otherrZ rows_to_stackZ other_rowsrrrstacks    z Dataset.stackc Cst|tsdS|js%|jrE|j s9|j rEtqEn|j|jkr`tny|j|j}Wntk rd}YnXt}x%|jD]}|jd||qWx%|jD]}|jd||qW||_|S)zStack two :class:`Dataset` instances together by joining at the column level, and return a new combined ``Dataset`` instance. If either ``Dataset`` has headers set, than the other must as well.Nr)r5r@rBrrLrnryr)r rrrrrrr stack_colss$      zDataset.stack_colscs6tfdd|jD|jdd.N)r8rD)r r)rrremove_duplicatess zDataset.remove_duplicatescCst|_d|_dS)zARemoves all content and headers from the :class:`Dataset` object.N)r rDrE)r rrrr|s z Dataset.wipec s=s dS|dkr.ttj}n|dkrLtj}nfdd|D}fdd|D}t}t||_g|_xtjD]\}}g}xL|jD]A}|jkrjj|}|j||qt qW||kr|jdt |qqW|S)zkReturns a new instance of the :class:`Dataset`, including only specified rows and columns. Ncs+g|]!}|tjkr|qSr)rangerL)rr)r rrrNs z"Dataset.subset..cs%g|]}|jkr|qSr)rB)rr)r rrrNs r) r rrLrBr@rDrSr1r0rPr ) r rcolsrZrow_norrorQrMr)r rsubsets*      zDataset.subset)Ar;r<r=r>rhrrrrr rrcrd classmethodrIrRrwrxrzr?rBr{rr!rrLrkrrrrrrrrrrrrrr r-r.r/r0r_rrrrrrrrrrrrrrrrrr|rrrrrr@nsv -        %           >   '   "  r@c@seZdZdZiZdddZddZddZed d Z d d Z d dZ dddZ e ddZddZddZdS)Databookz(A book of :class:`Dataset` objects. NcCs2|dkrt|_n ||_|jdS)N)r _datasetsrI)r Zsetsrrrrs  zDatabook.__init__c Cs2yd|jjSWntk r-dSYnXdS)Nz <%s databook>z)rCrTrU)r rrrr(s zDatabook.__repr__cCs g|_dS)z@Removes all :class:`Dataset` objects from the :class:`Databook`.N)r)r rrrr|.sz Databook.wipecCsxtjD]}yyBt||jt|j|j|j|jf|j|jrhrrr|rrIrrrwr?rrrrrrrrs      rc CsGx@tjD]5}y|j|r)|jSWq tk r>Yq Xq WdS)z#Return format name of given stream.N)rreZdetectrCrU)streamrjrrrrs   rNcKstj|||S)zReturn dataset of given stream.)r@r)rr]rKrrrrgsrgcKstj|||S)zReturn dataset of given stream.)rr)rr]rKrrrrsrc@seZdZdZdS)rz(Only Datasets can be added to a DataBookN)r;r<r=r>rrrrrs rc@seZdZdZdS)rnz Invalid sizeN)r;r<r=r>rrrrrns rnc@seZdZdZdS)rrzOutside of Dataset sizeN)r;r<r=r>rrrrrrs rrc@seZdZdZdS)rzGHeader parameter must be given when appending a column in this Dataset.N)r;r<r=r>rrrrrs rc@seZdZdZdS)rzFormat is not supportedN)r;r<r=r>rrrrrs r)r>roperatorrrrZ tablib.compatrrZ __title__ __version__Z __build__ __author__Z __license__ __copyright__Z __docformat__objectr r@rrrgr ExceptionrrnrrrNotImplementedErrorrrrrr s2Qh