B }dV@sXdZddlZddlZddlmZddlmZddlmZddl Z yddl m Z m Z Wnek rpdZ dZ YnXddlmZmZd d lmZd Zd Zd ZdZd9ddZed:ddZddZddZddZddZddZddZd d!Z d;d"d#Z!dd+d,Z%d?d-d.Z&d/d0Z'd1d2Z(d3d4Z)d5d6Z*ed7d8Z+dS)@zBasic utilities for reading/writing LIGO_LW-format XML files. All specific unified input/output for class objects should be placed in an 'io' subdirectory of the containing directory for that class. N)contextmanager)wraps) import_module) ElementErrorLIGOLWContentHandler) file_list FILE_LIKE)deprecated_functionz(Duncan Macleod scCs>ddlm}y |||Stk r8|t|t|SXdS)z3Catch TypeError and cast `s` and `ns` to `int` r) LIGOTimeGPSN)Zlalr TypeErrorint)snsr r[/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/gwpy/io/ligolw.py _ligotimegps7s   rligo.lw.lsctablesccs,t|}|j}t|_z dVWd||_XdS)zLContext manager to on-the-fly patch LIGOTimeGPS to accept all int types N)rr r)moduleorigrrrpatch_ligotimegpsAs  rcCsFy|d\}}}Wn$tk r<td|dYnXt|S)z0Convert an ``ilwd`` string into an integer. :zinvalid ilwd:char '')stripsplit ValueErrorr)Zilwd_irrr _int_ilwdPs rcsHddlmddlmmddlmGfddd}|S)zWrap a LIGO_LW content handler to swap ilwdchar for int on-the-fly when reading a document This is adapted from :func:`ligo.skymap.utils.ilwd`, copyright Leo Singer (GPL-3.0-or-later). r) TableByName)Column TableStream) FromPyTypecsPeZdZfddZejfddZejfddZZS)z-strip_ilwdchar..IlwdMapContentHandlercstj||i|_dS)N)super__init__ _idconverter)selfargskwargs) __class__rrr%gsz6strip_ilwdchar..IlwdMapContentHandler.__init__cst||}|jdkr6t|jt||jf<t|_y|jj}Wnt k rZ|SX|j|krfdd|D}|j|kr| d||j|S)Nz ilwd:charcsi|]}||qSr)Z ColumnName).0name)r!rr yszMstrip_ilwdchar..IlwdMapContentHandler.startColumn..Name) r$ startColumnTyperr&idr.r validcolumnsKeyErrorZ setAttribute)r'parentattrsresultr2Zstripped_column_to_valid_column)r!r#r r*rrr/ks       z9strip_ilwdchar..IlwdMapContentHandler.startColumncsnt||}t|rjt|j|jdk r:t|jMt||jfddt |j |jD|S)Ncs.g|]&\}}|kr&j|f|ndqS)N)r&pop)r+Zpytypecolname) loadcolumnspidr'rr szMstrip_ilwdchar..IlwdMapContentHandler.startStream..) r$ startStream isinstancesetZ columnnamesr9r1Z _tokenizerZ set_typeszipZ columnpytypes)r'r4r5r6)r"r*)r9r:r'rr<s   z9strip_ilwdchar..IlwdMapContentHandler.startStream)__name__ __module__ __qualname__r%rr/r< __classcell__r)r!r#r r"_ContentHandler)r*rIlwdMapContentHandleres rE)ligo.lw.lsctablesr ligo.lw.tabler!r" ligo.lw.typesr#)rDrEr)r!r#r r"rDrstrip_ilwdcharZs   2rIcCs(ddlm}t|Gddd|}|S)Nr)use_inc@s eZdZdS)z-_wrap_content_handler..ContentHandlerN)r@rArBrrrrContentHandlersrK)rFrJrI)contenthandlerrJrKrrr_wrap_content_handlers    rMcCsddlm}t|S)aReturn a standard content handler to read LIGO_LW documents This handler knows how to parse LSCTables, and automatically converts old-style ilwdchar ID types to `int`. Returns ------- contenthandler : subclass of `ligo.lw.ligolw.LIGOLWContentHandler` r)r)ligo.lw.ligolwrrM)rrrrdefault_content_handlers rOcsFddlm}ddlm}t|r0fdd}n fdd}t||S)amBuild a `PartialLIGOLWContentHandler` to read only this element Parameters ---------- element : `type`, subclass of :class:`~ligo.lw.ligolw.Element` the element class to be read Returns ------- contenthandler : `type` a subclass of `~ligo.lw.ligolw.PartialLIGOLWContentHandler` to read only the given `element` r)PartialLIGOLWContentHandler)Tablecs ||S)N)CheckProperties)r,r5)elementrr_element_filtersz3get_partial_contenthandler.._element_filtercs |jkS)N)tagName)r,r)rSrrrTs)rNrPrGrQ issubclassbuild_content_handler)rSrPrQrTr)rSrget_partial_contenthandlers     rXcsFddlm}ddlm}t|r0fdd}n fdd}t||S)aBuild a `FilteringLIGOLWContentHandler` to exclude this element Parameters ---------- element : `type`, subclass of :class:`~ligo.lw.ligolw.Element` the element to exclude (and its children) Returns ------- contenthandler : `type` a subclass of `~ligo.lw.ligolw.FilteringLIGOLWContentHandler` to exclude an element and its children r)FilteringLIGOLWContentHandler)rQcs||S)N)rR)r,r5)rSrrrTsz5get_filtering_contenthandler.._element_filtercs |jkS)N)rU)r,r)rSrrrTs)rNrYrGrQrVrW)rSrYrQrTr)rSrget_filtering_contenthandlers    rZcsGfddd|}t|S)aBuild a `~xml.sax.handler.ContentHandler` with a given filter Parameters ---------- parent : `type`, subclass of `xml.sax.handler.ContentHandler` a class of contenthandler to use filter_func : `callable` the filter function to pass to the content handler creation Returns ------- contenthandler : subclass of ``parent`` a new content handler that applies the filter function and the default parsing extras from :func:`_wrap_content_handler`. cseZdZfddZZS)z-build_content_handler..ContentHandlercst|dS)N)r$r%)r'Zdocument)r* filter_funcrrr%sz6build_content_handler..ContentHandler.__init__)r@rArBr%rCr)r[)r*rrKsrK)rM)r4r[rKr)r[rrWsrWc Ksddlm}ddlm}ddlm}m}|j}x0|jD]&}||j kr:t |j |j |j|<q:W|dkrrt }t|}z>t|dkr||dfd|i|S|j||fd|i|S||_XdS)aRead one or more LIGO_LW format files Parameters ---------- source : `str`, `file` the open file or file path to read contenthandler : `~xml.sax.handler.ContentHandler`, optional content handler used to parse document verbose : `bool`, optional be verbose when reading files, default: `False` Returns ------- xmldoc : :class:`~ligo.lw.ligolw.Document` the document object as parsed from the file(s) r)Document)types)load_url ligolw_addNrrL)rNr\ligo.lwr] ligo.lw.utilsr^r_ToPyTypecopy ToNumPyTypenumpyZdtypetyperOrlen) sourcerLr)r\r]r^r_Ztopytypekeyrrr read_ligolws,       rjc Ksddlm}ddlm}m}|dk rZ|j|j|}|dkrFt|}|j } |dk rZ||_ t ||rj|} n8|dkrxt }zt |fd|i|} Wd|dk r| |_ X|dkrt | } | stdt| dkrtdd | |j|j| d}|| S) aRead a :class:`~ligo.lw.table.Table` from one or more LIGO_LW files Parameters ---------- source : `Document`, `file`, `str`, `CacheEntry`, `list` object representing one or more files. One of - a LIGO_LW :class:`~ligo.lw.ligolw.Document` - an open `file` - a `str` pointing to a file path on disk - a formatted :class:`~lal.utils.CacheEntry` representing one file - a `list` of `str` file paths or :class:`~lal.utils.CacheEntry` tablename : `str` name of the table to read. columns : `list`, optional list of column name strings to read, default all. contenthandler : `~xml.sax.handler.ContentHandler`, optional SAX content handler for parsing LIGO_LW documents. **kwargs other keyword arguments are passed to `~gwpy.io.ligolw.read_ligolw` Returns ------- table : :class:`~ligo.lw.table.Table` `Table` of data r)r\)table lsctablesNrLz&No tables found in LIGO_LW document(s)rzMultiple tables found in LIGO_LW document(s), please specify the table to read via the ``tablename=`` keyword argument. The following tables were found: '{}'z', ')rNr\r`rkrlr rQ TableNamerXr9r=rOrj list_tablesrrgformatjoin get_table) rhZ tablenamecolumnsrLr)r\rkrlZ tableclassZ_oldcolsxmldoctablesrrr read_table>s>%    ruc Ksddlm}ddlm}|dkr&t}t|tsvy*t|d}t|fd|i|SQRXWnt t fk rt|SX||fd|i|S)aTry and open an existing LIGO_LW-format file, or create a new Document Parameters ---------- fobj : `str`, `file` file path or open file object to read contenthandler : `~xml.sax.handler.ContentHandler`, optional the content handler with which to parse the document, if not given a default handler will be created using :func:`default_content_handler`. **kwargs other keyword arguments to pass to :func:`~ligo.lw.utils.load_fileobj` as appropriate Returns -------- xmldoc : :class:`~ligo.lw.ligolw.Document` either the `Document` as parsed from an existing file, or a new, empty `Document` r)r\) load_fileobjNrbrL) rNr\rarvrOr=r open open_xmldocOSErrorIOError)ZfobjrLr)r\rvZfobj2rrrrys"    rycCsJddlm}m}t||r|Sx||D]}t||r(|Sq(WtddS)z element in this XML Document r)LIGO_LW WalkChildrenz+Cannot find LIGO_LW element in XML DocumentN)rNr|r}r=r)rsr|r}elemrrrget_ligolw_elements  rFc Csddlm}ddlm}y t|}Wn$tk rH|}||YnXxt|D]l}y|j||j  |}Wntk r||YqPX|r| || ||qP| |qPW|S)aWrite the given LIGO_LW table into a :class:`Document` Parameters ---------- xmldoc : :class:`~ligo.lw.ligolw.Document` the document to write into tables : `list` of :class:`~ligo.lw.table.Table` the set of tables to write overwrite : `bool`, optional, default: `False` if `True`, delete an existing instance of the table type, otherwise append new rows r)r|)rl)rNr|r`rlrrZ appendChildr rmr.rqZ removeChildunlinkextend)rsrt overwriter|rlllwrkoldrrrwrite_tables_to_documents&      rc Ksddlm}m}ddlm}t|||fr0|} nV|rP|dkrBt}t||d} n6|st|tt j frt j |rt d|n|} t| ||dt|tr|j} |j} n|j} t|} }| dr|d d | | |f|dS) atWrite an LIGO_LW table to file Parameters ---------- target : `str`, `file`, :class:`~ligo.lw.ligolw.Document` the file or document to write into tables : `list`, `tuple` of :class:`~ligo.lw.table.Table` the tables to write append : `bool`, optional, default: `False` if `True`, append to an existing file/table, otherwise `overwrite` overwrite : `bool`, optional, default: `False` if `True`, delete an existing instance of the table type, otherwise append new rows contenthandler : `~xml.sax.handler.ContentHandler`, optional the content handler with which to parse the document, if not given a default handler will be created using :func:`default_content_handler`. **kwargs other keyword arguments to pass to :func:`~ligo.lw.utils.load_fileobj` as appropriate r)r\r|)utilsN)rLz File exists: )rz.gzcompressgz)rNr\r|r`rr=rOrystrosPathLikepathexistsr{rr Z write_fileobjr,Zwrite_filenameendswith setdefault) targetrtappendrrLr)r\r|Z ligolw_utilsrswriterr,rrr write_tabless0"       rccs`ddlm}m}m}t||s2t|}t||d}t|}x ||D]}|jdkrD|VqDWdS)a;Iterate over all tables in the given document(s) Parameters ---------- source : `file`, `str`, :class:`~ligo.lw.ligolw.Document`, `list` one or more open files, file paths, or LIGO_LW `Document`s Yields ------ ligo.lw.table.Table a table structure from the document(s) r)ElementStreamr})rLrQN) rNrrr}r=rZrjrrU)rhrrr}Zfiltrr~rrr iter_tablesMs    rcCsddt|DS)aList the names of all tables in this file(s) Parameters ---------- source : `file`, `str`, :class:`~ligo.lw.ligolw.Document`, `list` one or more open files, file paths, or LIGO_LW `Document`s Examples -------- >>> from gwpy.io.ligolw import list_tables >>> print(list_tables('H1-LDAS_STRAIN-968654552-10.xml.gz')) ['process', 'process_params', 'sngl_burst', 'search_summary', 'segment_definer', 'segment_summary', 'segment'] cSsg|]}||jqSr)rmr.)r+tblrrrr;vszlist_tables..)r)rhrrrrnhsrncCsdddlm}m}|dks"||jkr&|S|j|}ytj|||Stk r^|||SXdS)aCast a value to the correct type for inclusion in a LIGO_LW table This method returns the input unmodified if a type mapping for ``colname`` isn't found. Parameters ---------- val : `object` The input object to convert, of any type cls : `type`, subclass of :class:`~ligo.lw.table.Table` the table class to map against colname : `str` The name of the mapping column Returns ------- obj : `object` The input ``val`` cast to the correct type Examples -------- >>> from gwpy.io.ligolw import to_table_type as to_ligolw_type >>> from ligo.lw.lsctables import SnglBurstTable >>> x = to_ligolw_type(1.0, SnglBurstTable, 'central_freq')) >>> print(type(x), x) 1.0 r)rdrbN)rHrdrbr2reZ sctypeDictr3)valclsr8Z numpytypesZpytypesZllwtyperrr to_table_typeys rc Os|dk r|}|dzp|}|}y|toL|ttfStk r|t do|t dt dfSXWd||Xyddl m }Wnt k rdSXt |dkot|d|S)z1Identify a file object as LIGO_LW-format XML Nrzutf-8)r)tellseekreadlinelower startswith XML_SIGNATURELIGOLW_SIGNATURELIGOLW_ELEMENTr decoderNr ImportErrorrgr=) originfilepathfileobjr(r)locline1line2rrrr is_ligolws(     rc OsV|dk r@|}|dz|d}|tkS||Xn|dk rR|dSdS)z/Identify a file object as XML (any format) Nr)z.xmlz.xml.gz)rrreadrrr)rrrr(r)rsigrrris_xmls r)r)r)N)NNN)N)F)FFN),__doc__ros.path contextlibr functoolsr importlibrrerNrZLigolwElementErrorrrrrr Zutils.decoratorsr __author__rrrrrrrIrMrOrXrZrWrjruryrrrrrnrrrrrrrsT        @  8 T 1 - J2!