X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/a6aa6360e0e488b4a70e92a9cff724b951309114..52847b61a3e1bc0791dd23809dc3c50fe6810df2:/nominatim/tokenizer/icu_rule_loader.py diff --git a/nominatim/tokenizer/icu_rule_loader.py b/nominatim/tokenizer/icu_rule_loader.py index ddb17ae7..cf725209 100644 --- a/nominatim/tokenizer/icu_rule_loader.py +++ b/nominatim/tokenizer/icu_rule_loader.py @@ -2,48 +2,86 @@ Helper class to create ICU rules from a configuration file. """ import io +import json import logging -from collections import defaultdict import itertools -from pathlib import Path +import re -import yaml from icu import Transliterator +from nominatim.config import flatten_config_list +from nominatim.db.properties import set_property, get_property from nominatim.errors import UsageError +from nominatim.tokenizer.icu_name_processor import ICUNameProcessor +from nominatim.tokenizer.place_sanitizer import PlaceSanitizer +import nominatim.tokenizer.icu_variants as variants LOG = logging.getLogger() -def _flatten_yaml_list(content): - if not content: - return [] +DBCFG_IMPORT_NORM_RULES = "tokenizer_import_normalisation" +DBCFG_IMPORT_TRANS_RULES = "tokenizer_import_transliteration" +DBCFG_IMPORT_ANALYSIS_RULES = "tokenizer_import_analysis_rules" - if not isinstance(content, list): - raise UsageError("List expected in ICU yaml configuration.") - output = [] - for ele in content: - if isinstance(ele, list): - output.extend(_flatten_yaml_list(ele)) - else: - output.append(ele) +class VariantRule: + """ Saves a single variant expansion. - return output + An expansion consists of the normalized replacement term and + a dicitonary of properties that describe when the expansion applies. + """ + + def __init__(self, replacement, properties): + self.replacement = replacement + self.properties = properties or {} class ICURuleLoader: """ Compiler for ICU rules from a tokenizer configuration file. """ - def __init__(self, configfile): - self.configfile = configfile - self.compound_suffixes = set() - self.abbreviations = defaultdict() + def __init__(self, config): + rules = config.load_sub_configuration('icu_tokenizer.yaml', + config='TOKENIZER_CONFIG') + + self.normalization_rules = self._cfg_to_icu_rules(rules, 'normalization') + self.transliteration_rules = self._cfg_to_icu_rules(rules, 'transliteration') + self.analysis_rules = self._get_section(rules, 'token-analysis') + self._setup_analysis() + + # Load optional sanitizer rule set. + self.sanitizer_rules = rules.get('sanitizers', []) + + + def load_config_from_db(self, conn): + """ Get previously saved parts of the configuration from the + database. + """ + self.normalization_rules = get_property(conn, DBCFG_IMPORT_NORM_RULES) + self.transliteration_rules = get_property(conn, DBCFG_IMPORT_TRANS_RULES) + self.analysis_rules = json.loads(get_property(conn, DBCFG_IMPORT_ANALYSIS_RULES)) + self._setup_analysis() + + + def save_config_to_db(self, conn): + """ Save the part of the configuration that cannot be changed into + the database. + """ + set_property(conn, DBCFG_IMPORT_NORM_RULES, self.normalization_rules) + set_property(conn, DBCFG_IMPORT_TRANS_RULES, self.transliteration_rules) + set_property(conn, DBCFG_IMPORT_ANALYSIS_RULES, json.dumps(self.analysis_rules)) + + + def make_sanitizer(self): + """ Create a place sanitizer from the configured rules. + """ + return PlaceSanitizer(self.sanitizer_rules) + - if configfile.suffix == '.yaml': - self._load_from_yaml() - else: - raise UsageError("Unknown format of tokenizer configuration.") + def make_token_analysis(self): + """ Create a token analyser from the reviouly loaded rules. + """ + return self.analysis[None].create(self.normalization_rules, + self.transliteration_rules) def get_search_rules(self): @@ -58,81 +96,46 @@ class ICURuleLoader: rules.write(self.transliteration_rules) return rules.getvalue() + def get_normalization_rules(self): """ Return rules for normalisation of a term. """ return self.normalization_rules + def get_transliteration_rules(self): """ Return the rules for converting a string into its asciii representation. """ return self.transliteration_rules - def get_replacement_pairs(self): - """ Return the list of possible compound decompositions with - application of abbreviations included. - The result is a list of pairs: the first item is the sequence to - replace, the second is a list of replacements. - """ - synonyms = defaultdict(set) - - # First add entries for compound decomposition. - for suffix in self.compound_suffixes: - variants = (suffix + ' ', ' ' + suffix + ' ') - for key in variants: - synonyms[key].update(variants) - - for full, abbr in self.abbreviations.items(): - key = ' ' + full + ' ' - # Entries in the abbreviation list always apply to full words: - synonyms[key].update((' ' + a + ' ' for a in abbr)) - # Replacements are optional, so add a noop - synonyms[key].add(key) - if full in self.compound_suffixes: - # Full word abbreviating to compunded version. - synonyms[key].update((a + ' ' for a in abbr)) - - key = full + ' ' - # Uncompunded suffix abbrevitating to decompounded version. - synonyms[key].update((' ' + a + ' ' for a in abbr)) - # Uncompunded suffix abbrevitating to compunded version. - synonyms[key].update((a + ' ' for a in abbr)) - - # sort the resulting list by descending length (longer matches are prefered). - sorted_keys = sorted(synonyms.keys(), key=len, reverse=True) - - return [(k, list(synonyms[k])) for k in sorted_keys] - - def _yaml_include_representer(self, loader, node): - value = loader.construct_scalar(node) - - if Path(value).is_absolute(): - content = Path(value).read_text() - else: - content = (self.configfile.parent / value).read_text() - - return yaml.safe_load(content) + def _setup_analysis(self): + """ Process the rules used for creating the various token analyzers. + """ + self.analysis = {} + if not isinstance(self.analysis_rules, list): + raise UsageError("Configuration section 'token-analysis' must be a list.") - def _load_from_yaml(self): - yaml.add_constructor('!include', self._yaml_include_representer, - Loader=yaml.SafeLoader) - rules = yaml.safe_load(self.configfile.read_text()) + for section in self.analysis_rules: + name = section.get('id', None) + if name in self.analysis: + if name is None: + LOG.fatal("ICU tokenizer configuration has two default token analyzers.") + else: + LOG.fatal("ICU tokenizer configuration has two token " + "analyzers with id '%s'.", name) + UsageError("Syntax error in ICU tokenizer config.") + self.analysis[name] = TokenAnalyzerRule(section, self.normalization_rules) - self.normalization_rules = self._cfg_to_icu_rules(rules, 'normalization') - self.transliteration_rules = self._cfg_to_icu_rules(rules, 'transliteration') - self._parse_compound_suffix_list(self._get_section(rules, 'compound_suffixes')) - self._parse_abbreviation_list(self._get_section(rules, 'abbreviations')) - - def _get_section(self, rules, section): + @staticmethod + def _get_section(rules, section): """ Get the section named 'section' from the rules. If the section does not exist, raise a usage error with a meaningful message. """ if section not in rules: - LOG.fatal("Section '%s' not found in tokenizer config '%s'.", - section, str(self.configfile)) + LOG.fatal("Section '%s' not found in tokenizer config.", section) raise UsageError("Syntax error in tokenizer configuration file.") return rules[section] @@ -150,41 +153,131 @@ class ICURuleLoader: if content is None: return '' - return ';'.join(_flatten_yaml_list(content)) + ';' + return ';'.join(flatten_config_list(content, section)) + ';' + + +class TokenAnalyzerRule: + """ Factory for a single analysis module. The class saves the configuration + and creates a new token analyzer on request. + """ + + def __init__(self, rules, normalization_rules): + self._parse_variant_list(rules.get('variants'), normalization_rules) + + + def create(self, normalization_rules, transliteration_rules): + """ Create an analyzer from the given rules. + """ + return ICUNameProcessor(normalization_rules, + transliteration_rules, + self.variants) + def _parse_variant_list(self, rules, normalization_rules): + self.variants = set() - def _parse_compound_suffix_list(self, rules): if not rules: - self.compound_suffixes = set() return - norm = Transliterator.createFromRules("rule_loader_normalization", - self.normalization_rules) + rules = flatten_config_list(rules, 'variants') - # Make sure all suffixes are in their normalised form. - self.compound_suffixes = set((norm.transliterate(s) for s in rules)) + vmaker = _VariantMaker(normalization_rules) + properties = [] + for section in rules: + # Create the property field and deduplicate against existing + # instances. + props = variants.ICUVariantProperties.from_rules(section) + for existing in properties: + if existing == props: + props = existing + break + else: + properties.append(props) - def _parse_abbreviation_list(self, rules): - self.abbreviations = defaultdict(list) + for rule in (section.get('words') or []): + self.variants.update(vmaker.compute(rule, props)) - if not rules: - return - norm = Transliterator.createFromRules("rule_loader_normalization", - self.normalization_rules) +class _VariantMaker: + """ Generater for all necessary ICUVariants from a single variant rule. - for rule in rules: - parts = rule.split('=>') - if len(parts) != 2: - LOG.fatal("Syntax error in abbreviation section, line: %s", rule) - raise UsageError("Syntax error in tokenizer configuration file.") + All text in rules is normalized to make sure the variants match later. + """ - # Make sure all terms match the normalised version. - fullterms = (norm.transliterate(t.strip()) for t in parts[0].split(',')) - abbrterms = (norm.transliterate(t.strip()) for t in parts[1].split(',')) + def __init__(self, norm_rules): + self.norm = Transliterator.createFromRules("rule_loader_normalization", + norm_rules) - for full, abbr in itertools.product(fullterms, abbrterms): - if full and abbr: - self.abbreviations[full].append(abbr) + + def compute(self, rule, props): + """ Generator for all ICUVariant tuples from a single variant rule. + """ + parts = re.split(r'(\|)?([=-])>', rule) + if len(parts) != 4: + raise UsageError("Syntax error in variant rule: " + rule) + + decompose = parts[1] is None + src_terms = [self._parse_variant_word(t) for t in parts[0].split(',')] + repl_terms = (self.norm.transliterate(t.strip()) for t in parts[3].split(',')) + + # If the source should be kept, add a 1:1 replacement + if parts[2] == '-': + for src in src_terms: + if src: + for froms, tos in _create_variants(*src, src[0], decompose): + yield variants.ICUVariant(froms, tos, props) + + for src, repl in itertools.product(src_terms, repl_terms): + if src and repl: + for froms, tos in _create_variants(*src, repl, decompose): + yield variants.ICUVariant(froms, tos, props) + + + def _parse_variant_word(self, name): + name = name.strip() + match = re.fullmatch(r'([~^]?)([^~$^]*)([~$]?)', name) + if match is None or (match.group(1) == '~' and match.group(3) == '~'): + raise UsageError("Invalid variant word descriptor '{}'".format(name)) + norm_name = self.norm.transliterate(match.group(2)) + if not norm_name: + return None + + return norm_name, match.group(1), match.group(3) + + +_FLAG_MATCH = {'^': '^ ', + '$': ' ^', + '': ' '} + + +def _create_variants(src, preflag, postflag, repl, decompose): + if preflag == '~': + postfix = _FLAG_MATCH[postflag] + # suffix decomposition + src = src + postfix + repl = repl + postfix + + yield src, repl + yield ' ' + src, ' ' + repl + + if decompose: + yield src, ' ' + repl + yield ' ' + src, repl + elif postflag == '~': + # prefix decomposition + prefix = _FLAG_MATCH[preflag] + src = prefix + src + repl = prefix + repl + + yield src, repl + yield src + ' ', repl + ' ' + + if decompose: + yield src, repl + ' ' + yield src + ' ', repl + else: + prefix = _FLAG_MATCH[preflag] + postfix = _FLAG_MATCH[postflag] + + yield prefix + src + postfix, prefix + repl + postfix