Merge pull request #26 from bryanforbes/improve-sql-type-api

Improve `sql.type_api` typings

Author: zzzeek

sqlalchemy-stubs/sql/type_api.pyi

@@ -9,21 +9,29 @@ from typing import Union
 
 from typing_extensions import Protocol
 
-from . import operators as operators
-from .base import SchemaEventTarget as SchemaEventTarget
-from .visitors import Traversible as Traversible
-from .visitors import TraversibleType as TraversibleType
-from .. import exc as exc
-from .. import util as util
+from . import operators
+from .base import SchemaEventTarget
+from .elements import ClauseElement
+from .sqltypes import Boolean
+from .sqltypes import Indexable
+from .sqltypes import Integer
+from .sqltypes import MatchType
+from .sqltypes import NullType
+from .sqltypes import String
+from .sqltypes import TableValueType
+from .visitors import Traversible
+from .visitors import TraversibleType
+from .. import util
+from ..engine import Dialect
 from ..util import compat
 
-BOOLEANTYPE: Any
-INTEGERTYPE: Any
-NULLTYPE: Any
-STRINGTYPE: Any
-MATCHTYPE: Any
-INDEXABLE: Any
-TABLEVALUE: Any
+BOOLEANTYPE: Boolean
+INTEGERTYPE: Integer
+NULLTYPE: NullType
+STRINGTYPE: String
+MATCHTYPE: MatchType
+INDEXABLE = Indexable
+TABLEVALUE: TableValueType
 
 _T = TypeVar("_T")
 _T_co = TypeVar("_T_co", covariant=True)
@@ -45,29 +53,37 @@ class _ResultProcessor(Protocol[_T_co]):
     def __call__(self, __value: Optional[Any]) -> Optional[_T_co]: ...
 
 class TypeEngine(Traversible, Generic[_T]):
-    class Comparator(operators.ColumnOperators):
+    class Comparator(operators.ColumnOperators, Generic[_TE]):
         default_comparator: Any = ...
-        def __clause_element__(self): ...
-        expr: Any = ...
-        type: Any = ...
-        def __init__(self, expr: Any) -> None: ...
-        def operate(self, op: Any, *other: Any, **kwargs: Any): ...
-        def reverse_operate(self, op: Any, other: Any, **kwargs: Any): ...
-        def __reduce__(self): ...
+        def __clause_element__(self) -> ClauseElement: ...
+        expr: ClauseElement = ...
+        type: _TE = ...
+        def __init__(self, expr: ClauseElement) -> None: ...
+        def operate(
+            self, op: Any, *other: Any, **kwargs: Any
+        ) -> ClauseElement: ...
+        def reverse_operate(
+            self, op: Any, other: Any, **kwargs: Any
+        ) -> ClauseElement: ...
+        def __reduce__(self) -> Any: ...
     hashable: bool = ...
-    comparator_factory: Type[Any] = ...
+    comparator_factory: Type[Comparator[TypeEngine[_T]]] = ...
     sort_key_function: Optional[compat._SortKeyFunction] = ...
     should_evaluate_none: bool = ...
     def evaluates_none(self: _TE) -> _TE: ...
     def copy(self: _TE, **kw: Any) -> _TE: ...
-    def compare_against_backend(self, dialect: Any, conn_type: Any) -> Any: ...
+    def compare_against_backend(
+        self, dialect: Dialect, conn_type: Any
+    ) -> Any: ...
     def copy_value(self, value: _T) -> _T: ...
     def literal_processor(
-        self, dialect: Any
+        self, dialect: Dialect
     ) -> Optional[_LiteralProcessor[_T]]: ...
-    def bind_processor(self, dialect: Any) -> Optional[_BindProcessor[_T]]: ...
+    def bind_processor(
+        self, dialect: Dialect
+    ) -> Optional[_BindProcessor[_T]]: ...
     def result_processor(
-        self, dialect: Any, coltype: Any
+        self, dialect: Dialect, coltype: Any
     ) -> Optional[_ResultProcessor[_T]]: ...
     def column_expression(self, colexpr: Any) -> Any: ...
     def bind_expression(self, bindvalue: Any) -> Any: ...
