#
# This file is part of Nominatim. (https://nominatim.org)
#
-# Copyright (C) 2023 by the Nominatim developer community.
+# Copyright (C) 2024 by the Nominatim developer community.
# For a full list of authors see the git log.
"""
Tests for lookup API call.
"""
-import datetime as dt
+import json
import pytest
-import nominatim.api as napi
+import nominatim_api as napi
+
+def test_lookup_empty_list(apiobj, frontend):
+ api = frontend(apiobj, options={'details'})
+ assert api.lookup([]) == []
+
+
+def test_lookup_non_existing(apiobj, frontend):
+ api = frontend(apiobj, options={'details'})
+ assert api.lookup((napi.PlaceID(332), napi.OsmID('W', 4),
+ napi.OsmID('W', 4, 'highway'))) == []
+
@pytest.mark.parametrize('idobj', (napi.PlaceID(332), napi.OsmID('W', 4),
napi.OsmID('W', 4, 'highway')))
-def test_lookup_in_placex(apiobj, idobj):
- import_date = dt.datetime(2022, 12, 7, 14, 14, 46, 0)
+def test_lookup_single_placex(apiobj, frontend, idobj):
apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
class_='highway', type='residential',
name={'name': 'Road'}, address={'city': 'Barrow'},
rank_search=27, rank_address=26,
importance=0.01,
centroid=(23, 34),
- indexed_date=import_date,
geometry='LINESTRING(23 34, 23.1 34, 23.1 34.1, 23 34)')
- result = apiobj.api.lookup(idobj, napi.LookupDetails())
+ api = frontend(apiobj, options={'details'})
+ result = api.lookup([idobj])
- assert result is not None
+ assert len(result) == 1
+
+ result = result[0]
assert result.source_table.name == 'PLACEX'
assert result.category == ('highway', 'residential')
assert result.centroid == (pytest.approx(23.0), pytest.approx(34.0))
assert result.place_id == 332
- assert result.parent_place_id == 34
- assert result.linked_place_id == 55
assert result.osm_object == ('W', 4)
- assert result.admin_level == 15
assert result.names == {'name': 'Road'}
assert result.address == {'city': 'Barrow'}
assert result.importance == pytest.approx(0.01)
assert result.country_code == 'gb'
- assert result.indexed_date == import_date
assert result.address_rows is None
assert result.linked_rows is None
assert result.name_keywords is None
assert result.address_keywords is None
- assert result.geometry == {'type': 'ST_LineString'}
+ assert result.geometry == {}
-def test_lookup_in_placex_minimal_info(apiobj):
- import_date = dt.datetime(2022, 12, 7, 14, 14, 46, 0)
+def test_lookup_multiple_places(apiobj, frontend):
apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
class_='highway', type='residential',
- admin_level=15,
+ name={'name': 'Road'}, address={'city': 'Barrow'},
+ extratags={'surface': 'paved'},
+ parent_place_id=34, linked_place_id=55,
+ admin_level=15, country_code='gb',
+ housenumber='4',
+ postcode='34425', wikipedia='en:Faa',
rank_search=27, rank_address=26,
+ importance=0.01,
centroid=(23, 34),
- indexed_date=import_date,
geometry='LINESTRING(23 34, 23.1 34, 23.1 34.1, 23 34)')
-
- result = apiobj.api.lookup(napi.PlaceID(332), napi.LookupDetails())
-
- assert result is not None
-
- assert result.source_table.name == 'PLACEX'
- assert result.category == ('highway', 'residential')
- assert result.centroid == (pytest.approx(23.0), pytest.approx(34.0))
-
- assert result.place_id == 332
- assert result.parent_place_id is None
- assert result.linked_place_id is None
- assert result.osm_object == ('W', 4)
- assert result.admin_level == 15
-
- assert result.names is None
- assert result.address is None
- assert result.extratags is None
-
- assert result.housenumber is None
- assert result.postcode is None
- assert result.wikipedia is None
-
- assert result.rank_search == 27
- assert result.rank_address == 26
- assert result.importance is None
-
- assert result.country_code is None
- assert result.indexed_date == import_date
-
- assert result.address_rows is None
- assert result.linked_rows is None
- assert result.parented_rows is None
- assert result.name_keywords is None
- assert result.address_keywords is None
-
- assert result.geometry == {'type': 'ST_LineString'}
-
-
-def test_lookup_in_placex_with_geometry(apiobj):
- apiobj.add_placex(place_id=332,
- geometry='LINESTRING(23 34, 23.1 34)')
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(geometry_output=napi.GeometryFormat.GEOJSON))
-
- assert result.geometry == {'geojson': '{"type":"LineString","coordinates":[[23,34],[23.1,34]]}'}
-
-
-def test_lookup_placex_with_address_details(apiobj):
- apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl',
- rank_search=27, rank_address=26)
- apiobj.add_address_placex(332, fromarea=False, isaddress=False,
- distance=0.0034,
- place_id=1000, osm_type='N', osm_id=3333,
- class_='place', type='suburb', name='Smallplace',
- country_code='pl', admin_level=13,
- rank_search=24, rank_address=23)
- apiobj.add_address_placex(332, fromarea=True, isaddress=True,
- place_id=1001, osm_type='N', osm_id=3334,
- class_='place', type='city', name='Bigplace',
- country_code='pl',
- rank_search=17, rank_address=16)
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(address_details=True))
-
- assert result.address_rows == [
- napi.AddressLine(place_id=332, osm_object=('W', 4),
- category=('highway', 'residential'),
- names={'name': 'Street'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=26, distance=0.0),
- napi.AddressLine(place_id=1000, osm_object=('N', 3333),
- category=('place', 'suburb'),
- names={'name': 'Smallplace'}, extratags={},
- admin_level=13, fromarea=False, isaddress=True,
- rank_address=23, distance=0.0034),
- napi.AddressLine(place_id=1001, osm_object=('N', 3334),
- category=('place', 'city'),
- names={'name': 'Bigplace'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=16, distance=0.0),
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'country_code'),
- names={'ref': 'pl'}, extratags={},
- admin_level=None, fromarea=True, isaddress=False,
- rank_address=4, distance=0.0)
- ]
-
-
-def test_lookup_place_with_linked_places_none_existing(apiobj):
- apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl', linked_place_id=45,
- rank_search=27, rank_address=26)
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(linked_places=True))
-
- assert result.linked_rows == []
-
-
-def test_lookup_place_with_linked_places_existing(apiobj):
- apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl', linked_place_id=45,
- rank_search=27, rank_address=26)
- apiobj.add_placex(place_id=1001, osm_type='W', osm_id=5,
- class_='highway', type='residential', name='Street',
- country_code='pl', linked_place_id=332,
- rank_search=27, rank_address=26)
- apiobj.add_placex(place_id=1002, osm_type='W', osm_id=6,
- class_='highway', type='residential', name='Street',
- country_code='pl', linked_place_id=332,
- rank_search=27, rank_address=26)
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(linked_places=True))
-
- assert result.linked_rows == [
- napi.AddressLine(place_id=1001, osm_object=('W', 5),
- category=('highway', 'residential'),
- names={'name': 'Street'}, extratags={},
- admin_level=15, fromarea=False, isaddress=True,
- rank_address=26, distance=0.0),
- napi.AddressLine(place_id=1002, osm_object=('W', 6),
- category=('highway', 'residential'),
- names={'name': 'Street'}, extratags={},
- admin_level=15, fromarea=False, isaddress=True,
- rank_address=26, distance=0.0),
- ]
-
-
-def test_lookup_place_with_parented_places_not_existing(apiobj):
- apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl', parent_place_id=45,
- rank_search=27, rank_address=26)
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(parented_places=True))
-
- assert result.parented_rows == []
-
-
-def test_lookup_place_with_parented_places_existing(apiobj):
- apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl', parent_place_id=45,
- rank_search=27, rank_address=26)
- apiobj.add_placex(place_id=1001, osm_type='N', osm_id=5,
- class_='place', type='house', housenumber='23',
- country_code='pl', parent_place_id=332,
- rank_search=30, rank_address=30)
- apiobj.add_placex(place_id=1002, osm_type='W', osm_id=6,
- class_='highway', type='residential', name='Street',
- country_code='pl', parent_place_id=332,
- rank_search=27, rank_address=26)
-
- result = apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(parented_places=True))
-
- assert result.parented_rows == [
- napi.AddressLine(place_id=1001, osm_object=('N', 5),
- category=('place', 'house'),
- names={'housenumber': '23'}, extratags={},
- admin_level=15, fromarea=False, isaddress=True,
- rank_address=30, distance=0.0),
- ]
-
-
-@pytest.mark.parametrize('idobj', (napi.PlaceID(4924), napi.OsmID('W', 9928)))
-def test_lookup_in_osmline(apiobj, idobj):
- import_date = dt.datetime(2022, 12, 7, 14, 14, 46, 0)
apiobj.add_osmline(place_id=4924, osm_id=9928,
parent_place_id=12,
startnumber=1, endnumber=4, step=1,
country_code='gb', postcode='34425',
address={'city': 'Big'},
- indexed_date=import_date,
geometry='LINESTRING(23 34, 23 35)')
- result = apiobj.api.lookup(idobj, napi.LookupDetails())
-
- assert result is not None
-
- assert result.source_table.name == 'OSMLINE'
- assert result.category == ('place', 'houses')
- assert result.centroid == (pytest.approx(23.0), pytest.approx(34.5))
-
- assert result.place_id == 4924
- assert result.parent_place_id == 12
- assert result.linked_place_id is None
- assert result.osm_object == ('W', 9928)
- assert result.admin_level == 15
-
- assert result.names is None
- assert result.address == {'city': 'Big'}
- assert result.extratags == {'startnumber': '1', 'endnumber': '4', 'step': '1'}
-
- assert result.housenumber is None
- assert result.postcode == '34425'
- assert result.wikipedia is None
-
- assert result.rank_search == 30
- assert result.rank_address == 30
- assert result.importance is None
-
- assert result.country_code == 'gb'
- assert result.indexed_date == import_date
-
- assert result.address_rows is None
- assert result.linked_rows is None
- assert result.parented_rows is None
- assert result.name_keywords is None
- assert result.address_keywords is None
-
- assert result.geometry == {'type': 'ST_LineString'}
+ api = frontend(apiobj, options={'details'})
+ result = api.lookup((napi.OsmID('W', 1),
+ napi.OsmID('W', 4),
+ napi.OsmID('W', 9928)))
-def test_lookup_in_osmline_split_interpolation(apiobj):
- apiobj.add_osmline(place_id=1000, osm_id=9,
- startnumber=2, endnumber=4, step=1)
- apiobj.add_osmline(place_id=1001, osm_id=9,
- startnumber=6, endnumber=9, step=1)
- apiobj.add_osmline(place_id=1002, osm_id=9,
- startnumber=11, endnumber=20, step=1)
+ assert len(result) == 2
- for i in range(1, 6):
- result = apiobj.api.lookup(napi.OsmID('W', 9, str(i)), napi.LookupDetails())
- assert result.place_id == 1000
- for i in range(7, 11):
- result = apiobj.api.lookup(napi.OsmID('W', 9, str(i)), napi.LookupDetails())
- assert result.place_id == 1001
- for i in range(12, 22):
- result = apiobj.api.lookup(napi.OsmID('W', 9, str(i)), napi.LookupDetails())
- assert result.place_id == 1002
+ assert set(r.place_id for r in result) == {332, 4924}
-def test_lookup_osmline_with_address_details(apiobj):
- apiobj.add_osmline(place_id=9000, osm_id=9,
- startnumber=2, endnumber=4, step=1,
- parent_place_id=332)
+@pytest.mark.parametrize('gtype', list(napi.GeometryFormat))
+def test_simple_place_with_geometry(apiobj, frontend, gtype):
apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='pl',
- rank_search=27, rank_address=26)
- apiobj.add_address_placex(332, fromarea=False, isaddress=False,
- distance=0.0034,
- place_id=1000, osm_type='N', osm_id=3333,
- class_='place', type='suburb', name='Smallplace',
- country_code='pl', admin_level=13,
- rank_search=24, rank_address=23)
- apiobj.add_address_placex(332, fromarea=True, isaddress=True,
- place_id=1001, osm_type='N', osm_id=3334,
- class_='place', type='city', name='Bigplace',
- country_code='pl',
- rank_search=17, rank_address=16)
-
- result = apiobj.api.lookup(napi.PlaceID(9000),
- napi.LookupDetails(address_details=True))
-
- assert result.address_rows == [
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'house_number'),
- names={'ref': '2'}, extratags={},
- admin_level=None, fromarea=True, isaddress=True,
- rank_address=28, distance=0.0),
- napi.AddressLine(place_id=332, osm_object=('W', 4),
- category=('highway', 'residential'),
- names={'name': 'Street'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=26, distance=0.0),
- napi.AddressLine(place_id=1000, osm_object=('N', 3333),
- category=('place', 'suburb'),
- names={'name': 'Smallplace'}, extratags={},
- admin_level=13, fromarea=False, isaddress=True,
- rank_address=23, distance=0.0034),
- napi.AddressLine(place_id=1001, osm_object=('N', 3334),
- category=('place', 'city'),
- names={'name': 'Bigplace'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=16, distance=0.0),
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'country_code'),
- names={'ref': 'pl'}, extratags={},
- admin_level=None, fromarea=True, isaddress=False,
- rank_address=4, distance=0.0)
- ]
-
-
-def test_lookup_in_tiger(apiobj):
- apiobj.add_tiger(place_id=4924,
- parent_place_id=12,
- startnumber=1, endnumber=4, step=1,
- postcode='34425',
- geometry='LINESTRING(23 34, 23 35)')
-
- result = apiobj.api.lookup(napi.PlaceID(4924), napi.LookupDetails())
-
- assert result is not None
-
- assert result.source_table.name == 'TIGER'
- assert result.category == ('place', 'houses')
- assert result.centroid == (pytest.approx(23.0), pytest.approx(34.5))
-
- assert result.place_id == 4924
- assert result.parent_place_id == 12
- assert result.linked_place_id is None
- assert result.osm_object is None
- assert result.admin_level == 15
-
- assert result.names is None
- assert result.address is None
- assert result.extratags == {'startnumber': '1', 'endnumber': '4', 'step': '1'}
-
- assert result.housenumber is None
- assert result.postcode == '34425'
- assert result.wikipedia is None
-
- assert result.rank_search == 30
- assert result.rank_address == 30
- assert result.importance is None
+ class_='highway', type='residential',
+ name={'name': 'Road'}, address={'city': 'Barrow'},
+ extratags={'surface': 'paved'},
+ parent_place_id=34, linked_place_id=55,
+ admin_level=15, country_code='gb',
+ housenumber='4',
+ postcode='34425', wikipedia='en:Faa',
+ rank_search=27, rank_address=26,
+ importance=0.01,
+ centroid=(23, 34),
+ geometry='POLYGON((23 34, 23.1 34, 23.1 34.1, 23 34))')
- assert result.country_code == 'us'
- assert result.indexed_date is None
+ api = frontend(apiobj, options={'details'})
+ result = api.lookup([napi.OsmID('W', 4)], geometry_output=gtype)
- assert result.address_rows is None
- assert result.linked_rows is None
- assert result.parented_rows is None
- assert result.name_keywords is None
- assert result.address_keywords is None
+ assert len(result) == 1
+ assert result[0].place_id == 332
- assert result.geometry == {'type': 'ST_LineString'}
+ if gtype == napi.GeometryFormat.NONE:
+ assert list(result[0].geometry.keys()) == []
+ else:
+ assert list(result[0].geometry.keys()) == [gtype.name.lower()]
-def test_lookup_tiger_with_address_details(apiobj):
- apiobj.add_tiger(place_id=9000,
- startnumber=2, endnumber=4, step=1,
- parent_place_id=332)
+def test_simple_place_with_geometry_simplified(apiobj, frontend):
apiobj.add_placex(place_id=332, osm_type='W', osm_id=4,
- class_='highway', type='residential', name='Street',
- country_code='us',
- rank_search=27, rank_address=26)
- apiobj.add_address_placex(332, fromarea=False, isaddress=False,
- distance=0.0034,
- place_id=1000, osm_type='N', osm_id=3333,
- class_='place', type='suburb', name='Smallplace',
- country_code='us', admin_level=13,
- rank_search=24, rank_address=23)
- apiobj.add_address_placex(332, fromarea=True, isaddress=True,
- place_id=1001, osm_type='N', osm_id=3334,
- class_='place', type='city', name='Bigplace',
- country_code='us',
- rank_search=17, rank_address=16)
-
- result = apiobj.api.lookup(napi.PlaceID(9000),
- napi.LookupDetails(address_details=True))
-
- assert result.address_rows == [
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'house_number'),
- names={'ref': '2'}, extratags={},
- admin_level=None, fromarea=True, isaddress=True,
- rank_address=28, distance=0.0),
- napi.AddressLine(place_id=332, osm_object=('W', 4),
- category=('highway', 'residential'),
- names={'name': 'Street'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=26, distance=0.0),
- napi.AddressLine(place_id=1000, osm_object=('N', 3333),
- category=('place', 'suburb'),
- names={'name': 'Smallplace'}, extratags={},
- admin_level=13, fromarea=False, isaddress=True,
- rank_address=23, distance=0.0034),
- napi.AddressLine(place_id=1001, osm_object=('N', 3334),
- category=('place', 'city'),
- names={'name': 'Bigplace'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=16, distance=0.0),
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'country_code'),
- names={'ref': 'us'}, extratags={},
- admin_level=None, fromarea=True, isaddress=False,
- rank_address=4, distance=0.0)
- ]
-
-
-def test_lookup_in_postcode(apiobj):
- import_date = dt.datetime(2022, 12, 7, 14, 14, 46, 0)
- apiobj.add_postcode(place_id=554,
- parent_place_id=152,
- postcode='34 425',
- country_code='gb',
- rank_search=20, rank_address=22,
- indexed_date=import_date,
- geometry='POINT(-9.45 5.6)')
-
- result = apiobj.api.lookup(napi.PlaceID(554), napi.LookupDetails())
-
- assert result is not None
-
- assert result.source_table.name == 'POSTCODE'
- assert result.category == ('place', 'postcode')
- assert result.centroid == (pytest.approx(-9.45), pytest.approx(5.6))
-
- assert result.place_id == 554
- assert result.parent_place_id == 152
- assert result.linked_place_id is None
- assert result.osm_object is None
- assert result.admin_level == 15
-
- assert result.names == {'ref': '34 425'}
- assert result.address is None
- assert result.extratags is None
-
- assert result.housenumber is None
- assert result.postcode is None
- assert result.wikipedia is None
-
- assert result.rank_search == 20
- assert result.rank_address == 22
- assert result.importance is None
+ class_='highway', type='residential',
+ name={'name': 'Road'}, address={'city': 'Barrow'},
+ extratags={'surface': 'paved'},
+ parent_place_id=34, linked_place_id=55,
+ admin_level=15, country_code='gb',
+ housenumber='4',
+ postcode='34425', wikipedia='en:Faa',
+ rank_search=27, rank_address=26,
+ importance=0.01,
+ centroid=(23, 34),
+ geometry='POLYGON((23 34, 22.999 34, 23.1 34, 23.1 34.1, 23 34))')
- assert result.country_code == 'gb'
- assert result.indexed_date == import_date
+ api = frontend(apiobj, options={'details'})
+ result = api.lookup([napi.OsmID('W', 4)],
+ geometry_output=napi.GeometryFormat.GEOJSON,
+ geometry_simplification=0.1)
- assert result.address_rows is None
- assert result.linked_rows is None
- assert result.parented_rows is None
- assert result.name_keywords is None
- assert result.address_keywords is None
+ assert len(result) == 1
+ assert result[0].place_id == 332
+
+ geom = json.loads(result[0].geometry['geojson'])
- assert result.geometry == {'type': 'ST_Point'}
-
-
-def test_lookup_postcode_with_address_details(apiobj):
- apiobj.add_postcode(place_id=9000,
- parent_place_id=332,
- postcode='34 425',
- country_code='gb',
- rank_search=25, rank_address=25)
- apiobj.add_placex(place_id=332, osm_type='N', osm_id=3333,
- class_='place', type='suburb', name='Smallplace',
- country_code='gb', admin_level=13,
- rank_search=24, rank_address=23)
- apiobj.add_address_placex(332, fromarea=True, isaddress=True,
- place_id=1001, osm_type='N', osm_id=3334,
- class_='place', type='city', name='Bigplace',
- country_code='gb',
- rank_search=17, rank_address=16)
-
- result = apiobj.api.lookup(napi.PlaceID(9000),
- napi.LookupDetails(address_details=True))
-
- assert result.address_rows == [
- napi.AddressLine(place_id=332, osm_object=('N', 3333),
- category=('place', 'suburb'),
- names={'name': 'Smallplace'}, extratags={},
- admin_level=13, fromarea=True, isaddress=True,
- rank_address=23, distance=0.0),
- napi.AddressLine(place_id=1001, osm_object=('N', 3334),
- category=('place', 'city'),
- names={'name': 'Bigplace'}, extratags={},
- admin_level=15, fromarea=True, isaddress=True,
- rank_address=16, distance=0.0),
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'postcode'),
- names={'ref': '34 425'}, extratags={},
- admin_level=None, fromarea=False, isaddress=True,
- rank_address=5, distance=0.0),
- napi.AddressLine(place_id=None, osm_object=None,
- category=('place', 'country_code'),
- names={'ref': 'gb'}, extratags={},
- admin_level=None, fromarea=True, isaddress=False,
- rank_address=4, distance=0.0)
- ]
-
-
-@pytest.mark.parametrize('gtype', (napi.GeometryFormat.KML,
- napi.GeometryFormat.SVG,
- napi.GeometryFormat.TEXT))
-def test_lookup_unsupported_geometry(apiobj, gtype):
- apiobj.add_placex(place_id=332)
-
- with pytest.raises(ValueError):
- apiobj.api.lookup(napi.PlaceID(332),
- napi.LookupDetails(geometry_output=gtype))
+ assert geom['type'] == 'Polygon'
+ assert geom['coordinates'] == [[[23, 34], [23.1, 34], [23.1, 34.1], [23, 34]]]