test/python/tokenizer/token_analysis/test_generic.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 import name normalisation and variant generation.
   9 """
  10 import pytest
  11
  12 from icu import Transliterator
  13
  14 import nominatim_db.tokenizer.token_analysis.generic as module
  15 from nominatim_db.errors import UsageError
  16
  17 DEFAULT_NORMALIZATION = """ :: NFD ();
  18                             '🜳' > ' ';
  19                             [[:Nonspacing Mark:] [:Cf:]] >;
  20                             :: lower ();
  21                             [[:Punctuation:][:Space:]]+ > ' ';
  22                             :: NFC ();
  23                         """
  24
  25 DEFAULT_TRANSLITERATION = """ ::  Latin ();
  26                               '🜵' > ' ';
  27                           """
  28
  29
  30 def make_analyser(*variants, variant_only=False):
  31     rules = {'analyzer': 'generic', 'variants': [{'words': variants}]}
  32     if variant_only:
  33         rules['mode'] = 'variant-only'
  34     trans = Transliterator.createFromRules("test_trans", DEFAULT_TRANSLITERATION)
  35     norm = Transliterator.createFromRules("test_norm", DEFAULT_NORMALIZATION)
  36     config = module.configure(rules, norm, trans)
  37
  38     return module.create(norm, trans, config)
  39
  40
  41 def get_normalized_variants(proc, name):
  42     norm = Transliterator.createFromRules("test_norm", DEFAULT_NORMALIZATION)
  43     return proc.compute_variants(norm.transliterate(name).strip())[0]
  44
  45
  46 def test_no_variants():
  47     rules = {'analyzer': 'generic'}
  48     trans = Transliterator.createFromRules("test_trans", DEFAULT_TRANSLITERATION)
  49     norm = Transliterator.createFromRules("test_norm", DEFAULT_NORMALIZATION)
  50     config = module.configure(rules, norm, trans)
  51
  52     proc = module.create(norm, trans, config)
  53
  54     assert get_normalized_variants(proc, '大德!') == ['dà dé']
  55
  56
  57 def test_variants_empty():
  58     proc = make_analyser('saint -> 🜵', 'street -> st')
  59
  60     assert get_normalized_variants(proc, '🜵') == []
  61     assert get_normalized_variants(proc, '🜳') == []
  62     assert get_normalized_variants(proc, 'saint') == ['saint']
  63
  64
  65 VARIANT_TESTS = [
  66     (('~strasse,~straße -> str', '~weg => weg'), "hallo", {'hallo'}),
  67     (('weg => wg',), "holzweg", {'holzweg'}),
  68     (('weg -> wg',), "holzweg", {'holzweg'}),
  69     (('~weg => weg',), "holzweg", {'holz weg', 'holzweg'}),
  70     (('~weg -> weg',), "holzweg",  {'holz weg', 'holzweg'}),
  71     (('~weg => w',), "holzweg", {'holz w', 'holzw'}),
  72     (('~weg -> w',), "holzweg",  {'holz weg', 'holzweg', 'holz w', 'holzw'}),
  73     (('~weg => weg',), "Meier Weg", {'meier weg', 'meierweg'}),
  74     (('~weg -> weg',), "Meier Weg", {'meier weg', 'meierweg'}),
  75     (('~weg => w',), "Meier Weg", {'meier w', 'meierw'}),
  76     (('~weg -> w',), "Meier Weg", {'meier weg', 'meierweg', 'meier w', 'meierw'}),
  77     (('weg => wg',), "Meier Weg", {'meier wg'}),
  78     (('weg -> wg',), "Meier Weg", {'meier weg', 'meier wg'}),
  79     (('~strasse,~straße -> str', '~weg => weg'), "Bauwegstraße",
  80      {'bauweg straße', 'bauweg str', 'bauwegstraße', 'bauwegstr'}),
  81     (('am => a', 'bach => b'), "am bach", {'a b'}),
  82     (('am => a', '~bach => b'), "am bach", {'a b'}),
  83     (('am -> a', '~bach -> b'), "am bach", {'am bach', 'a bach', 'am b', 'a b'}),
  84     (('am -> a', '~bach -> b'), "ambach", {'ambach', 'am bach', 'amb', 'am b'}),
  85     (('saint -> s,st', 'street -> st'), "Saint Johns Street",
  86      {'saint johns street', 's johns street', 'st johns street',
  87       'saint johns st', 's johns st', 'st johns st'}),
  88     (('river$ -> r',), "River Bend Road", {'river bend road'}),
  89     (('river$ -> r',), "Bent River", {'bent river', 'bent r'}),
  90     (('^north => n',), "North 2nd Street", {'n 2nd street'}),
  91     (('^north => n',), "Airport North", {'airport north'}),
  92     (('am -> a',), "am am am am am am am am", {'am am am am am am am am'}),
  93     (('am => a',), "am am am am am am am am", {'a a a a a a a a'})
  94     ]
  95
  96
  97 @pytest.mark.parametrize("rules,name,variants", VARIANT_TESTS)
  98 def test_variants(rules, name, variants):
  99     proc = make_analyser(*rules)
 100
 101     result = get_normalized_variants(proc, name)
 102
 103     assert len(result) == len(set(result))
 104     assert set(get_normalized_variants(proc, name)) == variants
 105
 106
 107 VARIANT_ONLY_TESTS = [
 108     (('weg => wg',), "hallo", set()),
 109     (('weg => wg',), "Meier Weg", {'meier wg'}),
 110     (('weg -> wg',), "Meier Weg", {'meier wg'}),
 111     ]
 112
 113
 114 @pytest.mark.parametrize("rules,name,variants", VARIANT_ONLY_TESTS)
 115 def test_variants_only(rules, name, variants):
 116     proc = make_analyser(*rules, variant_only=True)
 117
 118     result = get_normalized_variants(proc, name)
 119
 120     assert len(result) == len(set(result))
 121     assert set(get_normalized_variants(proc, name)) == variants
 122
 123
 124 class TestGetReplacements:
 125
 126     @staticmethod
 127     def configure_rules(*variants):
 128         rules = {'analyzer': 'generic', 'variants': [{'words': variants}]}
 129         trans = Transliterator.createFromRules("test_trans", DEFAULT_TRANSLITERATION)
 130         norm = Transliterator.createFromRules("test_norm", DEFAULT_NORMALIZATION)
 131         return module.configure(rules, norm, trans)
 132
 133     def get_replacements(self, *variants):
 134         config = self.configure_rules(*variants)
 135
 136         return sorted((k, sorted(v)) for k, v in config['replacements'])
 137
 138     @pytest.mark.parametrize("variant", ['foo > bar', 'foo -> bar -> bar',
 139                                          '~foo~ -> bar', 'fo~ o -> bar'])
 140     def test_invalid_variant_description(self, variant):
 141         with pytest.raises(UsageError):
 142             self.configure_rules(variant)
 143
 144     @pytest.mark.parametrize("rule", ["!!! -> bar", "bar => !!!"])
 145     def test_ignore_unnormalizable_terms(self, rule):
 146         repl = self.get_replacements(rule)
 147
 148         assert repl == []
 149
 150     def test_add_full(self):
 151         repl = self.get_replacements("foo -> bar")
 152
 153         assert repl == [(' foo ', [' bar', ' foo'])]
 154
 155     def test_replace_full(self):
 156         repl = self.get_replacements("foo => bar")
 157
 158         assert repl == [(' foo ', [' bar'])]
 159
 160     def test_add_suffix_no_decompose(self):
 161         repl = self.get_replacements("~berg |-> bg")
 162
 163         assert repl == [(' berg ', [' berg', ' bg']),
 164                         ('berg ', ['berg', 'bg'])]
 165
 166     def test_replace_suffix_no_decompose(self):
 167         repl = self.get_replacements("~berg |=> bg")
 168
 169         assert repl == [(' berg ', [' bg']), ('berg ', ['bg'])]
 170
 171     def test_add_suffix_decompose(self):
 172         repl = self.get_replacements("~berg -> bg")
 173
 174         assert repl == [(' berg ', [' berg', ' bg', 'berg', 'bg']),
 175                         ('berg ', [' berg', ' bg', 'berg', 'bg'])]
 176
 177     def test_replace_suffix_decompose(self):
 178         repl = self.get_replacements("~berg => bg")
 179
 180         assert repl == [(' berg ', [' bg', 'bg']),
 181                         ('berg ', [' bg', 'bg'])]
 182
 183     def test_add_prefix_no_compose(self):
 184         repl = self.get_replacements("hinter~ |-> hnt")
 185
 186         assert repl == [(' hinter', [' hinter', ' hnt']),
 187                         (' hinter ', [' hinter', ' hnt'])]
 188
 189     def test_replace_prefix_no_compose(self):
 190         repl = self.get_replacements("hinter~ |=> hnt")
 191
 192         assert repl == [(' hinter', [' hnt']), (' hinter ', [' hnt'])]
 193
 194     def test_add_prefix_compose(self):
 195         repl = self.get_replacements("hinter~-> h")
 196
 197         assert repl == [(' hinter', [' h', ' h ', ' hinter', ' hinter ']),
 198                         (' hinter ', [' h', ' h', ' hinter', ' hinter'])]
 199
 200     def test_replace_prefix_compose(self):
 201         repl = self.get_replacements("hinter~=> h")
 202
 203         assert repl == [(' hinter', [' h', ' h ']),
 204                         (' hinter ', [' h', ' h'])]
 205
 206     def test_add_beginning_only(self):
 207         repl = self.get_replacements("^Premier -> Pr")
 208
 209         assert repl == [('^ premier ', ['^ pr', '^ premier'])]
 210
 211     def test_replace_beginning_only(self):
 212         repl = self.get_replacements("^Premier => Pr")
 213
 214         assert repl == [('^ premier ', ['^ pr'])]
 215
 216     def test_add_final_only(self):
 217         repl = self.get_replacements("road$ -> rd")
 218
 219         assert repl == [(' road ^', [' rd ^', ' road ^'])]
 220
 221     def test_replace_final_only(self):
 222         repl = self.get_replacements("road$ => rd")
 223
 224         assert repl == [(' road ^', [' rd ^'])]
 225
 226     def test_decompose_only(self):
 227         repl = self.get_replacements("~foo -> foo")
 228
 229         assert repl == [(' foo ', [' foo', 'foo']),
 230                         ('foo ', [' foo', 'foo'])]
 231
 232     def test_add_suffix_decompose_end_only(self):
 233         repl = self.get_replacements("~berg |-> bg", "~berg$ -> bg")
 234
 235         assert repl == [(' berg ', [' berg', ' bg']),
 236                         (' berg ^', [' berg ^', ' bg ^', 'berg ^', 'bg ^']),
 237                         ('berg ', ['berg', 'bg']),
 238                         ('berg ^', [' berg ^', ' bg ^', 'berg ^', 'bg ^'])]
 239
 240     def test_replace_suffix_decompose_end_only(self):
 241         repl = self.get_replacements("~berg |=> bg", "~berg$ => bg")
 242
 243         assert repl == [(' berg ', [' bg']),
 244                         (' berg ^', [' bg ^', 'bg ^']),
 245                         ('berg ', ['bg']),
 246                         ('berg ^', [' bg ^', 'bg ^'])]
 247
 248     @pytest.mark.parametrize('rule', ["~berg,~burg -> bg",
 249                                       "~berg, ~burg -> bg",
 250                                       "~berg,,~burg -> bg"])
 251     def test_add_multiple_suffix(self, rule):
 252         repl = self.get_replacements(rule)
 253
 254         assert repl == [(' berg ', [' berg', ' bg', 'berg', 'bg']),
 255                         (' burg ', [' bg', ' burg', 'bg', 'burg']),
 256                         ('berg ', [' berg', ' bg', 'berg', 'bg']),
 257                         ('burg ', [' bg', ' burg', 'bg', 'burg'])]