File: test_simbad.py

package info (click to toggle)
astroquery 0.3.4%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 11,528 kB
  • ctags: 3,402
  • sloc: xml: 113,303; python: 21,713; makefile: 135; ansic: 88; sh: 46
file content (421 lines) | stat: -rw-r--r-- 18,037 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# Licensed under a 3-clause BSD style license - see LICENSE.rst
import os
import re
import requests

from astropy.extern import six
from astropy.tests.helper import pytest
import astropy.units as u
from astropy.table import Table
import numpy as np

from ... import simbad
from ...utils.testing_tools import MockResponse
from ...utils import commons
from ...exceptions import TableParseError

GALACTIC_COORDS = commons.GalacticCoordGenerator(l=-67.02084, b=-29.75447,
                                                 unit=(u.deg, u.deg))
ICRS_COORDS = commons.ICRSCoordGenerator("05h35m17.3s -05h23m28s")
FK4_COORDS = commons.FK4CoordGenerator(ra=84.90759, dec=-80.89403,
                                       unit=(u.deg, u.deg))
FK5_COORDS = commons.FK5CoordGenerator(ra=83.82207, dec=-80.86667,
                                       unit=(u.deg, u.deg))

DATA_FILES = {
    'id': 'query_id.data',
    'coo': 'query_coo.data',
    'cat': 'query_cat.data',
    'bibobj': 'query_bibobj.data',
    'bibcode': 'query_bibcode.data',
    'objectids': 'query_objectids.data',
    'error': 'query_error.data',
    'sample': 'query_sample.data',
    'region': 'query_sample_region.data',
}


class MockResponseSimbad(MockResponse):
    query_regex = re.compile(r'query\s+([a-z]+)\s+')

    def __init__(self, script, **kwargs):
        # preserve, e.g., headers
        super(MockResponseSimbad, self).__init__(**kwargs)
        self.content = self.get_content(script)

    def get_content(self, script):
        match = self.query_regex.search(script)
        if match:
            filename = DATA_FILES[match.group(1)]
            content = open(data_path(filename), "rb").read()
            return content


def data_path(filename):
    data_dir = os.path.join(os.path.dirname(__file__), 'data')
    return os.path.join(data_dir, filename)


@pytest.fixture
def patch_post(request):
    mp = request.getfixturevalue("monkeypatch")
    mp.setattr(requests, 'post', post_mockreturn)
    return mp


def post_mockreturn(url, data, timeout, **kwargs):
    response = MockResponseSimbad(data['script'], **kwargs)
    return response


@pytest.mark.parametrize(('radius', 'expected_radius'),
                         [('5d0m0s', '5.0d'),
                          ('5d', '5.0d'),
                          ('5.0d', '5.0d'),
                          (5 * u.deg, '5.0d'),
                          (5.0 * u.deg, '5.0d'),
                          (1.2 * u.deg, '1.2d'),
                          (0.5 * u.deg, '30.0m'),
                          ('0d1m12s', '1.2m'),
                          (0.003 * u.deg, '10.8s'),
                          ('0d0m15s', '15.0s')
                          ])
def test_parse_radius(radius, expected_radius):
    actual = simbad.core._parse_radius(radius)
    assert actual == expected_radius


@pytest.mark.parametrize(('ra', 'dec', 'expected_ra', 'expected_dec'),
                         [(ICRS_COORDS.ra, ICRS_COORDS.dec, u'5:35:17.3',
                           u'-80:52:00')
                          ])
def test_to_simbad_format(ra, dec, expected_ra, expected_dec):
    actual_ra, actual_dec = simbad.core._to_simbad_format(ra, dec)
    assert (actual_ra, actual_dec) == (expected_ra, expected_dec)


@pytest.mark.parametrize(('coordinates', 'expected_frame'),
                         [(GALACTIC_COORDS, 'GAL'),
                          (ICRS_COORDS, 'ICRS'),
                          (FK4_COORDS, 'FK4'),
                          (FK5_COORDS, 'FK5')
                          ])
def test_get_frame_coordinates(coordinates, expected_frame):
    actual_frame = simbad.core._get_frame_coords(coordinates)[2]
    assert actual_frame == expected_frame
    if actual_frame == 'GAL':
        l, b = simbad.core._get_frame_coords(coordinates)[:2]
        np.testing.assert_almost_equal(float(l) % 360, -67.02084 % 360)
        np.testing.assert_almost_equal(float(b), -29.75447)


