def test_get_waveforms_bulk(self):
# Some mock routing response.
content = """
http://example1.com/fdsnws/station/1/query
AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
http://example2.com/fdsnws/station/1/query
AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
"""
if hasattr(content, "encode"):
content = content.encode()
with mock.patch(self._cls + "._download") as p1, \
mock.patch(self._cls + "._download_waveforms") as p2, \
mock.patch(self._cls + ".get_stations_bulk") as p3:
p1.return_value = _DummyResponse(content=content)
p2.return_value = "1234"
# For the underlying get_stations_bulk() call.
_dummy_inv = mock.MagicMock()
_dummy_inv.get_contents.return_value = {
"channels": ["AA.BB.CC.DD", "AA.BB.CC.DD"]}
p3.return_value = _dummy_inv
st = self.client.get_waveforms_bulk(
[["AA", "B*", "", "DD", obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)]],
longestonly=True, minimumlength=2)
self.assertEqual(st, "1234")
self.assertEqual(p1.call_count, 1)
self.assertEqual(p1.call_args[0][0],
"http://www.orfeus-eu.org/eidaws/routing/1/query")
# This has been modified by our mocked call to get_stations_bulk().
self.assertEqual(p1.call_args[1]["data"], (
b"service=dataselect\nformat=post\n"
b"AA BB CC DD 2017-01-01T00:00:00.000000 "
b"2017-01-02T00:00:00.000000"))
# This is the final call to _download_waveforms() which is again
# dependent on the dummy response to the _download() function.
self.assertEqual(p2.call_args[0][0], {
"http://example1.com":
"AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00",
"http://example2.com":
"AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00"})
self.assertEqual(p2.call_args[1],
{"longestonly": True, "minimumlength": 2})
# Call to this only dependent on the original bulk request.
self.assertEqual(p3.call_count, 1)
self.assertEqual(p3.call_args[0][0][0],
["AA", "B*", "--", "DD",
str(obspy.UTCDateTime(2017, 1, 1))[:-1],
str(obspy.UTCDateTime(2017, 1, 2))[:-1]])
# Everything should be passed on.
self.assertEqual(p3.call_args[1], {
"format": "text", "level": "channel", "longestonly": True,
"minimumlength": 2})
def test_downloading_waveforms(self):
split = {
"https://example.com": "1234",
"http://example2.com": "1234",
"http://example3.com": "1234",
"http://service.iris.edu": "1234"
}
with mock.patch("obspy.clients.fdsn.client.Client") as p:
mock_instance = p.return_value
mock_instance.get_waveforms_bulk.return_value = obspy.read()
# Only accept test1 as a an argument.
mock_instance.services = {"dataselect": {"test1": True}}
c = self._cls_object(debug=False, timeout=240)
# test2 should not be passed on.
st = c._download_waveforms(split=split, test1="a", test2="b")
self.assertEqual(len(st), 12)
# Test initialization.
self.assertEqual(p.call_count, 4)
self.assertEqual(set(_i[0][0] for _i in p.call_args_list),
set(split.keys()))
self.assertEqual(set(_i[1]["debug"] for _i in p.call_args_list),
set([False]))
self.assertEqual(set(_i[1]["timeout"] for _i in p.call_args_list),
set([240]))
# Waveform download.
wf_bulk = mock_instance.get_waveforms_bulk
self.assertEqual(wf_bulk.call_count, 4)
self.assertEqual(set(_i[0][0] for _i in wf_bulk.call_args_list),
set(["test1=a\n1234"]))
for _i in wf_bulk.call_args_list:
self.assertEqual(_i[1], {})
# Once again, but raising exceptions this time.
with mock.patch("obspy.clients.fdsn.client.Client") as p:
mock_instance = p.return_value
mock_instance.get_waveforms_bulk.side_effect = \
FDSNNoDataException("No data")
# Only accept test1 as a an argument.
mock_instance.services = {"dataselect": {"test1": True}}
c = self._cls_object(debug=False, timeout=240)
# test2 should not be passed on.
st = c._download_waveforms(split=split, test1="a", test2="b")
self.assertEqual(len(st), 0)
# Provider filtering might result in no data left.
c.include_providers = "http://random.com"
with self.assertRaises(FDSNNoDataException) as e:
c._download_waveforms(split=split, test1="a", test2="b")
self.assertEqual(
e.exception.args[0],
"Nothing remains to download after the provider "
"inclusion/exclusion filters have been applied.")
def test_get_stations_bulk(self):
# Some mock routing response.
content = """
DATACENTER=GEOFON,http://geofon.gfz-potsdam.de
DATASELECTSERVICE=http://geofon.gfz-potsdam.de/fdsnws/dataselect/1/
STATIONSERVICE=http://geofon.gfz-potsdam.de/fdsnws/station/1/
AF CER -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00
AF CVNA -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00
DATACENTER=IRISDMC,http://ds.iris.edu
DATASELECTSERVICE=http://service.iris.edu/fdsnws/dataselect/1/
STATIONSERVICE=http://service.iris.edu/fdsnws/station/1/
EVENTSERVICE=http://service.iris.edu/fdsnws/event/1/
SACPZSERVICE=http://service.iris.edu/irisws/sacpz/1/
RESPSERVICE=http://service.iris.edu/irisws/resp/1/
AF CNG -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00
AK CAPN -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00
"""
if hasattr(content, "encode"):
content = content.encode()
with mock.patch(self._cls + "._download") as p1, \
mock.patch(self._cls + "._download_stations") as p2:
p1.return_value = _DummyResponse(content=content)
p2.return_value = "1234"
st = self.client.get_stations_bulk(
[["A*", "C*", "", "LHZ", obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)]],
level="network")
self.assertEqual(st, "1234")
self.assertEqual(p1.call_count, 1)
self.assertEqual(p1.call_args[0][0],
"http://service.iris.edu/irisws/fedcatalog/1/query")
self.assertEqual(p1.call_args[1]["data"], (
b"level=network\n"
b"format=request\n"
b"A* C* -- LHZ 2017-01-01T00:00:00.000000 "
b"2017-01-02T00:00:00.000000"))
self.assertEqual(p2.call_args[0][0], {
"http://geofon.gfz-potsdam.de": (
"AF CER -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00\n"
"AF CVNA -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00"),
"http://service.iris.edu": (
"AF CNG -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00\n"
"AK CAPN -- LHZ 2017-01-01T00:00:00 2017-01-02T00:00:00")})
self.assertEqual(p2.call_args[1],
{"level": "network"})
def test_downloading_stations(self):
split = {
"https://example.com": "1234",
"http://example2.com": "1234",
"http://example3.com": "1234",
"http://service.iris.edu": "1234"
}
with mock.patch("obspy.clients.fdsn.client.Client") as p:
mock_instance = p.return_value
mock_instance.get_stations_bulk.return_value = \
obspy.Inventory([], "")
# Only accept test1 as a an argument.
mock_instance.services = {"station": {"test1": True}}
c = self._cls_object(debug=False, timeout=240)
# test2 should not be passed on.
c._download_stations(split=split, test1="a", test2="b")
# Test initialization.
self.assertEqual(p.call_count, 4)
self.assertEqual(set(_i[0][0] for _i in p.call_args_list),
set(split.keys()))
self.assertEqual(set(_i[1]["debug"] for _i in p.call_args_list),
set([False]))
self.assertEqual(set(_i[1]["timeout"] for _i in p.call_args_list),
set([240]))
# Station download.
wf_bulk = mock_instance.get_stations_bulk
self.assertEqual(wf_bulk.call_count, 4)
self.assertEqual(set(_i[0][0] for _i in wf_bulk.call_args_list),
set(["test1=a\n1234"]))
for _i in wf_bulk.call_args_list:
self.assertEqual(_i[1], {})
def test_unexpected_exception_handling(self):
split = {
"https://example.com": "1234"
}
with mock.patch("obspy.clients.fdsn.client.Client") as p:
mock_instance = p.return_value
mock_instance.get_stations_bulk.side_effect = ValueError("random")
c = self._cls_object(debug=False, timeout=240)
# Should not fail, but a warning should be raised.
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
inv = c._download_stations(split=split)
# Returns an empty inventory.
self.assertIsInstance(inv, obspy.core.inventory.Inventory)
self.assertEqual(len(inv), 0)
# Raises a nice warning.
self.assertEqual(len(w), 1)
msg = w[0].message.args[0]
self.assertTrue(msg.startswith(
"Failed to download data of type 'station' from "
"'https://example.com' due to:"))
self.assertIn("ValueError: random", msg)
def test_get_waveforms(self):
"""
This just dispatches to the get_waveforms_bulk() method - so no need
to also test it explicitly.
"""
with mock.patch(self._cls + ".get_waveforms_bulk") as p:
p.return_value = "1234"
st = self.client.get_waveforms(
network="XX", station="XXXXX", location="XX",
channel="XXX", starttime=obspy.UTCDateTime(2017, 1, 1),
endtime=obspy.UTCDateTime(2017, 1, 2),
latitude=1.0, longitude=2.0,
longestonly=True, minimumlength=2)
self.assertEqual(st, "1234")
self.assertEqual(p.call_count, 1)
self.assertEqual(
p.call_args[0][0][0],
["XX", "XXXXX", "XX", "XXX", obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)])
# SNCLs + times should be filtered out.
self.assertEqual(p.call_args[1],
{"longestonly": True,
"minimumlength": 2, "latitude": 1.0,
"longitude": 2.0})
# Don't pass in the SNCLs.
with mock.patch(self._cls + ".get_waveforms_bulk") as p:
p.return_value = "1234"
st = self.client.get_waveforms(
starttime=obspy.UTCDateTime(2017, 1, 1),
endtime=obspy.UTCDateTime(2017, 1, 2),
latitude=1.0, longitude=2.0,
longestonly=True, minimumlength=2)
self.assertEqual(st, "1234")
self.assertEqual(p.call_count, 1)
self.assertEqual(
p.call_args[0][0][0],
["*", "*", "*", "*", obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)])
self.assertEqual(p.call_args[1],
{"longestonly": True,
"minimumlength": 2, "latitude": 1.0,
"longitude": 2.0})
def test_source_mechanisms_mock(self):
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
with mock.patch("requests.get") as p:
p.return_value = r
self.c.get_waveforms(model="ak135f_5s",
sourcemomenttensor=[1, 2, 3, 4, 5, 6])
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"model": native_str("ak135f_5s"),
"format": native_str("miniseed"),
"sourcemomenttensor": "1,2,3,4,5,6"})
with mock.patch("requests.get") as p:
p.return_value = r
self.c.get_waveforms(model="ak135f_5s",
sourcedoublecouple=[1, 2, 3, 4])
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"model": native_str("ak135f_5s"),
"format": native_str("miniseed"),
"sourcedoublecouple": "1,2,3,4"})
with mock.patch("requests.get") as p:
p.return_value = r
self.c.get_waveforms(model="ak135f_5s",
sourceforce=[3.32, 4.23, 5.11])
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"model": native_str("ak135f_5s"),
"format": native_str("miniseed"),
"sourceforce": "3.32,4.23,5.11"})
def test_get_available_models_mock(self):
with mock.patch("requests.get") as p:
p.return_value = RequestsMockResponse()
self.c.get_available_models()
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
'http://service.iris.edu/irisws/syngine/1/models')
self.assertEqual(p.call_args[1]["params"], None)
self.assertEqual(p.call_args[1]["headers"],
{'User-Agent': DEFAULT_TESTING_USER_AGENT})
def test_get_stations_bulk(self):
# Some mock routing response.
content = """
http://example1.com/fdsnws/station/1/query
AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
http://example2.com/fdsnws/station/1/query
AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
"""
if hasattr(content, "encode"):
content = content.encode()
with mock.patch(self._cls + "._download") as p1, \
mock.patch(self._cls + "._download_stations") as p2:
p1.return_value = _DummyResponse(content=content)
p2.return_value = "1234"
inv = self.client.get_stations_bulk(
[["AA", "B*", "", "DD", obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)]],
latitude=0.0, longitude=1.0,
starttime=obspy.UTCDateTime(2017, 1, 1))
self.assertEqual(inv, "1234")
self.assertEqual(p1.call_count, 1)
self.assertEqual(p1.call_args[0][0],
"http://www.orfeus-eu.org/eidaws/routing/1/query")
self.assertEqual(p1.call_args[1]["data"], (
b"service=station\nformat=post\nalternative=false\n"
b"AA B* -- DD 2017-01-01T00:00:00.000000 "
b"2017-01-02T00:00:00.000000"))
self.assertEqual(p2.call_args[0][0], {
"http://example1.com":
"AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00",
"http://example2.com":
"AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00"})
# Only select parameters are passed on.
self.assertEqual(p2.call_args[1], {
"longitude": 1.0, "latitude": 0.0,
"starttime": obspy.UTCDateTime(2017, 1, 1)})
def test_auto_file_format_during_writing(self):
"""
The file format is either determined by directly specifying the
format or deduced from the filename. The former overwrites the latter.
"""
# Get format name and name of the write function.
formats = [(key, value.module_name) for key, value in
_get_default_eps('obspy.plugin.waveform',
'writeFormat').items()
# Only test plugins that are actually part of ObsPy.
if value.dist.key == "obspy"]
# Test for stream as well as for trace.
stream_trace = [read(), read()[0]]
for suffix, module_name in formats:
# A bit of magic to get the fully qualified function name...
fct_name = module_name + "." + load_entry_point(
"obspy",
"obspy.plugin.waveform.%s" % suffix,
"writeFormat").__name__
# For stream and trace.
for obj in stream_trace:
# Various versions of the suffix.
for s in [suffix.capitalize(), suffix.lower(), suffix.upper()]:
with mock.patch(fct_name) as p:
obj.write("temp." + s)
# Make sure the fct has actually been called.
self.assertEqual(p.call_count, 1)
# Manually specifying the format name should overwrite
# this.
with mock.patch("obspy.io.mseed.core._write_mseed") as p:
obj.write("temp." + s, format="mseed")
self.assertEqual(p.call_count, 1)
# An unknown suffix should raise.
with self.assertRaises(TypeError):
for obj in stream_trace:
obj.write("temp.random_suffix")
def test_entry_point_buffer(self):
"""
Ensure the entry point buffer caches results from load_entry_point
"""
with mock.patch.dict(_ENTRY_POINT_CACHE, clear=True):
with mock.patch('obspy.core.util.misc.load_entry_point') as p:
# raises UserWarning: No matching response information found.
with warnings.catch_warnings(record=True):
warnings.simplefilter('ignore', UserWarning)
st = read()
st.write('temp.mseed', 'mseed')
self.assertEqual(len(_ENTRY_POINT_CACHE), 3)
self.assertEqual(p.call_count, 3)
def test_get_stations(self):
# Some mock routing response.
content = """
http://example1.com/fdsnws/station/1/query
AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
http://example2.com/fdsnws/station/1/query
AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
"""
if hasattr(content, "encode"):
content = content.encode()
with mock.patch(self._cls + "._download") as p1, \
mock.patch(self._cls + "._download_stations") as p2:
p1.return_value = _DummyResponse(content=content)
p2.return_value = "1234"
inv = self.client.get_stations(
network="AA", channel="DD",
starttime=obspy.UTCDateTime(2017, 1, 1), latitude=0.0,
longitude=1.0)
self.assertEqual(inv, "1234")
self.assertEqual(p1.call_count, 1)
self.assertEqual(p1.call_args[0][0],
"http://www.orfeus-eu.org/eidaws/routing/1/query")
# Only a few arguments should be part of the URL.
self.assertEqual(p1.call_args[1], {
'data': b'service=station\nformat=post\nalternative=false\n'
b'AA * * DD 2017-01-01T00:00:00.000000 *'})
self.assertEqual(p2.call_args[0][0], {
"http://example1.com":
"AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00",
"http://example2.com":
"AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00"})
# SNCL and times should be filtered out.
self.assertEqual(p2.call_args[1], {
"longitude": 1.0, "latitude": 0.0})
def test_get_service_version_mock(self):
with mock.patch("requests.get") as p:
p.return_value = RequestsMockResponse()
p.return_value.text = "1.2.3"
version = self.c.get_service_version()
self.assertEqual(version, "1.2.3")
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
'http://service.iris.edu/irisws/syngine/1/version')
self.assertEqual(p.call_args[1]["params"], None)
self.assertEqual(p.call_args[1]["headers"],
{'User-Agent': DEFAULT_TESTING_USER_AGENT})
def test_get_matplotlib_version(self):
"""
Tests for the get_matplotlib_version() function as it continues to
cause problems.
"""
versions = (("1.2.3", [1, 2, 3]), ("0.9.11", [0, 9, 11]),
("0.9.svn", [0, 9, 0]), ("1.1.1~rc1-1", [1, 1, 1]),
("1.2.x", [1, 2, 0]), ("1.3.1rc2", [1, 3, 1]))
for version_string, expected in versions:
with mock.patch('pkg_resources.get_distribution') as p:
class _D(object):
version = version_string
p.return_value = _D()
got = get_dependency_version('matplotlib')
self.assertEqual(expected, got)
def test_mock_read_inventory_http_errors(self):
"""
Tests HTTP Error on 204, 400, and 500
"""
url = "http://obspy.org"
for response_tuple in [("204", "No Content"), ("400", "Bad Request"),
("500", "Internal Server Error")]:
code = response_tuple[0]
reason = response_tuple[1]
with mock.patch("requests.get") as mocked_get:
mocked_get.return_value.status_code = code
mocked_get.return_value.reason = reason
with self.assertRaises(HTTPError) as e:
download_to_file(url, None)
self.assertEqual(e.exception.args[0],
"%s HTTP Error: %s for url: %s" %
(code, reason, url))
def test_get_model_info_mock(self):
"""
Mock test for the get_model_info() method.
"""
with mock.patch("requests.get") as p:
r = RequestsMockResponse()
r._json["slip"] = [0.0, 1.0, 2.0]
r._json["sliprate"] = [0.0, 1.0, 2.0]
p.return_value = r
self.c.get_model_info("test_model")
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
'http://service.iris.edu/irisws/syngine/1/info')
self.assertEqual(p.call_args[1]["params"],
{'model': 'test_model'})
self.assertEqual(p.call_args[1]["headers"],
{'User-Agent': DEFAULT_TESTING_USER_AGENT})
def test_bulk_waveform_send_custom_payload(self):
"""
The get_waveforms_bulk() method can send a custom payload.
"""
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
payload = []
def side_effect(*args, **kwargs):
payload[:] = [kwargs["data"]]
return r
# Test simple lists first.
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(
model="ak135f_5s", bulk=[], data=b"1234\n5678")
self.assertEqual(payload[0], b"1234\n5678")
def test_location_parameters(self):
"""
Tests how the variety of location values are handled.
Why location? Mostly because it is one tricky parameter. It is not
uncommon to assume that a non-existent location is "--", but in reality
"--" is "<space><space>". This substitution exists because mostly
because various applications have trouble digesting spaces (spaces in
the URL, for example).
The confusion begins when location is treated as empty instead, which
would imply "I want all locations" instead of "I only want locations of
<space><space>"
"""
# requests with no specified location should be treated as a wildcard
self.assertFalse("--" in build_url(
"http://service.iris.edu", "station", 1, "query", {
"network": "IU",
"station": "ANMO",
"starttime": "2013-01-01"
}))
# location of " " is the same as "--"
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": " "}),
"http://service.iris.edu/fdsnws/station/1/query?location=--")
# wildcard locations are valid. Will be encoded.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": "*"}),
"http://service.iris.edu/fdsnws/station/1/query?location=%2A")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": "A?"}),
"http://service.iris.edu/fdsnws/station/1/query?location=A%3F")
# lists are valid, including <space><space> lists. Again encoded
# result.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": " ,1?,?0"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=--%2C1%3F%2C%3F0")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": "1?,--,?0"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=1%3F%2C--%2C%3F0")
# Test all three special cases with empty parameters into lists.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": " ,AA,BB"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=--%2CAA%2CBB")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": "AA, ,BB"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=AA%2C--%2CBB")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1, "query",
{"location": "AA,BB, "}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=AA%2CBB%2C--")
# The location parameter is also passed through the
# _create_url_from_parameters() method and thus has to survive it!
# This guards against a regression where all empty location codes
# where removed by this function!
for service in ["station", "dataselect"]:
for loc in [
"", " ", " ", "--", b"", b" ", b" ", b"--", u"", u" ",
u" ", u"--"
]:
self.assertIn(
"location=--",
self.client._create_url_from_parameters(
service, [], {
"location": loc,
"starttime": 0,
"endtime": 1
}))
# Also check the full call with a mock test.
for loc in [
"", " ", " ", "--", b"", b" ", b" ", b"--", u"", u" ", u" ",
u"--"
]:
with mock.patch("obspy.clients.fdsn.Client._download") as p:
try:
self.client.get_stations(0, 0, location=loc)
except:
pass
self.assertEqual(p.call_count, 1)
self.assertIn("location=--", p.call_args[0][0])
with mock.patch("obspy.clients.fdsn.Client._download") as p:
try:
self.client.get_waveforms(1, 2, loc, 4, 0, 0)
except:
pass
self.assertEqual(p.call_count, 1)
self.assertIn("location=--", p.call_args[0][0])
def test_get_waveforms_bulk(self):
# Some mock routing response.
content = """
http://example1.com/fdsnws/station/1/query
AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
http://example2.com/fdsnws/station/1/query
AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00
"""
if hasattr(content, "encode"):
content = content.encode()
with mock.patch(self._cls + "._download") as p1, \
mock.patch(self._cls + "._download_waveforms") as p2, \
mock.patch(self._cls + ".get_stations_bulk") as p3:
p1.return_value = _DummyResponse(content=content)
p2.return_value = "1234"
# For the underlying get_stations_bulk() call.
_dummy_inv = mock.MagicMock()
_dummy_inv.get_contents.return_value = {
"channels": ["AA.BB.CC.DD", "AA.BB.CC.DD"]
}
p3.return_value = _dummy_inv
st = self.client.get_waveforms_bulk([[
"AA", "B*", "", "DD",
obspy.UTCDateTime(2017, 1, 1),
obspy.UTCDateTime(2017, 1, 2)
]],
longestonly=True,
minimumlength=2)
self.assertEqual(st, "1234")
self.assertEqual(p1.call_count, 1)
self.assertEqual(p1.call_args[0][0],
"http://www.orfeus-eu.org/eidaws/routing/1/query")
# This has been modified by our mocked call to get_stations_bulk().
self.assertEqual(p1.call_args[1]["data"],
(b"service=dataselect\nformat=post\n"
b"AA BB CC DD 2017-01-01T00:00:00.000000 "
b"2017-01-02T00:00:00.000000"))
# This is the final call to _download_waveforms() which is again
# dependent on the dummy response to the _download() function.
self.assertEqual(
p2.call_args[0][0], {
"http://example1.com":
"AA B1 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00",
"http://example2.com":
"AA B2 -- DD 2017-01-01T00:00:00 2017-01-02T00:10:00"
})
self.assertEqual(p2.call_args[1], {
"longestonly": True,
"minimumlength": 2
})
# Call to this only dependent on the original bulk request.
self.assertEqual(p3.call_count, 1)
self.assertEqual(p3.call_args[0][0][0], [
"AA", "B*", "--", "DD",
str(obspy.UTCDateTime(2017, 1, 1))[:-1],
str(obspy.UTCDateTime(2017, 1, 2))[:-1]
])
# Everything should be passed on.
self.assertEqual(
p3.call_args[1], {
"format": "text",
"level": "channel",
"longestonly": True,
"minimumlength": 2
})
def test_get_waveforms_mock(self):
"""
Test the queries from the IRIS syngine website and see if they
produce the correct URLS.
"""
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
# http://service.iris.edu/irisws/syngine/1/query?network=IU&
# station=ANMO&components=ZRT&eventid=GCMT:M110302J
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="IU",
station="ANMO",
components="ZRT",
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(
p.call_args[1]["params"], {
"components": "ZRT",
"eventid": "GCMT:M110302J",
"format": "miniseed",
"model": "ak135f_5s",
"network": "IU",
"station": "ANMO"
})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
# http://service.iris.edu/irisws/syngine/1/query?network=_GSN&
# components=Z&eventid=GCMT:M110302J&endtime=1800
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="_GSN",
components="Z",
endtime=1800.0,
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(
p.call_args[1]["params"], {
"components": native_str("Z"),
"endtime": native_str(1800.0),
"eventid": native_str("GCMT:M110302J"),
"format": native_str("miniseed"),
"model": native_str("ak135f_5s"),
"network": native_str("_GSN")
})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
# http://service.iris.edu/irisws/syngine/1/query?network=_GSN&
# components=Z&eventid=GCMT:M110302J&starttime=P-10&endtime=ScS%2B60
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="_GSN",
components="Z",
starttime="P-10",
endtime="ScS+60",
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(
p.call_args[1]["params"], {
"components": native_str("Z"),
"starttime": native_str("P-10"),
"endtime": native_str("ScS+60"),
"eventid": native_str("GCMT:M110302J"),
"format": native_str("miniseed"),
"model": native_str("ak135f_5s"),
"network": native_str("_GSN")
})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
def test_bulk_waveform_download_mock(self):
"""
Mock the bulk download requests to test the payload generation.
"""
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
payload = []
def side_effect(*args, **kwargs):
payload[:] = [kwargs["data"].decode()]
return r
# Test simple lists first.
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(model="ak135f_5s",
bulk=[[1.0, 2.0], (2.0, 3.0),
("AA", "BB")])
self.assertEqual(
payload[0], "\n".join([
"model=ak135f_5s", "format=miniseed", "1.0 2.0", "2.0 3.0",
"AA BB\n"
]))
# A couple more parameters
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(model="ak135f_5s",
bulk=[[1.0, 2.0], (2.0, 3.0),
("AA", "BB")],
format="miniseed",
sourcemomenttensor=[1, 2, 3, 4, 5, 6])
self.assertEqual(
payload[0], "\n".join([
"model=ak135f_5s", "format=miniseed",
"sourcemomenttensor=1,2,3,4,5,6", "1.0 2.0", "2.0 3.0",
"AA BB\n"
]))
# A couple of dictionaries.
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(model="ak135f_5s",
bulk=[{
"network": "IU",
"station": "ANMO"
}, {
"latitude": 12,
"longitude": 13.1
}, {
"latitude": 12,
"longitude": 13.1,
"networkcode": "IU"
}, {
"latitude": 12,
"longitude": 13.1,
"stationcode": "ANMO"
}, {
"latitude": 12,
"longitude": 13.1,
"locationcode": "00"
}, {
"latitude": 12,
"longitude": 13.1,
"networkcode": "IU",
"stationcode": "ANMO",
"locationcode": "00"
}],
format="miniseed",
eventid="GCMT:C201002270634A")
self.assertEqual(
payload[0], "\n".join([
"model=ak135f_5s", "eventid=GCMT:C201002270634A",
"format=miniseed", "IU ANMO", "12 13.1", "12 13.1 NETCODE=IU",
"12 13.1 STACODE=ANMO", "12 13.1 LOCCODE=00",
"12 13.1 NETCODE=IU STACODE=ANMO LOCCODE=00\n"
]))
def test_get_waveforms_mock(self):
"""
Test the queries from the IRIS syngine website and see if they
produce the correct URLS.
"""
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
# http://service.iris.edu/irisws/syngine/1/query?network=IU&
# station=ANMO&components=ZRT&eventid=GCMT:M110302J
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="IU", station="ANMO",
components="ZRT",
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"components": "ZRT",
"eventid": "GCMT:M110302J",
"format": "miniseed",
"model": "ak135f_5s",
"network": "IU",
"station": "ANMO"})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
# http://service.iris.edu/irisws/syngine/1/query?network=_GSN&
# components=Z&eventid=GCMT:M110302J&endtime=1800
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="_GSN",
components="Z",
endtime=1800.0,
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"components": native_str("Z"),
"endtime": native_str(1800.0),
"eventid": native_str("GCMT:M110302J"),
"format": native_str("miniseed"),
"model": native_str("ak135f_5s"),
"network": native_str("_GSN")})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
# http://service.iris.edu/irisws/syngine/1/query?network=_GSN&
# components=Z&eventid=GCMT:M110302J&starttime=P-10&endtime=ScS%2B60
with mock.patch("requests.get") as p:
p.return_value = r
st = self.c.get_waveforms(model="ak135f_5s",
network="_GSN",
components="Z",
starttime="P-10",
endtime="ScS+60",
eventid="GCMT:M110302J")
self.assertIsInstance(st, obspy.Stream)
self.assertEqual(p.call_count, 1)
self.assertEqual(p.call_args[1]["url"],
"http://service.iris.edu/irisws/syngine/1/query")
self.assertEqual(p.call_args[1]["params"], {
"components": native_str("Z"),
"starttime": native_str("P-10"),
"endtime": native_str("ScS+60"),
"eventid": native_str("GCMT:M110302J"),
"format": native_str("miniseed"),
"model": native_str("ak135f_5s"),
"network": native_str("_GSN")})
self.assertEqual(p.call_args[1]["headers"],
{"User-Agent": DEFAULT_TESTING_USER_AGENT})
def test_bulk_waveform_download_mock(self):
"""
Mock the bulk download requests to test the payload generation.
"""
r = RequestsMockResponse()
with io.BytesIO() as buf:
obspy.read()[0].write(buf, format="mseed")
buf.seek(0, 0)
r.content = buf.read()
payload = []
def side_effect(*args, **kwargs):
kwargs["data"].seek(0, 0)
payload[:] = [kwargs["data"].read().decode()]
return r
# Test simple lists first.
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(
model="ak135f_5s", bulk=[
[1.0, 2.0],
(2.0, 3.0),
("AA", "BB")])
self.assertEqual(payload[0], "\n".join([
"model=ak135f_5s",
"format=miniseed",
"1.0 2.0",
"2.0 3.0",
"AA BB\n"]))
# A couple more parameters
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(
model="ak135f_5s", bulk=[
[1.0, 2.0],
(2.0, 3.0),
("AA", "BB")],
format="miniseed",
sourcemomenttensor=[1, 2, 3, 4, 5, 6])
self.assertEqual(payload[0], "\n".join([
"model=ak135f_5s",
"format=miniseed",
"sourcemomenttensor=1,2,3,4,5,6",
"1.0 2.0",
"2.0 3.0",
"AA BB\n"]))
# A couple of dictionaries.
with mock.patch("requests.post") as p:
p.side_effect = side_effect
self.c.get_waveforms_bulk(
model="ak135f_5s", bulk=[
{"network": "IU", "station": "ANMO"},
{"latitude": 12, "longitude": 13.1},
{"latitude": 12, "longitude": 13.1, "networkcode": "IU"},
{"latitude": 12, "longitude": 13.1, "stationcode": "ANMO"},
{"latitude": 12, "longitude": 13.1, "locationcode": "00"},
{"latitude": 12, "longitude": 13.1, "networkcode": "IU",
"stationcode": "ANMO", "locationcode": "00"}],
format="miniseed", eventid="GCMT:C201002270634A")
self.assertEqual(payload[0], "\n".join([
"model=ak135f_5s",
"eventid=GCMT:C201002270634A",
"format=miniseed",
"IU ANMO",
"12 13.1",
"12 13.1 NETCODE=IU",
"12 13.1 STACODE=ANMO",
"12 13.1 LOCCODE=00",
"12 13.1 NETCODE=IU STACODE=ANMO LOCCODE=00\n"]))
def test_network_select(self):
"""
Test for the select() method of the network class.
"""
net = read_inventory()[0]
# Basic asserts to assert some things about the test data.
self.assertEqual(len(net), 2)
self.assertEqual(len(net[0]), 12)
self.assertEqual(len(net[1]), 9)
self.assertEqual(sum(len(i) for i in net), 21)
# Artificially move the start time of the first station before the
# channel start times.
net[0].start_date = UTCDateTime(1999, 1, 1)
# Nothing happens if nothing is specified or if everything is selected.
self.assertEqual(sum(len(i) for i in net.select()), 21)
self.assertEqual(sum(len(i) for i in net.select(station="*")), 21)
self.assertEqual(sum(len(i) for i in net.select(location="*")), 21)
self.assertEqual(sum(len(i) for i in net.select(channel="*")), 21)
self.assertEqual(sum(len(i) for i in net.select(
station="*", location="*", channel="*")), 21)
# No matching station.
self.assertEqual(sum(len(i) for i in net.select(station="RR")), 0)
# keep_empty does not do anything in these cases.
self.assertEqual(sum(len(i) for i in
net.select(station="RR", keep_empty=True)), 0)
# Selecting only one station.
self.assertEqual(sum(len(i) for i in
net.select(station="FUR", keep_empty=True)), 12)
self.assertEqual(sum(len(i) for i in
net.select(station="F*", keep_empty=True)), 12)
self.assertEqual(sum(len(i) for i in
net.select(station="WET", keep_empty=True)), 9)
# Test the keep_empty flag.
net_2 = net.select(time=UTCDateTime(2000, 1, 1))
self.assertEqual(len(net_2), 0)
self.assertEqual(sum(len(i) for i in net_2), 0)
# One is kept - it has no more channels but the station still has a
# valid start time.
net_2 = net.select(time=UTCDateTime(2000, 1, 1), keep_empty=True)
self.assertEqual(len(net_2), 1)
self.assertEqual(sum(len(i) for i in net_2), 0)
# location, channel, time, starttime, endtime, and sampling_rate are
# also passed on to the station selector.
select_kwargs = {
"location": "00",
"channel": "EHE",
"time": UTCDateTime(2001, 1, 1),
"sampling_rate": 123.0,
"starttime": UTCDateTime(2002, 1, 1),
"endtime": UTCDateTime(2003, 1, 1)}
with mock.patch("obspy.core.inventory.station.Station.select") as p:
p.return_value = obspy.core.inventory.station.Station("FUR", 1,
2, 3)
net.select(**select_kwargs)
self.assertEqual(p.call_args[1], select_kwargs)
def test_location_parameters(self):
"""
Tests how the variety of location values are handled.
Why location? Mostly because it is one tricky parameter. It is not
uncommon to assume that a non-existent location is "--", but in reality
"--" is "<space><space>". This substitution exists because mostly
because various applications have trouble digesting spaces (spaces in
the URL, for example).
The confusion begins when location is treated as empty instead, which
would imply "I want all locations" instead of "I only want locations of
<space><space>"
"""
# requests with no specified location should be treated as a wildcard
self.assertFalse(
"--" in build_url("http://service.iris.edu", "station", 1,
"query", {"network": "IU", "station": "ANMO",
"starttime": "2013-01-01"}))
# location of " " is the same as "--"
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": " "}),
"http://service.iris.edu/fdsnws/station/1/query?location=--")
# wildcard locations are valid. Will be encoded.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": "*"}),
"http://service.iris.edu/fdsnws/station/1/query?location=%2A")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": "A?"}),
"http://service.iris.edu/fdsnws/station/1/query?location=A%3F")
# lists are valid, including <space><space> lists. Again encoded
# result.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": " ,1?,?0"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=--%2C1%3F%2C%3F0")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": "1?,--,?0"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=1%3F%2C--%2C%3F0")
# Test all three special cases with empty parameters into lists.
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": " ,AA,BB"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=--%2CAA%2CBB")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": "AA, ,BB"}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=AA%2C--%2CBB")
self.assertEqual(
build_url("http://service.iris.edu", "station", 1,
"query", {"location": "AA,BB, "}),
"http://service.iris.edu/fdsnws/station/1/query?"
"location=AA%2CBB%2C--")
# The location parameter is also passed through the
# _create_url_from_parameters() method and thus has to survive it!
# This guards against a regression where all empty location codes
# where removed by this function!
for service in ["station", "dataselect"]:
for loc in ["", " ", " ", "--", b"", b" ", b" ", b"--",
u"", u" ", u" ", u"--"]:
self.assertIn(
"location=--",
self.client._create_url_from_parameters(
service, [],
{"location": loc, "starttime": 0, "endtime": 1}))
# Also check the full call with a mock test.
for loc in ["", " ", " ", "--", b"", b" ", b" ", b"--",
u"", u" ", u" ", u"--"]:
with mock.patch("obspy.clients.fdsn.Client._download") as p:
try:
self.client.get_stations(0, 0, location=loc)
except:
pass
self.assertEqual(p.call_count, 1)
self.assertIn("location=--", p.call_args[0][0])
with mock.patch("obspy.clients.fdsn.Client._download") as p:
try:
self.client.get_waveforms(1, 2, loc, 4, 0, 0)
except:
pass
self.assertEqual(p.call_count, 1)
self.assertIn("location=--", p.call_args[0][0])
def test_inventory_select(self):
"""
Test for the Inventory.select() method.
"""
inv = read_inventory()
# Currently contains 30 channels.
self.assertEqual(sum(len(sta) for net in inv for sta in net), 30)
# No arguments, everything should be selected.
self.assertEqual(
sum(len(sta) for net in inv.select() for sta in net),
30)
# All networks.
self.assertEqual(
sum(len(sta) for net in inv.select(network="*") for sta in net),
30)
# All stations.
self.assertEqual(
sum(len(sta) for net in inv.select(station="*") for sta in net),
30)
# All locations.
self.assertEqual(
sum(len(sta) for net in inv.select(location="*") for sta in net),
30)
# All channels.
self.assertEqual(
sum(len(sta) for net in inv.select(channel="*") for sta in net),
30)
# Only BW network.
self.assertEqual(
sum(len(sta) for net in inv.select(network="BW") for sta in net),
9)
self.assertEqual(
sum(len(sta) for net in inv.select(network="B?") for sta in net),
9)
# Only RJOB Station.
self.assertEqual(
sum(len(sta) for net in inv.select(station="RJOB") for sta in net),
9)
self.assertEqual(
sum(len(sta) for net in inv.select(station="R?O*") for sta in net),
9)
# Most parameters are just passed to the Network.select() method.
select_kwargs = {
"station": "BW",
"location": "00",
"channel": "EHE",
"keep_empty": True,
"time": UTCDateTime(2001, 1, 1),
"sampling_rate": 123.0,
"starttime": UTCDateTime(2002, 1, 1),
"endtime": UTCDateTime(2003, 1, 1)}
with mock.patch("obspy.core.inventory.network.Network.select") as p:
p.return_value = obspy.core.inventory.network.Network("BW")
inv.select(**select_kwargs)
self.assertEqual(p.call_args[1], select_kwargs)
# Artificially set start-and end dates for the first network.
inv[0].start_date = UTCDateTime(2000, 1, 1)
inv[0].end_date = UTCDateTime(2015, 1, 1)
# Nothing will stick around if keep_empty it False.
self.assertEqual(len(inv.select(time=UTCDateTime(2001, 1, 1))), 0)
# If given, both will stick around.
self.assertEqual(len(inv.select(time=UTCDateTime(2001, 1, 1),
keep_empty=True)), 2)
# Or only one.
self.assertEqual(len(inv.select(time=UTCDateTime(1999, 1, 1),
keep_empty=True)), 1)
# Also test the starttime and endtime parameters.
self.assertEqual(len(inv.select(starttime=UTCDateTime(1999, 1, 1),
keep_empty=True)), 2)
self.assertEqual(len(inv.select(starttime=UTCDateTime(2016, 1, 1),
keep_empty=True)), 1)
self.assertEqual(len(inv.select(endtime=UTCDateTime(1999, 1, 1),
keep_empty=True)), 1)
self.assertEqual(len(inv.select(endtime=UTCDateTime(2016, 1, 1),
keep_empty=True)), 2)
def test_inventory_select(self):
"""
Test for the Inventory.select() method.
"""
inv = read_inventory()
# Currently contains 30 channels.
self.assertEqual(sum(len(sta) for net in inv for sta in net), 30)
# No arguments, everything should be selected.
self.assertEqual(sum(len(sta) for net in inv.select() for sta in net),
30)
# All networks.
self.assertEqual(
sum(len(sta) for net in inv.select(network="*") for sta in net),
30)
# All stations.
self.assertEqual(
sum(len(sta) for net in inv.select(station="*") for sta in net),
30)
# All locations.
self.assertEqual(
sum(len(sta) for net in inv.select(location="*") for sta in net),
30)
# All channels.
self.assertEqual(
sum(len(sta) for net in inv.select(channel="*") for sta in net),
30)
# Only BW network.
self.assertEqual(
sum(len(sta) for net in inv.select(network="BW") for sta in net),
9)
self.assertEqual(
sum(len(sta) for net in inv.select(network="B?") for sta in net),
9)
# Only RJOB Station.
self.assertEqual(
sum(len(sta) for net in inv.select(station="RJOB") for sta in net),
9)
self.assertEqual(
sum(len(sta) for net in inv.select(station="R?O*") for sta in net),
9)
# Most parameters are just passed to the Network.select() method.
select_kwargs = {
"station": "BW",
"location": "00",
"channel": "EHE",
"keep_empty": True,
"time": UTCDateTime(2001, 1, 1),
"sampling_rate": 123.0,
"starttime": UTCDateTime(2002, 1, 1),
"endtime": UTCDateTime(2003, 1, 1)
}
with mock.patch("obspy.core.inventory.network.Network.select") as p:
p.return_value = obspy.core.inventory.network.Network("BW")
inv.select(**select_kwargs)
self.assertEqual(p.call_args[1], select_kwargs)
# Artificially set start-and end dates for the first network.
inv[0].start_date = UTCDateTime(2000, 1, 1)
inv[0].end_date = UTCDateTime(2015, 1, 1)
# Nothing will stick around if keep_empty it False.
self.assertEqual(len(inv.select(time=UTCDateTime(2001, 1, 1))), 0)
# If given, both will stick around.
self.assertEqual(
len(inv.select(time=UTCDateTime(2001, 1, 1), keep_empty=True)), 2)
# Or only one.
self.assertEqual(
len(inv.select(time=UTCDateTime(1999, 1, 1), keep_empty=True)), 1)
# Also test the starttime and endtime parameters.
self.assertEqual(
len(inv.select(starttime=UTCDateTime(1999, 1, 1),
keep_empty=True)), 2)
self.assertEqual(
len(inv.select(starttime=UTCDateTime(2016, 1, 1),
keep_empty=True)), 1)
self.assertEqual(
len(inv.select(endtime=UTCDateTime(1999, 1, 1), keep_empty=True)),
1)
self.assertEqual(
len(inv.select(endtime=UTCDateTime(2016, 1, 1), keep_empty=True)),
2)
def test_network_select(self):
"""
Test for the select() method of the network class.
"""
net = read_inventory()[0]
# Basic asserts to assert some things about the test data.
self.assertEqual(len(net), 2)
self.assertEqual(len(net[0]), 12)
self.assertEqual(len(net[1]), 9)
self.assertEqual(sum(len(i) for i in net), 21)
# Artificially move the start time of the first station before the
# channel start times.
net[0].start_date = UTCDateTime(1999, 1, 1)
# Nothing happens if nothing is specified or if everything is selected.
self.assertEqual(sum(len(i) for i in net.select()), 21)
self.assertEqual(sum(len(i) for i in net.select(station="*")), 21)
self.assertEqual(sum(len(i) for i in net.select(location="*")), 21)
self.assertEqual(sum(len(i) for i in net.select(channel="*")), 21)
self.assertEqual(
sum(
len(i)
for i in net.select(station="*", location="*", channel="*")),
21)
# No matching station.
self.assertEqual(sum(len(i) for i in net.select(station="RR")), 0)
# keep_empty does not do anything in these cases.
self.assertEqual(
sum(len(i) for i in net.select(station="RR", keep_empty=True)), 0)
# Selecting only one station.
self.assertEqual(
sum(len(i) for i in net.select(station="FUR", keep_empty=True)),
12)
self.assertEqual(
sum(len(i) for i in net.select(station="F*", keep_empty=True)), 12)
self.assertEqual(
sum(len(i) for i in net.select(station="WET", keep_empty=True)), 9)
# Test the keep_empty flag.
net_2 = net.select(time=UTCDateTime(2000, 1, 1))
self.assertEqual(len(net_2), 0)
self.assertEqual(sum(len(i) for i in net_2), 0)
# One is kept - it has no more channels but the station still has a
# valid start time.
net_2 = net.select(time=UTCDateTime(2000, 1, 1), keep_empty=True)
self.assertEqual(len(net_2), 1)
self.assertEqual(sum(len(i) for i in net_2), 0)
# location, channel, time, starttime, endtime, and sampling_rate are
# also passed on to the station selector.
select_kwargs = {
"location": "00",
"channel": "EHE",
"time": UTCDateTime(2001, 1, 1),
"sampling_rate": 123.0,
"starttime": UTCDateTime(2002, 1, 1),
"endtime": UTCDateTime(2003, 1, 1)
}
with mock.patch("obspy.core.inventory.station.Station.select") as p:
p.return_value = obspy.core.inventory.station.Station(
"FUR", 1, 2, 3)
net.select(**select_kwargs)
self.assertEqual(p.call_args[1], select_kwargs)
