HR-eAdZddlZddlmZdddddddd d dd d d d dddddddddd dZejdZdZdZGddej Z Gddej Z Gd d!ej ZGd"d#ejZGd$d%ejZGd&d'e ZGd(d)eZGd*d+eZGd,d-eZdS).zAn 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)col1col2) rr r r r rrrr runits)AA doublelinestemplatez(?z/LatexInputter.process_lines..]s --- ---r r3selfr)s r process_lineszLatexInputter.process_lines\s--u----r N)__name__ __module__ __qualname__r;r3r rr0r0[s#.....r r0c8eZdZdZdZfdZdZdZdZxZ S) LatexSplitterz1Split LaTeX table data. Default delimiter is `&`.&ct|dd}|ds|dz|d<t |S)Nrr#) RE_COMMENTsplitr5endswithsuper__call__)r:r) last_line __class__s rrHzLatexSplitter.__call__esg$$U2Y//288:: !!%(( *!E)E"Iww&&&r ct|d}|}|dr|d}nt jd|S)zaRemove whitespace at the beginning or end of line. Also remove \ at end of line. rr#z(Lines in LaTeX table have to end with \\)rDrEr5rFrstriprInconsistentTableErrorr:r-s r process_linezLatexSplitter.process_linelso%%a(zz|| ==   ;;u%%DD-;  r cv|}|r"|ddkr|ddkr |dd}|S)z:Remove whitespace and {} at the beginning or end of value.r{rC}rr4)r:vals r process_valzLatexSplitter.process_valzsAiikk  CFcMMB3ad)C r c`d|jzdz}|d|DdzS)z@Join values together and add a few extra spaces for readability. c3>K|]}|VdSNr4r6xs r z%LatexSplitter.join..s*66Aaggii666666r z \\) delimiterjoin)r:valsr\s rr]zLatexSplitter.joins9$.(3. ~~6666666??r ) r<r=r>__doc__r\rHrOrTr] __classcell__rJs@rr@r@`sw;;I'''''   @@@@@@@r r@c,eZdZdZdZeZdZdZdZ dS) LatexHeaderz)Class to read the header of Latex Tables.z\begin{tabular}c>t||j}||dzSdSNr)r.r)r:r)r-s r start_linezLatexHeader.start_lines(ud&788  !8O4r ci}d|jD}t|j|D]7\}}|r0 |d||<"#t$r|||<Y3wxYw8|S)Nc&g|]}|jjSr3)infounit)r6cols rr8z*LatexHeader._get_units..s888sSX]888r latex_inline)format)colszipcolnames to_stringAttributeError)r:r col_unitsnamerjs r _get_unitszLatexHeader._get_unitss88di888 dmY77 ' 'JD$ ''"&..."G"GE$KK%'''"&E$KKK' '  sA  AAcd|jvrt|jdz|jd<d|jvrd|jdzdz}nd}|jd)|d|jdzd z|zt |jd |d |jvr&|d |jd zd z||jd z|jdzd zt |jd|||j|j| d|jvr  |jdr>||jfd|jDt |jd|dS)Nr cr []r\begin{rRr r z \caption{rQrrc<g|]}|dSrVgetr6rtrs rr8z%LatexHeader.write..s'#S#S#STEIIdC$8$8#S#S#Sr r) r*lenrnrrrsplitterr]rpruupdate)r:r)alignrs @rwritezLatexHeader.writes dj ( (&)$)nns&:DJ{ # 4: % %$*\22S8EEE :k " . LLdj&==DuL M M MDJ E:::  " " LL 9(==C D D D T&- ;0GG$NOOODJ>>> T]'' 66777!! dj LLG, - - -   LL ""#S#S#S#ST]#S#S#STT    DJ e<<<<r_rr@splitter_classrfrurr3r rrcrcsQ33%L"N   =====r rcc0eZdZdZdZdZeZdZdZ dZ dS) LatexDataz'Class to read the data in LaTeX tables.Nz \end{tabular}c|jrt||jS|j|}|t jd|dzS)NzCould not find table startr)rr.headerrfrrM)r:r)starts rrfzLatexData.start_linesT ? "5$/:: :K**511E}12OPPP19 r c>|jrt||jSdSrX)r r.r9s rend_linezLatexData.end_lines# = "5$-88 84r cht|jd|tj||t|jd|||jt|jd||jd(|d|jdzdzdSdS)Nrr rr\end{rR)rr*rBaseDatarrr r9s rrzLatexData.writesDJ e<<< D%(((DJ E::: T]###DJ U;;; :k " . LLDJ{$;;cA B B B B B / .r ) r<r=r>r_rr r@rrfrrr3r rrrs[11JH"N CCCCCr rcZeZdZdZdZdgZdZdZeZ e Z e Z dZgdiddffd Zd d ZxZS) 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 tableN)hlinevspace tablelinetoprulemidrule bottomrulerzcti|_|j|j_|j|j_d|jd<|j||r ||jd<|r ||jd<||_ddd|jDz|j_|jj|j_dS)Nrrr r z%||cg|]}d|zS)r#r3)r6commands rr8z"Latex.__init__..ss G G GUW_ G G Gr ) rG__init__r*rdatarignore_latex_commandsr]comment)r:r latexdictr r rJs rrzLatex.__init__Us  !J * ") ; )$$$  ,$+DJy !  0&/DJ{ #%:""SXX G GD,F G G G& &   !K/ r ctd|j_d|j_tj||S)N)r)rrfrr BaseReaderr)r:rs rrz Latex.writews1!% # $$T$777r rX)r<r=r>r_ _format_name_io_registry_format_aliases_io_registry_suffix _descriptionrc header_classr data_classr0inputter_classmax_ndimrrr`ras@rrrsiiVL#*)  LLJ"NH    0 0 0 0 0 0D88888888r rc.eZdZdZfdZdZdZxZS)AASTexHeaderSplitterzExtract column names from a `deluxetable`_. This splitter expects the following LaTeX code **in a single line**: \tablehead{\colhead{col1} & ... & \colhead{coln}} cTtt||SrX)rGr@rH)r:r)rJs rrHzAASTexHeaderSplitter.__call__s!]D))225999r c&|dd}|dd}|}|ddkr|ddkr |dd}ntjd |d dS) z$extract column names from tablehead.%r \tableheadrzrQrCrRrz\tablehead is missing {}z\colhead)rEr&r5rrMrNs rrOz!AASTexHeaderSplitter.process_lineszz#q!||M2..zz|| GsNNbS":DD-.IJJ J||K,,,r c@dd|DS)N & c8g|]}dt|zdzSz \colhead{rR)rrYs rr8z-AASTexHeaderSplitter.join..s(EEE1<#a&&036EEEr )r])r:r^s rr]zAASTexHeaderSplitter.joins#zzEEEEEFFFr )r<r=r>r_rHrOr]r`ras@rrr}sg::::: - - -GGGGGGGr rc&eZdZdZdZeZdZdZdS) AASTexHeaderzIn a `deluxetable `_ some header keywords differ from standard LaTeX. This header is modified to take that into account. rc"t|dS)Nr)r.r9s rrfzAASTexHeader.start_linesum444r cd|jvrt|jdz|jd<d|jvrd|jdzdz}nd}|d|jdzd z|jdzd z|zt |jd |d |jvr&|d |jd zd zdd|jD}|d|jvr |jdr1|d|j fd|jDzz }|d|zd zdS)Nr rwr rxryrzr{rz}{rRr r z\tablecaption{rcg|] }d|zdz Srr3)r6rts rr8z&AASTexHeader.write..s"TTTd t 3c 9TTTr rz\\ c<g|]}|dSr}r~rs rr8z&AASTexHeader.write..s'@@@$4%%@@@r z \tablehead{) r*rrnrrr]rprurr)r:r)r tableheadrs @rrzAASTexHeader.writes dj ( (&)$)nns&:DJ{ # 4: % %$*\22S8EEE j% & j% &         DJ E:::  " " LL*TZ -BBSH I I IJJTTdmTTTUU !! dj LLG, - - -   $-"4"4@@@@$-@@@## I  ^i/#566666r N) r<r=r>r_rrrrfrr3r rrrsH!L)N55577777r rc&eZdZdZdZdZdZdZdS) AASTexDatazHIn a `deluxetable`_ the data is enclosed in `\startdata` and `\enddata`.z \startdataz\enddatac2t||jdzSre)r.rr9s rrfzAASTexData.start_linesudo66::r c||jt|}tj||t||kr+t jdd|dt j|d<||j t|j d||d|j dzdzdS) Nz\s* \\ \\ \s* $rzrC)flagsrrrrR) rrrrrrr$subVERBOSEr rr*)r:r)lines_length_initials rrzAASTexData.writes T_%%%"5zz D%((( u::, , ,12uRy SSSE"I T]###DJ U;;; X ; 77$>?????r N)r<r=r>r_rr rfrr3r rrrsGSSJH;;; @ @ @ @ @r rc<eZdZdZdZdgZdZdZeZ e Z fdZ xZ 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. aastexrzz(AASTeX deluxetable used for AAS journalsc ntjdi|d|vr d|dvs d|jd<dSdS)Nrr deluxetabler3)rGrr*)r:kwargsrJs rrzAASTex.__init__sU""6"""&&[F;r_rrrrrrrrrr`ras@rrrsf  L#+*=LLJ444444444r r)r_r$rzr latexdictsr%rDrr. BaseInputterr0 BaseSplitterr@ BaseHeaderrcrrrrrrrrr3r rrs (   (%# !" &"" (.AA   :RZ $ $ %%%$2.....D%... $@$@$@$@$@D%$@$@$@N.=.=.=.=.=$/.=.=.=bCCCCC CCC@b8b8b8b8b8DOb8b8b8JGGGGG=GGG4(7(7(7(7(7;(7(7(7V@@@@@@@@,44444U44444r