def test_parse_result():
    result1 = simbad.core.Simbad._parse_result(
        MockResponseSimbad('query id '), simbad.core.SimbadVOTableResult)
    assert isinstance(result1, Table)
    with pytest.raises(TableParseError) as ex:
        simbad.core.Simbad._parse_result(MockResponseSimbad('query error '),
                                         simbad.core.SimbadVOTableResult)
    assert str(ex.value) == ('Failed to parse SIMBAD result! The raw response '
                             'can be found in self.last_response, and the '
                             'error in self.last_table_parse_error. '
                             'The attempted parsed result is in '
                             'self.last_parsed_result.\n Exception: 7:115: '
                             'no element found')
    assert isinstance(simbad.Simbad.last_response.text, six.string_types)
    assert isinstance(simbad.Simbad.last_response.content, six.binary_type)

votable_fields = ",".join(simbad.core.Simbad.get_votable_fields())


@pytest.mark.parametrize(('args', 'kwargs', 'expected_script'),
                         [([ICRS_COORDS], dict(radius=5.0 * u.deg,
                                               frame='ICRS',
                                               equinox=2000.0, epoch='J2000',
                                               caller='query_region_async'),
                           ("\nvotable {" + votable_fields + "}\n"
                            "votable open\n"
                            "query coo  5:35:17.3 -80:52:00 "
                            "radius=5.0d frame=ICRS equi=2000.0 epoch=J2000 \n"
                            "votable close")),
                          (["m [0-9]"], dict(wildcard=True,
                                             caller='query_object_async'),
                           ("\nvotable {" + votable_fields + "}\n"
                            "votable open\n"
                            "query id wildcard m [0-9]  \n"
                            "votable close"
                            )),
                          (["2006ApJ"], dict(caller='query_bibcode_async',
                                             get_raw=True),
                           ("\n\n\nquery bibcode  2006ApJ  \n"))
                          ])
def test_args_to_payload(args, kwargs, expected_script):
    script = simbad.Simbad._args_to_payload(*args, **kwargs)['script']
    assert script == expected_script


@pytest.mark.parametrize(('epoch', 'equinox'),
                         [(2000, 'thousand'),
                          ('J-2000', None),
                          (None, '10e3')
                          ])
def test_args_to_payload_validate(epoch, equinox):
    with pytest.raises(Exception):
        simbad.Simbad._args_to_payload(caller='query_region_async',
                                       epoch=epoch, equinox=equinox)


@pytest.mark.parametrize(('bibcode', 'wildcard'),
                         [('2006ApJ*', True),
                          ('2005A&A.430.165F', None)
                          ])
def test_query_bibcode_async(patch_post, bibcode, wildcard):
    response1 = simbad.core.Simbad.query_bibcode_async(bibcode,
                                                       wildcard=wildcard)
    response2 = simbad.core.Simbad().query_bibcode_async(bibcode,
                                                         wildcard=wildcard)
    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


def test_query_bibcode_class(patch_post):
    result1 = simbad.core.Simbad.query_bibcode("2006ApJ*", wildcard=True)
    assert isinstance(result1, Table)


def test_query_bibcode_instance(patch_post):
    S = simbad.core.Simbad()
    result2 = S.query_bibcode("2006ApJ*", wildcard=True)
    assert isinstance(result2, Table)


def test_query_objectids_async(patch_post):
    response1 = simbad.core.Simbad.query_objectids_async('Polaris')
    response2 = simbad.core.Simbad().query_objectids_async('Polaris')
    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


def test_query_objectids(patch_post):
    result1 = simbad.core.Simbad.query_objectids('Polaris')
    result2 = simbad.core.Simbad().query_objectids('Polaris')
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


def test_query_bibobj_async(patch_post):
    response1 = simbad.core.Simbad.query_bibobj_async('2005A&A.430.165F')
    response2 = simbad.core.Simbad().query_bibobj_async('2005A&A.430.165F')
    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


def test_query_bibobj(patch_post):
    result1 = simbad.core.Simbad.query_bibobj('2005A&A.430.165F')
    result2 = simbad.core.Simbad().query_bibobj('2005A&A.430.165F')
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


