IR-eldZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z ddlmZddlZdd lmZgd Zeed fZe d ZdZdZdZd!dZGddZGddZGddeZ Gdde Z!Gdde!Z"Gdde"Z#Gdd e#Z$dS)"aThis module contains functions and methods that relate to the DataInfo class which provides a container for informational attributes as well as summary info methods. A DataInfo object is attached to the Quantity, SkyCoord, and Time classes in astropy. Here it allows those classes to be used in Tables and uniformly carry table column attributes such as name, format, dtype, meta, and description. N) OrderedDict)contextmanager)deepcopy)partial)StringIO)metadata)data_info_factorydtype_info_nameBaseColumnInfoDataInfo MixinInfoParentDtypeInfozUAll-NaN|Mean of empty slice|Degrees of freedom <= 0|invalid value encountered in sqrt)categorymessagec#~Ktj}|t_ dV|t_dS#|t_wxYw)avSet context for serialization. This will allow downstream code to understand the context in which a column is being serialized. Objects like Time or SkyCoord will have different default serialization representations depending on context. Parameters ---------- context : str Context name, e.g. 'fits', 'hdf5', 'parquet', 'ecsv', 'yaml' N)r _serialize_context)context old_contexts 7lib/python3.11/site-packages/astropy/utils/data_info.pyserialize_context_asr6sH!3K(/N%8 ,7)))K)7777s.<ctj|}|j[B] where is like ``int`` or ``bool`` and [B] is an optional number of bits which gets included only for numeric types. The output is shown below for ``bytes`` and ``str`` types, with being the number of characters. This representation corresponds to the Python type that matches the dtype:: Numpy S U Python bytes str Parameters ---------- dtype : str, `~numpy.dtype`, type Input as an object that can be converted via :class:`numpy.dtype`. Returns ------- dtype_info_name : str String name of ``dtype`` Nz, c3@K|]}t|dVdS)rN)r ).0dts r z"dtype_info_name..gs.VV"r!u55VVVVVV())SUr!bytesstrz(\d+)r[,c34K|]}t|VdSN)r$)rns rrz"dtype_info_name..vs(22qCFF222222r]) npdtypenamesjoinfieldsvaluessubdtypekindresearchr$groupname)r, info_namesshape type_namelengthouts rr r Ks4 HUOOE {YYVV @S@S@U@UVVVVV  :     ~!~ uu zZ$zS00GGe 8UY//55a88& j 6 538822E222225555 Jrcfd}|S)a4 Factory to create a function that can be used as an ``option`` for outputting data object summary information. Examples -------- >>> from astropy.utils.data_info import data_info_factory >>> from astropy.table import Column >>> c = Column([4., 3., 2., 1.]) >>> mystats = data_info_factory(names=['min', 'median', 'max'], ... funcs=[np.min, np.median, np.max]) >>> c.info(option=mystats) min = 1 median = 2.5 max = 4 n_bad = 0 length = 4 Parameters ---------- names : list List of information attribute names funcs : list List of functions that compute the corresponding information attribute Returns ------- func : function Function that can be used as a data info option cg}tD]\}} t|trt||}n ||} ||dX#t t f$r%|t|YwxYw#t$r|dYwxYwtt|S)Ngz--) zip isinstancer$getattrappend TypeError ValueError Exceptionr)datoutsr6funcr;funcsr-s rrHzdata_info_factory..funcs eU++ * *JD$ *dC(($,'#t,,..CC$s))C*KK3 ++++!:.***KKC)))))*  " " " D!!!!! "3ud++,,,s#9B%A,,3B"!B"%CCr )r-rIrHs`` rr r {s*@------$ KrcDi}|D]}t||d}||||<|S)a Get the values for object ``attrs`` and return as a dict. This ignores any attributes that are None. In the context of serializing the supported core astropy classes this conversion will succeed and results in more succinct and less python-specific YAML. N)rA)objattrsr;attrvals r_get_obj_attrs_maprOs= Cc4&& ?CI Jrc|dkrt|j}nQ|dkrt|jj}n1|dkr|jdd}|r|nd}nt |j|}|d}t|S)zQ Get a data object attribute for the ``attributes`` info summary method. classr,r8rN)type__name__r infor,r8rAr$)rFrMrNdatshapes r_get_data_attributerWs w3ii  chn-- 9QRR="*hhch%% { s88Orc"eZdZddZdZdZdS) InfoAttributeNc"||_||_dSr()rMdefault)selfrMr[s r__init__zInfoAttribute.__init__s  rcT||S|j|j|jSr()_attrsgetrMr[r\instance owner_clss r__get__zInfoAttribute.__get__s)  K""49dl;;;rcF|td||j|j<dSNcannot set unbound descriptor)rDr_rMr\rbvalues r__set__zInfoAttribute.__set__s+  <== =%* """rr(rT __module__ __qualname__r]rdrjr rrrYrYsF<<< +++++rrYc eZdZdZdZdZdS)ParentAttributec||_dSr(rM)r\rMs rr]zParentAttribute.__init__s  rc>||St|j|jSr()rA_parentrMras rrdzParentAttribute.__get__s"  Kx'333rc^|tdt|j|j|dSrf)rDsetattrrsrMrhs rrjzParentAttribute.__set__s4  <== = $)U33333rNrkr rrrorosA444 44444rroc(eZdZfdZfdZxZS) DataInfoMetacx|dgt||||S)N __slots__) setdefaultsuper__new__)mclsr6basesdct __class__s rr|zDataInfoMeta.__new__s5 {B'''wwtT5#666rc t||||jD]}||vrt||d}||jvr8d|vr3t |t st||t |X|rt |t r7t||t||j |dS)Nattrs_from_parent) r{r] attr_namesrArr@rorurY_attr_defaultsr`)clsr6r~rrMcls_attrrs rr]zDataInfoMeta.__init__s uc***N  D3#3d333000+c11* /;;1 T?4+@+@AAA!Z/%J%J T=s7I7M7Md7S7S#T#T'  r)rTrlrmr|r] __classcell__rs@rrwrwsQ77777 rrwcbeZdZdZgdZeZhdZdej diZ eZ dZ gdZ dZdZd Zdd Zed Zd ZdZdZdZddZdZeee de DZeeedeDZddZfdZxZ S)r a Descriptor that data classes use to add an ``info`` attribute for storing data attributes in a uniform and portable way. Note that it *must* be called ``info`` so that the DataInfo() object can be stored in the ``instance`` using the ``info`` key. Because owner_cls.x is a descriptor, Python doesn't use __dict__['x'] normally, and the descriptor can safely store stuff there. Thanks to https://nbviewer.jupyter.org/urls/gist.github.com/ChrisBeaumont/5758381/raw/descriptor_writeup.ipynb for this trick that works for non-hashable classes. Parameters ---------- bound : bool If True this is a descriptor attribute in a class definition, else it is a DataInfo() object that is bound to a data object instance. Default is False. )meanstdminmax>metar6unitr,format descriptionr,O)r,r8rrrrQ) _parent_cls _parent_refr_r NFc|r i|_dSdSr(r_)r\bounds rr]zDataInfo.__init__Is!  DKKK  rcv |}n#t$rYdSwxYw|td|S)Nafailed to access "info" attribute on a temporary object. It looks like you have done something like ``col[3:5].info`` or ``col.quantity.info``, i.e. you accessed ``info`` from a temporary slice object that only exists momentarily. This has failed because the reference to that temporary object is now lost. Instead force a permanent reference (e.g. ``c = col[3:5]`` followed by ``c.info``).)rAttributeError)r\parents rrszDataInfo._parentPsa %%''FF   44  > -    s  %%c| ||_|S|jd}| |dx}|jd<t j||_|S)NrUTr)r__dict__r`rweakrefrefr)r\rbrcrUs rrdzDataInfo.__get__esi  (D K $$V,, R+RS "T%;;d>QQ C C$,WUD-A-A$B$B D!! C CGHH Hrc|jSr(rr\s r __getstate__zDataInfo.__getstate__s {rc||_dSr(r)r\states r __setstate__zDataInfo.__setstate__s  rc>||j}t|j|S)z|Get the values for the parent ``attrs`` and return as a dict. By default, uses '_represent_as_dict_attrs'. )_represent_as_dict_attrsrOrs)r\rLs r_represent_as_dictzDataInfo._represent_as_dicts# =1E!$,666rcDfd|jD}|j|iS)Nc:g|]}|Sr )pop)rrMmaps r z1DataInfo._construct_from_dict..s#III$ IIIr)_construct_from_dict_argsr)r\rargss ` r_construct_from_dictzDataInfo._construct_from_dicts7IIII$*HIIIt----rc:g|]}tt|S)rq)rrW)rrMs rrzDataInfo.s3<@+$777r)r-rIc>g|]}ttd|zS)nan)rAr+)rstats rrzDataInfo.s& N N NtUT\!:!: N N Nr attributesrRc|dkr tj}|j}t}|jj}|||d<t |ttfr|n|g}|D]}t |tr:t|d|zrt|d|z}ntd|dtj5tD]}tjd i||||dddn #1swxYwYt|drt%j|j}nO t%jt%j|t%j|z}n#t.$rd }YnwxYw||d < t1||d <n#t2t4f$rYnwxYw||S|D]2\} } | dkr'|| d | t:jz3dS)a Write summary information about data object to the ``out`` filehandle. By default this prints to standard output via sys.stdout. The ``option`` argument specifies what type of information to include. This can be a string, a function, or a list of strings or functions. Built-in options are: - ``attributes``: data object attributes like ``dtype`` and ``format`` - ``stats``: basic statistics: min, mean, and max If a function is specified then that function will be called with the data object as its single argument. The function must return an OrderedDict containing the information attributes. If a list is provided then the information attributes will be appended for each of the options, in order. Examples -------- >>> from astropy.table import Column >>> c = Column([1, 2], unit='m', dtype='int32') >>> c.info() dtype = int32 unit = m class = Column n_bad = 0 length = 2 >>> c.info(['attributes', 'stats']) dtype = int32 unit = m class = Column mean = 1.5 std = 0.5 min = 1 max = 2 n_bad = 0 length = 2 Parameters ---------- option : str, callable, list of (str or callable) Info option, defaults to 'attributes'. out : file-like, None Output destination, defaults to sys.stdout. If None then the OrderedDict with information attributes is returned Returns ------- info : `~collections.OrderedDict` or None `~collections.OrderedDict` if out==None else None rRNr6 info_summary_zoption=z# is not an allowed information typeignoremaskrn_badr:z = )r)sysstdoutrsrrUr6r@listtupler$hasattrrArDwarningscatch_warningsIGNORE_WARNINGSfilterwarningsupdater+ count_nonzerorisinfisnanrElenrC IndexErroritemswriteoslinesep) r\optionr;rFrUr6options ignore_kwargsrkeyrNs r__call__zDataInfo.__call__sl "99*Cl}}x}  DL&ve}==K&&F8 ) )F&#&& V46!9::V$T?V+CDDFF$%T%T%T%TUUU(** ) )%4GGM+FF FFFF FF3KK((( ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) 3   $SX..EE (##)FGG    W   XXDNN:&    D  ;K  9 9HCbyy S**S**RZ7888 9 9s6:DD D ?;E;; F  F F&&F:9F:c|j tSt}|||S)N)r;)rsr{__repr__rrgetvalue)r\r;rs rrzDataInfo.__repr__sL < 77##%% %jj # ||~~rFr()rrR)!rTrlrm__doc___statsrrrr+r,rr_info_summary_attrsryrr_represent_as_dict_primary_datar]propertyrsrdrjrrrr staticmethodr info_summary_attributesinfo_summary_statsrrrrs@rr r s"+ * *FKKKJxrx}}-NSUUNV888I " !#'+#X(   III.7777...+l%DW   & N Nv N N N    _9_9_9_9Brr ) metaclassceZdZdZejddhzZddhZdZddgZe dZ e j dZ dfd Z fd Z d Ze d Zej dZdZdZedZdZxZS)r abBase info class for anything that can be a column in an astropy Table. There are at least two classes that inherit from this: ColumnInfo: for native astropy Column / MaskedColumn objects MixinInfo: for mixin column objects Note that this class is defined here so that mixins can use it without importing the table package. parent_tableindicesN _format_funcs _copy_indicescl|jd}t|r |}|SNr)r_r`callable)r\ris rrzBaseColumnInfo.parent_table0s3 // E?? EGGE rc||jdddStj|}||jd<dSr)r_rrr)r\rs rrzBaseColumnInfo.parent_table7sE   KOOND 1 1 1 1 1";|44L*6DK ' ' 'rFcbt||r i|_dSdS)Nr)r{r]r)r\rrs rr]zBaseColumnInfo.__init__?s@ u%%%  $!#D    $ $rc |jsdSn#t$rYnwxYwt||dSr()r8rr{rj)r\rbrirs rrjzBaseColumnInfo.__set__Gs\ >      D  %(((((s  c#K|j}|jddlm}n |jj}|j}||dddiEd{VdS)zG This is a mixin-safe version of Column.iter_str_vals. Nr) FORMATTERF)rsrastropy.table.columnr formatter_pformat_col_iter)r\colrrs r iter_str_valszBaseColumnInfo.iter_str_valsQsrl   $ C C C C C C C)3I%7$$S"eUB???????????rc8|jdgSNr)r_rzrs rrzBaseColumnInfo.indices^s {%%i444rc||jd<dSrr)r\rs rrzBaseColumnInfo.indicesfs!( Irc|jsdSt|tr,||}tt |}nHt|t jr+|jjdkrt j |d}n|g}t j |}|j dkrt|t|z}t||D]+\}}|jD]}|||j|,dS)a Adjust info indices after column modification. Parameters ---------- index : slice, int, list, or ndarray Element(s) of column to modify. This parameter can be a single row number, a list of row numbers, an ndarray of row numbers, a boolean ndarray (a mask), or a column slice. value : int, list, or ndarray New value(s) to insert col_len : int Length of the column Nbrr)rr@slicerranger+ndarrayr,r2where atleast_1dsizerr?replacer6) r\indexricol_lentkeysrrN col_indexs radjust_indiceszBaseColumnInfo.adjust_indicesjs |  F eU # #  g&&Aq ??DD rz * * u{/?3/F/F8E??1%DD7D e$$ :??KK#d))+ED%(( 7 7HC!\ 7 7 !!#ty#6666 7 7 7rc~ddlm}t|ddsg|j_|St t rfd|jD|j_n|jrt tjr*j j dkrtj dtd|zk}g|j_|jD]n}|st ||r| |}n$t|}||jj|o|S)a Given a sliced object, modify its indices to correctly represent the slice. Parameters ---------- col_slice : `~astropy.table.Column` or mixin Sliced object. If not a column, it must be a valid mixin, see https://docs.astropy.org/en/stable/table/mixin_columns.html item : slice, list, or ndarray Slice used to create col_slice col_len : int Length of original object r) SortedArrayrTc g|] }| Sr r )rxitems rrz0BaseColumnInfo.slice_indices..s%D%D%D!ag%D%D%Drrg333333?)astropy.table.sorted_arrayr rArUrr@rr+rr,r2rr get_slicer replace_rowsrB)r\ col_slicer rr smallr new_indexs ` r slice_indiceszBaseColumnInfo.slice_indicessN ;:::::t_d33 9%'IN "  e $ $ 9%D%D%D%Dt|%D%D%DIN " " \ 9$ ++ ) 30F0Fx~~a( IIw.E%'IN " 9 91Juk::1 % 4 @ @II (I**4000&--i8888rcfddlm}fd}fd}||d}|ddD]#}tj|||||}$tj||d<d |D} t | dkr |d | |d <|d <|S) a Utility method to merge and validate the attributes ``attrs`` for the input table columns ``cols``. Note that ``dtype`` and ``shape`` attributes are handled specially. These should not be passed in ``attrs`` but will always be in the returned dict of merged attributes. Parameters ---------- cols : list List of input Table column objects metadata_conflicts : str ('warn'|'error'|'silent') How to handle metadata conflicts name : str Output column name attrs : list List of attribute names to be merged Returns ------- attrs : dict Of merged attributes. r)TableMergeErrorc ,dd|d|d|d|d }|S)NzIn merged column 'z' the 'z' attribute does not match (z != z ). Using z for merged outputr )rleftrightr;r6s r warn_str_funcz;BaseColumnInfo.merge_cols_attributes..warn_str_funcsdITII#IIII#II/4III Jrc"fdDS)Nchi|].}tj|d|tj|/Sr()rArU)rrMrs r zJBaseColumnInfo.merge_cols_attributes..getattrs..sE38T400<gch--<<.getattrss/! rrN)metadata_conflictsrr,c,h|]}|jddS)rN)r8)rrs r z7BaseColumnInfo.merge_cols_attributes..s"555sy}555rzcolumns have different shapesr8r6)astropy.table.np_utilsrr merge common_dtyperr) colsrr6rLrrrr;r uniq_shapess `` rmerge_cols_attributesz$BaseColumnInfo.merge_cols_attributess6 ;:::::          htAw8  C. #5+ CC ,T22G 65555 {  q !/"ABB B"((G   CK rc2td|jd)a  Return a list of arrays which can be lexically sorted to represent the order of the parent column. The base method raises NotImplementedError and must be overridden. Returns ------- arrays : list of ndarray zcolumn z is not sortable)NotImplementedErrorr6rs rget_sortable_arraysz"BaseColumnInfo.get_sortable_arrayss ""GDI"G"G"GHHHrr)rTrlrmrr rrrryrrsetterr]rjrrrrrr&r)rrs@rr r sg  $ 'BBJ$i0N /2I X 777$$$$$$))))) @ @ @55X5 ^))^)$7$7$7L)))V@@\@D I I I I I I Irr cZeZdZedZejdZedZdS)rc6|jdSNr6)r_r`rs rr6zMixinInfo.name s{v&&&rc|j8|dnt|}|jj|j|||jd<dSr-)rr$columns_rename_columnr6r_)r\r6new_names rr6zMixinInfo.namesP   (#|ttTH   % 4 4TY I I I" Frctddlm}|jd||jS)Nr)groupsr3) astropy.tabler3r_rz ColumnGroupsrs)r\r3s rr3zMixinInfo.groupss> )((((({%%h0C0CDL0Q0QRRRrN)rTrlrmrr6r*r3r rrrr sj ''X' [##[#SSXSSSrrceZdZdZdhZdS)rz'Mixin that gets info.dtype from parent.r,N)rTrlrmrrr rrrr's11 rrr()%rrr3rrr collectionsr contextlibrcopyr functoolsriornumpyr+rRr __all__dictRuntimeWarningrrr r rOrWrYrorSrwr r rrr rrr@s ######%%%%%%    D 0 888(---`222j    $++++++++&44444444$     4   F{{{{{{{{{|qIqIqIqIqIXqIqIqIhSSSSSSSS6"""""i"""""r