Improve typing when using 'get' on API response (#1283)

Author: eddyg

slack_sdk/web/async_slack_response.py

@@ -1,11 +1,13 @@
 """A Python module for interacting and consuming responses from Slack."""
 
 import logging
-from typing import Union
+from typing import Any, Optional, TypeVar, Union, overload
 
 import slack_sdk.errors as e
 from .internal_utils import _next_cursor_is_present
 
+T = TypeVar("T")
+
 
 class AsyncSlackResponse:
     """An iterable container of response data.
@@ -159,6 +161,14 @@ async def __anext__(self):
         else:
             raise StopAsyncIteration
 
+    @overload
+    def get(self, key: str, default: None = None) -> Optional[Any]:
+        ...
+
+    @overload
+    def get(self, key: str, default: T) -> T:
+        ...
+
     def get(self, key, default=None):
         """Retrieves any key from the response data.
 

slack_sdk/web/slack_response.py

@@ -1,11 +1,13 @@
 """A Python module for interacting and consuming responses from Slack."""
 
 import logging
-from typing import Union
+from typing import Any, Optional, TypeVar, Union, overload
 
 import slack_sdk.errors as e
 from .internal_utils import _next_cursor_is_present
 
+T = TypeVar("T")
+
 
 class SlackResponse:
     """An iterable container of response data.
@@ -156,6 +158,14 @@ def __next__(self):
         else:
             raise StopIteration
 
+    @overload
+    def get(self, key: str, default: None = None) -> Optional[Any]:
+        ...
+
+    @overload
+    def get(self, key: str, default: T) -> T:
+        ...
+
     def get(self, key, default=None):
         """Retrieves any key from the response data.