Enable pytype and fix detected issues (#1128)

Author: seratch

.github/workflows/pytype.yml

@@ -0,0 +1,30 @@
+name: pytype validation
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        python-version: ['3.9']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install -U pip
+        pip install -e ".[testing]"
+        pip install -e ".[optional]"
+        # As pytype can change its behavior in newer versions, we manually upgrade it
+        pip install "pytype==2021.10.11"
+    - name: Run pytype
+      run: |
+        pytype slack_sdk/

slack_sdk/audit_logs/v1/async_client.py

@@ -100,7 +100,7 @@ def __init__(
     async def schemas(
         self,
         *,
-        query_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """Returns information about the kind of objects which the Audit Logs API
@@ -122,7 +122,7 @@ async def schemas(
     async def actions(
         self,
         *,
-        query_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """Returns information about the kind of actions that the Audit Logs API
@@ -151,7 +151,7 @@ async def logs(
         action: Optional[str] = None,
         actor: Optional[str] = None,
         entity: Optional[str] = None,
-        additional_query_params: Optional[Dict[str, any]] = None,
+        additional_query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """This is the primary endpoint for retrieving actual audit events from your organization.
@@ -199,8 +199,8 @@ async def api_call(
         *,
         http_verb: str = "GET",
         path: str,
-        query_params: Optional[Dict[str, any]] = None,
-        body_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
+        body_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         url = f"{self.base_url}{path}"

slack_sdk/audit_logs/v1/client.py

@@ -7,7 +7,7 @@
 import urllib
 from http.client import HTTPResponse
 from ssl import SSLContext
-from typing import Dict, Optional, List
+from typing import Dict, Optional, List, Any
 from urllib.error import HTTPError
 from urllib.request import Request, urlopen, OpenerDirector, ProxyHandler, HTTPSHandler
 
@@ -89,7 +89,7 @@ def __init__(
     def schemas(
         self,
         *,
-        query_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """Returns information about the kind of objects which the Audit Logs API
@@ -111,7 +111,7 @@ def schemas(
     def actions(
         self,
         *,
-        query_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """Returns information about the kind of actions that the Audit Logs API
@@ -140,7 +140,7 @@ def logs(
         action: Optional[str] = None,
         actor: Optional[str] = None,
         entity: Optional[str] = None,
-        additional_query_params: Optional[Dict[str, any]] = None,
+        additional_query_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """This is the primary endpoint for retrieving actual audit events from your organization.
@@ -188,8 +188,8 @@ def api_call(
         *,
         http_verb: str = "GET",
         path: str,
-        query_params: Optional[Dict[str, any]] = None,
-        body_params: Optional[Dict[str, any]] = None,
+        query_params: Optional[Dict[str, Any]] = None,
+        body_params: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> AuditLogsResponse:
         """Performs a Slack API request and returns the result."""
@@ -214,7 +214,7 @@ def _perform_http_request(
         *,
         http_verb: str = "GET",
         url: str,
-        body: Optional[Dict[str, any]] = None,
+        body: Optional[Dict[str, Any]] = None,
         headers: Dict[str, str],
     ) -> AuditLogsResponse:
         if body is not None:
@@ -261,11 +261,20 @@ def _perform_http_request(
                     url=url,
                     status_code=e.code,
                     raw_body=response_body,
-                    headers=e.headers,
+                    headers=dict(e.headers.items()),
                 )
                 if e.code == 429:
                     # for backward-compatibility with WebClient (v.2.5.0 or older)
-                    resp.headers["Retry-After"] = resp.headers["retry-after"]
+                    if (
+                        "retry-after" not in resp.headers
+                        and "Retry-After" in resp.headers
+                    ):
+                        resp.headers["retry-after"] = resp.headers["Retry-After"]
+                    if (
+                        "Retry-After" not in resp.headers
+                        and "retry-after" in resp.headers
+                    ):
+                        resp.headers["Retry-After"] = resp.headers["retry-after"]
                 _debug_log_response(self.logger, resp)
 
                 # Try to find a retry handler for this error
@@ -356,20 +365,20 @@ def _perform_http_request_internal(
             raise SlackRequestError(f"Invalid URL detected: {url}")
 
         # NOTE: BAN-B310 is already checked above
-        resp: Optional[HTTPResponse] = None
+        http_resp: Optional[HTTPResponse] = None
         if opener:
-            resp = opener.open(req, timeout=self.timeout)  # skipcq: BAN-B310
+            http_resp = opener.open(req, timeout=self.timeout)  # skipcq: BAN-B310
         else:
-            resp = urlopen(  # skipcq: BAN-B310
+            http_resp = urlopen(  # skipcq: BAN-B310
                 req, context=self.ssl, timeout=self.timeout
             )
-        charset: str = resp.headers.get_content_charset() or "utf-8"
-        response_body: str = resp.read().decode(charset)
+        charset: str = http_resp.headers.get_content_charset() or "utf-8"
+        response_body: str = http_resp.read().decode(charset)
         resp = AuditLogsResponse(
             url=url,
-            status_code=resp.status,
+            status_code=http_resp.status,
             raw_body=response_body,
-            headers=resp.headers,
+            headers=http_resp.headers,
         )
         _debug_log_response(self.logger, resp)
         return resp

slack_sdk/audit_logs/v1/response.py

@@ -1,5 +1,5 @@
 import json
-from typing import Dict, Any
+from typing import Dict, Any, Optional
 
 from slack_sdk.audit_logs.v1.logs import LogsResponse
 
@@ -8,20 +8,22 @@ class AuditLogsResponse:
     url: str
     status_code: int
     headers: Dict[str, Any]
-    raw_body: str
-    body: Dict[str, Any]
-    typed_body: LogsResponse
+    raw_body: Optional[str]
+    body: Optional[Dict[str, Any]]
+    typed_body: Optional[LogsResponse]
 
     @property
-    def typed_body(self) -> LogsResponse:
+    def typed_body(self) -> Optional[LogsResponse]:  # type: ignore
+        if self.body is None:
+            return None
         return LogsResponse(**self.body)
 
     def __init__(
         self,
         *,
         url: str,
         status_code: int,
-        raw_body: str,
+        raw_body: Optional[str],
         headers: dict,
     ):
         self.url = url

slack_sdk/http_retry/builtin_async_handlers.py

@@ -1,6 +1,6 @@
 import asyncio
 import random
-from typing import Optional, List
+from typing import Optional, List, Type
 
 from aiohttp import ServerDisconnectedError, ServerConnectionError, ClientOSError
 
@@ -19,7 +19,7 @@ def __init__(
         self,
         max_retry_count: int = 1,
         interval_calculator: RetryIntervalCalculator = default_interval_calculator,
-        error_types: List[Exception] = [
+        error_types: List[Type[Exception]] = [
             ServerConnectionError,
             ServerDisconnectedError,
             # ClientOSError: [Errno 104] Connection reset by peer
@@ -57,7 +57,7 @@ async def _can_retry_async(
         response: Optional[HttpResponse],
         error: Optional[Exception],
     ) -> bool:
-        return response.status_code == 429
+        return response is not None and response.status_code == 429
 
     async def prepare_for_next_attempt_async(
         self,

slack_sdk/http_retry/builtin_handlers.py

@@ -1,7 +1,7 @@
 import random
 import time
 from http.client import RemoteDisconnected
-from typing import Optional, List
+from typing import Optional, List, Type
 from urllib.error import URLError
 
 from slack_sdk.http_retry.interval_calculator import RetryIntervalCalculator
@@ -18,7 +18,7 @@ def __init__(
         self,
         max_retry_count: int = 1,
         interval_calculator: RetryIntervalCalculator = default_interval_calculator,
-        error_types: List[Exception] = [
+        error_types: List[Type[Exception]] = [
             # To cover URLError: <urlopen error [Errno 104] Connection reset by peer>
             URLError,
             ConnectionResetError,

slack_sdk/models/__init__.py

@@ -12,7 +12,7 @@
 # NOTE: used only for legacy components - don't use this for Block Kit
 def extract_json(
     item_or_items: Union[JsonObject, Sequence[JsonObject]], *format_args
-) -> Union[Dict[Any, Any], List[Dict[Any, Any]]]:
+) -> Union[Dict[Any, Any], List[Dict[Any, Any]]]:  # type: ignore
     """
     Given a sequence (or single item), attempt to call the to_dict() method on each
     item and return a plain list. If item is not the expected type, return it
@@ -24,12 +24,12 @@ def extract_json(
             method
     """
     try:
-        return [
+        return [  # type: ignore
             elem.to_dict(*format_args) if isinstance(elem, JsonObject) else elem
             for elem in item_or_items
         ]
     except TypeError:  # not iterable, so try returning it as a single item
-        return (
+        return (  # type: ignore
             item_or_items.to_dict(*format_args)
             if isinstance(item_or_items, JsonObject)
             else item_or_items

slack_sdk/models/attachments/__init__.py

@@ -284,8 +284,7 @@ class Attachment(JsonObject):
         "ts",
     }
 
-    fields: List[AttachmentField]
-    actions: List[Action]
+    fields: Sequence[AttachmentField]
 
     MarkdownFields = {"fields", "pretext", "text"}
 
@@ -388,11 +387,11 @@ def __init__(
         self.markdown_in = markdown_in or []
 
     @JsonValidator(f"footer attribute cannot exceed {footer_max_length} characters")
-    def footer_length(self):
+    def footer_length(self) -> bool:
         return self.footer is None or len(self.footer) <= self.footer_max_length
 
     @JsonValidator("ts attribute cannot be present if footer attribute is absent")
-    def ts_without_footer(self):
+    def ts_without_footer(self) -> bool:
         return self.ts is None or self.footer is not None
 
     @EnumValidator("markdown_in", MarkdownFields)
@@ -404,23 +403,23 @@ def markdown_in_valid(self):
     @JsonValidator(
         "color attribute must be 'good', 'warning', 'danger', or a hex color code"
     )
-    def color_valid(self):
+    def color_valid(self) -> bool:
         return (
             self.color is None
             or self.color in SeededColors
-            or re.match("^#(?:[0-9A-F]{2}){3}$", self.color, re.IGNORECASE)
+            or re.match("^#(?:[0-9A-F]{2}){3}$", self.color, re.IGNORECASE) is not None
         )
 
     @JsonValidator("image_url attribute cannot be present if thumb_url is populated")
-    def image_url_and_thumb_url_populated(self):
+    def image_url_and_thumb_url_populated(self) -> bool:
         return self.image_url is None or self.thumb_url is None
 
     @JsonValidator("name must be present if link is present")
-    def author_link_without_author_name(self):
+    def author_link_without_author_name(self) -> bool:
         return self.author_link is None or self.author_name is not None
 
     @JsonValidator("icon must be present if link is present")
-    def author_link_without_author_icon(self):
+    def author_link_without_author_icon(self) -> bool:
         return self.author_link is None or self.author_icon is not None
 
     def to_dict(self) -> dict:  # skipcq: PYL-W0221
@@ -463,7 +462,7 @@ def __init__(
         self.blocks = list(blocks)
 
     @JsonValidator("fields attribute cannot be populated on BlockAttachment")
-    def fields_attribute_absent(self):
+    def fields_attribute_absent(self) -> bool:
         return not self.fields
 
     def to_dict(self) -> dict:
@@ -588,7 +587,7 @@ def __init__(
         self.actions = actions or []
 
     @JsonValidator(f"actions attribute cannot exceed {actions_max_length} elements")
-    def actions_length(self):
+    def actions_length(self) -> bool:
         return len(self.actions) <= self.actions_max_length
 
     def to_dict(self) -> dict:

slack_sdk/models/blocks/basic_components.py

@@ -417,7 +417,7 @@ def __init__(
         text: Union[str, dict, TextObject],
         confirm: Union[str, dict, PlainTextObject] = "Yes",
         deny: Union[str, dict, PlainTextObject] = "No",
-        style: str = None,
+        style: Optional[str] = None,
     ):
         """
         An object that defines a dialog that provides a confirmation step to any
@@ -439,25 +439,25 @@ def __init__(
         self.style = self._style
 
     @JsonValidator(f"title attribute cannot exceed {title_max_length} characters")
-    def title_length(self):
+    def title_length(self) -> bool:
         return self._title is None or len(self._title.text) <= self.title_max_length
 
     @JsonValidator(f"text attribute cannot exceed {text_max_length} characters")
-    def text_length(self):
+    def text_length(self) -> bool:
         return self._text is None or len(self._text.text) <= self.text_max_length
 
     @JsonValidator(f"confirm attribute cannot exceed {confirm_max_length} characters")
-    def confirm_length(self):
+    def confirm_length(self) -> bool:
         return (
             self._confirm is None or len(self._confirm.text) <= self.confirm_max_length
         )
 
     @JsonValidator(f"deny attribute cannot exceed {deny_max_length} characters")
-    def deny_length(self):
+    def deny_length(self) -> bool:
         return self._deny is None or len(self._deny.text) <= self.deny_max_length
 
     @JsonValidator('style for confirm must be either "primary" or "danger"')
-    def _validate_confirm_style(self):
+    def _validate_confirm_style(self) -> bool:
         return self._style is None or self._style in ["primary", "danger"]
 
     def to_dict(self, option_type: str = "block") -> dict:  # skipcq: PYL-W0221