pep-484 for engine

All modules in sqlalchemy.engine are strictly
typed with the exception of cursor, default, and
reflection.  cursor and default pass with non-strict
typing, reflection is waiting on the multi-reflection
refactor.

Behavioral changes:

* create_connect_args() methods return a tuple of list,
  dict, rather than a list of list, dict
* removed allow_chars parameter from
  pyodbc connector ._get_server_version_info()
  method
* the parameter list passed to do_executemany is now
  a list in all cases. previously, this was being run
  through dialect.execute_sequence_format, which
  defaults to tuple and was only intended for individual
  tuple params.
* broke up dialect.dbapi into dialect.import_dbapi
  class method and dialect.dbapi module object.  added
  a deprecation path for legacy dialects.  it's not
  really feasible to type a single attr as a classmethod
  vs. module type.  The "type_compiler" attribute also
  has this problem with greater ability to work around,
  left that one for now.
* lots of constants changing to be Enum, so that we can
  type them.  for fixed tuple-position constants in
  cursor.py / compiler.py (which are used to avoid the
  speed overhead of namedtuple), using Literal[value]
  which seems to work well
* some tightening up in Row regarding __getitem__, which
  we can do since we are on full 2.0 style result use
* altered the set_connection_execution_options and
  set_engine_execution_options event flows so that the
  dictionary of options may be mutated within the event
  hook, where it will then take effect as the actual
  options used.  Previously, changing the dict would
  be silently ignored which seems counter-intuitive
  and not very useful.
* A lot of DefaultDialect/DefaultExecutionContext
  methods and attributes, including underscored ones, move
  to interfaces.  This is not fully ideal as it means
  the Dialect/ExecutionContext interfaces aren't publicly
  subclassable directly, but their current purpose
  is more of documentation for dialect authors who should
  (and certainly are) still be subclassing the DefaultXYZ
  versions in all cases

Overall, Result was the most extremely difficult class
hierarchy to type here as this hierarchy passes through
largely amorphous "row" datatypes throughout, which
can in fact by all kinds of different things, like
raw DBAPI rows, or Row objects, or "scalar"/Any, but
at the same time these types have meaning so I tried still
maintaining some level of semantic markings for these,
it highlights how complex Result is now, as it's trying
to be extremely efficient and inlined while also being
very open-ended and extensible.

Change-Id: I98b75c0c09eab5355fc7a33ba41dd9874274f12a

1 files changed, 43 insertions, 14 deletions

diff --git a/lib/sqlalchemy/engine/mock.py b/lib/sqlalchemy/engine/mock.py
index 76e77a3f3..a0ba96603 100644
--- a/lib/sqlalchemy/engine/mock.py
+++ b/lib/sqlalchemy/engine/mock.py
@@ -8,40 +8,69 @@
 from __future__ import annotations
 
 from operator import attrgetter
+import typing
+from typing import Any
+from typing import Callable
+from typing import cast
+from typing import Optional
+from typing import Type
+from typing import Union
 
 from . import url as _url
 from .. import util
 
 
+if typing.TYPE_CHECKING:
+    from .base import Connection
+    from .base import Engine
+    from .interfaces import _CoreAnyExecuteParams
+    from .interfaces import _ExecuteOptionsParameter
+    from .interfaces import Dialect
+    from .url import URL
+    from ..sql.base import Executable
+    from ..sql.ddl import DDLElement
+    from ..sql.ddl import SchemaDropper
+    from ..sql.ddl import SchemaGenerator
+    from ..sql.schema import HasSchemaAttr
+
+
 class MockConnection:
-    def __init__(self, dialect, execute):
+    def __init__(self, dialect: Dialect, execute: Callable[..., Any]):
         self._dialect = dialect
-        self.execute = execute
+        self._execute_impl = execute
 
-    engine = property(lambda s: s)
-    dialect = property(attrgetter("_dialect"))
-    name = property(lambda s: s._dialect.name)
+    engine: Engine = cast(Any, property(lambda s: s))
+    dialect: Dialect = cast(Any, property(attrgetter("_dialect")))
+    name: str = cast(Any, property(lambda s: s._dialect.name))
 
-    def connect(self, **kwargs):
+    def connect(self, **kwargs: Any) -> MockConnection:
         return self
 
-    def schema_for_object(self, obj):
+    def schema_for_object(self, obj: HasSchemaAttr) -> Optional[str]:
         return obj.schema
 
-    def execution_options(self, **kw):
+    def execution_options(self, **kw: Any) -> MockConnection:
         return self
 
     def _run_ddl_visitor(
-        self, visitorcallable, element, connection=None, **kwargs
-    ):
+        self,
+        visitorcallable: Type[Union[SchemaGenerator, SchemaDropper]],
+        element: DDLElement,
+        **kwargs: Any,
+    ) -> None:
         kwargs["checkfirst"] = False
         visitorcallable(self.dialect, self, **kwargs).traverse_single(element)
 
-    def execute(self, object_, *multiparams, **params):
-        raise NotImplementedError()
+    def execute(
+        self,
+        obj: Executable,
+        parameters: Optional[_CoreAnyExecuteParams] = None,
+        execution_options: Optional[_ExecuteOptionsParameter] = None,
+    ) -> Any:
+        return self._execute_impl(obj, parameters)
 
 
-def create_mock_engine(url, executor, **kw):
+def create_mock_engine(url: URL, executor: Any, **kw: Any) -> MockConnection:
     """Create a "mock" engine used for echoing DDL.
 
     This is a utility function used for debugging or storing the output of DDL
@@ -96,6 +125,6 @@ def create_mock_engine(url, executor, **kw):
             dialect_args[k] = kw.pop(k)
 
     # create dialect
-    dialect = dialect_cls(**dialect_args)
+    dialect = dialect_cls(**dialect_args)  # type: ignore
 
     return MockConnection(dialect, executor)