test/python/api/search/test_icu_query_analyzer.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2025 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for query analyzer for ICU tokenizer.
   9 """
  10 import pytest
  11 import pytest_asyncio
  12
  13 from nominatim_api import NominatimAPIAsync
  14 from nominatim_api.search.query import Phrase
  15 import nominatim_api.search.query as qmod
  16 import nominatim_api.search.icu_tokenizer as tok
  17 from nominatim_api.logging import set_log_output, get_and_disable
  18
  19
  20 async def add_word(conn, word_id, word_token, wtype, word, info=None):
  21     t = conn.t.meta.tables['word']
  22     await conn.execute(t.insert(), {'word_id': word_id,
  23                                     'word_token': word_token,
  24                                     'type': wtype,
  25                                     'word': word,
  26                                     'info': info})
  27
  28
  29 def make_phrase(query):
  30     return [Phrase(qmod.PHRASE_ANY, s) for s in query.split(',')]
  31
  32
  33 @pytest_asyncio.fixture
  34 async def conn(table_factory):
  35     """ Create an asynchronous SQLAlchemy engine for the test DB.
  36     """
  37     table_factory('nominatim_properties',
  38                   definition='property TEXT, value TEXT',
  39                   content=(('tokenizer_import_normalisation', ':: lower();'),
  40                            ('tokenizer_import_transliteration', "'1' > '/1/'; 'ä' > 'ä '")))
  41     table_factory('word',
  42                   definition='word_id INT, word_token TEXT, type TEXT, word TEXT, info JSONB')
  43
  44     async with NominatimAPIAsync() as api:
  45         async with api.begin() as conn:
  46             yield conn
  47
  48
  49 @pytest.mark.asyncio
  50 async def test_empty_phrase(conn):
  51     ana = await tok.create_query_analyzer(conn)
  52
  53     query = await ana.analyze_query([])
  54
  55     assert len(query.source) == 0
  56     assert query.num_token_slots() == 0
  57
  58
  59 @pytest.mark.asyncio
  60 async def test_single_phrase_with_unknown_terms(conn):
  61     ana = await tok.create_query_analyzer(conn)
  62
  63     await add_word(conn, 1, 'foo', 'w', 'FOO')
  64
  65     query = await ana.analyze_query(make_phrase('foo BAR'))
  66
  67     assert len(query.source) == 1
  68     assert query.source[0].ptype == qmod.PHRASE_ANY
  69     assert query.source[0].text == 'foo bar'
  70
  71     assert query.num_token_slots() == 2
  72     assert len(query.nodes[0].starting) == 1
  73     assert not query.nodes[1].starting
  74
  75
  76 @pytest.mark.asyncio
  77 async def test_multiple_phrases(conn):
  78     ana = await tok.create_query_analyzer(conn)
  79
  80     await add_word(conn, 1, 'one', 'w', 'one')
  81     await add_word(conn, 2, 'two', 'w', 'two')
  82     await add_word(conn, 100, 'one two', 'W', 'one two')
  83     await add_word(conn, 3, 'three', 'w', 'three')
  84
  85     query = await ana.analyze_query(make_phrase('one two,three'))
  86
  87     assert len(query.source) == 2
  88
  89
  90 @pytest.mark.asyncio
  91 async def test_splitting_in_transliteration(conn):
  92     ana = await tok.create_query_analyzer(conn)
  93
  94     await add_word(conn, 1, 'mä', 'W', 'ma')
  95     await add_word(conn, 2, 'fo', 'W', 'fo')
  96
  97     query = await ana.analyze_query(make_phrase('mäfo'))
  98
  99     assert query.num_token_slots() == 2
 100     assert query.nodes[0].starting
 101     assert query.nodes[1].starting
 102     assert query.nodes[1].btype == qmod.BREAK_TOKEN
 103
 104
 105 @pytest.mark.asyncio
 106 @pytest.mark.parametrize('term,order', [('23456', ['P', 'H', 'W', 'w']),
 107                                         ('3', ['H', 'W', 'w'])])
 108 async def test_penalty_postcodes_and_housenumbers(conn, term, order):
 109     ana = await tok.create_query_analyzer(conn)
 110
 111     await add_word(conn, 2, term, 'H', term)
 112     await add_word(conn, 3, term, 'w', term)
 113     await add_word(conn, 4, term, 'W', term)
 114
 115     query = await ana.analyze_query(make_phrase(term))
 116
 117     assert query.num_token_slots() == 1
 118
 119     torder = [(tl.tokens[0].penalty, tl.ttype) for tl in query.nodes[0].starting]
 120     torder.sort()
 121
 122     assert [t[1] for t in torder] == order
 123
 124
 125 @pytest.mark.asyncio
 126 async def test_category_words_only_at_beginning(conn):
 127     ana = await tok.create_query_analyzer(conn)
 128
 129     await add_word(conn, 1, 'foo', 'S', 'FOO', {'op': 'in'})
 130     await add_word(conn, 2, 'bar', 'w', 'BAR')
 131
 132     query = await ana.analyze_query(make_phrase('foo BAR foo'))
 133
 134     assert query.num_token_slots() == 3
 135     assert len(query.nodes[0].starting) == 1
 136     assert query.nodes[0].starting[0].ttype == qmod.TOKEN_NEAR_ITEM
 137     assert not query.nodes[2].starting
 138
 139
 140 @pytest.mark.asyncio
 141 async def test_freestanding_qualifier_words_become_category(conn):
 142     ana = await tok.create_query_analyzer(conn)
 143
 144     await add_word(conn, 1, 'foo', 'S', 'FOO', {'op': '-'})
 145
 146     query = await ana.analyze_query(make_phrase('foo'))
 147
 148     assert query.num_token_slots() == 1
 149     assert len(query.nodes[0].starting) == 1
 150     assert query.nodes[0].starting[0].ttype == qmod.TOKEN_NEAR_ITEM
 151
 152
 153 @pytest.mark.asyncio
 154 async def test_qualifier_words(conn):
 155     ana = await tok.create_query_analyzer(conn)
 156
 157     await add_word(conn, 1, 'foo', 'S', None, {'op': '-'})
 158     await add_word(conn, 2, 'bar', 'w', None)
 159
 160     query = await ana.analyze_query(make_phrase('foo BAR foo BAR foo'))
 161
 162     assert query.num_token_slots() == 5
 163     assert set(t.ttype for t in query.nodes[0].starting) == {qmod.TOKEN_QUALIFIER}
 164     assert set(t.ttype for t in query.nodes[2].starting) == {qmod.TOKEN_QUALIFIER}
 165     assert set(t.ttype for t in query.nodes[4].starting) == {qmod.TOKEN_QUALIFIER}
 166
 167
 168 @pytest.mark.asyncio
 169 async def test_add_unknown_housenumbers(conn):
 170     ana = await tok.create_query_analyzer(conn)
 171
 172     await add_word(conn, 1, '23', 'H', '23')
 173
 174     query = await ana.analyze_query(make_phrase('466 23 99834 34a'))
 175
 176     assert query.num_token_slots() == 4
 177     assert query.nodes[0].starting[0].ttype == qmod.TOKEN_HOUSENUMBER
 178     assert len(query.nodes[0].starting[0].tokens) == 1
 179     assert query.nodes[0].starting[0].tokens[0].token == 0
 180     assert query.nodes[1].starting[0].ttype == qmod.TOKEN_HOUSENUMBER
 181     assert len(query.nodes[1].starting[0].tokens) == 1
 182     assert query.nodes[1].starting[0].tokens[0].token == 1
 183     assert query.nodes[2].has_tokens(3, qmod.TOKEN_POSTCODE)
 184     assert not query.nodes[2].has_tokens(3, qmod.TOKEN_HOUSENUMBER)
 185     assert not query.nodes[2].has_tokens(4, qmod.TOKEN_HOUSENUMBER)
 186     assert not query.nodes[3].has_tokens(4, qmod.TOKEN_HOUSENUMBER)
 187
 188
 189 @pytest.mark.asyncio
 190 @pytest.mark.parametrize('logtype', ['text', 'html'])
 191 async def test_log_output(conn, logtype):
 192
 193     ana = await tok.create_query_analyzer(conn)
 194
 195     await add_word(conn, 1, 'foo', 'w', 'FOO')
 196
 197     set_log_output(logtype)
 198     await ana.analyze_query(make_phrase('foo'))
 199
 200     assert get_and_disable()