mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-14 18:37:58 +00:00
add output formatters for ReverseResults
These formatters are written in a way that they can be reused for search results later.
This commit is contained in:
Sarah Hoffmann
@@ -6,6 +6,9 @@
|
||||
# For a full list of authors see the git log.
|
||||
"""
|
||||
Tests for formatting results for the V1 API.
|
||||
|
||||
These test only ensure that the Python code is correct.
|
||||
For functional tests see BDD test suite.
|
||||
"""
|
||||
import datetime as dt
|
||||
import json
|
||||
@@ -165,6 +168,28 @@ def test_search_details_with_geometry():
|
||||
assert js['isarea'] == False
|
||||
|
||||
|
||||
def test_search_details_with_icon_available():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'restaurant'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
result = api_impl.format_result(search, 'json', {'icon_base_url': 'foo'})
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['icon'] == 'foo/food_restaurant.p.20.png'
|
||||
|
||||
|
||||
def test_search_details_with_icon_not_available():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'tree'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
result = api_impl.format_result(search, 'json', {'icon_base_url': 'foo'})
|
||||
js = json.loads(result)
|
||||
|
||||
assert 'icon' not in js
|
||||
|
||||
|
||||
def test_search_details_with_address_minimal():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
@@ -193,28 +218,32 @@ def test_search_details_with_address_minimal():
|
||||
'isaddress': False}]
|
||||
|
||||
|
||||
def test_search_details_with_address_full():
|
||||
@pytest.mark.parametrize('field,outfield', [('address_rows', 'address'),
|
||||
('linked_rows', 'linked_places'),
|
||||
('parented_rows', 'hierarchy')
|
||||
])
|
||||
def test_search_details_with_further_infos(field, outfield):
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
address_rows=[
|
||||
napi.AddressLine(place_id=3498,
|
||||
osm_object=('R', 442),
|
||||
category=('bnd', 'note'),
|
||||
names={'name': 'Trespass'},
|
||||
extratags={'access': 'no',
|
||||
'place_type': 'spec'},
|
||||
admin_level=4,
|
||||
fromarea=True,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.034)
|
||||
])
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
setattr(search, field, [napi.AddressLine(place_id=3498,
|
||||
osm_object=('R', 442),
|
||||
category=('bnd', 'note'),
|
||||
names={'name': 'Trespass'},
|
||||
extratags={'access': 'no',
|
||||
'place_type': 'spec'},
|
||||
admin_level=4,
|
||||
fromarea=True,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.034)
|
||||
])
|
||||
|
||||
result = api_impl.format_result(search, 'json', {})
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['address'] == [{'localname': 'Trespass',
|
||||
assert js[outfield] == [{'localname': 'Trespass',
|
||||
'place_id': 3498,
|
||||
'osm_id': 442,
|
||||
'osm_type': 'R',
|
||||
@@ -225,3 +254,70 @@ def test_search_details_with_address_full():
|
||||
'rank_address': 10,
|
||||
'distance': 0.034,
|
||||
'isaddress': True}]
|
||||
|
||||
|
||||
def test_search_details_grouped_hierarchy():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
parented_rows =
|
||||
[napi.AddressLine(place_id=3498,
|
||||
osm_object=('R', 442),
|
||||
category=('bnd', 'note'),
|
||||
names={'name': 'Trespass'},
|
||||
extratags={'access': 'no',
|
||||
'place_type': 'spec'},
|
||||
admin_level=4,
|
||||
fromarea=True,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.034)
|
||||
])
|
||||
|
||||
result = api_impl.format_result(search, 'json', {'group_hierarchy': True})
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['hierarchy'] == {'note': [{'localname': 'Trespass',
|
||||
'place_id': 3498,
|
||||
'osm_id': 442,
|
||||
'osm_type': 'R',
|
||||
'place_type': 'spec',
|
||||
'class': 'bnd',
|
||||
'type': 'note',
|
||||
'admin_level': 4,
|
||||
'rank_address': 10,
|
||||
'distance': 0.034,
|
||||
'isaddress': True}]}
|
||||
|
||||
|
||||
def test_search_details_keywords_name():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
name_keywords=[
|
||||
napi.WordInfo(23, 'foo', 'mefoo'),
|
||||
napi.WordInfo(24, 'foo', 'bafoo')])
|
||||
|
||||
result = api_impl.format_result(search, 'json', {'keywords': True})
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['keywords'] == {'name': [{'id': 23, 'token': 'foo'},
|
||||
{'id': 24, 'token': 'foo'}],
|
||||
'address': []}
|
||||
|
||||
|
||||
def test_search_details_keywords_address():
|
||||
search = napi.DetailedResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
address_keywords=[
|
||||
napi.WordInfo(23, 'foo', 'mefoo'),
|
||||
napi.WordInfo(24, 'foo', 'bafoo')])
|
||||
|
||||
result = api_impl.format_result(search, 'json', {'keywords': True})
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['keywords'] == {'address': [{'id': 23, 'token': 'foo'},
|
||||
{'id': 24, 'token': 'foo'}],
|
||||
'name': []}
|
||||
|
||||
|
||||
320
test/python/api/test_result_formatting_v1_reverse.py
Normal file
320
test/python/api/test_result_formatting_v1_reverse.py
Normal file
@@ -0,0 +1,320 @@
|
||||
# SPDX-License-Identifier: GPL-2.0-only
|
||||
#
|
||||
# This file is part of Nominatim. (https://nominatim.org)
|
||||
#
|
||||
# Copyright (C) 2023 by the Nominatim developer community.
|
||||
# For a full list of authors see the git log.
|
||||
"""
|
||||
Tests for formatting reverse results for the V1 API.
|
||||
|
||||
These test only ensure that the Python code is correct.
|
||||
For functional tests see BDD test suite.
|
||||
"""
|
||||
import json
|
||||
import xml.etree.ElementTree as ET
|
||||
|
||||
import pytest
|
||||
|
||||
import nominatim.api.v1 as api_impl
|
||||
import nominatim.api as napi
|
||||
|
||||
FORMATS = ['json', 'jsonv2', 'geojson', 'geocodejson', 'xml']
|
||||
|
||||
@pytest.mark.parametrize('fmt', FORMATS)
|
||||
def test_format_reverse_minimal(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'post_box'),
|
||||
napi.Point(0.3, -8.9))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt, {})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.tag == 'reversegeocode'
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
assert isinstance(result, dict)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', FORMATS)
|
||||
def test_format_reverse_no_result(fmt):
|
||||
raw = api_impl.format_result(napi.ReverseResults(), fmt, {})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('error').text == 'Unable to geocode'
|
||||
else:
|
||||
assert json.loads(raw) == {'error': 'Unable to geocode'}
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', FORMATS)
|
||||
def test_format_reverse_with_osm_id(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'post_box'),
|
||||
napi.Point(0.3, -8.9),
|
||||
place_id=5564,
|
||||
osm_object=('N', 23))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt, {})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw).find('result')
|
||||
assert root.attrib['osm_type'] == 'node'
|
||||
assert root.attrib['osm_id'] == '23'
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
if fmt == 'geocodejson':
|
||||
props = result['features'][0]['properties']['geocoding']
|
||||
elif fmt == 'geojson':
|
||||
props = result['features'][0]['properties']
|
||||
else:
|
||||
props = result
|
||||
assert props['osm_type'] == 'node'
|
||||
assert props['osm_id'] == 23
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', FORMATS)
|
||||
def test_format_reverse_with_address(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
country_code='fe',
|
||||
address_rows=napi.AddressLines([
|
||||
napi.AddressLine(place_id=None,
|
||||
osm_object=None,
|
||||
category=('place', 'county'),
|
||||
names={'name': 'Hello'},
|
||||
extratags=None,
|
||||
admin_level=5,
|
||||
fromarea=False,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.0),
|
||||
napi.AddressLine(place_id=None,
|
||||
osm_object=None,
|
||||
category=('place', 'county'),
|
||||
names={'name': 'ByeBye'},
|
||||
extratags=None,
|
||||
admin_level=5,
|
||||
fromarea=False,
|
||||
isaddress=False,
|
||||
rank_address=10,
|
||||
distance=0.0)
|
||||
]))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'addressdetails': True})
|
||||
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('addressparts').find('county').text == 'Hello'
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
assert isinstance(result, dict)
|
||||
|
||||
if fmt == 'geocodejson':
|
||||
props = result['features'][0]['properties']['geocoding']
|
||||
assert 'admin' in props
|
||||
assert props['county'] == 'Hello'
|
||||
else:
|
||||
if fmt == 'geojson':
|
||||
props = result['features'][0]['properties']
|
||||
else:
|
||||
props = result
|
||||
assert 'address' in props
|
||||
|
||||
|
||||
def test_format_reverse_geocodejson_special_parts():
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'house'),
|
||||
napi.Point(1.0, 2.0),
|
||||
place_id=33,
|
||||
country_code='fe',
|
||||
address_rows=napi.AddressLines([
|
||||
napi.AddressLine(place_id=None,
|
||||
osm_object=None,
|
||||
category=('place', 'house_number'),
|
||||
names={'ref': '1'},
|
||||
extratags=None,
|
||||
admin_level=15,
|
||||
fromarea=False,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.0),
|
||||
napi.AddressLine(place_id=None,
|
||||
osm_object=None,
|
||||
category=('place', 'postcode'),
|
||||
names={'ref': '99446'},
|
||||
extratags=None,
|
||||
admin_level=11,
|
||||
fromarea=False,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.0),
|
||||
napi.AddressLine(place_id=33,
|
||||
osm_object=None,
|
||||
category=('place', 'county'),
|
||||
names={'name': 'Hello'},
|
||||
extratags=None,
|
||||
admin_level=5,
|
||||
fromarea=False,
|
||||
isaddress=True,
|
||||
rank_address=10,
|
||||
distance=0.0)
|
||||
]))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), 'geocodejson',
|
||||
{'addressdetails': True})
|
||||
|
||||
props = json.loads(raw)['features'][0]['properties']['geocoding']
|
||||
assert props['housenumber'] == '1'
|
||||
assert props['postcode'] == '99446'
|
||||
assert 'county' not in props
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', FORMATS)
|
||||
def test_format_reverse_with_address_none(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
address_rows=napi.AddressLines())
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'addressdetails': True})
|
||||
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('addressparts') is None
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
assert isinstance(result, dict)
|
||||
|
||||
if fmt == 'geocodejson':
|
||||
props = result['features'][0]['properties']['geocoding']
|
||||
print(props)
|
||||
assert 'admin' in props
|
||||
else:
|
||||
if fmt == 'geojson':
|
||||
props = result['features'][0]['properties']
|
||||
else:
|
||||
props = result
|
||||
assert 'address' in props
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2', 'geojson', 'xml'])
|
||||
def test_format_reverse_with_extratags(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
extratags={'one': 'A', 'two':'B'})
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'extratags': True})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('extratags').find('tag').attrib['key'] == 'one'
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
if fmt == 'geojson':
|
||||
extra = result['features'][0]['properties']['extratags']
|
||||
else:
|
||||
extra = result['extratags']
|
||||
|
||||
assert extra == {'one': 'A', 'two':'B'}
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2', 'geojson', 'xml'])
|
||||
def test_format_reverse_with_extratags_none(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'extratags': True})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('extratags') is not None
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
if fmt == 'geojson':
|
||||
extra = result['features'][0]['properties']['extratags']
|
||||
else:
|
||||
extra = result['extratags']
|
||||
|
||||
assert extra is None
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2', 'geojson', 'xml'])
|
||||
def test_format_reverse_with_namedetails_with_name(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0),
|
||||
names={'name': 'A', 'ref':'1'})
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'namedetails': True})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('namedetails').find('name').text == 'A'
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
if fmt == 'geojson':
|
||||
extra = result['features'][0]['properties']['namedetails']
|
||||
else:
|
||||
extra = result['namedetails']
|
||||
|
||||
assert extra == {'name': 'A', 'ref':'1'}
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2', 'geojson', 'xml'])
|
||||
def test_format_reverse_with_namedetails_without_name(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('place', 'thing'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
raw = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'namedetails': True})
|
||||
|
||||
if fmt == 'xml':
|
||||
root = ET.fromstring(raw)
|
||||
assert root.find('namedetails') is not None
|
||||
else:
|
||||
result = json.loads(raw)
|
||||
if fmt == 'geojson':
|
||||
extra = result['features'][0]['properties']['namedetails']
|
||||
else:
|
||||
extra = result['namedetails']
|
||||
|
||||
assert extra is None
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2'])
|
||||
def test_search_details_with_icon_available(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'restaurant'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
result = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'icon_base_url': 'foo'})
|
||||
|
||||
js = json.loads(result)
|
||||
|
||||
assert js['icon'] == 'foo/food_restaurant.p.20.png'
|
||||
|
||||
|
||||
@pytest.mark.parametrize('fmt', ['json', 'jsonv2'])
|
||||
def test_search_details_with_icon_not_available(fmt):
|
||||
reverse = napi.ReverseResult(napi.SourceTable.PLACEX,
|
||||
('amenity', 'tree'),
|
||||
napi.Point(1.0, 2.0))
|
||||
|
||||
result = api_impl.format_result(napi.ReverseResults([reverse]), fmt,
|
||||
{'icon_base_url': 'foo'})
|
||||
|
||||
assert 'icon' not in json.loads(result)
|
||||
|
||||
Reference in New Issue
Block a user