Fix #1209 Add __all__ to __init__.py (#1210)

slackapi · May 18, 2022 · b7f838b · b7f838b
1 parent 5019f65
commit b7f838b
Show file tree

Hide file tree

Showing 29 changed files with 371 additions and 166 deletions.
diff --git a/.github/workflows/pytype.yml b/.github/workflows/pytype.yml
@@ -24,7 +24,7 @@ jobs:
         pip install -e ".[testing]"
         pip install -e ".[optional]"
         # As pytype can change its behavior in newer versions, we manually upgrade it
-        pip install "pytype==2022.4.26"
+        pip install "pytype==2022.5.10"
     - name: Run pytype
       run: |
         pytype slack_sdk/
diff --git a/setup.py b/setup.py
@@ -37,7 +37,7 @@
     "moto>=3,<4",  # For AWS tests
 ]
 codegen_dependencies = [
-    "black==22.1.0",
+    "black==22.3.0",
 ]
 
 needs_pytest = {"pytest", "test", "ptr"}.intersection(sys.argv)

diff --git a/slack_sdk/__init__.py b/slack_sdk/__init__.py
@@ -40,9 +40,14 @@
 import logging
 from logging import NullHandler
 
-# from .rtm import RTMClient  # noqa
-from .web import WebClient  # noqa
-from .webhook import WebhookClient  # noqa
+# from .rtm import RTMClient
+from .web import WebClient
+from .webhook import WebhookClient
+
+__all__ = [
+    "WebClient",
+    "WebhookClient",
+]
 
 # Set default logging handler to avoid "No handler found" warnings.
 logging.getLogger(__name__).addHandler(NullHandler())