@@ -79,12 +95,12 @@ class TypeEngine(Traversible, Generic[_T]):
         self, type_: Type[TypeEngine[_U]], dialect_name: str
     ) -> Variant[_U]: ...
     def as_generic(self, allow_nulltype: bool = ...) -> TypeEngine[Any]: ...
-    def dialect_impl(self, dialect: Any) -> Type[Any]: ...
+    def dialect_impl(self, dialect: Dialect) -> Type[Any]: ...
     def adapt(self, __cls: Type[_U], **kw: Any) -> _U: ...
     def coerce_compared_value(
         self, op: Any, value: Any
     ) -> TypeEngine[Any]: ...
-    def compile(self, dialect: Optional[Any] = ...) -> Any: ...
+    def compile(self, dialect: Optional[Dialect] = ...) -> Any: ...
 
 class VisitableCheckKWArg(util.EnsureKWArgType, TraversibleType): ...
 
@@ -110,25 +126,31 @@ class TypeDecorator(SchemaEventTarget, TypeEngine[_T]):
     impl: Any = ...
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
     coerce_to_is_types: Tuple[Type[Any], ...] = ...
-    class Comparator(TypeEngine.Comparator):
-        def operate(self, op: Any, *other: Any, **kwargs: Any): ...
-        def reverse_operate(self, op: Any, other: Any, **kwargs: Any): ...
+    class Comparator(TypeEngine.Comparator[_TE]):
+        def operate(
+            self, op: Any, *other: Any, **kwargs: Any
+        ) -> ClauseElement: ...
+        def reverse_operate(
+            self, op: Any, other: Any, **kwargs: Any
+        ) -> ClauseElement: ...
     @property
-    def comparator_factory(self) -> Type[Any]: ...  # type: ignore[override]
-    def type_engine(self, dialect: Any) -> TypeEngine[Any]: ...
-    def load_dialect_impl(self, dialect: Any) -> TypeEngine[Any]: ...
+    def comparator_factory(self) -> Type[Comparator[TypeEngine[_T]]]: ...  # type: ignore[override]
+    def type_engine(self, dialect: Dialect) -> TypeEngine[Any]: ...
+    def load_dialect_impl(self, dialect: Dialect) -> TypeEngine[Any]: ...
     def __getattr__(self, key: Any) -> Any: ...
     def process_literal_param(
-        self, value: Optional[_T], dialect: Any
+        self, value: Optional[_T], dialect: Dialect
     ) -> str: ...
-    def process_bind_param(self, value: Optional[_T], dialect: Any) -> Any: ...
+    def process_bind_param(
+        self, value: Optional[_T], dialect: Dialect
+    ) -> Any: ...
     def process_result_value(
-        self, value: Any, dialect: Any
+        self, value: Any, dialect: Dialect
     ) -> Optional[_T]: ...
-    def literal_processor(self, dialect: Any) -> _LiteralProcessor[_T]: ...
-    def bind_processor(self, dialect: Any) -> _BindProcessor[_T]: ...
+    def literal_processor(self, dialect: Dialect) -> _LiteralProcessor[_T]: ...
+    def bind_processor(self, dialect: Dialect) -> _BindProcessor[_T]: ...
     def result_processor(
-        self, dialect: Any, coltype: Any
+        self, dialect: Dialect, coltype: Any
     ) -> _ResultProcessor[_T]: ...
     def bind_expression(self, bindparam: Any) -> Any: ...
     def column_expression(self, column: Any) -> Any: ...
@@ -148,12 +170,12 @@ class Variant(TypeDecorator[_T]):
     def coerce_compared_value(
         self: _VT, operator: Any, value: Any
     ) -> Union[_VT, TypeEngine[Any]]: ...
-    def load_dialect_impl(self, dialect: Any) -> TypeEngine[Any]: ...
+    def load_dialect_impl(self, dialect: Dialect) -> TypeEngine[Any]: ...
     def with_variant(
         self, type_: Type[TypeEngine[_U]], dialect_name: str
     ) -> Variant[_U]: ...
     @property
     def comparator_factory(self) -> Type[Any]: ...  # type: ignore[override]
 
-def to_instance(typeobj: Any, *arg: Any, **kw: Any): ...
-def adapt_type(typeobj: Any, colspecs: Any): ...
+def to_instance(typeobj: Any, *arg: Any, **kw: Any) -> Any: ...
+def adapt_type(typeobj: Any, colspecs: Any) -> Any: ...