test/python/tokenizer/test_icu_rule_loader.py

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