B q\P @s8ddlZddlZddlZddlZddlmZddlmZddlZ dddddd d d d d dg Z dgZ eZ eZ eZeejfZGdd d eZeZejddZd*dd ZddZd+ddZddZd,ddZddZd-ddZddZddZ dd Z!d!dZ"d"d Z#dd#d$d Z$dd#d%d Z%d&d'Z&d(d)Z'dS).N) OrderedDict) itemgetterregister_readerregister_writerregister_identifieridentify_format get_reader get_writerreadwrite get_formatsIORegistryErrordelay_doc_updatesc@seZdZdZdS)r z'Custom error for registry clashes. N)__name__ __module__ __qualname____doc__rr2lib/python3.7/site-packages/astropy/io/registry.pyr sccs2t|dVt|t|dt|ddS)aContextmanager to disable documentation updates when registering reader and writer. The documentation is only built once when the contextmanager exits. .. versionadded:: 1.3 Parameters ---------- cls : class Class for which the documentation updates should be delayed. Notes ----- Registering multiple readers and writers can cause significant overhead because the documentation of the corresponding ``read`` and ``write`` methods are build every time. .. warning:: This contextmanager is experimental and may be replaced by a more general approach. Examples -------- see for example the source code of ``astropy.table.__init__``. Nr r )_delayed_docs_classesadddiscard_update__doc__)clsrrrr*s    c Csbddlm}tttttBtdd}g}x|D]}|dk rPt||d|sPq2|tkr\dnd}|tkrldnd}|tkr|dnd}d|d|df} | |krdnd } | |dj |d|||| fq2W|dk r |d krd d |D}n"|d krdd |D}nt d|r0t t t|tdddd} nd} || dd} t| ddks^| d| S)a Get the list of registered I/O formats as a Table. Parameters ---------- data_class : classobj, optional Filter readers/writer to match data class (default = all classes). readwrite : str or None, optional Search only for readers (``"Read"``) or writers (``"Write"``). If None search for both. Default is None. .. versionadded:: 1.3 Returns ------- format_table : Table Table of available I/O formats. r)Table)keyNYesZNozascii.ReadcSsg|]}|ddkr|qS)rr).0rowrrr {szget_formats..WritecSsg|]}|ddkr|qS)rr)r!r"rrrr#}szQunrecognized value for "readwrite": {0}. Allowed are "Read" and "Write" and None.)z Data classZFormatrr$z Auto-identify Deprecated)namesr')Z astropy.tablersortedset_readers_writersr_is_best_match _identifiersappendr ValueErrorlistzipnpany remove_column) data_class readwriterformat_classesZrowsZ format_classZhas_readZ has_writeZ has_identifyZascii_format_classZ deprecateddata format_tablerrrr Ns6       c sPdt||}t|jtsdS|j}fddt|D}|rV|d}|d|}dd|ddD}dtd d |Dt||}| d |j d d d}t dd|d} | |d<| d| || d|jkr|dddgdg|}|fdd|Dyd||_Wn$tk rJd||j_YnXdS)z Update the docstring to include all the available readers / writers for the ``data_class.read`` or ``data_class.write`` functions (respectively). z#The available built-in formats are:Ncsg|]\}}|kr|qSrr)r!Ziiline) FORMATS_TEXTrrr#sz"_update__doc__..rcSsg|]}td|qS)z(\S))research)r!r;rrrr#sr css|]}|r|VqdS)N)start)r!matchrrr sz!_update__doc__..z Data classP) max_linesZ max_width-=r'rzZDeprecated format names like ``aastex`` will be removed in a future version. Use the full z%name (e.g. ``ascii.aastex``) instead.csg|] }|qSrr)r!r;) left_indentrrr#s )getattr isinstancerstr splitlines enumerateminr capitalizer5pformatr=subinsertr/ZcolnamesextendjoinAttributeError__func__) r6r7Zclass_readwrite_funclinesZ sep_indicesZ chop_indexZmatchesr:Z new_linesZ table_rst_sepr)r<rHrrs8         rFcCsF||ftks|r|t||f<ntd||j|tkrBt|ddS)a Register a reader function. Parameters ---------- data_format : str The data format identifier. This is the string that will be used to specify the data type when reading. data_class : classobj The class of the object that the reader produces. function : function The function to read in a data object. force : bool, optional Whether to override any existing function if already present. Default is ``False``. z:Reader for format '{0}' and class '{1}' is already definedr N)r+r formatrrr) data_formatr6functionforcerrrrs  cCsD||ftkrt||fntd||j|tkr@t|ddS)z Unregister a reader function Parameters ---------- data_format : str The data format identifier. data_class : classobj The class of the object that the reader produces. z2No reader defined for format '{0}' and class '{1}'r N)r+popr rYrrr)rZr6rrrunregister_readers  r^cCsF||ftks|r|t||f<ntd||j|tkrBt|ddS)a Register a table writer function. Parameters ---------- data_format : str The data format identifier. This is the string that will be used to specify the data type when writing. data_class : classobj The class of the object that can be written. function : function The function to write out a data object. force : bool, optional Whether to override any existing function if already present. Default is ``False``. z:Writer for format '{0}' and class '{1}' is already definedr N)r,r rYrrr)rZr6r[r\rrrrs  cCsD||ftkrt||fntd||j|tkr@t|ddS)z Unregister a writer function Parameters ---------- data_format : str The data format identifier. data_class : classobj The class of the object that can be written. z2No writer defined for format '{0}' and class '{1}'r N)r,r]r rYrrr)rZr6rrrunregister_writers  r_cCs4||ftks|r|t||f<ntd||jdS)a2 Associate an identifier function with a specific data type. Parameters ---------- data_format : str The data format identifier. This is the string that is used to specify the data type when reading/writing. data_class : classobj The class of the object that can be written. identifier : function A function that checks the argument specified to `read` or `write` to determine whether the input can be interpreted as a table of type ``data_format``. This function should take the following arguments: - ``origin``: A string ``"read"`` or ``"write"`` identifying whether the file is to be opened for reading or writing. - ``path``: The path to the file. - ``fileobj``: An open file object to read the file's contents, or `None` if the file could not be opened. - ``*args``: Positional arguments for the `read` or `write` function. - ``**kwargs``: Keyword arguments for the `read` or `write` function. One or both of ``path`` or ``fileobj`` may be `None`. If they are both `None`, the identifier will need to work from ``args[0]``. The function should return True if the input can be identified as being of format ``data_format``, and False otherwise. force : bool, optional Whether to override any existing function if already present. Default is ``False``. Examples -------- To set the identifier based on extensions, for formats that take a filename as a first argument, you can do for example:: >>> def my_identifier(*args, **kwargs): ... return isinstance(args[0], str) and args[0].endswith('.tbl') >>> register_identifier('ipac', Table, my_identifier) z>Identifier for format '{0}' and class '{1}' is already definedN)r.r rYr)rZr6Z identifierr\rrrr3s -cCs2||ftkrt||fntd||jdS)z Unregister an identifier function Parameters ---------- data_format : str The data format identifier. data_class : classobj The class of the object that can be read/written. z6No identifier defined for format '{0}' and class '{1}'N)r.r]r rYr)rZr6rrrunregister_identifierhs r`c CsLg}xBtD]:\}}t||tr t||f|||f||r ||q W|S)aLoop through identifiers to see which formats match. Parameters ---------- origin : str A string ``"read`` or ``"write"`` identifying whether the file is to be opened for reading or writing. data_class_required : object The specified class for the result of `read` or the class that is to be written. path : str, other path object or None The path to the file or None. fileobj : File object or None. An open file object to read the file's contents, or ``None`` if the file could not be opened. args : sequence Positional arguments for the `read` or `write` function. Note that these must be provided as sequence. kwargs : dict-like Keyword arguments for the `read` or `write` function. Note that this parameter must be `dict`-like. Returns ------- valid_formats : list List of matching formats. )r.r-r/) originZdata_class_requiredpathfileobjargskwargs valid_formatsrZr6rrrr{s  cCs,t||d}|dd|jdd}|S)N)r7z Data classrIrC)rE)r r5rUrQ)r6r7r:format_table_strrrr_get_format_table_strs  rhcs^fddtD}xF|D] \}}t|||rt||fSqWt|d}td|j|dS)aGet reader for ``data_format``. Parameters ---------- data_format : str The data format identifier. This is the string that is used to specify the data type when reading/writing. data_class : classobj The class of the object that can be written. Returns ------- reader : callable The registered reader function for this format and class. cs g|]\}}|kr||fqSrr)r!fmtr)rZrrr#szget_reader..rzRNo reader defined for format '{0}' and class '{1}'. The available formats are: {2}N)r+r-rhr rYr)rZr6ZreadersZ reader_formatZ reader_classrgr)rZrrs  cs^fddtD}xF|D] \}}t|||rt||fSqWt|d}td|j|dS)aGet writer for ``data_format``. Parameters ---------- data_format : str The data format identifier. This is the string that is used to specify the data type when reading/writing. data_class : classobj The class of the object that can be written. Returns ------- writer : callable The registered writer function for this format and class. cs g|]\}}|kr||fqSrr)r!rir)rZrrr#szget_writer..r$zRNo writer defined for format '{0}' and class '{1}'. The available formats are: {2}N)r,r-rhr rYr)rZr6ZwritersZ writer_formatZ writer_classrgr)rZrr s  )rYc Ospd}zJ|dkrd}d}t|rt|dtrddlm}t|dtjrdt|df|dd}|d}y||ddd}|}Wn,t k rYqt k rd}YqX|gt |dd}nt |ddrd}|d}t d|||||}t||}|||} t| |sNy || } Wn&t k rLtd|jYnXWd|dk rj|jtX| S) zV Read in data. The arguments passed to this method depend on the format. Nr)get_readable_fileobjrZbinary)encodingr z-could not convert reader output to {0} class.)lenrK PATH_TYPESZastropy.utils.datarjpathlibPathrL __enter__OSError Exceptionr1hasattr_get_valid_formatr TypeErrorrYr__exit__sysexc_info) rrYrdreZctxrbrcrjreaderr9rrrr sF        cOs|dkrd}d}t|rxt|dtr^t|dtjrPt|df|dd}|d}d}nt|ddrxd}|d}td|j||||}t ||j}||f||dS)zX Write out data. The arguments passed to this method depend on the format. Nrrr r ) rlrKrmrnrorLrsrt __class__r )r9rYrdrerbrcwriterrrrr s  cCsDt||r@dd|D}x&|jD]}||kr0dS||kr dSq WdS)ad Determine if class2 is the "best" match for class1 in the list of classes. It is assumed that (class2 in classes) is True. class2 is the the best match if: - ``class1`` is a subclass of ``class2`` AND - ``class2`` is the nearest ancestor of ``class1`` that is in classes (which includes the case that ``class1 is class2``) cSsh|] \}}|qSrr)r!rirrrr >sz!_is_best_match..TF) issubclass__mro__)Zclass1Zclass2r8classesparentrrrr-3s  r-c Cspt||||||}t|dkrFormat could not be identified. The available formats are: {0}rz&Format is ambiguous - options are: {0}z, )r) rrlrhrPr rYrUr)r)moderrbrcrdrerfrgrrrrtGs   rt)NN)F)F)F)( contextlibrnr=rw collectionsroperatorrZnumpyr3__all__Z__doctest_skip__r+r,r.rLrormrrr r*rcontextmanagerrr rrr^rr_rr`rrhrr r r r-rtrrrrsB      $ D;   5&7