diff --git a/slack_sdk/audit_logs/__init__.py b/slack_sdk/audit_logs/__init__.py
@@ -2,5 +2,10 @@
 
 Refer to https://slack.dev/python-slack-sdk/audit-logs/ for details.
 """
-from .v1.client import AuditLogsClient  # noqa
-from .v1.response import AuditLogsResponse  # noqa
+from .v1.client import AuditLogsClient
+from .v1.response import AuditLogsResponse
+
+__all__ = [
+    "AuditLogsClient",
+    "AuditLogsResponse",
+]
diff --git a/slack_sdk/audit_logs/async_client.py b/slack_sdk/audit_logs/async_client.py
@@ -1 +1,5 @@
-from .v1.async_client import AsyncAuditLogsClient  # noqa
+from .v1.async_client import AsyncAuditLogsClient
+
+__all__ = [
+    "AsyncAuditLogsClient",
+]
diff --git a/slack_sdk/audit_logs/v1/logs.py b/slack_sdk/audit_logs/v1/logs.py
@@ -61,7 +61,7 @@ class Actor:
     def __init__(
         self,
         type: Optional[str] = None,
-        user: Optional[User] = None,
+        user: Optional[Union[User, Dict[str, Any]]] = None,
         **kwargs,
     ) -> None:
         self.type = type
@@ -103,18 +103,18 @@ class Context:
     def __init__(
         self,
         *,
-        location: Optional[Location] = None,
+        location: Optional[Union[Location, Dict[str, Any]]] = None,
         ua: Optional[str] = None,
         ip_address: Optional[str] = None,
         session_id: Optional[str] = None,
-        app: Optional[App] = None,
+        app: Optional[Union[App, Dict[str, Any]]] = None,
         **kwargs,
     ) -> None:
         self.location = Location(**location) if isinstance(location, dict) else location
         self.ua = ua
         self.ip_address = ip_address
         self.session_id = session_id
-        self.app = app
+        self.app = App(**app) if isinstance(app, dict) else app
         self.unknown_fields = kwargs
 
 
@@ -304,9 +304,9 @@ def __init__(
         creator: Optional[str] = None,
         team: Optional[str] = None,
         app_id: Optional[str] = None,
-        enable_at_here: Optional[FeatureEnablement] = None,
-        enable_at_channel: Optional[FeatureEnablement] = None,
-        can_huddle: Optional[FeatureEnablement] = None,
+        enable_at_here: Optional[Union[Dict[str, Any], FeatureEnablement]] = None,
+        enable_at_channel: Optional[Union[Dict[str, Any], FeatureEnablement]] = None,
+        can_huddle: Optional[Union[Dict[str, Any], FeatureEnablement]] = None,
         **kwargs,
     ) -> None:
         self.name = name
@@ -548,15 +548,15 @@ def __init__(
         self,
         *,
         type: Optional[str] = None,
-        user: Optional[Union[User, dict]] = None,
-        workspace: Optional[Union[Location, dict]] = None,
-        enterprise: Optional[Union[Location, dict]] = None,
-        channel: Optional[Union[Channel, dict]] = None,
-        file: Optional[Union[File, dict]] = None,
-        app: Optional[Union[App, dict]] = None,
-        usergroup: Optional[Usergroup] = None,
-        workflow: Optional[Workflow] = None,
-        barrier: Optional[InformationBarrier] = None,
+        user: Optional[Union[User, Dict[str, Any]]] = None,
+        workspace: Optional[Union[Location, Dict[str, Any]]] = None,
+        enterprise: Optional[Union[Location, Dict[str, Any]]] = None,
+        channel: Optional[Union[Channel, Dict[str, Any]]] = None,
+        file: Optional[Union[File, Dict[str, Any]]] = None,
+        app: Optional[Union[App, Dict[str, Any]]] = None,
+        usergroup: Optional[Union[Usergroup, Dict[str, Any]]] = None,
+        workflow: Optional[Union[Workflow, Dict[str, Any]]] = None,
+        barrier: Optional[Union[InformationBarrier, Dict[str, Any]]] = None,
         **kwargs,
     ) -> None:
         self.type = type
@@ -596,10 +596,10 @@ def __init__(
         id: Optional[str] = None,
         date_create: Optional[int] = None,
         action: Optional[str] = None,
-        actor: Optional[Actor] = None,
-        entity: Optional[Entity] = None,
-        context: Optional[Context] = None,
-        details: Optional[Details] = None,
+        actor: Optional[Union[Actor, Dict[str, Any]]] = None,
+        entity: Optional[Union[Entity, Dict[str, Any]]] = None,
+        context: Optional[Union[Context, Dict[str, Any]]] = None,
+        details: Optional[Union[Details, Dict[str, Any]]] = None,
         **kwargs,
     ) -> None:
         self.id = id
@@ -638,8 +638,8 @@ class LogsResponse:
     def __init__(
         self,
         *,
-        entries: Optional[List[Union[Entry, dict]]] = None,
-        response_metadata: Optional[Union[ResponseMetadata, dict]] = None,
+        entries: Optional[List[Union[Entry, Dict[str, Any]]]] = None,
+        response_metadata: Optional[Union[ResponseMetadata, Dict[str, Any]]] = None,
         ok: Optional[bool] = None,
         error: Optional[str] = None,
         needed: Optional[str] = None,

diff --git a/slack_sdk/http_retry/__init__.py b/slack_sdk/http_retry/__init__.py
@@ -1,22 +1,22 @@
 from typing import List
 
-from .handler import RetryHandler  # noqa
+from .handler import RetryHandler
 from .builtin_handlers import (
-    ConnectionErrorRetryHandler,  # noqa
-    RateLimitErrorRetryHandler,  # noqa
-)  # noqa
-from .interval_calculator import RetryIntervalCalculator  # noqa
-from .builtin_interval_calculators import (  # noqa
-    FixedValueRetryIntervalCalculator,  # noqa
-    BackoffRetryIntervalCalculator,  # noqa
-)  # noqa
-from .jitter import Jitter  # noqa
-from .request import HttpRequest  # noqa
-from .response import HttpResponse  # noqa
-from .state import RetryState  # noqa
-
-connect_error_retry_handler = ConnectionErrorRetryHandler()  # noqa
-rate_limit_error_retry_handler = RateLimitErrorRetryHandler()  # noqa
+    ConnectionErrorRetryHandler,
+    RateLimitErrorRetryHandler,
+)
+from .interval_calculator import RetryIntervalCalculator
+from .builtin_interval_calculators import (
+    FixedValueRetryIntervalCalculator,
+    BackoffRetryIntervalCalculator,
+)
+from .jitter import Jitter
+from .request import HttpRequest
+from .response import HttpResponse
+from .state import RetryState
+
+connect_error_retry_handler = ConnectionErrorRetryHandler()
+rate_limit_error_retry_handler = RateLimitErrorRetryHandler()
 
 
 def default_retry_handlers() -> List[RetryHandler]:
@@ -28,3 +28,21 @@ def all_builtin_retry_handlers() -> List[RetryHandler]:
         connect_error_retry_handler,
         rate_limit_error_retry_handler,
     ]
+
+
+__all__ = [
+    "RetryHandler",
+    "ConnectionErrorRetryHandler",
+    "RateLimitErrorRetryHandler",
+    "RetryIntervalCalculator",
+    "FixedValueRetryIntervalCalculator",
+    "BackoffRetryIntervalCalculator",
+    "Jitter",
+    "HttpRequest",
+    "HttpResponse",
+    "RetryState",
+    "connect_error_retry_handler",
+    "rate_limit_error_retry_handler",
+    "default_retry_handlers",
+    "all_builtin_retry_handlers",
+]
diff --git a/slack_sdk/http_retry/async_handler.py b/slack_sdk/http_retry/async_handler.py
@@ -79,3 +79,13 @@ async def prepare_for_next_attempt_async(
         )
         await asyncio.sleep(duration)
         state.increment_current_attempt()
+
+
+__all__ = [
+    "RetryState",
+    "HttpRequest",
+    "HttpResponse",
+    "RetryIntervalCalculator",
+    "BackoffRetryIntervalCalculator",
+    "default_interval_calculator",
+]
diff --git a/slack_sdk/models/__init__.py b/slack_sdk/models/__init__.py
@@ -3,10 +3,10 @@
 import logging
 from typing import Union, Dict, Any, Sequence, List
 
-from .basic_objects import BaseObject  # noqa
-from .basic_objects import EnumValidator  # noqa
-from .basic_objects import JsonObject  # noqa
-from .basic_objects import JsonValidator  # noqa
+from .basic_objects import BaseObject
+from .basic_objects import EnumValidator
+from .basic_objects import JsonObject
+from .basic_objects import JsonValidator
 
 
 # NOTE: used only for legacy components - don't use this for Block Kit
@@ -49,3 +49,13 @@ def show_unknown_key_warning(name: Union[str, object], others: dict):
             f"If they should be supported by this library, report this issue to the project :bow: "
             f"https://github.com/slackapi/python-slack-sdk/issues"
         )
+
+
+__all__ = [
+    "BaseObject",
+    "EnumValidator",
+    "JsonObject",
+    "JsonValidator",
+    "extract_json",
+    "show_unknown_key_warning",
+]
diff --git a/slack_sdk/models/blocks/__init__.py b/slack_sdk/models/blocks/__init__.py
@@ -6,45 +6,90 @@
 * https://api.slack.com/reference/block-kit/blocks
 * https://app.slack.com/block-kit-builder
 """
