fix type hint for event constraint to allow None subtypes (#616)

* fix type hint for message constraint to allow None subtypes

Signed-off-by: Alexander Rashed <alexander.rashed@localstack.cloud>

* revert changes to auto-generated docs

Signed-off-by: Alexander Rashed <alexander.rashed@localstack.cloud>

Author: alexrashed

docs/_basic/listening_events.md

@@ -36,6 +36,7 @@ def ask_for_introduction(event, say):
 The `message()` listener is equivalent to `event("message")`.
 
 You can filter on subtypes of events by passing in the additional key `subtype`. Common message subtypes like `bot_message` and `message_replied` can be found [on the message event page](https://api.slack.com/events/message#message_subtypes).
+You can explicitly filter for events without a subtype by explicitly setting `None`.
 
 </div>
 

slack_bolt/app/app.py

@@ -724,7 +724,9 @@ def custom_error_handler(error, body, logger):
     def event(
         self,
         event: Union[
-            str, Pattern, Dict[str, Union[str, Sequence[Optional[Union[str, Pattern]]]]]
+            str,
+            Pattern,
+            Dict[str, Optional[Union[str, Sequence[Optional[Union[str, Pattern]]]]]],
         ],
         matchers: Optional[Sequence[Callable[..., bool]]] = None,
         middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,

slack_bolt/app/async_app.py

@@ -782,7 +782,9 @@ async def custom_error_handler(error, body, logger):
     def event(
         self,
         event: Union[
-            str, Pattern, Dict[str, Union[str, Sequence[Optional[Union[str, Pattern]]]]]
+            str,
+            Pattern,
+            Dict[str, Optional[Union[str, Sequence[Optional[Union[str, Pattern]]]]]],
         ],
         matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
         middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,

slack_bolt/listener_matcher/builtins.py

@@ -78,7 +78,9 @@ async def async_fun(body: Dict[str, Any]) -> bool:
 
 def event(
     constraints: Union[
-        str, Pattern, Dict[str, Union[str, Sequence[Optional[Union[str, Pattern]]]]]
+        str,
+        Pattern,
+        Dict[str, Optional[Union[str, Sequence[Optional[Union[str, Pattern]]]]]],
     ],
     asyncio: bool = False,
 ) -> Union[ListenerMatcher, "AsyncListenerMatcher"]:
@@ -110,7 +112,9 @@ def func(body: Dict[str, Any]) -> bool:
 
 
 def message_event(
-    constraints: Dict[str, Union[str, Sequence[Optional[Union[str, Pattern]]]]],
+    constraints: Dict[
+        str, Optional[Union[str, Sequence[Optional[Union[str, Pattern]]]]]
+    ],
     keyword: Union[str, Pattern],
     asyncio: bool = False,
 ) -> Union[ListenerMatcher, "AsyncListenerMatcher"]:
@@ -140,8 +144,8 @@ def _check_event_subtype(event_payload: dict, constraints: dict) -> bool:
     if not _matches(constraints["type"], event_payload["type"]):
         return False
     if "subtype" in constraints:
-        expected_subtype: Union[
-            str, Sequence[Optional[Union[str, Pattern]]]
+        expected_subtype: Optional[
+            Union[str, Sequence[Optional[Union[str, Pattern]]]]
         ] = constraints["subtype"]
         if expected_subtype is None:
             # "subtype" in constraints is intentionally None for this pattern