HR-eGddlZddlZddlZddlZddlmZddlmZddlZ dgZ Gdde Z Gddej ZdS) N) OrderedDict) itemgetterIORegistryErrorceZdZdZdS)rz"Custom error for registry clashes.N)__name__ __module__ __qualname____doc__8lib/python3.11/site-packages/astropy/io/registry/base.pyrrs,,Dr ceZdZdZdZedZddZej dZ ddZ d Z d Z d Zd Zd ZdZdZdS)_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 ct|_t|_tdd|jd<d|_t |_dS)N _identifiersz Auto-identify)attrcolumnidentify)r)rrdict _registries_registries_orderset_delayed_docs_classesselfs r __init__z_UnifiedIORegistryBase.__init__)sR'MM 66'+'X'X'X$!. &)UU"""r c4|jS)zUAvailable registries. Returns ------- ``dict_keys`` )rkeysrs r available_registriesz+_UnifiedIORegistryBase.available_registries7s$$&&&r Nc ddlm}ddgfdjDdR}|d}|d}|jjdd|d}t }jdhz D]3} |t tj| d z}4t|td } g} | D]\| || sfd j Dd zf} | | vrdnd} | j gfdjD| Rt|jvrIjt|fd| D} n|t!djd| r5t#t%t| t||| }nd }t'j5t'jdt,|||}t/j|djdks|dd d d n #1swxYwY|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 classFormatc6g|]}j|dS)r)r).0krs r z6_UnifiedIORegistryBase.get_formats..]s& L L Ldq!(+ L L Lr DeprecatedrrrkeyNc Ti|]$\}}|ft|dvrdnd%S)rYesNo)getattr)r%r&vclsfmtrs r z6_UnifiedIORegistryBase.get_formats..wsOAqS#J'$& *B*BBB55r zascii.r,c g|] }| Sr r )r%nhas_s r r'z6_UnifiedIORegistryBase.get_formats..s>>>!d1g>>>r c2g|]}|zdk|S)r,r )r%row i_regstartindexs r r'z6_UnifiedIORegistryBase.get_formats..s-LLLC3zE/A+Be+K+KC+K+K+Kr z5unrecognized value for "filter_on": {0}. Allowed are z and None.ignore)actioncategory)names) astropy.tabler!rr:rrrr.sortedr_is_best_matchitemsappendrstrlower ValueErrorlistzipwarningscatch_warnings simplefilter FutureWarningnpanydata remove_column)r data_class filter_onr!colnames i_dataclassi_format i_deprecatedregsr&format_classesrowsascii_format_class deprecatedrO format_tabler0r1r6r9r:s` @@@@@r get_formatsz"_UnifiedIORegistryBase.get_formatsAs, ('''''   M L L LT5K L L L      nn\22 >>(++^^  T3A6 7 A   ~~l33 uu!&&((J<7 D DA Cd&6q&9&&ABBCC CDD*Q--888&  HC%d.A.AC//% ,2244D#+S.#!6 "4"F"FBJ KKL?>>>t'=>>>      y>>   ! !T%; ; ;*00Y1E1E1G1GHHELLLLL4LLLDD  "B#5BBB   VDjlH&U&UVVVWDDD  $ & & 9 9  !M J J J J 5X666L6,|49UBCC 9**<888  9 9 9 9 9 9 9 9 9 9 9 9 9 9 9s7A!K$$K(+K(c#K|j|dV|j||jdhz D]}|||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__)rr0methods r delay_doc_updatesz(_UnifiedIORegistryBase.delay_doc_updatess. "&&s+++  "**3///&++-- < - -F   V , , , , - -r Fcn||f|jvs|r||j||f<dStd|d|jd)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)rrr)r data_formatrQ identifierforces r register_identifierz*_UnifiedIORegistryBase.register_identifiersmbZ(D,====;ED {J7 8 8 8!???'??? r c||f|jvr|j||fdStd|d|j)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 reN)rpoprr)rrfrQs r unregister_identifierz,_UnifiedIORegistryBase.unregister_identifiersl  $(9 9 9   ! !; "; < < < < <!,K,,',, r cg}|jD]Q\}} ||| |jr0|j|| f|||g|Ri|r||R|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. )rrArC) rorigindata_class_requiredpathfileobjargskwargs valid_formatsrfrQs r identify_formatz&_UnifiedIORegistryBase.identify_formats8 '+'8 6 6 #K""#6 DDUVV 6?4$k:%>?D',04:6"((555r c|||}|dd|d}|S)z9``get_formats()``, without column "Data class", as a str.r" ) max_lines)r]rPjoinpformat)rrQrRr\format_table_strs r _get_format_table_strz,_UnifiedIORegistryBase._get_format_table_strCsT'' I>> ""<00099\%9%9B%9%G%GHHr cnt||r$d|D}|jD]}||urdS||vrdSdS)awDetermine 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``) ch|]\}}|Sr r )r%r1r0s r z8_UnifiedIORegistryBase._is_best_match..Us:::xsCs:::r TF) issubclass__mro__)rclass1class2rXclassesparents r rAz%_UnifiedIORegistryBase._is_best_matchJsh ff % % !::>:::G . ! !V##44W$$ 55%ur c4|||||||}t|dkr:|||}t d|t|dkr||||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: )rulenr} capitalizer_get_highest_priority_format) rmoder0rprqrrrsrtr|s r _get_valid_formatz(_UnifiedIORegistryBase._get_valid_format]s ,,T3gtVTT }   " "#99#t?P?PQQ !B0@BB    ! # #44T3 NN NQr c |dkr |j}d}n|dkr |j}d}g}tj }|D]U} |||f\} } n#t$rtj } YnwxYw| |kr||J| |kr|g}| }Vt |dkrAtddt|td |dS) zh Returns the reader or writer with the highest priority. If it is a tie, error. readreaderwritewriterrz#Format is ambiguous - options are: z, rr)) _readers_writersrMinfKeyErrorrCrrrzr@r) rrr0rt format_dict mode_loader best_formatscurrent_priorityformat_prioritys r rz3_UnifiedIORegistryBase._get_highest_priority_formatqs5 6>>-K"KK W__-K"K F7# , ,F #)63-8 88 # # #F7 # +++##F++++,,, &x #+ |  q !JIIf] 1 FFFGGJJ As AAAcN t||sdSddlm}d t||}t |jt sdS|j} fdt|D}|r|d}|d|}d|ddD}dtd |Dz | || } | d | d d } tjdd| d} | | d<| d| | | d| jvr| gd dg| z} | fd| Dt ||r!d||j_dS d||_dS#t,$r#d||j_YdSwxYw)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. Nr)UnifiedReadWritez#The available built-in formats are:c"g|] \}}|v | Sr r )r%iiline FORMATS_TEXTs r r'z9_UnifiedIORegistryBase._update__doc__..s'SSShb$ld>R>Rr>R>R>Rr rc8g|]}tjd|S)z(\S))research)r%rs r r'z9_UnifiedIORegistryBase._update__doc__..s$BBB29Wd++BBBr  c3BK|]}||VdS)N)start)r%matchs r z8_UnifiedIORegistryBase._update__doc__..s/LL%eL LLLLLLr r"rxP)ry max_width-=r()r3zZDeprecated format names like ``aastex`` will be removed in a future version. Use the full z%name (e.g. ``ascii.aastex``) instead.r3cg|]}|zSr r )r%r left_indents r r'z9_UnifiedIORegistryBase._update__doc__..s???TkD(???r rw)hasattr interfacerr. isinstancer rD splitlines enumerateminr]rrPr{rsubinsertrCrSextendrz __class__AttributeError__func__)rrQ readwriterclass_readwrite_funclines sep_indices chop_indexmatchesr\ new_lines table_rst_seprrs @@r raz%_UnifiedIORegistryBase._update__doc__sz9--  F//////<  'z9==.6<<  F$,7799TSSS)E*:*:SSS  '$QJ+:+&ECBabb BBBCLL7LLLLLL '' I4H4H4J4JKK ""<000!((2(DD sC166 $ ! M***''' <0 0 0      "2&2  ????Y???@@@ *,< = = I59YYu5E5E * 2 2 2 I/3yy/?/?$,,,! I I I8< %8H8H$-5555 IsG77)H$#H$)NN)F)rrr r rpropertyrr] contextlibcontextmanagerrcrirlrur}rArrrar r r rrs  + + +''X'iiiiV---B7777r&$$$R   &   (!!!FFIFIFIFIFIr r) metaclass)abcrrrI collectionsroperatorrnumpyrM__all__ ExceptionrABCMetarr r r rs  ######       i   BIBIBIBIBIs{BIBIBIBIBIBIr