src/nominatim_api/typing.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 Type definitions for typing annotations.
   9
  10 Complex type definitions are moved here, to keep the source files readable.
  11 """
  12 from typing import Union, TYPE_CHECKING
  13
  14 # flake8: noqa
  15
  16 # SQLAlchemy introduced generic types in version 2.0 making typing
  17 # incompatible with older versions. Add wrappers here so we don't have
  18 # to litter the code with bare-string types.
  19
  20 if TYPE_CHECKING:
  21     from typing import Any
  22     import sqlalchemy as sa
  23     import os
  24     from typing_extensions import (TypeAlias as TypeAlias,
  25                                    Protocol as Protocol)
  26 else:
  27     TypeAlias = str
  28     Protocol = object
  29
  30 StrPath = Union[str, 'os.PathLike[str]']
  31
  32 SaLambdaSelect: TypeAlias = 'Union[sa.Select[Any], sa.StatementLambdaElement]'
  33 SaSelect: TypeAlias = 'sa.Select[Any]'
  34 SaScalarSelect: TypeAlias = 'sa.ScalarSelect[Any]'
  35 SaRow: TypeAlias = 'sa.Row[Any]'
  36 SaColumn: TypeAlias = 'sa.ColumnElement[Any]'
  37 SaExpression: TypeAlias = 'sa.ColumnElement[bool]'
  38 SaLabel: TypeAlias = 'sa.Label[Any]'
  39 SaFromClause: TypeAlias = 'sa.FromClause'
  40 SaSelectable: TypeAlias = 'sa.Selectable'
  41 SaBind: TypeAlias = 'sa.BindParameter[Any]'
  42 SaDialect: TypeAlias = 'sa.Dialect'