Remove noqa comments and add __all__ to __init__.py files (#647)

seratch · web-flow · commit b637c298dfb1 · 2022-05-16T08:42:19.000+09:00
diff --git a/scripts/run_pytype.sh b/scripts/run_pytype.sh
@@ -5,5 +5,5 @@ script_dir=$(dirname $0)
 cd ${script_dir}/.. && \
   pip install -e ".[async]" && \
   pip install -e ".[adapter]" && \
-  pip install "pytype==2022.4.26" && \
+  pip install "pytype==2022.5.10" && \
   pytype slack_bolt/
diff --git a/slack_bolt/__init__.py b/slack_bolt/__init__.py
@@ -6,13 +6,26 @@
 * The class representing a Bolt app: `slack_bolt.app.app`
 """  # noqa: E501
 # Don't add async module imports here
-from .app import App  # noqa
-from .context import BoltContext  # noqa
-from .context.ack import Ack  # noqa
-from .context.respond import Respond  # noqa
-from .context.say import Say  # noqa
-from .kwargs_injection import Args  # noqa
-from .listener import Listener  # noqa
-from .listener_matcher import CustomListenerMatcher  # noqa
-from .request import BoltRequest  # noqa
-from .response import BoltResponse  # noqa
+from .app import App
+from .context import BoltContext
+from .context.ack import Ack
+from .context.respond import Respond
+from .context.say import Say
+from .kwargs_injection import Args
+from .listener import Listener
+from .listener_matcher import CustomListenerMatcher
+from .request import BoltRequest
+from .response import BoltResponse
+
+__all__ = [
+    "App",
+    "BoltContext",
+    "Ack",
+    "Respond",
+    "Say",
+    "Args",
+    "Listener",
+    "CustomListenerMatcher",
+    "BoltRequest",
+    "BoltResponse",
+]
diff --git a/slack_bolt/adapter/aiohttp/__init__.py b/slack_bolt/adapter/aiohttp/__init__.py
@@ -39,3 +39,9 @@ async def to_aiohttp_response(bolt_resp: BoltResponse) -> web.Response:
                 httponly=True,
             )
     return resp
+
+
+__all__ = [
+    "to_bolt_request",
+    "to_aiohttp_response",
+]
diff --git a/slack_bolt/adapter/aws_lambda/__init__.py b/slack_bolt/adapter/aws_lambda/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/bottle/__init__.py b/slack_bolt/adapter/bottle/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/cherrypy/__init__.py b/slack_bolt/adapter/cherrypy/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/django/__init__.py b/slack_bolt/adapter/django/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/falcon/__init__.py b/slack_bolt/adapter/falcon/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from .resource import SlackAppResource  # noqa: F401
+from .resource import SlackAppResource
+
+__all__ = [
+    "SlackAppResource",
+]
diff --git a/slack_bolt/adapter/fastapi/__init__.py b/slack_bolt/adapter/fastapi/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from ..starlette.handler import SlackRequestHandler  # noqa
+from ..starlette.handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/fastapi/async_handler.py b/slack_bolt/adapter/fastapi/async_handler.py
@@ -1 +1,5 @@
-from ..starlette.async_handler import AsyncSlackRequestHandler  # noqa
+from ..starlette.async_handler import AsyncSlackRequestHandler
+
+__all__ = [
+    "AsyncSlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/flask/__init__.py b/slack_bolt/adapter/flask/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/pyramid/__init__.py b/slack_bolt/adapter/pyramid/__init__.py
@@ -1 +1,5 @@
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/sanic/__init__.py b/slack_bolt/adapter/sanic/__init__.py
@@ -1 +1,5 @@
-from .async_handler import AsyncSlackRequestHandler  # noqa: F401
+from .async_handler import AsyncSlackRequestHandler
+
+__all__ = [
+    "AsyncSlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/socket_mode/__init__.py b/slack_bolt/adapter/socket_mode/__init__.py
@@ -7,4 +7,8 @@
 """  # noqa: E501
 
 # Don't add async module imports here
-from .builtin import SocketModeHandler  # noqa: F401
+from .builtin import SocketModeHandler
+
+__all__ = [
+    "SocketModeHandler",
+]
diff --git a/slack_bolt/adapter/socket_mode/async_handler.py b/slack_bolt/adapter/socket_mode/async_handler.py
@@ -1,2 +1,6 @@
 """Default implementation is the aiohttp-based one."""
-from .aiohttp import AsyncSocketModeHandler  # noqa
+from .aiohttp import AsyncSocketModeHandler
+
+__all__ = [
+    "AsyncSocketModeHandler",
+]
diff --git a/slack_bolt/adapter/starlette/__init__.py b/slack_bolt/adapter/starlette/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from .handler import SlackRequestHandler  # noqa: F401
+from .handler import SlackRequestHandler
+
+__all__ = [
+    "SlackRequestHandler",
+]
diff --git a/slack_bolt/adapter/tornado/__init__.py b/slack_bolt/adapter/tornado/__init__.py
@@ -1 +1,6 @@
-from .handler import SlackEventsHandler, SlackOAuthHandler  # noqa: F401
+from .handler import SlackEventsHandler, SlackOAuthHandler
+
+__all__ = [
+    "SlackEventsHandler",
+    "SlackOAuthHandler",
+]
diff --git a/slack_bolt/app/__init__.py b/slack_bolt/app/__init__.py
@@ -8,3 +8,7 @@
 
 # Don't add async module imports here
 from .app import App  # type: ignore
+
+__all__ = [
+    "App",
+]
diff --git a/slack_bolt/app/async_app.py b/slack_bolt/app/async_app.py
@@ -14,7 +14,7 @@
 from slack_bolt.listener.async_listener_completion_handler import (
     AsyncDefaultListenerCompletionHandler,
 )
-from slack_bolt.listener.asyncio_runner import AsyncioListenerRunner
+from slack_bolt.listener.asyncio_runner import AsyncioListenerRunner  # type: ignore
 from slack_bolt.middleware.async_middleware_error_handler import (
     AsyncCustomMiddlewareErrorHandler,
     AsyncDefaultMiddlewareErrorHandler,
diff --git a/slack_bolt/async_app.py b/slack_bolt/async_app.py
@@ -44,11 +44,22 @@ async def command(ack, body, respond):
 
 Refer to `slack_bolt.app.async_app` for more details.
 """  # noqa: E501
-from .app.async_app import AsyncApp  # noqa
-from .context.ack.async_ack import AsyncAck  # noqa
-from .context.async_context import AsyncBoltContext  # noqa
-from .context.respond.async_respond import AsyncRespond  # noqa
-from .context.say.async_say import AsyncSay  # noqa
-from .listener.async_listener import AsyncListener  # noqa
-from .listener_matcher.async_listener_matcher import AsyncCustomListenerMatcher  # noqa
-from .request.async_request import AsyncBoltRequest  # noqa
+from .app.async_app import AsyncApp
+from .context.ack.async_ack import AsyncAck
+from .context.async_context import AsyncBoltContext
+from .context.respond.async_respond import AsyncRespond
+from .context.say.async_say import AsyncSay
+from .listener.async_listener import AsyncListener
+from .listener_matcher.async_listener_matcher import AsyncCustomListenerMatcher
+from .request.async_request import AsyncBoltRequest
+
+__all__ = [
+    "AsyncApp",
+    "AsyncAck",
+    "AsyncBoltContext",
+    "AsyncRespond",
+    "AsyncSay",
+    "AsyncListener",
+    "AsyncCustomListenerMatcher",
+    "AsyncBoltRequest",
+]
diff --git a/slack_bolt/authorization/__init__.py b/slack_bolt/authorization/__init__.py
@@ -3,4 +3,8 @@
 
 Refer to https://slack.dev/bolt-python/concepts#authorization for details.
 """
-from .authorize_result import AuthorizeResult  # noqa
+from .authorize_result import AuthorizeResult
+
+__all__ = [
+    "AuthorizeResult",
+]
diff --git a/slack_bolt/context/__init__.py b/slack_bolt/context/__init__.py
@@ -6,4 +6,8 @@
 """
 
 # Don't add async module imports here
-from .context import BoltContext  # noqa: F401
+from .context import BoltContext
+
+__all__ = [
+    "BoltContext",
+]
diff --git a/slack_bolt/context/ack/__init__.py b/slack_bolt/context/ack/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from .ack import Ack  # noqa: F401
+from .ack import Ack
+
+__all__ = [
+    "Ack",
+]
diff --git a/slack_bolt/context/respond/__init__.py b/slack_bolt/context/respond/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from .respond import Respond  # noqa: F401
+from .respond import Respond
+
+__all__ = [
+    "Respond",
+]
diff --git a/slack_bolt/context/say/__init__.py b/slack_bolt/context/say/__init__.py
@@ -1,2 +1,6 @@
 # Don't add async module imports here
-from .say import Say  # noqa: F401
+from .say import Say
+
+__all__ = [
+    "Say",
+]
diff --git a/slack_bolt/kwargs_injection/__init__.py b/slack_bolt/kwargs_injection/__init__.py
@@ -5,5 +5,10 @@
 """
 
 # Don't add async module imports here
-from .args import Args  # noqa: F401
-from .utils import build_required_kwargs  # noqa: F401
+from .args import Args
+from .utils import build_required_kwargs
+
+__all__ = [
+    "Args",
+    "build_required_kwargs",
+]
diff --git a/slack_bolt/lazy_listener/__init__.py b/slack_bolt/lazy_listener/__init__.py
@@ -22,5 +22,10 @@ def run_long_process(respond, body):
 Refer to https://slack.dev/bolt-python/concepts#lazy-listeners for more details.
 """
 # Don't add async module imports here
-from .runner import LazyListenerRunner  # noqa
-from .thread_runner import ThreadLazyListenerRunner  # noqa
+from .runner import LazyListenerRunner
+from .thread_runner import ThreadLazyListenerRunner
+
+__all__ = [
+    "LazyListenerRunner",
+    "ThreadLazyListenerRunner",
+]
diff --git a/slack_bolt/listener/__init__.py b/slack_bolt/listener/__init__.py
@@ -12,3 +12,9 @@
 ]
 for cls in builtin_listener_classes:
     Listener.register(cls)
+
+__all__ = [
+    "CustomListener",
+    "Listener",
+    "builtin_listener_classes",
+]
diff --git a/slack_bolt/listener_matcher/__init__.py b/slack_bolt/listener_matcher/__init__.py
@@ -11,3 +11,9 @@
 ]
 for cls in builtin_listener_matcher_classes:
     ListenerMatcher.register(cls)
+
+__all__ = [
+    "CustomListenerMatcher",
+    "ListenerMatcher",
+    "builtin_listener_matcher_classes",
+]
diff --git a/slack_bolt/logger/__init__.py b/slack_bolt/logger/__init__.py
@@ -44,3 +44,9 @@ def _configure_from_base_logger(new_logger: Logger, base_logger: Logger):
 def _configure_from_root(new_logger: Logger):
     new_logger.disabled = logging.root.disabled
     new_logger.level = logging.root.level
+
+
+__all__ = [
+    "get_bolt_logger",
+    "get_bolt_app_logger",
+]
diff --git a/slack_bolt/middleware/__init__.py b/slack_bolt/middleware/__init__.py
@@ -9,13 +9,13 @@
 from .authorization import (
     SingleTeamAuthorization,
     MultiTeamsAuthorization,
-)  # noqa: F401
-from .custom_middleware import CustomMiddleware  # noqa: F401
-from .ignoring_self_events import IgnoringSelfEvents  # noqa: F401
-from .middleware import Middleware  # noqa: F401
-from .request_verification import RequestVerification  # noqa: F401
-from .ssl_check import SslCheck  # noqa: F401
-from .url_verification import UrlVerification  # noqa: F401
+)
+from .custom_middleware import CustomMiddleware
+from .ignoring_self_events import IgnoringSelfEvents
+from .middleware import Middleware
+from .request_verification import RequestVerification
+from .ssl_check import SslCheck
+from .url_verification import UrlVerification
 
 builtin_middleware_classes = [
     SslCheck,
@@ -27,3 +27,15 @@
 ]
 for cls in builtin_middleware_classes:
     Middleware.register(cls)
+
+__all__ = [
+    "SingleTeamAuthorization",
+    "MultiTeamsAuthorization",
+    "CustomMiddleware",
+    "IgnoringSelfEvents",
+    "Middleware",
+    "RequestVerification",
+    "SslCheck",
+    "UrlVerification",
+    "builtin_middleware_classes",
+]
diff --git a/slack_bolt/middleware/async_builtins.py b/slack_bolt/middleware/async_builtins.py
@@ -1,11 +1,19 @@
-from .ignoring_self_events.async_ignoring_self_events import (  # noqa: F401
+from .ignoring_self_events.async_ignoring_self_events import (
     AsyncIgnoringSelfEvents,
 )
-from .request_verification.async_request_verification import (  # noqa: F401
+from .request_verification.async_request_verification import (
     AsyncRequestVerification,
 )
-from .ssl_check.async_ssl_check import AsyncSslCheck  # noqa: F401
-from .url_verification.async_url_verification import AsyncUrlVerification  # noqa: F401
-from .message_listener_matches.async_message_listener_matches import (  # noqa: F401
+from .ssl_check.async_ssl_check import AsyncSslCheck
+from .url_verification.async_url_verification import AsyncUrlVerification
+from .message_listener_matches.async_message_listener_matches import (
     AsyncMessageListenerMatches,
 )
+
+__all__ = [
+    "AsyncIgnoringSelfEvents",
+    "AsyncRequestVerification",
+    "AsyncSslCheck",
+    "AsyncUrlVerification",
+    "AsyncMessageListenerMatches",
+]
diff --git a/slack_bolt/middleware/authorization/__init__.py b/slack_bolt/middleware/authorization/__init__.py
@@ -1,4 +1,10 @@
 # Don't add async module imports here
-from .authorization import Authorization  # noqa: F401
-from .multi_teams_authorization import MultiTeamsAuthorization  # noqa: F401
-from .single_team_authorization import SingleTeamAuthorization  # noqa: F401
+from .authorization import Authorization
+from .multi_teams_authorization import MultiTeamsAuthorization
+from .single_team_authorization import SingleTeamAuthorization
+
+__all__ = [
+    "Authorization",
+    "MultiTeamsAuthorization",
+    "SingleTeamAuthorization",
+]
diff --git a/slack_bolt/middleware/ignoring_self_events/__init__.py b/slack_bolt/middleware/ignoring_self_events/__init__.py
@@ -1 +1,5 @@
-from .ignoring_self_events import IgnoringSelfEvents  # noqa
+from .ignoring_self_events import IgnoringSelfEvents
+
+__all__ = [
+    "IgnoringSelfEvents",
+]
diff --git a/slack_bolt/middleware/message_listener_matches/__init__.py b/slack_bolt/middleware/message_listener_matches/__init__.py
@@ -1 +1,5 @@
-from .message_listener_matches import MessageListenerMatches  # noqa
+from .message_listener_matches import MessageListenerMatches
+
+__all__ = [
+    "MessageListenerMatches",
+]
diff --git a/slack_bolt/middleware/request_verification/__init__.py b/slack_bolt/middleware/request_verification/__init__.py
diff --git a/slack_bolt/middleware/ssl_check/__init__.py b/slack_bolt/middleware/ssl_check/__init__.py
diff --git a/slack_bolt/middleware/url_verification/__init__.py b/slack_bolt/middleware/url_verification/__init__.py
diff --git a/slack_bolt/oauth/__init__.py b/slack_bolt/oauth/__init__.py
diff --git a/slack_bolt/request/__init__.py b/slack_bolt/request/__init__.py
diff --git a/slack_bolt/response/__init__.py b/slack_bolt/response/__init__.py
diff --git a/slack_bolt/workflows/step/__init__.py b/slack_bolt/workflows/step/__init__.py
diff --git a/slack_bolt/workflows/step/async_step_middleware.py b/slack_bolt/workflows/step/async_step_middleware.py
