1 # SPDX-License-Identifier: GPL-3.0-or-later
3 # This file is part of Nominatim. (https://nominatim.org)
5 # Copyright (C) 2025 by the Nominatim developer community.
6 # For a full list of authors see the git log.
8 Tests for running the generic place searcher.
14 import nominatim_api as napi
15 from nominatim_api.types import SearchDetails
16 from nominatim_api.search.db_searches import PlaceSearch
17 from nominatim_api.search.db_search_fields import WeightedStrings, WeightedCategories, \
18 FieldLookup, FieldRanking, RankedTokens
19 from nominatim_api.search.db_search_lookups import LookupAll, LookupAny, Restrict
21 APIOPTIONS = ['search']
24 def run_search(apiobj, frontend, global_penalty, lookup, ranking, count=2,
25 hnrs=[], pcs=[], ccodes=[], quals=[],
26 details=SearchDetails()):
28 penalty = global_penalty
29 postcodes = WeightedStrings(pcs, [0.0] * len(pcs))
30 countries = WeightedStrings(ccodes, [0.0] * len(ccodes))
31 housenumbers = WeightedStrings(hnrs, [0.0] * len(hnrs))
32 qualifiers = WeightedCategories(quals, [0.0] * len(quals))
36 search = PlaceSearch(0.0, MySearchData(), count)
41 api = frontend(apiobj, options=APIOPTIONS)
44 async with api._async_api.begin() as conn:
45 return await search.lookup(conn, details)
47 results = api._loop.run_until_complete(run())
48 results.sort(key=lambda r: r.accuracy)
53 class TestNameOnlySearches:
55 @pytest.fixture(autouse=True)
56 def fill_database(self, apiobj):
57 apiobj.add_placex(place_id=100, country_code='us',
59 apiobj.add_search_name(100, names=[1, 2, 10, 11], country_code='us',
61 apiobj.add_placex(place_id=101, country_code='mx',
62 centroid=(-10.3, 56.9))
63 apiobj.add_search_name(101, names=[1, 2, 20, 21], country_code='mx',
64 centroid=(-10.3, 56.9))
66 @pytest.mark.parametrize('lookup_type', [LookupAll, Restrict])
67 @pytest.mark.parametrize('rank,res', [([10], [100, 101]),
69 def test_lookup_all_match(self, apiobj, frontend, lookup_type, rank, res):
70 lookup = FieldLookup('name_vector', [1, 2], lookup_type)
71 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, rank)])
73 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking])
75 assert [r.place_id for r in results] == res
77 @pytest.mark.parametrize('lookup_type', [LookupAll, Restrict])
78 def test_lookup_all_partial_match(self, apiobj, frontend, lookup_type):
79 lookup = FieldLookup('name_vector', [1, 20], lookup_type)
80 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [21])])
82 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking])
84 assert len(results) == 1
85 assert results[0].place_id == 101
87 @pytest.mark.parametrize('rank,res', [([10], [100, 101]),
89 def test_lookup_any_match(self, apiobj, frontend, rank, res):
90 lookup = FieldLookup('name_vector', [11, 21], LookupAny)
91 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, rank)])
93 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking])
95 assert [r.place_id for r in results] == res
97 def test_lookup_any_partial_match(self, apiobj, frontend):
98 lookup = FieldLookup('name_vector', [20], LookupAll)
99 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [21])])
101 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking])
103 assert len(results) == 1
104 assert results[0].place_id == 101
106 @pytest.mark.parametrize('cc,res', [('us', 100), ('mx', 101)])
107 def test_lookup_restrict_country(self, apiobj, frontend, cc, res):
108 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
109 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [10])])
111 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], ccodes=[cc])
113 assert [r.place_id for r in results] == [res]
115 def test_lookup_restrict_placeid(self, apiobj, frontend):
116 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
117 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [10])])
119 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking],
120 details=SearchDetails(excluded=[101]))
122 assert [r.place_id for r in results] == [100]
124 @pytest.mark.parametrize('geom', [napi.GeometryFormat.GEOJSON,
125 napi.GeometryFormat.KML,
126 napi.GeometryFormat.SVG,
127 napi.GeometryFormat.TEXT])
128 def test_return_geometries(self, apiobj, frontend, geom):
129 lookup = FieldLookup('name_vector', [20], LookupAll)
130 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [21])])
132 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking],
133 details=SearchDetails(geometry_output=geom))
135 assert geom.name.lower() in results[0].geometry
137 @pytest.mark.parametrize('factor,npoints', [(0.0, 3), (1.0, 2)])
138 def test_return_simplified_geometry(self, apiobj, frontend, factor, npoints):
139 apiobj.add_placex(place_id=333, country_code='us',
141 geometry='LINESTRING(8.9 9.0, 9.0 9.0, 9.1 9.0)')
142 apiobj.add_search_name(333, names=[55], country_code='us',
145 lookup = FieldLookup('name_vector', [55], LookupAll)
146 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [21])])
148 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking],
149 details=SearchDetails(geometry_output=napi.GeometryFormat.GEOJSON,
150 geometry_simplification=factor))
152 assert len(results) == 1
154 geom = json.loads(result.geometry['geojson'])
156 assert result.place_id == 333
157 assert len(geom['coordinates']) == npoints
159 @pytest.mark.parametrize('viewbox', ['5.0,4.0,6.0,5.0', '5.7,4.0,6.0,5.0'])
160 @pytest.mark.parametrize('wcount,rids', [(2, [100, 101]), (20000, [100])])
161 def test_prefer_viewbox(self, apiobj, frontend, viewbox, wcount, rids):
162 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
163 ranking = FieldRanking('name_vector', 0.2, [RankedTokens(0.0, [21])])
165 api = frontend(apiobj, options=APIOPTIONS)
166 results = run_search(api, None, 0.1, [lookup], [ranking])
167 assert [r.place_id for r in results] == [101, 100]
169 results = run_search(api, None, 0.1, [lookup], [ranking], count=wcount,
170 details=SearchDetails.from_kwargs({'viewbox': viewbox}))
171 assert [r.place_id for r in results] == rids
173 @pytest.mark.parametrize('viewbox', ['5.0,4.0,6.0,5.0', '5.55,4.27,5.62,4.31'])
174 def test_force_viewbox(self, apiobj, frontend, viewbox):
175 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
177 details = SearchDetails.from_kwargs({'viewbox': viewbox,
178 'bounded_viewbox': True})
180 results = run_search(apiobj, frontend, 0.1, [lookup], [], details=details)
181 assert [r.place_id for r in results] == [100]
183 def test_prefer_near(self, apiobj, frontend):
184 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
185 ranking = FieldRanking('name_vector', 0.4, [RankedTokens(0.0, [21])])
187 api = frontend(apiobj, options=APIOPTIONS)
188 results = run_search(api, None, 0.1, [lookup], [ranking])
189 assert [r.place_id for r in results] == [101, 100]
191 results = run_search(api, None, 0.1, [lookup], [ranking],
192 details=SearchDetails.from_kwargs({'near': '5.6,4.3'}))
193 results.sort(key=lambda r: -r.importance)
194 assert [r.place_id for r in results] == [100, 101]
196 @pytest.mark.parametrize('radius', [0.09, 0.11])
197 def test_force_near(self, apiobj, frontend, radius):
198 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
200 details = SearchDetails.from_kwargs({'near': '5.6,4.3',
201 'near_radius': radius})
203 results = run_search(apiobj, frontend, 0.1, [lookup], [], details=details)
205 assert [r.place_id for r in results] == [100]
208 class TestStreetWithHousenumber:
210 @pytest.fixture(autouse=True)
211 def fill_database(self, apiobj):
212 apiobj.add_placex(place_id=1, class_='place', type='house',
213 parent_place_id=1000,
214 housenumber='20 a', country_code='es')
215 apiobj.add_placex(place_id=2, class_='place', type='house',
216 parent_place_id=1000,
217 housenumber='21;22', country_code='es')
218 apiobj.add_placex(place_id=1000, class_='highway', type='residential',
219 rank_search=26, rank_address=26,
221 apiobj.add_search_name(1000, names=[1, 2, 10, 11],
222 search_rank=26, address_rank=26,
224 apiobj.add_placex(place_id=91, class_='place', type='house',
225 parent_place_id=2000,
226 housenumber='20', country_code='pt')
227 apiobj.add_placex(place_id=92, class_='place', type='house',
228 parent_place_id=2000,
229 housenumber='22', country_code='pt')
230 apiobj.add_placex(place_id=93, class_='place', type='house',
231 parent_place_id=2000,
232 housenumber='24', country_code='pt')
233 apiobj.add_placex(place_id=2000, class_='highway', type='residential',
234 rank_search=26, rank_address=26,
236 apiobj.add_search_name(2000, names=[1, 2, 20, 21],
237 search_rank=26, address_rank=26,
240 @pytest.mark.parametrize('hnr,res', [('20', [91, 1]), ('20 a', [1]),
241 ('21', [2]), ('22', [2, 92]),
242 ('24', [93]), ('25', [])])
243 def test_lookup_by_single_housenumber(self, apiobj, frontend, hnr, res):
244 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
245 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
247 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=[hnr])
249 assert [r.place_id for r in results] == res + [1000, 2000]
251 @pytest.mark.parametrize('cc,res', [('es', [2, 1000]), ('pt', [92, 2000])])
252 def test_lookup_with_country_restriction(self, apiobj, frontend, cc, res):
253 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
254 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
256 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
259 assert [r.place_id for r in results] == res
261 def test_lookup_exclude_housenumber_placeid(self, apiobj, frontend):
262 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
263 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
265 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
266 details=SearchDetails(excluded=[92]))
268 assert [r.place_id for r in results] == [2, 1000, 2000]
270 def test_lookup_exclude_street_placeid(self, apiobj, frontend):
271 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
272 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
274 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
275 details=SearchDetails(excluded=[1000]))
277 assert [r.place_id for r in results] == [2, 92, 2000]
279 def test_lookup_only_house_qualifier(self, apiobj, frontend):
280 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
281 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
283 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
284 quals=[('place', 'house')])
286 assert [r.place_id for r in results] == [2, 92]
288 def test_lookup_only_street_qualifier(self, apiobj, frontend):
289 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
290 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
292 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
293 quals=[('highway', 'residential')])
295 assert [r.place_id for r in results] == [1000, 2000]
297 @pytest.mark.parametrize('rank,found', [(26, True), (27, False), (30, False)])
298 def test_lookup_min_rank(self, apiobj, frontend, rank, found):
299 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
300 ranking = FieldRanking('name_vector', 0.3, [RankedTokens(0.0, [10])])
302 results = run_search(apiobj, frontend, 0.1, [lookup], [ranking], hnrs=['22'],
303 details=SearchDetails(min_rank=rank))
305 assert [r.place_id for r in results] == ([2, 92, 1000, 2000] if found else [2, 92])
307 @pytest.mark.parametrize('geom', [napi.GeometryFormat.GEOJSON,
308 napi.GeometryFormat.KML,
309 napi.GeometryFormat.SVG,
310 napi.GeometryFormat.TEXT])
311 def test_return_geometries(self, apiobj, frontend, geom):
312 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
314 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=['20', '21', '22'],
315 details=SearchDetails(geometry_output=geom))
318 assert all(geom.name.lower() in r.geometry for r in results)
321 def test_very_large_housenumber(apiobj, frontend):
322 apiobj.add_placex(place_id=93, class_='place', type='house',
323 parent_place_id=2000,
324 housenumber='2467463524544', country_code='pt')
325 apiobj.add_placex(place_id=2000, class_='highway', type='residential',
326 rank_search=26, rank_address=26,
328 apiobj.add_search_name(2000, names=[1, 2],
329 search_rank=26, address_rank=26,
332 lookup = FieldLookup('name_vector', [1, 2], LookupAll)
334 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=['2467463524544'],
335 details=SearchDetails())
338 assert [r.place_id for r in results] == [93, 2000]
341 @pytest.mark.parametrize('wcount,rids', [(2, [990, 991]), (30000, [990])])
342 def test_name_and_postcode(apiobj, frontend, wcount, rids):
343 apiobj.add_placex(place_id=990, class_='highway', type='service',
344 rank_search=27, rank_address=27,
346 centroid=(10.0, 10.0),
347 geometry='LINESTRING(9.995 10, 10.005 10)')
348 apiobj.add_search_name(990, names=[111], centroid=(10.0, 10.0),
349 search_rank=27, address_rank=27)
350 apiobj.add_placex(place_id=991, class_='highway', type='service',
351 rank_search=27, rank_address=27,
353 centroid=(10.3, 10.3),
354 geometry='LINESTRING(9.995 10.3, 10.005 10.3)')
355 apiobj.add_search_name(991, names=[111], centroid=(10.3, 10.3),
356 search_rank=27, address_rank=27)
357 apiobj.add_postcode(place_id=100, country_code='ch', postcode='11225',
358 geometry='POINT(10 10)')
360 lookup = FieldLookup('name_vector', [111], LookupAll)
362 results = run_search(apiobj, frontend, 0.1, [lookup], [], pcs=['11225'], count=wcount,
363 details=SearchDetails())
366 assert [r.place_id for r in results] == rids
369 class TestInterpolations:
371 @pytest.fixture(autouse=True)
372 def fill_database(self, apiobj):
373 apiobj.add_placex(place_id=990, class_='highway', type='service',
374 rank_search=27, rank_address=27,
375 centroid=(10.0, 10.0),
376 geometry='LINESTRING(9.995 10, 10.005 10)')
377 apiobj.add_search_name(990, names=[111],
378 search_rank=27, address_rank=27)
379 apiobj.add_placex(place_id=991, class_='place', type='house',
381 rank_search=30, rank_address=30,
383 centroid=(10.0, 10.00002))
384 apiobj.add_osmline(place_id=992,
386 startnumber=21, endnumber=29, step=2,
387 centroid=(10.0, 10.00001),
388 geometry='LINESTRING(9.995 10.00001, 10.005 10.00001)')
390 @pytest.mark.parametrize('hnr,res', [('21', [992]), ('22', []), ('23', [991])])
391 def test_lookup_housenumber(self, apiobj, frontend, hnr, res):
392 lookup = FieldLookup('name_vector', [111], LookupAll)
394 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=[hnr])
396 assert [r.place_id for r in results] == res + [990]
398 @pytest.mark.parametrize('geom', [napi.GeometryFormat.GEOJSON,
399 napi.GeometryFormat.KML,
400 napi.GeometryFormat.SVG,
401 napi.GeometryFormat.TEXT])
402 def test_osmline_with_geometries(self, apiobj, frontend, geom):
403 lookup = FieldLookup('name_vector', [111], LookupAll)
405 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=['21'],
406 details=SearchDetails(geometry_output=geom))
408 assert results[0].place_id == 992
409 assert geom.name.lower() in results[0].geometry
414 @pytest.fixture(autouse=True)
415 def fill_database(self, apiobj):
416 apiobj.add_placex(place_id=990, class_='highway', type='service',
417 rank_search=27, rank_address=27,
419 centroid=(10.0, 10.0),
420 geometry='LINESTRING(9.995 10, 10.005 10)')
421 apiobj.add_search_name(990, names=[111], country_code='us',
422 search_rank=27, address_rank=27)
423 apiobj.add_placex(place_id=991, class_='place', type='house',
425 rank_search=30, rank_address=30,
428 centroid=(10.0, 10.00002))
429 apiobj.add_tiger(place_id=992,
431 startnumber=21, endnumber=29, step=2,
432 centroid=(10.0, 10.00001),
433 geometry='LINESTRING(9.995 10.00001, 10.005 10.00001)')
435 @pytest.mark.parametrize('hnr,res', [('21', [992]), ('22', []), ('23', [991])])
436 def test_lookup_housenumber(self, apiobj, frontend, hnr, res):
437 lookup = FieldLookup('name_vector', [111], LookupAll)
439 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=[hnr])
441 assert [r.place_id for r in results] == res + [990]
443 @pytest.mark.parametrize('geom', [napi.GeometryFormat.GEOJSON,
444 napi.GeometryFormat.KML,
445 napi.GeometryFormat.SVG,
446 napi.GeometryFormat.TEXT])
447 def test_tiger_with_geometries(self, apiobj, frontend, geom):
448 lookup = FieldLookup('name_vector', [111], LookupAll)
450 results = run_search(apiobj, frontend, 0.1, [lookup], [], hnrs=['21'],
451 details=SearchDetails(geometry_output=geom))
453 assert results[0].place_id == 992
454 assert geom.name.lower() in results[0].geometry
457 class TestLayersRank30:
459 @pytest.fixture(autouse=True)
460 def fill_database(self, apiobj):
461 apiobj.add_placex(place_id=223, class_='place', type='house',
465 apiobj.add_search_name(223, names=[34],
467 address_rank=30, search_rank=30)
468 apiobj.add_placex(place_id=224, class_='amenity', type='toilet',
471 apiobj.add_search_name(224, names=[34],
473 address_rank=30, search_rank=30)
474 apiobj.add_placex(place_id=225, class_='man_made', type='tower',
477 apiobj.add_search_name(225, names=[34],
479 address_rank=0, search_rank=30)
480 apiobj.add_placex(place_id=226, class_='railway', type='station',
483 apiobj.add_search_name(226, names=[34],
485 address_rank=0, search_rank=30)
486 apiobj.add_placex(place_id=227, class_='natural', type='cave',
489 apiobj.add_search_name(227, names=[34],
491 address_rank=0, search_rank=30)
493 @pytest.mark.parametrize('layer,res',
494 [(napi.DataLayer.ADDRESS, [223]),
495 (napi.DataLayer.POI, [224]),
496 (napi.DataLayer.ADDRESS | napi.DataLayer.POI, [223, 224]),
497 (napi.DataLayer.MANMADE, [225]),
498 (napi.DataLayer.RAILWAY, [226]),
499 (napi.DataLayer.NATURAL, [227]),
500 (napi.DataLayer.MANMADE | napi.DataLayer.NATURAL, [225, 227]),
501 (napi.DataLayer.MANMADE | napi.DataLayer.RAILWAY, [225, 226])])
502 def test_layers_rank30(self, apiobj, frontend, layer, res):
503 lookup = FieldLookup('name_vector', [34], LookupAny)
505 results = run_search(apiobj, frontend, 0.1, [lookup], [],
506 details=SearchDetails(layers=layer))
508 assert [r.place_id for r in results] == res