nominatim/tools/special_phrases/sp_csv_loader.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     Module containing the SPCsvLoader class.
   9
  10     The class allows to load phrases from a csv file.
  11 """
  12 import csv
  13 import os
  14 from collections.abc import Iterator
  15 from nominatim.tools.special_phrases.special_phrase import SpecialPhrase
  16 from nominatim.errors import UsageError
  17
  18 class SPCsvLoader(Iterator):
  19     """
  20         Handles loading of special phrases from external csv file.
  21     """
  22     def __init__(self, csv_path):
  23         super().__init__()
  24         self.csv_path = csv_path
  25         self.has_been_read = False
  26
  27     def __next__(self):
  28         if self.has_been_read:
  29             raise StopIteration()
  30
  31         self.has_been_read = True
  32         self.check_csv_validity()
  33         return self.parse_csv()
  34
  35     def parse_csv(self):
  36         """
  37             Open and parse the given csv file.
  38             Create the corresponding SpecialPhrases.
  39         """
  40         phrases = set()
  41
  42         with open(self.csv_path, encoding='utf-8') as fd:
  43             reader = csv.DictReader(fd, delimiter=',')
  44             for row in reader:
  45                 phrases.add(
  46                     SpecialPhrase(row['phrase'], row['class'], row['type'], row['operator'])
  47                 )
  48         return phrases
  49
  50     def check_csv_validity(self):
  51         """
  52             Check that the csv file has the right extension.
  53         """
  54         _, extension = os.path.splitext(self.csv_path)
  55
  56         if extension != '.csv':
  57             raise UsageError(f'The file {self.csv_path} is not a csv file.')