def test_query_catalog_async(patch_post):
    response1 = simbad.core.Simbad.query_catalog_async('m')
    response2 = simbad.core.Simbad().query_catalog_async('m')
    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


def test_query_catalog(patch_post):
    result1 = simbad.core.Simbad.query_catalog('m')
    result2 = simbad.core.Simbad().query_catalog('m')
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


@pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
                         [(ICRS_COORDS, None, None, None),
                          (GALACTIC_COORDS, 5 * u.deg, 2000.0, 'J2000'),
                          (FK4_COORDS, '5d0m0s', None, None),
                          (FK5_COORDS, None, None, None)
                          ])
def test_query_region_async(patch_post, coordinates, radius, equinox, epoch):
    response1 = simbad.core.Simbad.query_region_async(
        coordinates, radius=radius, equinox=equinox, epoch=epoch)

    response2 = simbad.core.Simbad().query_region_async(
        coordinates, radius=radius, equinox=equinox, epoch=epoch)

    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


@pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
                         [(ICRS_COORDS, None, None, None),
                          (GALACTIC_COORDS, 5 * u.deg, 2000.0, 'J2000'),
                          (FK4_COORDS, '5d0m0s', None, None),
                          (FK5_COORDS, None, None, None)
                          ])
def test_query_region(patch_post, coordinates, radius, equinox, epoch):
    result1 = simbad.core.Simbad.query_region(coordinates, radius=radius,
                                              equinox=equinox, epoch=epoch)
    result2 = simbad.core.Simbad().query_region(coordinates, radius=radius,
                                                equinox=equinox, epoch=epoch)
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


@pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
                         [(ICRS_COORDS, 0, None, None)])
def test_query_region_radius_error(patch_post, coordinates, radius,
                                   equinox, epoch):
    with pytest.raises(u.UnitsError):
        simbad.core.Simbad.query_region(
            coordinates, radius=radius, equinox=equinox, epoch=epoch)

    with pytest.raises(u.UnitsError):
        simbad.core.Simbad().query_region(
            coordinates, radius=radius, equinox=equinox, epoch=epoch)


@pytest.mark.parametrize(('coordinates', 'radius', 'equinox', 'epoch'),
                         [(ICRS_COORDS, "0d", None, None),
                          (GALACTIC_COORDS, 1.0 * u.marcsec, 2000.0, 'J2000')
                          ])
def test_query_region_small_radius(patch_post, coordinates, radius,
                                   equinox, epoch):
    result1 = simbad.core.Simbad.query_region(coordinates, radius=radius,
                                              equinox=equinox, epoch=epoch)
    result2 = simbad.core.Simbad().query_region(coordinates, radius=radius,
                                                equinox=equinox, epoch=epoch)
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


@pytest.mark.parametrize(('object_name', 'wildcard'),
                         [("m1", None),
                          ("m [0-9]", True)
                          ])
def test_query_object_async(patch_post, object_name, wildcard):
    response1 = simbad.core.Simbad.query_object_async(object_name,
                                                      wildcard=wildcard)
    response2 = simbad.core.Simbad().query_object_async(object_name,
                                                        wildcard=wildcard)
    assert response1 is not None and response2 is not None
    assert response1.content == response2.content


@pytest.mark.parametrize(('object_name', 'wildcard'),
                         [("m1", None),
                          ("m [0-9]", True),
                          ])
def test_query_object(patch_post, object_name, wildcard):
    result1 = simbad.core.Simbad.query_object(object_name,
                                              wildcard=wildcard)
    result2 = simbad.core.Simbad().query_object(object_name,
                                                wildcard=wildcard)
    assert isinstance(result1, Table)
    assert isinstance(result2, Table)


def test_list_votable_fields():
    simbad.core.Simbad.list_votable_fields()
    simbad.core.Simbad().list_votable_fields()


def test_get_field_description():
    simbad.core.Simbad.get_field_description('bibcodelist(y1-y2)')
    simbad.core.Simbad().get_field_description('bibcodelist(y1-y2)')
    with pytest.raises(Exception):
        simbad.core.Simbad.get_field_description('xyz')


