HR-eHS\dZddlZddlmZmZddlmZddlmZddl m Z ddl m Z dd l mZmZmZGd d eZGd d eZGddejZGddejZGddejZGddejZGddejZdS)zAn extensible ASCII table reader and writer. ipac.py: Classes to read IPAC table format :Copyright: Smithsonian Astrophysical Observatory (2011) :Author: Tom Aldcroft (aldcroft@head.cfa.harvard.edu) N) OrderedDict defaultdict)wrap)warn)get_auto_format_func)AstropyUserWarning)basiccore fixedwidthceZdZfdZxZS)IpacFormatErrorDBMScldtdS)N {} See {}zIhttps://irsa.ipac.caltech.edu/applications/DDGEN/Doc/DBMSrestriction.htmlformatsuper__str__self __class__s 5lib/python3.11/site-packages/astropy/io/ascii/ipac.pyrzIpacFormatErrorDBMS.__str__s/"" GGOO   W   __name__ __module__ __qualname__r __classcell__rs@rrr8         rrceZdZfdZxZS)IpacFormatErrorcldtdS)NrzBhttps://irsa.ipac.caltech.edu/applications/DDGEN/Doc/ipac_tbl.htmlrrs rrzIpacFormatError.__str__ s/"" GGOO   P   rrrs@rr"r"r rr"c<eZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dS) IpacHeaderSplitterzSplitter for Ipac Headers. This splitter is similar its parent when reading, but supports a fixed width format (as required for Ipac table headers) for writing. N|Fz\s*\\z\\c|jpd}|jpd}||z|z}||z}||z}dt||D}|||z|zS)Nr'cDg|]\}}d|t|z z|zS) len).0valwidths r z+IpacHeaderSplitter.join..?s1SSS:3us3xx'(3.SSSr) delimiter_pad delimiterzipjoin)rvalswidthspadr2 padded_delim bookend_left bookend_rights rr4zIpacHeaderSplitter.join8sv &BN(b Y,  3 i SST6ARARSSSl//555 EEr)rrr__doc__ process_line process_valr2r1skipinitialspacecomment write_comment col_startscol_endsr4rrr%r%'sb LKIMGMJHFFFFFrr%ceZdZdZeZdejfdejfdejfdejfdejfdej fdej ffZ d Z d Z d Z d Zd ZdZdZdZd S) IpacHeaderzIPAC table header.integerlongdoublefloatrealchardateignoreNc#K|jj}|D]W}|}||r,||r||VXdS)zGenerator to yield IPAC header lines, i.e. those starting and ending with delimiter character (with trailing whitespace stripped). N)splitterr2rstrip startswithendswithstrip)rlinesdelimlines r process_lineszIpacHeader.process_linesWsx ' ( (D;;==Du%% ($--*>*> (jj''''' ( (rcd}|d}g|d<t|d<|d}tjdtj}|D]}|dsd S||}|r||d} ||d} | |vr=t| tr(|| d} t| tr| | z} d| i|| <|d r9|d d  } | r|d | d S) z Extract table-level comments and keywords for IPAC table. See: https://irsa.ipac.caltech.edu/applications/DDGEN/Doc/ipac_tbl.html#kw. c(|} t|}nl#t$r_ t|}nK#t$r>dD]8}||r!||r |dd}n9YnwxYwYnwxYw|S)zw Take a string value and convert to float, int or str, and strip quotes as needed. )"'r )rSint ExceptionrIrQrR)r.quotes rprocess_keyword_valuez5IpacHeader.update_meta..process_keyword_valuegs ))++C "#hh " " ""**CC """","">>%00"S\\%5H5H""%ad)C!E " "Js3& BABAB BB  BBtablecommentskeywordsz&\\(?P \w+)\s* = (?P .+) $\namevalue\ N) rrecompileVERBOSErQmatchgroup isinstancestrrSappend) rrTmetar` table_metarc re_keywordrVmrer.prev_vals r update_metazIpacHeader.update_metaas~    ('] !# :!, :j)Z & J    ; ;D??4((   &&A ;wwv++AGGG,<,<== 8## 3(<(<#'~g6H!(C00-&n")3??5));qrr(..**C;":.55c:::3 ; ;rc|jD]5\}}||jr|cS6t d|jd|jd)NzUnknown data type ""z"" for column "rZ) col_type_listrQraw_typelower ValueErrorre)rcol col_type_keycol_types r get_col_typezIpacHeader.get_col_typesy&*&8   "L(&&s|'9'9';';<<  Os|OOCHOOO rc||}d||D}t|dkrtdt|dkrtdg}d}t |dD]\}}t j|d}||_|t|z|_ t|dkr@|d|d|_ | ||_ t|d kr'|d |pd |_ t|d krj|d |} t|j t jrd nd } |jj| | |jf|j dz}|||jdkr|xjdzc_|jdkr|xj dz c_ d|D|_||_d S)a: Initialize the header Column objects from the table ``lines``. Based on the previously set Header attributes find or create the column names. Sets ``self.cols`` with the list of Columns. Parameters ---------- lines : list List of table lines cg|]}|SrCrC)r-r5s rr0z'IpacHeader.get_cols..sDDDtDDDrrzEAt least one header line beginning and ending with delimiter requiredz&More than four header lines were foundr z -rerhNr'0rightleftcg|] }|j SrCr)r-xs rr0z'IpacHeader.get_cols..s+++af+++r)rWrOr,r{ enumerater ColumnrSstartendryrtypeunit issubclassStrTypedata fill_valuesrpreipac_definitionnamescols) rrT header_lines header_valsrrirer|nullfillvals rget_colszIpacHeader.get_colssG))%00 DD l(C(CDDD {  q W    ! !EFF F Q00  GAt+4::d#3#3444CCIc$ii'CG;!##*1~a066t<< ,,S11;!##&q>!,2244<;!###1~a(..00 *38T\ B BK"" %,,dGSX-FGGGGaKE KK   #w.. Q %//1 ++d+++  rc|jrt}nt}|j}|jrbt t |jD]$}|xxdz cc<%fdD}|gkr|d||D]}tjd|}| t|kr||d|jr4|d s|ddks|d||jr4|d vr||d t|d kr||d t|d kr||dg}g}g}|j D]} | j j} | j j} | j j} | jdvr7| jdkr|dnm|dnW| jdkr7| jdkr|dn+|dn|d| |dn,|t)| j j| jt,j} t1| }| j j| |}||| | |#t8$r8|t)| YwxYw||||gS)Nr c,g|]}|dk|S)r rC)r-r countnamelists rr0z'IpacHeader.str_vals..s(LLL}Q7G!7K7K17K7K7KrzMIPAC DBMS tables are not case sensitive. This causes duplicate column names: z\w+zB - Only alphanumeric characters and _ are allowed in column names.r_z'Column name cannot start with numbers: )ryzXYZzJ - x, y, z, X, Y, Z are reserved names and cannot be used as column names.z2 - Maximum length for column name is 16 characters(z3 - Maximum length for column name is 40 characters.)rurhr]rGfrrIrHrKr')DBMSrr"colnamesrr]rzrirlrr,isalpharinfodtyperrkinditemsizerprorr maskedr _format_funcsgetrSr^)r IpacFormatEnamelistre doublenamesrt dtypelistunitlistnullistr| col_dtypecol_unit col_formatrauto_format_func format_funcrs @rstr_valszIpacHeader.str_valss 9 *-KK)K= 9 ',,M  1 1djjll+++q0++++LLLLmLLLKb  !kI;FII   D&&Auuww#d))##!k333y T$q'//"3"3 TQ3!k"RD"R"RSSSy 999%+:::t99r>>%+SSS" t99r>>%+TTT"  9! 2! 2CIx}HJ~++%**$$U++++$$V,,,,3&&%**$$W----$$X....  (((####CHM 2 2333?4;/D 2#7#<#< !h488EUVV  J = =DDFFGGGG 2 2 2 s4yy0011111  2)Xw77sA K55>L76L7c|D]0}||j||1|S)zWrite header. The width of each column is determined in Ipac.write. Writing the header must be delayed until that time. This function is called from there, once the width information is available. )rrprOr4)rrTr6r5s rwritezIpacHeader.write9sGMMOO ; ;D LL++D&99 : : : : r)rrrr;r%splitter_classr IntType FloatTyperrx definition start_linerWrvrrrrrCrrrErECs'N DL!  4>" $.!   MJJ(((@;@;@;D888tQ8Q8Q8f     rrEceZdZdZdZdZdS)IpacDataSplitterr*r'TN)rrrr2r1bookendrCrrrrFsIMGGGrrc8eZdZdZdZdZeZej dfgZ dZ dS)IpacDatazIPAC table data reader.z[|\\]rrcl|D]0}||j||1|S)z-IPAC writer, modified from FixedWidth writer.)rprOr4)rrTr6 vals_listr5s rrzIpacData.writeTs= ; ;D LL++D&99 : : : : rN) rrrr;r?rrrr rrrrCrrrrLsG!!GJ%NK()KrrcDeZdZdZdZdgZdZdZeZ e Z d fd Z dZ xZS) IpacaEIPAC format table. See: https://irsa.ipac.caltech.edu/applications/DDGEN/Doc/ipac_tbl.html Example:: \\name=value \\ Comment | column1 | column2 | column3 | column4 | column5 | | double | double | int | double | char | | unit | unit | unit | unit | unit | | null | null | null | null | null | 2.0978 29.09056 73765 2.06000 B8IVpMnHg Or:: |-----ra---|----dec---|---sao---|------v---|----sptype--------| 2.09708 29.09056 73765 2.06000 B8IVpMnHg The comments and keywords defined in the header are available via the output table ``meta`` attribute:: >>> import os >>> from astropy.io import ascii >>> filename = os.path.join(ascii.__path__[0], 'tests/data/ipac.dat') >>> data = ascii.read(filename) >>> print(data.meta['comments']) ['This is an example of a valid comment'] >>> for name, keyword in data.meta['keywords'].items(): ... print(name, keyword['value']) ... intval 1 floatval 2300.0 date Wed Sp 20 09:48:36 1995 key_continue IPAC keywords can continue across lines Note that there are different conventions for characters occurring below the position of the ``|`` symbol in IPAC tables. By default, any character below a ``|`` will be ignored (since this is the current standard), but if you need to read files that assume characters below the ``|`` symbols belong to the column before or after the ``|``, you can specify ``definition='left'`` or ``definition='right'`` respectively when reading the table (the default is ``definition='ignore'``). The following examples demonstrate the different conventions: * ``definition='ignore'``:: | ra | dec | | float | float | 1.2345 6.7890 * ``definition='left'``:: | ra | dec | | float | float | 1.2345 6.7890 * ``definition='right'``:: | ra | dec | | float | float | 1.2345 6.7890 IPAC tables can specify a null value in the header that is shown in place of missing or bad data. On writing, this value defaults to ``null``. To specify a different null value, use the ``fill_values`` option to replace masked values with a string or number of your choice as described in :ref:`astropy:io_ascii_write_parameters`:: >>> from astropy.io.ascii import masked >>> fill = [(masked, 'N/A', 'ra'), (masked, -999, 'sptype')] >>> ascii.write(data, format='ipac', fill_values=fill) \ This is an example of a valid comment ... | ra| dec| sai| v2| sptype| | double| double| long| double| char| | unit| unit| unit| unit| ergs| | N/A| null| null| null| -999| N/A 29.09056 null 2.06 -999 2345678901.0 3456789012.0 456789012 4567890123.0 567890123456789012 When writing a table with a column of integers, the data type is output as ``int`` when the column ``dtype.itemsize`` is less than or equal to 2; otherwise the data type is ``long``. For a column of floating-point values, the data type is ``float`` when ``dtype.itemsize`` is less than or equal to 4; otherwise the data type is ``double``. Parameters ---------- definition : str, optional Specify the convention for characters in the data table that occur directly below the pipe (``|``) symbol in the header column definition: * 'ignore' - Any character beneath a pipe symbol is ignored (default) * 'right' - Character is associated with the column to the right * 'left' - Character is associated with the column to the left DBMS : bool, optional If true, this verifies that written tables adhere (semantically) to the `IPAC/DBMS `_ definition of IPAC tables. If 'False' it only checks for the (less strict) `IPAC `_ definition. ipacTzIPAC format tablerMFct|dvr ||j_nt d||j_dS)N)rMrrz-definition should be one of ignore/left/right)r__init__headerrr{r)rrrrs rrz Ipac.__init__sQ  4 4 4*4DK ' 'LMM M rcn|jjtjdft |j|j_ |j |j |j |j tj||j |j|j||t |j}||j_ ||j_ g}d|jvr}|jdD]o}t't)|dkrt+dt,t/t)|dddD]}||pd|jvrw|jd}|D]g} ||d }|d |d |?#t2$rt+d |d t,YdwxYwd|jD} t5| rt+d| dt,|j|jj t9|jD]<\} t;fd|jD| _=g} |j} tA| D]} | | t9|jD]/\} | r!t;fd| D| _!(d| _!0d|jD}|j"|||j"||| |S)a Write ``table`` as list of strings. Parameters ---------- table : `~astropy.table.Table` Input table data Returns ------- lines : list List of strings corresponding to ASCII table rrbNz9Comment string > 78 characters was automatically wrapped.Prg)initial_indentsubsequent_indentrcrfrd=zTable metadata keyword ze has been skipped. IPAC metadata must be in the form {{'keywords':{{'keyword': {{'value': value}} }}cg|]}|dv| S))rcrbrC)r-keys rr0zIpac.write..s*   4L)L)LC)L)L)LrzTable metadata keyword(s) ze were not written. IPAC metadata must be in the form {{'keywords':{{'keyword': {{'value': value}} }}c3BK|]}t|VdSNr+r-r5rs r zIpac.write..*s-PPDG PPPPPPrc3BK|]}t|VdSrr+rs rrzIpac.write..5s-GGDG GGGGGGrrcBg|]}t|j|jSrC)maxr/ headwidth)r-r|s rr0zIpac.write..9s&RRRC#ci//RRRr)#rrrpr rlistcolumnsvaluesrrcheck_column_namesr strict_namesguessing_apply_include_exclude_names include_names exclude_names_check_multidim_tablerqr,rorrrrS TypeErrorany_set_fill_valuesrrrrr3r/r)rranew_colsrTr?rVkeydictkeywordr. ignored_keysr| data_str_vals col_str_itersr5r6rs @rrz Ipac.writes& $$dk6%:;;;  4 4 6 677  &&tz43DdmTTT ) 4:t143E   ""5))) ,,..//# !   # # :j1 ' 's7||$$r))S*!LL"Ue''DLL&&&&'  # #j,G"   !'*73CLL!?gmmoo!?!?!?!?@@@@ ='===+    :    |    5\555#     ""49>222  4 4 6 677 Q QFAsPPPP9M9M9O9OPPPPPCMM  **,, ' ' 'D   & & & & 4 4 6 677  FAs GGGGGGGGG  RR5=;O;O;Q;QRRR %((( v}555 s$;G  #HH)rMF)rrrr; _format_name_io_registry_format_aliases_io_registry_can_write _descriptionr data_classrE header_classrrrrs@rrr[shhTL#)(!&LJL      gggggggrr)r;ri collectionsrrtextwraprwarningsrastropy.table.pprintrastropy.utils.exceptionsrr'r r r r^rr" BaseSplitterr%FixedWidthHeaderrEFixedWidthSplitterrFixedWidthDatarBasicrrCrrrs 00000000555555777777%%%%%%%%%%     )        i   FFFFF*FFF8@@@@@,@@@Fz4     z(   ccccc5;cccccr