-from .basic_components import ButtonStyles  # noqa
-from .basic_components import ConfirmObject  # noqa
-from .basic_components import DynamicSelectElementTypes  # noqa
-from .basic_components import MarkdownTextObject  # noqa
-from .basic_components import Option  # noqa
-from .basic_components import OptionGroup  # noqa
-from .basic_components import PlainTextObject  # noqa
-from .basic_components import TextObject  # noqa
-from .block_elements import BlockElement  # noqa
-from .block_elements import ButtonElement  # noqa
-from .block_elements import ChannelMultiSelectElement  # noqa
-from .block_elements import ChannelSelectElement  # noqa
-from .block_elements import CheckboxesElement  # noqa
-from .block_elements import ConversationFilter  # noqa
-from .block_elements import ConversationMultiSelectElement  # noqa
-from .block_elements import ConversationSelectElement  # noqa
-from .block_elements import DatePickerElement  # noqa
-from .block_elements import TimePickerElement  # noqa
-from .block_elements import ExternalDataMultiSelectElement  # noqa
-from .block_elements import ExternalDataSelectElement  # noqa
-from .block_elements import ImageElement  # noqa
-from .block_elements import InputInteractiveElement  # noqa
-from .block_elements import InteractiveElement  # noqa
-from .block_elements import LinkButtonElement  # noqa
-from .block_elements import OverflowMenuElement  # noqa
-from .block_elements import PlainTextInputElement  # noqa
-from .block_elements import RadioButtonsElement  # noqa
-from .block_elements import SelectElement  # noqa
-from .block_elements import StaticMultiSelectElement  # noqa
-from .block_elements import StaticSelectElement  # noqa
-from .block_elements import UserMultiSelectElement  # noqa
-from .block_elements import UserSelectElement  # noqa
-from .blocks import ActionsBlock  # noqa
-from .blocks import Block  # noqa
-from .blocks import CallBlock  # noqa
-from .blocks import ContextBlock  # noqa
-from .blocks import DividerBlock  # noqa
-from .blocks import FileBlock  # noqa
-from .blocks import HeaderBlock  # noqa
-from .blocks import ImageBlock  # noqa
-from .blocks import InputBlock  # noqa
-from .blocks import SectionBlock  # noqa
+from .basic_components import ButtonStyles
+from .basic_components import ConfirmObject
+from .basic_components import DynamicSelectElementTypes
+from .basic_components import MarkdownTextObject
+from .basic_components import Option
+from .basic_components import OptionGroup
+from .basic_components import PlainTextObject
+from .basic_components import TextObject
+from .block_elements import BlockElement
+from .block_elements import ButtonElement
+from .block_elements import ChannelMultiSelectElement
+from .block_elements import ChannelSelectElement
+from .block_elements import CheckboxesElement
+from .block_elements import ConversationFilter
+from .block_elements import ConversationMultiSelectElement
+from .block_elements import ConversationSelectElement
+from .block_elements import DatePickerElement
+from .block_elements import TimePickerElement
+from .block_elements import ExternalDataMultiSelectElement
+from .block_elements import ExternalDataSelectElement
+from .block_elements import ImageElement
+from .block_elements import InputInteractiveElement
+from .block_elements import InteractiveElement
+from .block_elements import LinkButtonElement
+from .block_elements import OverflowMenuElement
+from .block_elements import PlainTextInputElement
+from .block_elements import RadioButtonsElement
+from .block_elements import SelectElement
+from .block_elements import StaticMultiSelectElement
+from .block_elements import StaticSelectElement
+from .block_elements import UserMultiSelectElement
+from .block_elements import UserSelectElement
+from .blocks import ActionsBlock
+from .blocks import Block
+from .blocks import CallBlock
+from .blocks import ContextBlock
+from .blocks import DividerBlock
+from .blocks import FileBlock
+from .blocks import HeaderBlock
+from .blocks import ImageBlock
+from .blocks import InputBlock
+from .blocks import SectionBlock
+
+__all__ = [
+    "ButtonStyles",
+    "ConfirmObject",
+    "DynamicSelectElementTypes",
+    "MarkdownTextObject",
+    "Option",
+    "OptionGroup",
+    "PlainTextObject",
+    "TextObject",
+    "BlockElement",
+    "ButtonElement",
+    "ChannelMultiSelectElement",
+    "ChannelSelectElement",
+    "CheckboxesElement",
+    "ConversationFilter",
+    "ConversationMultiSelectElement",
+    "ConversationSelectElement",
+    "DatePickerElement",
+    "TimePickerElement",
+    "ExternalDataMultiSelectElement",
+    "ExternalDataSelectElement",
+    "ImageElement",
+    "InputInteractiveElement",
+    "InteractiveElement",
+    "LinkButtonElement",
+    "OverflowMenuElement",
+    "PlainTextInputElement",
+    "RadioButtonsElement",
+    "SelectElement",
+    "StaticMultiSelectElement",
+    "StaticSelectElement",
+    "UserMultiSelectElement",
+    "UserSelectElement",
+    "ActionsBlock",
+    "Block",
+    "CallBlock",
+    "ContextBlock",
+    "DividerBlock",
+    "FileBlock",
+    "HeaderBlock",
+    "ImageBlock",
+    "InputBlock",
+    "SectionBlock",
+]