Fixing a couple type problems: how I would address most of #381 (#382)

* Create py.typed Signed-off-by: wyattscarpenter <wyattscarpenter@gmail.com> * add -> Connection annotation Signed-off-by: wyattscarpenter <wyattscarpenter@gmail.com> * massage the code to appease the particular version of the project's mypy deps Signed-off-by: wyattscarpenter <wyattscarpenter@gmail.com> * fix circular import problem Signed-off-by: wyattscarpenter <wyattscarpenter@gmail.com> --------- Signed-off-by: wyattscarpenter <wyattscarpenter@gmail.com>
databricks · Apr 2, 2024 · 6e0fb78 · 6e0fb78
1 parent 7fade51
commit 6e0fb78
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/databricks/py.typed b/src/databricks/py.typed
diff --git a/src/databricks/sql/__init__.py b/src/databricks/sql/__init__.py
@@ -10,6 +10,12 @@
 
 import re
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    # Use this import purely for type annotations, a la https://mypy.readthedocs.io/en/latest/runtime_troubles.html#import-cycles
+    from .client import Connection
+
 
 class RedactUrlQueryParamsFilter(logging.Filter):
     pattern = re.compile(r"(\?|&)([\w-]+)=([^&]+)")
@@ -78,7 +84,7 @@ def TimestampFromTicks(ticks):
     return Timestamp(*time.localtime(ticks)[:6])
 
 
-def connect(server_hostname, http_path, access_token=None, **kwargs):
+def connect(server_hostname, http_path, access_token=None, **kwargs) -> "Connection":
     from .client import Connection
 
     return Connection(server_hostname, http_path, access_token, **kwargs)