src/nominatim_db/tools/special_phrases/special_phrase.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) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8     Module containing the class SpecialPhrase.
   9
  10     This class is a model used to transfer a special phrase through
  11     the process of load and importation.
  12 """
  13 from typing import Any
  14
  15 class SpecialPhrase:
  16     """
  17         Model representing a special phrase.
  18     """
  19     def __init__(self, p_label: str, p_class: str, p_type: str, p_operator: str) -> None:
  20         self.p_label = p_label.strip()
  21         self.p_class = p_class.strip()
  22         self.p_type = p_type.strip()
  23         # Needed if some operator in the wiki are not written in english
  24         p_operator = p_operator.strip().lower()
  25         self.p_operator = '-' if p_operator not in ('near', 'in') else p_operator
  26
  27     def __eq__(self, other: Any) -> bool:
  28         if not isinstance(other, SpecialPhrase):
  29             return False
  30
  31         return self.p_label == other.p_label \
  32                and self.p_class == other.p_class \
  33                and self.p_type == other.p_type \
  34                and self.p_operator == other.p_operator
  35
  36     def __hash__(self) -> int:
  37         return hash((self.p_label, self.p_class, self.p_type, self.p_operator))