test/python/tokenizer/test_icu_rule_loader.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 converting a config file to ICU rules.
   9 """
  10 from textwrap import dedent
  11
  12 import pytest
  13 import yaml
  14
  15 from nominatim_db.tokenizer.icu_rule_loader import ICURuleLoader
  16 from nominatim_db.errors import UsageError
  17
  18 from icu import Transliterator
  19
  20 CONFIG_SECTIONS = ('normalization', 'transliteration', 'token-analysis')
  21
  22
  23 class TestIcuRuleLoader:
  24
  25     @pytest.fixture(autouse=True)
  26     def init_env(self, project_env):
  27         self.project_env = project_env
  28
  29     def write_config(self, content):
  30         (self.project_env.project_dir / 'icu_tokenizer.yaml').write_text(dedent(content))
  31
  32     def config_rules(self, *variants):
  33         content = dedent("""\
  34         normalization:
  35             - ":: NFD ()"
  36             - "[[:Nonspacing Mark:] [:Cf:]] >"
  37             - ":: lower ()"
  38             - "[[:Punctuation:][:Space:]]+ > ' '"
  39             - ":: NFC ()"
  40         transliteration:
  41             - "::  Latin ()"
  42             - "[[:Punctuation:][:Space:]]+ > ' '"
  43         token-analysis:
  44             - analyzer: generic
  45               variants:
  46                   - words:
  47         """)
  48         content += '\n'.join(("             - " + s for s in variants)) + '\n'
  49         self.write_config(content)
  50
  51     def get_replacements(self, *variants):
  52         self.config_rules(*variants)
  53         loader = ICURuleLoader(self.project_env)
  54         rules = loader.analysis[None].config['replacements']
  55
  56         return sorted((k, sorted(v)) for k, v in rules)
  57
  58     def test_empty_rule_set(self):
  59         self.write_config("""\
  60             normalization:
  61             transliteration:
  62             token-analysis:
  63               - analyzer: generic
  64                 variants:
  65             """)
  66
  67         rules = ICURuleLoader(self.project_env)
  68         assert rules.get_search_rules() == ''
  69         assert rules.get_normalization_rules() == ''
  70         assert rules.get_transliteration_rules() == ''
  71
  72     @pytest.mark.parametrize("section", CONFIG_SECTIONS)
  73     def test_missing_section(self, section):
  74         rule_cfg = {s: [] for s in CONFIG_SECTIONS if s != section}
  75         self.write_config(yaml.dump(rule_cfg))
  76
  77         with pytest.raises(UsageError):
  78             ICURuleLoader(self.project_env)
  79
  80     def test_get_search_rules(self):
  81         self.config_rules()
  82         loader = ICURuleLoader(self.project_env)
  83
  84         rules = loader.get_search_rules()
  85         trans = Transliterator.createFromRules("test", rules)
  86
  87         assert trans.transliterate(" Baum straße ") == " baum straße "
  88         assert trans.transliterate(" Baumstraße ") == " baumstraße "
  89         assert trans.transliterate(" Baumstrasse ") == " baumstrasse "
  90         assert trans.transliterate(" Baumstr ") == " baumstr "
  91         assert trans.transliterate(" Baumwegstr ") == " baumwegstr "
  92         assert trans.transliterate(" Αθήνα ") == " athēna "
  93         assert trans.transliterate(" проспект ") == " prospekt "
  94
  95     def test_get_normalization_rules(self):
  96         self.config_rules()
  97         loader = ICURuleLoader(self.project_env)
  98         rules = loader.get_normalization_rules()
  99         trans = Transliterator.createFromRules("test", rules)
 100
 101         assert trans.transliterate(" проспект-Prospekt ") == " проспект prospekt "
 102
 103     def test_get_transliteration_rules(self):
 104         self.config_rules()
 105         loader = ICURuleLoader(self.project_env)
 106         rules = loader.get_transliteration_rules()
 107         trans = Transliterator.createFromRules("test", rules)
 108
 109         assert trans.transliterate(" проспект-Prospekt ") == " prospekt Prospekt "
 110
 111     def test_transliteration_rules_from_file(self):
 112         self.write_config("""\
 113             normalization:
 114             transliteration:
 115                 - "'ax' > 'b'"
 116                 - !include transliteration.yaml
 117             token-analysis:
 118                 - analyzer: generic
 119                   variants:
 120             """)
 121         transpath = self.project_env.project_dir / ('transliteration.yaml')
 122         transpath.write_text('- "x > y"')
 123
 124         loader = ICURuleLoader(self.project_env)
 125         rules = loader.get_transliteration_rules()
 126         trans = Transliterator.createFromRules("test", rules)
 127
 128         assert trans.transliterate(" axxt ") == " byt "
 129
 130     def test_search_rules(self):
 131         self.config_rules('~street => s,st', 'master => mstr')
 132         proc = ICURuleLoader(self.project_env).make_token_analysis()
 133
 134         assert proc.search.transliterate('Master Street').strip() == 'master street'
 135         assert proc.search.transliterate('Earnes St').strip() == 'earnes st'
 136         assert proc.search.transliterate('Nostreet').strip() == 'nostreet'
 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         self.config_rules(variant)
 142         with pytest.raises(UsageError):
 143             ICURuleLoader(self.project_env)
 144
 145     def test_add_full(self):
 146         repl = self.get_replacements("foo -> bar")
 147
 148         assert repl == [(' foo ', [' bar', ' foo'])]
 149
 150     def test_replace_full(self):
 151         repl = self.get_replacements("foo => bar")
 152
 153         assert repl == [(' foo ', [' bar'])]
 154
 155     def test_add_suffix_no_decompose(self):
 156         repl = self.get_replacements("~berg |-> bg")
 157
 158         assert repl == [(' berg ', [' berg', ' bg']),
 159                         ('berg ', ['berg', 'bg'])]
 160
 161     def test_replace_suffix_no_decompose(self):
 162         repl = self.get_replacements("~berg |=> bg")
 163
 164         assert repl == [(' berg ', [' bg']), ('berg ', ['bg'])]
 165
 166     def test_add_suffix_decompose(self):
 167         repl = self.get_replacements("~berg -> bg")
 168
 169         assert repl == [(' berg ', [' berg', ' bg', 'berg', 'bg']),
 170                         ('berg ', [' berg', ' bg', 'berg', 'bg'])]
 171
 172     def test_replace_suffix_decompose(self):
 173         repl = self.get_replacements("~berg => bg")
 174
 175         assert repl == [(' berg ', [' bg', 'bg']),
 176                         ('berg ', [' bg', 'bg'])]
 177
 178     def test_add_prefix_no_compose(self):
 179         repl = self.get_replacements("hinter~ |-> hnt")
 180
 181         assert repl == [(' hinter', [' hinter', ' hnt']),
 182                         (' hinter ', [' hinter', ' hnt'])]
 183
 184     def test_replace_prefix_no_compose(self):
 185         repl = self.get_replacements("hinter~ |=> hnt")
 186
 187         assert repl == [(' hinter', [' hnt']), (' hinter ', [' hnt'])]
 188
 189     def test_add_prefix_compose(self):
 190         repl = self.get_replacements("hinter~-> h")
 191
 192         assert repl == [(' hinter', [' h', ' h ', ' hinter', ' hinter ']),
 193                         (' hinter ', [' h', ' h', ' hinter', ' hinter'])]
 194
 195     def test_replace_prefix_compose(self):
 196         repl = self.get_replacements("hinter~=> h")
 197
 198         assert repl == [(' hinter', [' h', ' h ']),
 199                         (' hinter ', [' h', ' h'])]
 200
 201     def test_add_beginning_only(self):
 202         repl = self.get_replacements("^Premier -> Pr")
 203
 204         assert repl == [('^ premier ', ['^ pr', '^ premier'])]
 205
 206     def test_replace_beginning_only(self):
 207         repl = self.get_replacements("^Premier => Pr")
 208
 209         assert repl == [('^ premier ', ['^ pr'])]
 210
 211     def test_add_final_only(self):
 212         repl = self.get_replacements("road$ -> rd")
 213
 214         assert repl == [(' road ^', [' rd ^', ' road ^'])]
 215
 216     def test_replace_final_only(self):
 217         repl = self.get_replacements("road$ => rd")
 218
 219         assert repl == [(' road ^', [' rd ^'])]
 220
 221     def test_decompose_only(self):
 222         repl = self.get_replacements("~foo -> foo")
 223
 224         assert repl == [(' foo ', [' foo', 'foo']),
 225                         ('foo ', [' foo', 'foo'])]
 226
 227     def test_add_suffix_decompose_end_only(self):
 228         repl = self.get_replacements("~berg |-> bg", "~berg$ -> bg")
 229
 230         assert repl == [(' berg ', [' berg', ' bg']),
 231                         (' berg ^', [' berg ^', ' bg ^', 'berg ^', 'bg ^']),
 232                         ('berg ', ['berg', 'bg']),
 233                         ('berg ^', [' berg ^', ' bg ^', 'berg ^', 'bg ^'])]
 234
 235     def test_replace_suffix_decompose_end_only(self):
 236         repl = self.get_replacements("~berg |=> bg", "~berg$ => bg")
 237
 238         assert repl == [(' berg ', [' bg']),
 239                         (' berg ^', [' bg ^', 'bg ^']),
 240                         ('berg ', ['bg']),
 241                         ('berg ^', [' bg ^', 'bg ^'])]
 242
 243     def test_add_multiple_suffix(self):
 244         repl = self.get_replacements("~berg,~burg -> bg")
 245
 246         assert repl == [(' berg ', [' berg', ' bg', 'berg', 'bg']),
 247                         (' burg ', [' bg', ' burg', 'bg', 'burg']),
 248                         ('berg ', [' berg', ' bg', 'berg', 'bg']),
 249                         ('burg ', [' bg', ' burg', 'bg', 'burg'])]