nominatim/tokenizer/sanitizers/clean_housenumbers.py

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2022 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Sanitizer that preprocesses address tags for house numbers. The sanitizer
   9 allows to
  10
  11 * define which tags are to be considered house numbers (see 'filter-kind')
  12 * split house number lists into individual numbers (see 'delimiters')
  13
  14 Arguments:
  15     delimiters: Define the set of characters to be used for
  16                 splitting a list of house numbers into parts. (default: ',;')
  17     filter-kind: Define the address tags that are considered to be a
  18                  house number. Either takes a single string or a list of strings,
  19                  where each string is a regular expression. An address item
  20                  is considered a house number if the 'kind' fully matches any
  21                  of the given regular expressions. (default: 'housenumber')
  22
  23 """
  24 from nominatim.tokenizer.sanitizers.helpers import create_split_regex, create_kind_filter
  25
  26 class _HousenumberSanitizer:
  27
  28     def __init__(self, config):
  29         self.filter_kind = create_kind_filter(config, 'housenumber')
  30         self.split_regexp = create_split_regex(config)
  31
  32
  33     def __call__(self, obj):
  34         if not obj.address:
  35             return
  36
  37         new_address = []
  38         for item in obj.address:
  39             if self.filter_kind(item):
  40                 new_address.extend(item.clone(kind='housenumber', name=n)
  41                                    for n in self.sanitize(item.name))
  42             else:
  43                 # Don't touch other address items.
  44                 new_address.append(item)
  45
  46         obj.address = new_address
  47
  48
  49     def sanitize(self, value):
  50         """ Extract housenumbers in a regularized format from an OSM value.
  51
  52             The function works as a generator that yields all valid housenumbers
  53             that can be created from the value.
  54         """
  55         for hnr in self.split_regexp.split(value):
  56             if hnr:
  57                 yield from self._regularize(hnr)
  58
  59
  60     @staticmethod
  61     def _regularize(hnr):
  62         yield hnr
  63
  64
  65 def create(config):
  66     """ Create a housenumber processing function.
  67     """
  68
  69     return _HousenumberSanitizer(config)