U e{jA@sdZddlZddlmZdddddddd d dd d d d dddddddddd dZedZddZddZGdddej Z Gd d!d!ej Z Gd"d#d#ej ZGd$d%d%ejZGd&d'd'ejZGd(d)d)e ZGd*d+d+eZGd,d-d-eZGd.d/d/eZdS)0zAn extensible ASCII table reader and writer. latex.py: Classes to read and write LaTeX tables :Copyright: Smithsonian Astrophysical Observatory (2011) :Author: Tom Aldcroft (aldcroft@head.cfa.harvard.edu) N)coretablez \hline \hlinez\hline) tabletype header_start header_enddata_endz \hline\hlinercaption tablealign col_alignpreamblerr data_startr tablefootz unit of col1z unit of col2)Zcol1Zcol2) rr r r r rrr rrunits)ZAAZ doublelinestemplatez(?]sz/LatexInputter.process_lines..rselfr"rrr process_lines\szLatexInputter.process_linesN)__name__ __module__ __qualname__r.rrrrr'[sr'cs<eZdZdZdZfddZddZddZd d ZZ S) LatexSplitterz1Split LaTeX table data. Default delimiter is `&`.&cs8t|dd}|ds,|d|d<t|S)Nrr) RE_COMMENTsplitr)endswithsuper__call__)r-r" last_line __class__rrr9es  zLatexSplitter.__call__cCs:t|d}|}|dr,|d}n td|S)zWRemove whitespace at the beginning or end of line. Also remove \ at end of linerrz(Lines in LaTeX table have to end with \\)r5r6r)r7rstriprInconsistentTableErrorr-r%rrr process_linels  zLatexSplitter.process_linecCs4|}|r0|ddkr0|ddkr0|dd}|S)z:Remove whitespace and {} at the beginning or end of value.r{r4}rr()r-valrrr process_valys zLatexSplitter.process_valcCs&d|jd}|dd|DdS)z?Join values together and add a few extra spaces for readability css|]}|VqdSNr(r*xrrr sz%LatexSplitter.join..z \\) delimiterjoin)r-valsrJrrrrKszLatexSplitter.join) r/r0r1__doc__rJr9r@rDrK __classcell__rrr;rr2`s   r2c@s0eZdZdZdZeZddZddZddZ d S) LatexHeaderz(Class to read the header of Latex Tablesz\begin{tabular}cCs$t||j}|dk r|dSdSdSNr)r&r)r-r"r%rrr start_lines zLatexHeader.start_linec Csdi}dd|jD}t|j|D]>\}}|r z|jdd||<Wq tk r\|||<Yq Xq |S)NcSsg|] }|jjqSr)infounit)r*colrrrr+sz*LatexHeader._get_units..Z latex_inline)format)colszipcolnamesZ to_stringAttributeError)r-rZ col_unitsnamerSrrr _get_unitsszLatexHeader._get_unitscs6d|jkrt|jd|jd<d|jkr.r) r#lenrVrrrsplitterrKrXr[update)r-r"alignrrerwrites*    zLatexHeader.writeN) r/r0r1rMrr2splitter_classrQr[rjrrrrrOs  rOc@s4eZdZdZdZdZeZddZddZ dd Z dS) LatexDataz&Class to read the data in LaTeX tablesNz \end{tabular}cCs<|jrt||jS|j|}|dkr0td|dSdS)NzCould not find table startr)r r&headerrQrr>)r-r"startrrrrQs    zLatexData.start_linecCs|jrt||jSdSdSrF)rr&r,rrrend_lines zLatexData.end_linecCsnt|jd|tj||t|jd|||jt|jd||jddk rj|d|jdddS)Nr rrr\end{rB)rr#rBaseDatarjrrr,rrrrjs zLatexData.write) r/r0r1rMr rr2rkrQrorjrrrrrls rlcsbeZdZdZdZdgZdZdZeZ e Z e Z dZdddd d d gid dffd d ZdddZZS)LatexaLaTeX format table. This class implements some LaTeX specific commands. Its main purpose is to write out a table in a form that LaTeX can compile. It is beyond the scope of this class to implement every possible LaTeX command, instead the focus is to generate a syntactically valid LaTeX tables. This class can also read simple LaTeX tables (one line per table row, no ``\multicolumn`` or similar constructs), specifically, it can read the tables that it writes. Reading a LaTeX table, the following keywords are accepted: **ignore_latex_commands** : Lines starting with these LaTeX commands will be treated as comments (i.e. ignored). When writing a LaTeX table, the some keywords can customize the format. Care has to be taken here, because python interprets ``\\`` in a string as an escape character. In order to pass this to the output either format your strings as raw strings with the ``r`` specifier or use a double ``\\\\``. Examples:: caption = r'My table \label{mytable}' caption = 'My table \\\\label{mytable}' **latexdict** : Dictionary of extra parameters for the LaTeX output * tabletype : used for first and last line of table. The default is ``\\begin{table}``. The following would generate a table, which spans the whole page in a two-column document:: ascii.write(data, sys.stdout, Writer = ascii.Latex, latexdict = {'tabletype': 'table*'}) If ``None``, the table environment will be dropped, keeping only the ``tabular`` environment. * tablealign : positioning of table in text. The default is not to specify a position preference in the text. If, e.g. the alignment is ``ht``, then the LaTeX will be ``\\begin{table}[ht]``. * col_align : Alignment of columns If not present all columns will be centered. * caption : Table caption (string or list of strings) This will appear above the table as it is the standard in many scientific publications. If you prefer a caption below the table, just write the full LaTeX command as ``latexdict['tablefoot'] = r'\caption{My table}'`` * preamble, header_start, header_end, data_start, data_end, tablefoot: Pure LaTeX Each one can be a string or a list of strings. These strings will be inserted into the table without any further processing. See the examples below. * units : dictionary of strings Keys in this dictionary should be names of columns. If present, a line in the LaTeX table directly below the column names is added, which contains the values of the dictionary. Example:: from astropy.io import ascii data = {'name': ['bike', 'car'], 'mass': [75,1200], 'speed': [10, 130]} ascii.write(data, Writer=ascii.Latex, latexdict = {'units': {'mass': 'kg', 'speed': 'km/h'}}) If the column has no entry in the ``units`` dictionary, it defaults to the **unit** attribute of the column. If this attribute is not specified (i.e. it is None), the unit will be written as ``' '``. Run the following code to see where each element of the dictionary is inserted in the LaTeX table:: from astropy.io import ascii data = {'cola': [1,2], 'colb': [3,4]} ascii.write(data, Writer=ascii.Latex, latexdict=ascii.latex.latexdicts['template']) Some table styles are predefined in the dictionary ``ascii.latex.latexdicts``. The following generates in table in style preferred by A&A and some other journals:: ascii.write(data, Writer=ascii.Latex, latexdict=ascii.latex.latexdicts['AA']) As an example, this generates a table, which spans all columns and is centered on the page:: ascii.write(data, Writer=ascii.Latex, col_align='|lr|', latexdict={'preamble': r'\begin{center}', 'tablefoot': r'\end{center}', 'tabletype': 'table*'}) **caption** : Set table caption Shorthand for:: latexdict['caption'] = caption **col_align** : Set the column alignment. If not present this will be auto-generated for centered columns. Shorthand for:: latexdict['col_align'] = col_align r#z.texz LaTeX tableNZhlineZvspaceZ tablelineZtopruleZmidruleZ bottomruler_csti|_|j|j_|j|j_d|jd<|j||rH||jd<|rV||jd<||_dddd|jD|j_|jj|j_dS) Nrrr r z%||cSsg|] }d|qS)rr)r*commandrrrr+qsz"Latex.__init__..) r8__init__r#rmdatarhignore_latex_commandsrKcomment)r-rw latexdictr r r;rrruSs        zLatex.__init__cCs d|j_d|j_tjj||dS)N)r)rmrQrvr BaseReaderrj)r-rrrrrjusz Latex.write)N)r/r0r1rM _format_name_io_registry_format_aliases_io_registry_suffix _descriptionrO header_classrl data_classr'Zinputter_classZmax_ndimrurjrNrrr;rrrs*j"rrcs0eZdZdZfddZddZddZZS)AASTexHeaderSplitterzExtract column names from a `deluxetable`_. This splitter expects the following LaTeX code **in a single line**: \tablehead{\colhead{col1} & ... & \colhead{coln}} cstt||SrF)r8r2r9r,r;rrr9szAASTexHeaderSplitter.__call__cCs^|dd}|dd}|}|ddkrH|ddkrH|dd}n td |d dS) z#extract column names from tablehead%r \tableheadr_rAr4rBrz\tablehead is missing {}z\colhead)r6rr)rr>r?rrrr@s  z!AASTexHeaderSplitter.process_linecCsddd|DS)N & cSsg|]}dt|dqSz \colhead{rB)rrGrrrr+sz-AASTexHeaderSplitter.join..)rK)r-rLrrrrKszAASTexHeaderSplitter.join)r/r0r1rMr9r@rKrNrrr;rr{s  rc@s(eZdZdZdZeZddZddZdS) AASTexHeaderzIn a `deluxetable `_ some header keywords differ from standard LaTeX. This header is modified to take that into account. rcCs t|dS)Nr)r&r,rrrrQszAASTexHeader.start_linecsd|jkrt|jd|jd<d|jkr.rz\\ csg|]}|dqSrarbrdrerrr+sz \tablehead{) r#rfrVrrrKrXr[rhrg)r-r"riZ tableheadrrerrjs<     zAASTexHeader.writeN) r/r0r1rMrrrkrQrjrrrrrs rc@s(eZdZdZdZdZddZddZdS) AASTexDatazGIn a `deluxetable`_ the data is enclosed in `\startdata` and `\enddata`z \startdataz\enddatacCst||jdSrP)r&r r,rrrrQszAASTexData.start_linecCs||jt|}tj||t||krJtjdd|dtjd|d<||j t |j d||d|j dddS) Nz\s* \\ \\ \s* $r_r4)flagsrrprrB) rr rfrrqrjrsubVERBOSErrr#)r-r"Zlines_length_initialrrrrjs   zAASTexData.writeN)r/r0r1rMr rrQrjrrrrrs rcs:eZdZdZdZdgZdZdZeZ e Z fddZ Z S)AASTexaAASTeX format table. This class implements some AASTeX specific commands. AASTeX is used for the AAS (American Astronomical Society) publications like ApJ, ApJL and AJ. It derives from the ``Latex`` reader and accepts the same keywords. However, the keywords ``header_start``, ``header_end``, ``data_start`` and ``data_end`` in ``latexdict`` have no effect. Zaastexr_z(AASTeX deluxetable used for AAS journalsc s0tjf|d|kr"d|dks,d|jd<dS)NryrZ deluxetable)r8rur#)r-kwargsr;rrruszAASTex.__init__)r/r0r1rMr{r|r}r~rrrrrurNrrr;rrs r)rMrr_rZ latexdictsrr5rr&Z BaseInputterr'Z BaseSplitterr2Z BaseHeaderrOrqrlrzrrrrrrrrrrsL   &1 %*