+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 by the Nominatim developer community.
+# For a full list of authors see the git log.
"""
Classes wrapping HTTP responses from the Nominatim API.
"""
from check_functions import Almost
+OSM_TYPE = {'N' : 'node', 'W' : 'way', 'R' : 'relation',
+ 'n' : 'node', 'w' : 'way', 'r' : 'relation',
+ 'node' : 'n', 'way' : 'w', 'relation' : 'r'}
+
def _geojson_result_to_json_result(geojson_result):
result = geojson_result['properties']
result['geojson'] = geojson_result['geometry']
""" Common base class for all API responses.
"""
def __init__(self, page, fmt, errorcode=200):
+ fmt = fmt.strip()
+ if fmt == 'jsonv2':
+ fmt = 'json'
+
self.page = page
self.format = fmt
self.errorcode = errorcode
self.result = []
self.header = dict()
- if errorcode == 200:
+ if errorcode == 200 and fmt != 'debug':
getattr(self, '_parse_' + fmt)()
def _parse_json(self):
self.header['json_func'] = m.group(1)
self.result = json.JSONDecoder(object_pairs_hook=OrderedDict).decode(code)
if isinstance(self.result, OrderedDict):
- self.result = [self.result]
+ if 'error' in self.result:
+ self.result = []
+ else:
+ self.result = [self.result]
def _parse_geojson(self):
self._parse_json()
- if 'error' in self.result[0]:
- self.result = []
- else:
+ if self.result:
self.result = list(map(_geojson_result_to_json_result, self.result[0]['features']))
def _parse_geocodejson(self):
assert str(self.result[idx][field]) == str(value), \
BadRowValueAssert(self, idx, field, value)
- def match_row(self, row):
+ def assert_address_field(self, idx, field, value):
+ """ Check that result rows`idx` has a field `field` with value `value`
+ in its address. If idx is None, then all results are checked.
+ """
+ if idx is None:
+ todo = range(len(self.result))
+ else:
+ todo = [int(idx)]
+
+ for idx in todo:
+ assert 'address' in self.result[idx], \
+ "Result row {} has no field 'address'.\nFull row: {}"\
+ .format(idx, json.dumps(self.result[idx], indent=4))
+
+ address = self.result[idx]['address']
+ assert field in address, \
+ "Result row {} has no field '{}' in address.\nFull address: {}"\
+ .format(idx, field, json.dumps(address, indent=4))
+
+ assert address[field] == value, \
+ "\nBad value for row {} field '{}' in address. Expected: {}, got: {}.\nFull address: {}"""\
+ .format(idx, field, value, address[field], json.dumps(address, indent=4))
+
+ def match_row(self, row, context=None):
""" Match the result fields against the given behave table row.
"""
if 'ID' in row.headings:
if name == 'ID':
pass
elif name == 'osm':
- self.assert_field(i, 'osm_type', value[0])
+ assert 'osm_type' in self.result[i], \
+ "Result row {} has no field 'osm_type'.\nFull row: {}"\
+ .format(i, json.dumps(self.result[i], indent=4))
+ assert self.result[i]['osm_type'] in (OSM_TYPE[value[0]], value[0]), \
+ BadRowValueAssert(self, i, 'osm_type', value)
self.assert_field(i, 'osm_id', value[1:])
+ elif name == 'osm_type':
+ assert self.result[i]['osm_type'] in (OSM_TYPE[value[0]], value[0]), \
+ BadRowValueAssert(self, i, 'osm_type', value)
elif name == 'centroid':
- lon, lat = value.split(' ')
+ if ' ' in value:
+ lon, lat = value.split(' ')
+ elif context is not None:
+ lon, lat = context.osm.grid_node(int(value))
+ else:
+ raise RuntimeError("Context needed when using grid coordinates")
self.assert_field(i, 'lat', float(lat))
self.assert_field(i, 'lon', float(lon))
else: