U e{jG@snddlZddlZddlZddlZddlmZddlmZddlZ dgZ Gddde Z Gdddej dZdS) N) OrderedDict) itemgetterIORegistryErrorc@seZdZdZdS)rz"Custom error for registry clashes.N)__name__ __module__ __qualname____doc__r r W/var/www/html/bwave/python/venv/lib/python3.8/site-packages/astropy/io/registry/base.pyrsc@s~eZdZdZddZeddZdddZej d d Z dd d Z ddZ ddZ ddZddZddZddZddZdS)_UnifiedIORegistryBaseaBase class for registries in Astropy's Unified IO. This base class provides identification functions and miscellaneous utilities. For an example how to build a registry subclass we suggest :class:`~astropy.io.registry.UnifiedInputRegistry`, which enables read-only registries. These higher-level subclasses will probably serve better as a baseclass, for instance :class:`~astropy.io.registry.UnifiedIORegistry` subclasses both :class:`~astropy.io.registry.UnifiedInputRegistry` and :class:`~astropy.io.registry.UnifiedOutputRegistry` to enable both reading from and writing to files. .. versionadded:: 5.0 cCs4t|_t|_tddd|jd<d|_t|_dS)N _identifiersz Auto-identify)attrcolumnidentify)r)rr dict _registries_registries_orderset_delayed_docs_classesselfr r r __init__)s z_UnifiedIORegistryBase.__init__cCs |jS)zUAvailable registries. Returns ------- ``dict_keys`` )rkeysrr r r available_registries7sz+_UnifiedIORegistryBase.available_registriesNc sddlm}dfddjDd}|d}|d}|jjdd|d}t}jd hD] } |ttj| d O}qtt|t dd } g} | D]\|d k rΈ || sqfd dj Ddf} | | krdnd} | j ffddjD| fqt|jkrpjt|fdd| D} n|d k rtdjd| rttt| t |||d }nd }t@tjdtd|||d}t|djdks|dW5QRX|S)a{ Get the list of registered formats as a `~astropy.table.Table`. Parameters ---------- data_class : class or None, optional Filter readers/writer to match data class (default = all classes). filter_on : str or None, optional Which registry to show. E.g. "identify" If None search for both. Default is None. Returns ------- format_table : :class:`~astropy.table.Table` Table of available I/O formats. Raises ------ ValueError If ``filter_on`` is not None nor a registry name. r)Table Data classFormatcsg|]}j|dqS)r)r).0krr r ]sz6_UnifiedIORegistryBase.get_formats.. Deprecatedrrr keyNcs0i|](\}}|ft|dkr(dndqS)r YesZNo)getattr)rrv)clsfmtrr r wsz6_UnifiedIORegistryBase.get_formats..zascii.r#csg|] }|qSr r )rn)has_r r rscs g|]}|dkr|qS)r#r )rrow) i_regstartindexr r rsz5unrecognized value for "filter_on": {0}. Allowed are z and None.ignore)actioncategory)names)rr)r )Z astropy.tablerrr.rrrr$sortedr_is_best_matchitemsappendrstrlower ValueErrorlistzipwarningscatch_warnings simplefilter FutureWarningnpanydata remove_column)r data_class filter_onrcolnamesZ i_dataclassZi_formatZ i_deprecatedregsrformat_classesrowsZascii_format_class deprecatedrB format_tabler )r&r'r+r-r.rr get_formatsAsp            z"_UnifiedIORegistryBase.get_formatsccsD|j|dV|j||jdhD]}|||q.dS)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. Examples -------- see for example the source code of ``astropy.table.__init__``. Nr)radddiscardrr_update__doc__)rr&methodr r r delay_doc_updatess   z(_UnifiedIORegistryBase.delay_doc_updatesFcCs>||f|jks|r"||j||f<ntd|d|jddS)an 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 : class 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 .. code-block:: python from astropy.io.registry import register_identifier from astropy.table import Table def my_identifier(*args, **kwargs): return isinstance(args[0], str) and args[0].endswith('.tbl') register_identifier('ipac', Table, my_identifier) unregister_identifier('ipac', Table) zIdentifier for format and class z is already definedN)r rr)r data_formatrD identifierforcer r r register_identifiers 1z*_UnifiedIORegistryBase.register_identifiercCs:||f|jkr |j||fntd|d|jdS)z Unregister an identifier function Parameters ---------- data_format : str The data format identifier. data_class : class The class of the object that can be read/written. z!No identifier defined for format rRN)r poprr)rrSrDr r r unregister_identifiers z,_UnifiedIORegistryBase.unregister_identifierc CsPg}|jD]@\}} ||| |jr |j|| f|||f||r ||q |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 or path-like or None The path to the file or None. fileobj : file-like 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 r4r6) roriginZdata_class_requiredpathfileobjargskwargs valid_formatsrSrDr r r identify_formats  z&_UnifiedIORegistryBase.identify_formatcCs,|||}|dd|jdd}|S)z9``get_formats()``, without column "Data class", as a str.r ) max_lines)rLrCjoinpformat)rrDrErKformat_table_strr r r _get_format_table_strCs  z,_UnifiedIORegistryBase._get_format_table_strcCsDt||r@dd|D}|jD] }||kr0dS||krdSqdS)a 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|] \}}|qSr r )rr'r&r r r Usz8_UnifiedIORegistryBase._is_best_match..TF) issubclass__mro__)rZclass1Zclass2rHclassesparentr r r r4Js  z%_UnifiedIORegistryBase._is_best_matchc Csb|||||||}t|dkr@|||}td|nt|dkrZ||||S|dS)z Returns the first valid format that can be used to read/write the data in question. Mode can be either 'read' or 'write'. rzFormat could not be identified based on the file name or contents, please provide a 'format' argument. The available formats are: )r_lenrf capitalizer_get_highest_priority_format) rmoder&rZr[r\r]r^rer r r _get_valid_format]s  z(_UnifiedIORegistryBase._get_valid_formatc Cs|dkr|j}d}n|dkr&|j}d}g}tj }|D]\}z|||f\} } Wntk rjtj } YnX| |kr||q6| |kr6|g}| }q6t|dkrtddt |t dd |dS) zh Returns the reader or writer with the highest priority. If it is a tie, error. readreaderwritewriterrlz#Format is ambiguous - options are: z, rr!) _readers_writersr@infKeyErrorr6rmrrcr3r) rrpr&r^Z format_dictZ mode_loaderZ best_formatsZcurrent_priorityformat_priorityr r r roqs.  z3_UnifiedIORegistryBase._get_highest_priority_formatc st||sdSddlm}dt||}t|jts8dS|j}fddt|D}|rp|d}|d|}dd|ddD}d t d d |D| || } | d | j d dd} tdd| d} | | d<| d| | | d| jkr| dddgdg| } |fdd| Dt||rPd||j_n6zd||_Wn$tk rd||j_YnXdS)z Update the docstring to include all the available readers / writers for the ``data_class.read``/``data_class.write`` functions (respectively). Don't update if the data_class does not have the relevant method. Nrl)UnifiedReadWritez#The available built-in formats are:csg|]\}}|kr|qSr r )riiline) FORMATS_TEXTr r rsz9_UnifiedIORegistryBase._update__doc__..rcSsg|]}td|qS)z(\S))researchrrr r r rs css|]}|r|VqdS)N)start)rmatchr r r sz8_UnifiedIORegistryBase._update__doc__..rraP)rb max_width-=r r)zZDeprecated format names like ``aastex`` will be removed in a future version. Use the full z%name (e.g. ``ascii.aastex``) instead.csg|] }|qSr r r) left_indentr r rsr`)hasattrZ interfacer}r$ isinstancerr7 splitlines enumerateminrLrnrCrdrsubinsertr6rFextendrc __class__AttributeError__func__) rrDZ readwriter}Zclass_readwrite_funclinesZ sep_indicesZ chop_indexmatchesrK new_linesZ table_rst_sepr )rrr rOsH            z%_UnifiedIORegistryBase._update__doc__)NN)F)rrrrrpropertyrrL contextlibcontextmanagerrQrVrXr_rfr4rqrorOr r r r r s k ! 9)#r ) metaclass)abcrrr< collectionsroperatorrnumpyr@__all__ ExceptionrABCMetar r r r r s