B d76@sdZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZdd lmZmZd Zd d gZGdd d ejZGdd d ejeZdS)z2Connection utilities for the GW datafind service. N)client)loads) HTTPError)urlparse)segments)api)get_default_host file_segmentz(Duncan Macleod HTTPConnectionHTTPSConnectionc@seZdZdZddejdfddZddZddZd!d d Z d d Z d"ddZ d#ddZ d$ddZ d%ddZddZd&ddZd'ddZdd ZdS)(r aConnect to a GWDataFind host using HTTP. .. warning:: This class is deprecated and will be removed in a future release. Use the functions from the :ref:`gwdatafind-top-api` instead. Parameters ---------- host : `str` the name of the server with which to connect. port : `int`, optional the port on which to connect. kwargs other keywords are passed directly to `http.client.HTTPConnection` NcKs6tdt|dkrt}tjj|||||f|dS)z!Create a new connection. zmthis class is deprecated and will be removed in a future release, please use the gwdatafind.ui module insteadN)warningswarnDeprecationWarningr http_clientr __init__)selfhostporttimeoutsource_addresskwargsr\/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/gwdatafind/http.pyr;szHTTPConnection.__init__cKsT|dsd|}|j||f||}|jdkrPt||j|j||j|S)aInternal method to perform request and verify reponse. Parameters ---------- method : `str` name of the method to use (e.g. ``'GET'``). url : `str` remote URL to query. kwargs other keyword arguments are passed to :meth:`http.client.HTTPConnection.request`. Returns ------- response : `str` reponse from server query Raises ------ RuntimeError if query is unsuccessful /) startswithrequest getresponsestatusrreason getheadersfp)rmethodurlrresponserrr_request_responseJs    z HTTPConnection._request_responsecKs0|jd|f|}t|tr(|d}t|S)aPerform a 'GET' request and return the decode the result as JSON Parameters ---------- url : `str` remote URL to query kwargs other keyword arguments are passed to :meth:`HTTPConnection._request_response` Returns ------- data : `object` JSON decoded using :func:`json.loads` GETzutf-8)r&read isinstancebytesdecoder)rr$rr%rrrget_jsonls  zHTTPConnection.get_jsonignorec sX|j|f|}r(ttfdd|}|sTd}|dkrDt|n|dkrTt||S)aPerform a 'GET' request and return a list of URLs. Parameters ---------- url : `str` remote URL to query scheme : `str`, `None`, optional the URL scheme to match, default: `None` on_missing : `str`, optional how to handle an empty (but successful) response, one of - ``'ignore'``: do nothing, return empty `list` - ``'warn'``: print warning, return empty `list` - ``'raise'``: raise `RuntimeError` kwargs other keyword arguments are passed to :meth:`HTTPConnection.get_json` Returns ------- urls : `list` of `str` a list of file paths as returned from the server. cst|jkS)N)rscheme)e)r.rrz)HTTPConnection.get_urls..zno files foundrr-)r,listfilterr r RuntimeError)rr$r. on_missingrurlserrr)r.rget_urlss zHTTPConnection.get_urlscCs|dtdS)z~Ping the LDR host to test for life. Raises ------ RuntimeError if the ping fails HEADr)r&rZ ping_path)rrrrpingszHTTPConnection.pingcs:t|t}|r2t|fdd|DSt|S)aQuery the LDR host for observatories. Parameters ---------- match : `str`, `re.Pattern` restrict returned observatories to those matching a regular expression. Returns ------- obs : `list` of `str` the list of known osbervatory prefices (and combinations) Examples -------- >>> from gwdatafind import connect >>> conn = connect() >>> conn.find_observatories() ['AGHLT', 'G', 'GHLTV', 'GHLV', 'GHT', 'H', 'HL', 'HLT', 'L', 'T', 'V', 'Z'] >>> conn.find_observatories("H") ['H', 'HL', 'HLT'] csg|]}|r|qSr)search).0site)regmatchrr sz5HTTPConnection.find_observatories..)setr,rZfind_observatories_pathrecompiler2)rmatchZsitelistr)r>rfind_observatoriess  z!HTTPConnection.find_observatoriescsBtj|d}t||}|r:t|fdd|DSt|S)aQuery the LDR host for frame types. Parameters ---------- site : `str` single-character name of site to match match : `str`, `re.Pattern` regular expression to match against known types Returns ------- types : `list` of `str` list of frame types Examples -------- >>> from gwdatafind import connect >>> conn = connect() >>> conn.find_types("L", "RDS") ['L1_RDS_C01_LX', 'L1_RDS_C02_LX', 'L1_RDS_C03_L2', 'L1_RDS_R_L1', 'L1_RDS_R_L3', 'L1_RDS_R_L4', 'PEM_RDS_A6', 'RDS_R_L1', 'RDS_R_L2', 'RDS_R_L3', 'TESTPEM_RDS_A6'] )r=csg|]}|r|qSr)r;)r<type_)r>rrr?sz-HTTPConnection.find_types..)rZfind_types_pathr@r,rArBr2)rr=rCpathZtypelistr)r>r find_typess !  zHTTPConnection.find_typescCs<t|||ptd|ptd}||}tttj|S)aQuery the LDR for times for which files are avaliable. Parameters ---------- site : `str` single-character name of site to match frametype : `str` name of frametype to match gpsstart : `int` GPS start time of query gpsend : `int` GPS end time of query Returns ------- segments : `ligo.segments.segmentlist` the list of `[start, stop)` intervals for which files are available. rgeA)rZfind_times_pathintr,r segmentlistmapsegment)rr= frametypegpsstartgpsendrFrIrrr find_timess  zHTTPConnection.find_timesfileerrorcCst|}|j|||dS)aQuery the LDR host for a single filename. Parameters ---------- framefile : `str` base name of file to match urltype : `str`, optional file scheme to search for, one of ``'file'``, ``'gsiftp'``, or `None`, default: 'file' on_missing : `str` what to do when the requested file isn't found, one of: - ``'warn'``: print a warning (default), - ``'error'``: raise a `RuntimeError`, or - ``'ignore'``: do nothing Returns ------- urls : `list` of `str` a list of structured file paths for all instances of ``filename``. )r.r5)rZ find_url_pathr8)rZ framefileurltyper5rFrrrfind_url s zHTTPConnection.find_urlcOstdt|j||S)zBDEPRECATED, use :meth:`~HTTPConnection.find_url` instead. z#find_frame() was renamed find_url())r rrrS)rargsrrrr find_frame;szHTTPConnection.find_framecCs tj|||d}|j|||dS)aQQuery for the most recent file of a given type. Parameters ---------- site : `str` single-character name of site to match frametype : `str` name of frametype to match urltype : `str`, optional file scheme to search for, one of 'file', 'gsiftp', or `None`, default: 'file' on_missing : `str`, optional what to do when the requested frame isn't found, one of: - ``'warn'`` print a warning (default), or - ``'error'``: raise a `RuntimeError`, or - ``'ignore'``: do nothing Returns ------- latest : `list` with one `str` the URLs of the latest file found (all file types) Raises ------ RuntimeError if no frames are found )rR)r.r5)rZfind_latest_pathr8)rr=rLrRr5rFrrr find_latestBs zHTTPConnection.find_latestrcCstj||||||d}||} |dkr,| St||} ttt| } t| g| } | sh| Sdd tt | } |dkrt | | St | dS)aFind all files of the given type in the [start, end) GPS interval. site : `str` single-character name of site to match frametype : `str` name of frametype to match gpsstart : `int` integer GPS start time of query gpsend : `int` integer GPS end time of query match : `str`, `re.Pattern`, optional regular expression to match against urltype : `str`, optional file scheme to search for, one of 'file', 'gsiftp', or `None`, default: 'file' on_gaps : `str`, optional what to do when the requested frame isn't found, one of: - ``'warn'`` print a warning (default), or - ``'error'``: raise a `RuntimeError`, or - ``'ignore'``: do nothing Returns ------- cache : `list` of `str` the list of discovered file URLs )rRrCr-zMissing segments: %s rN)rZfind_urls_pathr8rrKrIrJr Zcoalescejoinstrr rr4)rr=rLrMrNrCrRZon_gapsrFr6spanZseglistmissingmsgrrr find_urlses($   zHTTPConnection.find_urlscOstdt|j||S)zCDEPRECATED, use :meth:`~HTTPConnection.find_urls` instead. z)find_frame_urls() was renamed find_urls())r rrr])rrTrrrrfind_frame_urlsszHTTPConnection.find_frame_urls)Nr-)N)NN)NN)rPrQ)rPrQ)NrPr)__name__ __module__ __qualname____doc__socket_GLOBAL_DEFAULT_TIMEOUTrr&r,r8r:rDrGrOrSrUrVr]r^rrrrr (s" -  (  $ ?c@seZdZdZdddZdS)r aConnect to a GWDataFind host using HTTPS. .. warning:: This class is deprecated and will be removed in a future release. Use the functions from the :ref:`gwdatafind-top-api` instead. This requires a valid X509 credential registered with the remote host. Parameters ---------- host : `str` the name of the server with which to connect. port : `int`, optional the port on which to connect. kwargs other keywords are passed directly to `http.client.HTTPSConnection` NcKs,|dkrt}tjj||fd|i|dS)z!Create a new connection. Nr)r rr r)rrrrrrrrszHTTPSConnection.__init__)NN)r_r`rarbrrrrrr s)rbrArcr httprrjsonr urllib.errorr urllib.parserZligorrutilsr r __author____all__r r rrrrs"