Merge pull request #3385 from mtmail/docs-reverse-only

[nominatim.git] / nominatim / typing.py

diff --git a/nominatim/typing.py b/nominatim/typing.py
index 308f3e6a2cbb515245e81aa47a739ce562b1c04e..62ecd8c3e169ce7340dca7c6eb6a83a7881cd3d5 100644 (file)
--- a/nominatim/typing.py
+++ b/nominatim/typing.py
@@ -2,7 +2,7 @@
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #

-# Copyright (C) 2022 by the Nominatim developer community.
+# Copyright (C) 2023 by the Nominatim developer community.

 # For a full list of authors see the git log.
 """
 Type definitions for typing annotations.
 # For a full list of authors see the git log.
 """
 Type definitions for typing annotations.


@@ -11,7 +11,7 @@ Complex type definitions are moved here, to keep the source files readable.
 """
 from typing import Any, Union, Mapping, TypeVar, Sequence, TYPE_CHECKING
 
 """
 from typing import Any, Union, Mapping, TypeVar, Sequence, TYPE_CHECKING
 

-# Generics varaible names do not confirm to naming styles, ignore globally here.
+# Generics variable names do not confirm to naming styles, ignore globally here.

 # pylint: disable=invalid-name,abstract-method,multiple-statements
 # pylint: disable=missing-class-docstring,useless-import-alias
 
 # pylint: disable=invalid-name,abstract-method,multiple-statements
 # pylint: disable=missing-class-docstring,useless-import-alias
 


@@ -50,3 +50,26 @@ else:
     Protocol = object
     Final = 'Final'
     TypedDict = dict
     Protocol = object
     Final = 'Final'
     TypedDict = dict

+
+
+# SQLAlchemy introduced generic types in version 2.0 making typing
+# incompatible with older versions. Add wrappers here so we don't have
+# to litter the code with bare-string types.
+
+if TYPE_CHECKING:
+    import sqlalchemy as sa
+    from typing_extensions import (TypeAlias as TypeAlias)
+else:
+    TypeAlias = str
+
+SaLambdaSelect: TypeAlias = 'Union[sa.Select[Any], sa.StatementLambdaElement]'
+SaSelect: TypeAlias = 'sa.Select[Any]'
+SaScalarSelect: TypeAlias = 'sa.ScalarSelect[Any]'
+SaRow: TypeAlias = 'sa.Row[Any]'
+SaColumn: TypeAlias = 'sa.ColumnElement[Any]'
+SaExpression: TypeAlias = 'sa.ColumnElement[bool]'
+SaLabel: TypeAlias = 'sa.Label[Any]'
+SaFromClause: TypeAlias = 'sa.FromClause'
+SaSelectable: TypeAlias = 'sa.Selectable'
+SaBind: TypeAlias = 'sa.BindParameter[Any]'
+SaDialect: TypeAlias = 'sa.Dialect'