Generic column operators and update Index signature. (#108)

* Make columnoperators generic in typeengine

* Add ticket 82 test-case

* Fix init of Index

* tests: add index.__init__ with str expression.

Author: MaicoTimmerman

sqlalchemy-stubs/sql/elements.pyi

@@ -126,7 +126,7 @@ class ColumnElement(
     roles.DMLColumnRole,
     roles.DDLConstraintColumnRole,
     roles.DDLExpressionRole,
-    operators.ColumnOperators,
+    operators.ColumnOperators[_TE],
     ClauseElement,
     Generic[_TE],
 ):

sqlalchemy-stubs/sql/operators.pyi

@@ -19,15 +19,21 @@ from operator import sub as sub
 from operator import truediv as truediv
 from typing import Any
 from typing import Callable
+from typing import Generic
+from typing import NoReturn
 from typing import Optional
 from typing import Type
 from typing import TypeVar
 from typing import Union
 
+from . import sqltypes
 from .elements import ClauseElement
+from .elements import ColumnElement
 from .type_api import TypeEngine
 
 _F = TypeVar("_F", bound=Callable[..., Any])
+_T = TypeVar("_T")
+_TE = TypeVar("_TE", bound=TypeEngine[Any])
 
 div = truediv
 
@@ -77,137 +83,123 @@ class custom_op:
     def __hash__(self) -> int: ...
     def __call__(self, left: Any, right: Any, **kw: Any) -> ClauseElement: ...
 
-class ColumnOperators(Operators):
+class ColumnOperators(Operators, Generic[_TE]):
     timetuple: Any = ...
-    def __lt__(self, other: Any) -> ClauseElement: ...
-    def __le__(self, other: Any) -> ClauseElement: ...
-    def __eq__(self, other: Any) -> ClauseElement: ...  # type: ignore[override]
-    def __ne__(self, other: Any) -> ClauseElement: ...  # type: ignore[override]
-    def is_distinct_from(self, other: Any) -> ClauseElement: ...
-    def is_not_distinct_from(self, other: Any) -> ClauseElement: ...
-    def isnot_distinct_from(self, other: Any) -> ClauseElement: ...
-    def __gt__(self, other: Any) -> ClauseElement: ...
-    def __ge__(self, other: Any) -> ClauseElement: ...
-    def __neg__(self) -> ClauseElement: ...
-    def __contains__(self, other: Any) -> ClauseElement: ...
-    def __getitem__(self, index: Any) -> ClauseElement: ...
-    def __lshift__(self, other: Any) -> ClauseElement: ...
-    def __rshift__(self, other: Any) -> ClauseElement: ...
-    def concat(self, other: Any) -> ClauseElement: ...
+    # TODO https://github.com/sqlalchemy/sqlalchemy2-stubs/issues/114
+    #  Can we also limit the "other" parameter? Most should be
+    #  Same TypeEngine[_T] or _T, but in case of ORM expressions
+    #  _T is a Mapped type, can we extract the pure python type from
+    #  a TypeEngine bounded TypeVar?
+    # def __lt__(
+    #     self, other: Union[ColumnElement[TypeEngine[_T]], _T]
+    # ) -> ColumnElement[sqltypes.Boolean]: ...
+    def __lt__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def __le__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def __eq__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...  # type: ignore[override]
+    def __ne__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...  # type: ignore[override]
+    def is_distinct_from(
+        self, other: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def is_not_distinct_from(
+        self, other: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def __gt__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def __ge__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def __neg__(self) -> ColumnElement[_TE]: ...
+    def __contains__(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    # TODO __getitem__ is hard: Arrays return Random Types and Strings return Strings?
+    def __getitem__(self, index: Any) -> ColumnElement[Any]: ...
+    def __lshift__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rshift__(self, other: Any) -> ColumnElement[_TE]: ...
+    def concat(self, other: Any) -> ColumnElement[sqltypes.String]: ...
     def like(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
+        self, other: Any, escape: Optional[str] = ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
     def ilike(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
-    def in_(self, other: Any) -> ClauseElement: ...
-    def not_in(self, other: Any) -> ClauseElement: ...
-    def notin_(self, other: Any) -> ClauseElement: ...
+        self, other: Any, escape: Optional[str] = ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def in_(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def not_in(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
     def not_like(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
-    def notlike(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
+        self, other: Any, escape: Optional[str] = ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
     def not_ilike(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
-    def notilike(
-        self, other: Any, escape: Optional[Any] = ...
-    ) -> ClauseElement: ...
-    def is_(self, other: Any) -> ClauseElement: ...
-    def is_not(self, other: Any) -> ClauseElement: ...
-    isnot: Any = ...
-    def startswith(self, other: Any, **kwargs: Any) -> ClauseElement: ...
-    def endswith(self, other: Any, **kwargs: Any) -> ClauseElement: ...
-    def contains(self, other: Any, **kwargs: Any) -> ClauseElement: ...
-    def match(self, other: Any, **kwargs: Any) -> ClauseElement: ...
+        self, other: Any, escape: Optional[str] = ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def is_(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def is_not(self, other: Any) -> ColumnElement[sqltypes.Boolean]: ...
+    def startswith(
+        self, other: Any, **kwargs: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def endswith(
+        self, other: Any, **kwargs: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def contains(
+        self, other: Any, **kwargs: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def match(
+        self, other: Any, **kwargs: Any
+    ) -> ColumnElement[sqltypes.Boolean]: ...
     def regexp_match(
         self, pattern: Any, flags: Optional[Any] = ...
-    ) -> ClauseElement: ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
     def regexp_replace(
         self, pattern: Any, replacement: Any, flags: Optional[Any] = ...
-    ) -> ClauseElement: ...
-    def desc(self) -> ClauseElement: ...
-    def asc(self) -> ClauseElement: ...
-    def nulls_first(self) -> ClauseElement: ...
-    def nullsfirst(self) -> ClauseElement: ...
-    def nulls_last(self) -> ClauseElement: ...
-    def nullslast(self) -> ClauseElement: ...
-    def collate(self, collation: Any) -> ClauseElement: ...
-    def __radd__(self, other: Any) -> ClauseElement: ...
-    def __rsub__(self, other: Any) -> ClauseElement: ...
-    def __rmul__(self, other: Any) -> ClauseElement: ...
-    def __rdiv__(self, other: Any) -> ClauseElement: ...
-    def __rmod__(self, other: Any) -> ClauseElement: ...
+    ) -> ColumnElement[sqltypes.String]: ...
+    def desc(self) -> ColumnElement[sqltypes.NullType]: ...
+    def asc(self) -> ColumnElement[sqltypes.NullType]: ...
+    def nulls_first(self) -> ColumnElement[sqltypes.NullType]: ...
+    def nulls_last(self) -> ColumnElement[sqltypes.NullType]: ...
+    def collate(self, collation: str) -> ColumnElement[_TE]: ...
+    def __radd__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rsub__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rmul__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rdiv__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rmod__(self, other: Any) -> ColumnElement[_TE]: ...
     def between(
         self, cleft: Any, cright: Any, symmetric: bool = ...
-    ) -> ClauseElement: ...
-    def distinct(self) -> ClauseElement: ...
-    def any_(self) -> ClauseElement: ...
-    def all_(self) -> ClauseElement: ...
-    def __add__(self, other: Any) -> ClauseElement: ...
-    def __sub__(self, other: Any) -> ClauseElement: ...
-    def __mul__(self, other: Any) -> ClauseElement: ...
-    def __div__(self, other: Any) -> ClauseElement: ...
-    def __mod__(self, other: Any) -> ClauseElement: ...
-    def __truediv__(self, other: Any) -> ClauseElement: ...
-    def __rtruediv__(self, other: Any) -> ClauseElement: ...
+    ) -> ColumnElement[sqltypes.Boolean]: ...
+    def distinct(self) -> ColumnElement[_TE]: ...
+    def any_(self) -> ColumnElement[sqltypes.NullType]: ...
+    def all_(self) -> ColumnElement[sqltypes.NullType]: ...
+    def __add__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __sub__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __mul__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __div__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __mod__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __truediv__(self, other: Any) -> ColumnElement[_TE]: ...
+    def __rtruediv__(self, other: Any) -> ColumnElement[_TE]: ...
 
 def commutative_op(fn: _F) -> _F: ...
 def comparison_op(fn: _F) -> _F: ...
-def from_() -> None: ...
-def function_as_comparison_op() -> None: ...
-def as_() -> None: ...
-def exists() -> None: ...
-def is_true(a: Any) -> None: ...
-
-istrue = is_true
-
-def is_false(a: Any) -> None: ...
-
-isfalse = is_false
-
+def from_() -> NoReturn: ...
+def function_as_comparison_op() -> NoReturn: ...
+def as_() -> NoReturn: ...
+def exists() -> NoReturn: ...
+def is_true(a: Any) -> NoReturn: ...
+def is_false(a: Any) -> NoReturn: ...
 def is_distinct_from(a: Any, b: Any) -> ClauseElement: ...
 def is_not_distinct_from(a: Any, b: Any) -> ClauseElement: ...
-
-isnot_distinct_from = is_not_distinct_from
-
 def is_(a: Any, b: Any) -> ClauseElement: ...
 def is_not(a: Any, b: Any) -> ClauseElement: ...
-
-isnot = is_not
-
 def collate(a: Any, b: Any) -> ClauseElement: ...
 def op(a: Any, opstring: str, b: Any) -> ClauseElement: ...
 def like_op(a: Any, b: Any, escape: Optional[Any] = ...) -> ClauseElement: ...
 def not_like_op(
     a: Any, b: Any, escape: Optional[Any] = ...
 ) -> ClauseElement: ...
-
-notlike_op = not_like_op
-
 def ilike_op(a: Any, b: Any, escape: Optional[Any] = ...) -> ClauseElement: ...
 def not_ilike_op(
     a: Any, b: Any, escape: Optional[Any] = ...
 ) -> ClauseElement: ...
-
-notilike_op = not_ilike_op
-
 def between_op(
     a: Any, b: Any, c: Any, symmetric: bool = ...
 ) -> ClauseElement: ...
 def not_between_op(
     a: Any, b: Any, c: Any, symmetric: bool = ...
 ) -> ClauseElement: ...
-
-notbetween_op = not_between_op
-
 def in_op(a: Any, b: Any) -> ClauseElement: ...
 def not_in_op(a: Any, b: Any) -> ClauseElement: ...
-
-notin_op = not_in_op
-
 def distinct_op(a: Any) -> ClauseElement: ...
 def any_op(a: Any) -> ClauseElement: ...
 def all_op(a: Any) -> ClauseElement: ...
@@ -217,27 +209,18 @@ def startswith_op(
 def not_startswith_op(
     a: Any, b: Any, escape: Optional[Any] = ..., autoescape: bool = ...
 ) -> ClauseElement: ...
-
-notstartswith_op = not_startswith_op
-
 def endswith_op(
     a: Any, b: Any, escape: Optional[Any] = ..., autoescape: bool = ...
 ) -> ClauseElement: ...
 def not_endswith_op(
     a: Any, b: Any, escape: Optional[Any] = ..., autoescape: bool = ...
 ) -> ClauseElement: ...
-
-notendswith_op = not_endswith_op
-
 def contains_op(
     a: Any, b: Any, escape: Optional[Any] = ..., autoescape: bool = ...
 ) -> ClauseElement: ...
 def not_contains_op(
     a: Any, b: Any, escape: Optional[Any] = ..., autoescape: bool = ...
 ) -> ClauseElement: ...
-
-notcontains_op = not_contains_op
-
 def match_op(a: Any, b: Any, **kw: Any) -> ClauseElement: ...
 def regexp_match_op(
     a: Any, b: Any, flags: Optional[Any] = ...
@@ -249,24 +232,15 @@ def regexp_replace_op(
     a: Any, b: Any, replacement: Any, flags: Optional[Any] = ...
 ) -> ClauseElement: ...
 def not_match_op(a: Any, b: Any, **kw: Any) -> ClauseElement: ...
-
-notmatch_op = not_match_op
-
-def comma_op(a: Any, b: Any) -> None: ...
-def filter_op(a: Any, b: Any) -> None: ...
+def comma_op(a: Any, b: Any) -> NoReturn: ...
+def filter_op(a: Any, b: Any) -> NoReturn: ...
 def concat_op(a: Any, b: Any) -> ClauseElement: ...
 def desc_op(a: Any) -> ClauseElement: ...
 def asc_op(a: Any) -> ClauseElement: ...
 def nulls_first_op(a: Any) -> ClauseElement: ...
-
-nullsfirst_op = nulls_first_op
-
 def nulls_last_op(a: Any) -> ClauseElement: ...
-
-nullslast_op = nulls_last_op
-
-def json_getitem_op(a: Any, b: Any) -> None: ...
-def json_path_getitem_op(a: Any, b: Any) -> None: ...
+def json_getitem_op(a: Any, b: Any) -> NoReturn: ...
+def json_path_getitem_op(a: Any, b: Any) -> NoReturn: ...
 def is_comparison(op: Any) -> bool: ...
 def is_commutative(op: Any) -> bool: ...
 def is_ordering_modifier(op: Any) -> bool: ...
@@ -275,3 +249,19 @@ def is_boolean(op: Any) -> bool: ...
 def mirror(op: Any) -> Any: ...
 def is_associative(op: Any) -> bool: ...
 def is_precedent(operator: Any, against: Any) -> bool: ...
+
+# 1.4 deprecated; see sqlalchemy#5435
+istrue = is_true
+isfalse = is_false
+isnot_distinct_from = is_not_distinct_from
+isnot = is_not
+notlike_op = not_like_op
+notilike_op = not_ilike_op
+notbetween_op = not_between_op
+notin_op = not_in_op
+notstartswith_op = not_startswith_op
+notendswith_op = not_endswith_op
+notcontains_op = not_contains_op
+notmatch_op = not_match_op
+nullsfirst_op = nulls_first_op
+nullslast_op = nulls_last_op

sqlalchemy-stubs/sql/schema.pyi

@@ -545,7 +545,10 @@ class Index(DialectKWArgs, ColumnCollectionMixin, SchemaItem):
     unique: bool = ...
     expressions: List[Column[Any]] = ...
     def __init__(
-        self, name: str, *expressions: ColumnClause[Any], **kw: Any
+        self,
+        name: str,
+        *expressions: Union[str, roles.DDLConstraintColumnRole],
+        **kw: Any,
     ) -> None: ...
     @property
     def bind(self) -> Optional[Union[Engine, Connection]]: ...