ligo.raven.mock_gracedb

class ligo.raven.mock_gracedb.MockGraceDb(input)

Bases: object

Mock GraceDB class meant to be similar and callable like ligo.gracedb.rest.GraceDb but being populated by a given file, such as .csv.

Parameters:

input (str) – Path to file, such as .csv, to create mock GraceDB class from or data in JSON format

events(args)

Query mock database for external events.

Parameters:

args (str) – String to perform query, in the format of ‘group start_time .. end_time search pipeline far_cutoff’

Returns:

results – List of event dictonaries

Return type:

list

superevents(args)

Query mock database for superevents.

Parameters:

args (str) – String to perform query, in the format of ‘start_time .. end_time far_cutoff’

Returns:

results – List of superevent dictonaries

Return type:

list

superevent(graceid)

event(graceid)

files(graceid, filename, raw=True)

writeLog(*args, **kwargs)

class ligo.raven.mock_gracedb.File(file)

Bases: object

Load files by pointing to local path.

read()

class ligo.raven.mock_gracedb.mock_event(graceid, data=None)

Bases: object

Return event from mock database, as well as mock up other calls that could be performed for an individual event.

Parameters:

• graceid (str) – GraceDB ID

• data (Table) – Mock GraceDB database to populate result from

json()

class ligo.raven.mock_gracedb.mock_superevent(graceid, data=None)

Bases: object

Return superevent from mock database, as well as mock up other calls that could be performed for an individual superevent.

Parameters:

• graceid (str) – GraceDB ID

• data (Table) – Mock GraceDB database to populate result from

json()

ligo.raven.mock_gracedb.is_string_a_url(url_string)

Takes URL string and returns True or False whether a string is a URL.

ligo.raven.mock_gracedb.choose_gracedb(path)

Determine whether the input given is from an official GraceDB online

server or from a local file.

Parameters:

path (str) – Either GraceDB API URL or path to local local

Returns:

GraceDB – GraceDB class instance, either official online or mock offline

Return type:

class

ligo.raven.mock_gracedb.get_list_item(list, index)

Grab item from list at a given index, return None if missing.

ligo.raven.mock_gracedb.to_float(val)

Convert to float if present. If missing return None.

ligo.raven.mock_gracedb.to_str(val)

Convert to string if not None. If None return None.