a ߙfb5 @sdZddlZddlZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl mZgd Zgd Zed d d ddddejddddddf ddZddZdddZejddfddZd ddZddZddZdS)!zP This file contains a contains the high-level functions to read a VOTable file. N) exceptions)tree) iterparser)data)deprecated_renamed_argument)parseparse_single_table from_tablewritetovalidatereset_vo_warnings)ignorewarn exceptionZpedanticverifyz5.0)ZsincerFc  Csddlm} |}|dvr$td|durL| j} | dvrH| dk}n| }t|trd|r^dnd }n|tvrtd d t| duri} |||||||| d } |durt|t r|| d <t j || d&}t j | dd|| WdS1s0YdS)af Parses a VOTABLE_ xml file (or file-like object), and returns a `~astropy.io.votable.tree.VOTableFile` object. Parameters ---------- source : path-like or file-like Path or file-like object containing a VOTABLE_ xml file. If file, must be readable. columns : sequence of str, optional List of field names to include in the output. The default is to include all fields. invalid : str, optional One of the following values: - 'exception': throw an exception when an invalid value is encountered (default) - 'mask': mask out invalid values verify : {'ignore', 'warn', 'exception'}, optional When ``'exception'``, raise an error when the file violates the spec, otherwise either issue a warning (``'warn'``) or silently continue (``'ignore'``). Warnings may be controlled using the standard Python mechanisms. See the `warnings` module in the Python standard library for more information. When not provided, uses the configuration setting ``astropy.io.votable.verify``, which defaults to 'ignore'. .. versionchanged:: 4.0 ``verify`` replaces the ``pedantic`` argument, which will be deprecated in future. .. versionchanged:: 5.0 The ``pedantic`` argument is deprecated. chunk_size : int, optional The number of rows to read before converting to an array. Higher numbers are likely to be faster, but will consume more memory. table_number : int, optional The number of table in the file to read in. If `None`, all tables will be read. If a number, 0 refers to the first table in the file, and only that numbered table will be parsed and read in. Should not be used with ``table_id``. table_id : str, optional The ID of the table in the file to read in. Should not be used with ``table_number``. filename : str, optional A filename, URL or other identifier to use in error messages. If *filename* is None and *source* is a string (i.e. a path), then *source* will be used as a filename for error messages. Therefore, *filename* is only required when source is a file-like object. unit_format : str, astropy.units.format.Base instance or None, optional The unit format to use when parsing unit attributes. If a string, must be the name of a unit formatter. The built-in formats include ``generic``, ``fits``, ``cds``, and ``vounit``. A custom formatter may be provided by passing a `~astropy.units.UnitBase` instance. If `None` (default), the unit format to use will be the one specified by the VOTable specification (which is ``cds`` up to version 1.3 of VOTable, and ``vounit`` in more recent versions of the spec). datatype_mapping : dict, optional A mapping of datatype names (`str`) to valid VOTable datatype names (str). For example, if the file being read contains the datatype "unsignedInt" (an invalid datatype in VOTable), include the mapping ``{"unsignedInt": "long"}``. Returns ------- votable : `~astropy.io.votable.tree.VOTableFile` object See also -------- astropy.io.votable.exceptions : The exceptions this function may raise. r)conf)rmaskzBaccepted values of ``invalid`` are: ``'exception'`` or ``'mask'``.N)Zfalsetruerrrzverify should be one of /)columnsinvalidr chunk_size table_numberfilename unit_formatdatatype_mappingr)_debug_python_based_parser)rr)configpos)rlower ValueErrorr isinstanceboolVERIFY_OPTIONSjoinstrrget_xml_iteratorr VOTableFiler)sourcerrrrrtable_idrrrrrZconf_verify_lowercaseriteratorr-7lib/python3.9/site-packages/astropy/io/votable/table.pyrsHW     rcKs.|ddurd|d<t|fi|}|S)a Parses a VOTABLE_ xml file (or file-like object), reading and returning only the first `~astropy.io.votable.tree.Table` instance. See `parse` for a description of the keyword arguments. Returns ------- votable : `~astropy.io.votable.tree.Table` object rNr)getrZget_first_table)r*kwargsvotabler-r-r.r s r cCsLddlm}t||r$tj|}nt|tjs8td|j||dddS)a Writes a `~astropy.io.votable.tree.VOTableFile` to a VOTABLE_ xml file. Parameters ---------- table : `~astropy.io.votable.tree.VOTableFile` or `~astropy.table.Table` instance. file : str or writable file-like Path or file object to write to tabledata_format : str, optional Override the format of the table(s) data to write. Must be one of ``tabledata`` (text representation), ``binary`` or ``binary2``. By default, use the format that was specified in each ``table`` object as it was created or read in. See :ref:`astropy:astropy:votable-serialization`. r)TablezPfirst argument must be astropy.io.vo.VOTableFile or astropy.table.Table instanceT)tabledata_formatrN)Z astropy.tabler2r#rr)r TypeErrorZto_xml)tablefiler3r2r-r-r.r s   r c Csddlm}m}d}|dur(t}d}g}d}ttj|dd} | } Wdn1sb0Yt | } | d|durt |t r|}n(t |dr|j}nt |d r|j}nd }tjdd r} ttjd tjdd zt| d|d}Wn4ty.} z|t | WYd} ~ n d} ~ 00Wdn1sF0Ydd| D|}| d|d|dt|rTt| }|D]}t|}|ds||d|dn|||dd}|d}|drd}nd}||dddd|pd|ddtj|dd d!d" |d#|||d$|d#|d%qn |d&d}|rt!j"#|rdd'l$m%}|durd(}n|j&}|'||\}}}|dkr|d)||(d*n |d+|r|)St|dko|dkS),a: Prints a validation report for the given file. Parameters ---------- source : path-like or file-like Path to a VOTABLE_ xml file or `~pathlib.Path` object having Path to a VOTABLE_ xml file. If file-like object, must be readable. output : file-like, optional Where to output the report. Defaults to ``sys.stdout``. If `None`, the output will be returned as a string. Must be writable. xmllint : bool, optional When `True`, also send the file to ``xmllint`` for schema and DTD validation. Requires that ``xmllint`` is installed. The default is `False`. ``source`` must be a file on the local filesystem in order for ``xmllint`` to work. filename : str, optional A filename to use in the error messages. If not provided, one will be automatically determined from ``source``. Returns ------- is_valid : bool or str Returns `True` if no warnings were found. If ``output`` is `None`, the return value will be a string. r)print_code_line color_printFNTZbinary)encodingnameurlz )recordalways)appendr)rrcSs$g|]}t|jtjrt|jqSr-) issubclasscategoryr VOWarningr'message).0xr-r-r. szvalidate..zValidation report for z Z is_somethingrBZnlinerwarningZ is_warningZyellowZreddz: r ZEXCz z )Zinitial_indentZsubsequent_indent)r6Znchar z)astropy.io.votable found no violations. )xmlutilz1.1zxmllint schema violations: zutf-8zxmllint passed )*Zastropy.utils.consoler7r8ioStringIOr rZget_readable_fileobjreadBytesIOseekr#r'hasattrr:r;warningscatch_warnings resetwarnings simplefilterrrArr"r>writelenrZ xml_readlinesZparse_vowarningtextwrapZfilllstripospathexistsr rIversionZvalidate_schemadecodegetvalue)r*outputZxmllintrr7r8Z return_as_strlinesr1fdZcontentZcontent_bufferZ warning_lineseZ xml_linesrFwlineZcolorZsuccessrIr[stdoutstderrr-r-r.r s!&     D                r cCstjj||dS)a Given an `~astropy.table.Table` object, return a `~astropy.io.votable.tree.VOTableFile` file structure containing just that single table. Parameters ---------- table : `~astropy.table.Table` instance table_id : str, optional If not `None`, set the given id on the returned `~astropy.io.votable.tree.Table` instance. Returns ------- votable : `~astropy.io.votable.tree.VOTableFile` instance )r+)rr)r )r5r+r-r-r.r Ssr cCszt|x}|D],\}}}}|dkr:WdWdSq@q|D],\}}}}|dkrlWdWdSqrqDWdWdS1s0YWntyYdS0dS)aW Reads the header of a file to determine if it is a VOTable file. Parameters ---------- source : path-like or file-like Path or file object containing a VOTABLE_ xml file. If file, must be readable. Returns ------- is_votable : bool Returns `True` if the given file is a VOTable file. ZxmlNFZVOTABLET)rr(r")r*r,starttagrGrr-r-r. is_votablehs & rhc CsBddlm}m}|tt|fD] }z|`Wqty:Yq0qdS)z Resets all of the vo warning state so that warnings that have already been emitted will be emitted again. This is used, for example, by `validate` which must emit all warnings each time it is called. r) convertersrIN)r rirIrrZ__warningregistry__AttributeError)rirImoduler-r-r.r s  r )N)N)__doc__rJrXsysrVrPr rrZastropy.utils.xmlrZ astropy.utilsrZastropy.utils.decoratorsr__all__r%ZDEFAULT_CHUNK_SIZErr r rdr r rhr r-r-r-r.s2