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