def test_votable_fields():
    simbad.core.Simbad.add_votable_fields('rot', 'ze', 'z')
    assert (set(simbad.core.Simbad.get_votable_fields()) ==
            set(['main_id', 'coordinates', 'rot', 'ze', 'z']))
    try:
        simbad.core.Simbad.add_votable_fields('z')
    except KeyError:
        pass  # this is the expected response
    assert (set(simbad.core.Simbad.get_votable_fields()) ==
            set(['main_id', 'coordinates', 'rot', 'ze', 'z']))
    simbad.core.Simbad.remove_votable_fields('rot', 'main_id', 'coordinates')
    assert set(simbad.core.Simbad.get_votable_fields()) == set(['ze', 'z'])
    simbad.core.Simbad.remove_votable_fields('rot', 'main_id', 'coordinates')
    assert set(simbad.core.Simbad.get_votable_fields()) == set(['ze', 'z'])
    simbad.core.Simbad.remove_votable_fields('ze', 'z')
    assert (set(simbad.core.Simbad.get_votable_fields()) ==
            set(['main_id', 'coordinates']))
    simbad.core.Simbad.add_votable_fields('rot', 'ze', 'z')
    simbad.core.Simbad.reset_votable_fields()
    assert (set(simbad.core.Simbad.get_votable_fields()) ==
            set(['main_id', 'coordinates']))


def test_query_criteria1(patch_post):
    result = simbad.core.Simbad.query_criteria(
        "region(box, GAL, 49.89 -0.3, 0.5d 0.5d)", otype='HII')
    assert isinstance(result, Table)


def test_query_criteria2(patch_post):
    S = simbad.core.Simbad()
    S.add_votable_fields('ra(d)', 'dec(d)')
    S.remove_votable_fields('coordinates')
    assert S.get_votable_fields() == ['main_id', 'ra(d)', 'dec(d)']
    result = S.query_criteria(otype='SNR')
    assert isinstance(result, Table)


def test_simbad_settings1():
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']
    simbad.core.Simbad.add_votable_fields('ra', 'dec(5)')
    simbad.core.Simbad.remove_votable_fields('ra', 'dec')
    assert (simbad.Simbad.get_votable_fields() ==
            ['main_id', 'coordinates', 'dec(5)'])
    simbad.core.Simbad.reset_votable_fields()


def test_simbad_settings2():
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']
    simbad.core.Simbad.add_votable_fields('ra', 'dec(5)')
    simbad.core.Simbad.remove_votable_fields('ra', 'dec', strip_params=True)
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']


def test_regression_votablesettings():
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']
    simbad.core.Simbad.add_votable_fields('ra', 'dec(5)')
    with pytest.raises(KeyError) as ex:
        simbad.core.Simbad.add_votable_fields('ra(d)', 'dec(d)')
    assert ex.value.args[0] == ('ra(d): field already present. Fields '
                                'ra,dec,id,otype, and bibcodelist can only '
                                'be specified once.  To change their options, '
                                'first remove the existing entry, then add '
                                'a new one.')
    # cleanup
    simbad.core.Simbad.remove_votable_fields('ra', 'dec', strip_params=True)
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']


def test_regression_votablesettings2():
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']
    simbad.core.Simbad.add_votable_fields('fluxdata(J)')
    simbad.core.Simbad.add_votable_fields('fluxdata(H)')
    simbad.core.Simbad.add_votable_fields('fluxdata(K)')
    assert (simbad.Simbad.get_votable_fields() ==
            ['main_id', 'coordinates',
             'fluxdata(J)', 'fluxdata(H)', 'fluxdata(K)'])
    simbad.core.Simbad.remove_votable_fields('fluxdata', strip_params=True)
    assert simbad.Simbad.get_votable_fields() == ['main_id', 'coordinates']


def test_regression_issue388():
    # This is a python-3 issue: content needs to be decoded?
    response = MockResponseSimbad('\nvotable {main_id,coordinates}\nvotable '
                                  'open\nquery id  m1  \nvotable close')
    with open(data_path('m1.data'), "rb") as f:
        response.content = f.read()
    parsed_table = simbad.Simbad._parse_result(response,
                                               simbad.core.SimbadVOTableResult)
    assert parsed_table['MAIN_ID'][0] == b'M   1'
    assert len(parsed_table) == 1