Fix and enable mypy return check

.github/scripts/mr_generate_summary.py

@@ -58,7 +58,13 @@ def read_results(file):
     with open(file) as json_file:
         data = json.load(json_file)
 
-        keys = ["accuracy", "weighted avg", "macro avg", "micro avg", "conversation_accuracy"]
+        keys = [
+            "accuracy",
+            "weighted avg",
+            "macro avg",
+            "micro avg",
+            "conversation_accuracy",
+        ]
         result = {key: data[key] for key in keys if key in data}
 
     return result

.github/scripts/mr_publish_results.py

@@ -69,7 +69,13 @@ def read_results(file):
     with open(file) as json_file:
         data = json.load(json_file)
 
-        keys = ["accuracy", "weighted avg", "macro avg", "micro avg", "conversation_accuracy"]
+        keys = [
+            "accuracy",
+            "weighted avg",
+            "macro avg",
+            "micro avg",
+            "conversation_accuracy",
+        ]
         result = {key: data[key] for key in keys if key in data}
 
     return result

pyproject.toml

@@ -156,6 +156,7 @@ types-requests = "^2.25.0"
 types-setuptools = "^57.0.0"
 memory-profiler = "^0.58.0"
 psutil = "^5.8.0"
+mypy-extensions = "^0.4.3"
 
 [tool.poetry.extras]
 spacy = [ "spacy",]

rasa/cli/train.py

@@ -165,6 +165,7 @@ def run_core_training(
         rasa.utils.common.run_in_loop(
             do_compare_training(args, story_file, additional_arguments)
         )
+        return None
 
 
 def run_nlu_training(

rasa/cli/x.py

@@ -2,7 +2,8 @@
 import asyncio
 import importlib.util
 import logging
-from multiprocessing import get_context, Process
+from multiprocessing.process import BaseProcess
+from multiprocessing import get_context
 import os
 import signal
 import sys
@@ -198,7 +199,7 @@ def _is_correct_event_broker(event_broker: EndpointConfig) -> bool:
 
 def start_rasa_for_local_rasa_x(
     args: argparse.Namespace, rasa_x_token: Text
-) -> Process:
+) -> BaseProcess:
     """Starts the Rasa X API with Rasa as a background process."""
     credentials_path, endpoints_path = _get_credentials_and_endpoints_paths(args)
     endpoints = AvailableEndpoints.read_endpoints(endpoints_path)

rasa/core/actions/action.py

@@ -510,7 +510,7 @@ async def run(
         domain: "Domain",
     ) -> List[Event]:
         """Runs action. Please see parent class for the full docstring."""
-        _events = [SessionStarted(metadata=self.metadata)]
+        _events: List[Event] = [SessionStarted(metadata=self.metadata)]
 
         if domain.session_config.carry_over_slots:
             _events.extend(self._slot_set_events_from_tracker(tracker))
@@ -690,7 +690,7 @@ async def run(
 
             events_json = response.get("events", [])
             responses = response.get("responses", [])
-            bot_messages = await self._utter_responses(
+            bot_messages: List[Event] = await self._utter_responses(
                 responses, output_channel, nlg, tracker
             )
 

rasa/core/actions/forms.py

@@ -425,7 +425,7 @@ async def validate_slots(
         domain: Domain,
         output_channel: OutputChannel,
         nlg: NaturalLanguageGenerator,
-    ) -> List[Event]:
+    ) -> List[Union[SlotSet, Event]]:
         """Validate the extracted slots.
 
         If a custom action is available for validating the slots, we call it to validate
@@ -445,7 +445,7 @@ async def validate_slots(
             for the validated slots.
         """
         logger.debug(f"Validating extracted slots: {slot_candidates}")
-        events = [
+        events: List[Union[SlotSet, Event]] = [
             SlotSet(slot_name, value) for slot_name, value in slot_candidates.items()
         ]
 
@@ -506,7 +506,7 @@ async def validate(
         domain: Domain,
         output_channel: OutputChannel,
         nlg: NaturalLanguageGenerator,
-    ) -> List[Event]:
+    ) -> List[Union[SlotSet, Event]]:
         """Extract and validate value of requested slot.
 
         If nothing was extracted reject execution of the form action.
@@ -560,9 +560,9 @@ async def request_next_slot(
         output_channel: OutputChannel,
         nlg: NaturalLanguageGenerator,
         events_so_far: List[Event],
-    ) -> List[Event]:
+    ) -> List[Union[SlotSet, Event]]:
         """Request the next slot and response if needed, else return `None`."""
-        request_slot_events = []
+        request_slot_events: List[Union[SlotSet, Event]] = []
 
         if await self.is_done(output_channel, nlg, tracker, domain, events_so_far):
             # The custom action for slot validation decided to stop the form early

rasa/core/actions/two_stage_fallback.py

@@ -104,7 +104,8 @@ async def deactivate(
             return await self._give_up(output_channel, nlg, tracker, domain)
 
         # revert fallback events
-        return [UserUtteranceReverted()] + _message_clarification(tracker)
+        reverted_event: List[Event] = [UserUtteranceReverted()]
+        return reverted_event + _message_clarification(tracker)
 
     async def _give_up(
         self,
@@ -137,7 +138,7 @@ def _two_fallbacks_in_a_row(tracker: DialogueStateTracker) -> bool:
 
 def _last_n_intent_names(
     tracker: DialogueStateTracker, number_of_last_intent_names: int
-) -> List[Text]:
+) -> List[Optional[Text]]:
     intent_names = []
     for i in range(number_of_last_intent_names):
         message = tracker.get_last_event_for(

rasa/core/agent.py

@@ -4,7 +4,16 @@
 import shutil
 import tempfile
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Text, Tuple, Union
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Text,
+    Tuple,
+    Union,
+)
 import uuid
 
 import aiohttp
@@ -52,6 +61,8 @@
 from rasa.utils.endpoints import EndpointConfig
 import rasa.utils.io
 
+from rasa.shared.core.generator import TrackerWithCachedStates
+
 logger = logging.getLogger(__name__)
 
 
@@ -679,7 +690,7 @@ def _are_all_featurizers_using_a_max_history(self) -> bool:
         """Check if all featurizers are MaxHistoryTrackerFeaturizer."""
 
         def has_max_history_featurizer(policy: Policy) -> bool:
-            return (
+            return bool(
                 policy.featurizer
                 and hasattr(policy.featurizer, "max_history")
                 and policy.featurizer.max_history is not None
@@ -700,9 +711,8 @@ async def load_data(
         use_story_concatenation: bool = True,
         debug_plots: bool = False,
         exclusion_percentage: Optional[int] = None,
-    ) -> List[DialogueStateTracker]:
+    ) -> List["TrackerWithCachedStates"]:
         """Load training data from a resource."""
-
         max_history = self._max_history()
 
         if unique_last_num_states is None:
@@ -769,7 +779,6 @@ def _clear_model_directory(model_path: Text) -> None:
         Only removes files if the directory seems to contain a previously
         persisted model. Otherwise does nothing to avoid deleting
         `/` by accident."""
-
         if not os.path.exists(model_path):
             return
 

rasa/core/channels/botframework.py

@@ -75,6 +75,7 @@ async def _get_headers(self) -> Optional[Dict[Text, Any]]:
                 return BotFramework.headers
             else:
                 logger.error("Could not get BotFramework token")
+                return None
         else:
             return BotFramework.headers
 

rasa/core/channels/channel.py

@@ -200,6 +200,8 @@ def decode_bearer_token(
     except Exception:
         logger.exception("Failed to decode bearer token.")
 
+    return None
+
 
 class OutputChannel:
     """Output channel base class.

rasa/core/channels/console.py

@@ -47,9 +47,10 @@ def print_buttons(
             rasa.shared.utils.cli.print_color(
                 cli_utils.button_to_string(button, idx), color=color
             )
+        return None
 
 
-def print_bot_output(
+def _print_bot_output(
     message: Dict[Text, Any],
     is_latest_message: bool = False,
     color: Text = rasa.shared.utils.io.bcolors.OKBLUE,
@@ -90,17 +91,19 @@ def print_bot_output(
             json.dumps(message.get("custom"), indent=2), color=color
         )
 
+    return None
 
-def get_user_input(previous_response: Optional[Dict[str, Any]]) -> Optional[Text]:
+
+def _get_user_input(previous_response: Optional[Dict[str, Any]]) -> Optional[Text]:
     button_response = None
     if previous_response is not None:
-        button_response = print_bot_output(previous_response, is_latest_message=True)
+        button_response = _print_bot_output(previous_response, is_latest_message=True)
 
     if button_response is not None:
         response = cli_utils.payload_from_button_question(button_response)
         if response == cli_utils.FREE_TEXT_INPUT_PROMPT:
             # Re-prompt user with a free text input
-            response = get_user_input({})
+            response = _get_user_input({})
     else:
         response = questionary.text(
             "",
@@ -169,7 +172,7 @@ async def record_messages(
     previous_response = None
     await asyncio.sleep(0.5)  # Wait for server to start
     while not utils.is_limit_reached(num_messages, max_message_limit):
-        text = get_user_input(previous_response)
+        text = _get_user_input(previous_response)
 
         if text == exit_text or text is None:
             break
@@ -181,7 +184,7 @@ async def record_messages(
             previous_response = None
             async for response in bot_responses:
                 if previous_response is not None:
-                    print_bot_output(previous_response)
+                    _print_bot_output(previous_response)
                 previous_response = response
         else:
             bot_responses = await send_message_receive_block(
@@ -190,7 +193,7 @@ async def record_messages(
             previous_response = None
             for response in bot_responses:
                 if previous_response is not None:
-                    print_bot_output(previous_response)
+                    _print_bot_output(previous_response)
                 previous_response = response
 
         num_messages += 1

rasa/core/channels/hangouts.py

@@ -63,7 +63,7 @@ def _text_button_card(text: Text, buttons: List) -> Union[Dict, None]:
                 logger.error(
                     "Buttons must be a list of dicts with 'title' and 'payload' as keys"
                 )
-                return
+                return None
 
             hangouts_buttons.append(
                 {
@@ -246,10 +246,11 @@ def _extract_message(self, req: Request) -> Text:
 
     @staticmethod
     def _extract_room(req: Request) -> Union[Text, None]:
-
         if req.json["space"]["type"] == "ROOM":
             return req.json["space"]["displayName"]
 
+        return None
+
     def _extract_input_channel(self) -> Text:
         return self.name()
 

rasa/core/channels/slack.py

@@ -308,7 +308,6 @@ def _is_interactive_message(payload: Dict) -> bool:
     @staticmethod
     def _get_interactive_response(action: Dict) -> Optional[Text]:
         """Parse the payload for the response value."""
-
         if action["type"] == "button":
             return action.get("value")
         elif action["type"] == "select":
@@ -328,6 +327,8 @@ def _get_interactive_response(action: Dict) -> Optional[Text]:
         elif action["type"] == "datepicker":
             return action.get("selected_date")
 
+        return None
+
     async def process_message(
         self,
         request: Request,

rasa/core/channels/socketio.py

@@ -170,12 +170,13 @@ def get_output_channel(self) -> Optional["OutputChannel"]:
                 "Please use a different channel for external events in these "
                 "scenarios."
             )
-            return
+            return None
         return SocketIOOutput(self.sio, self.bot_message_evt)
 
     def blueprint(
         self, on_new_message: Callable[[UserMessage], Awaitable[Any]]
     ) -> Blueprint:
+        """Defines a Sanic blueprint."""
         # Workaround so that socketio works with requests from other origins.
         # https://github.com/miguelgrinberg/python-socketio/issues/205#issuecomment-493769183
         sio = AsyncServer(async_mode="sanic", cors_allowed_origins=[])
@@ -203,10 +204,12 @@ async def connect(
 
                 if jwt_payload:
                     logger.debug(f"User {sid} connected to socketIO endpoint.")
+                    return True
                 else:
                     return False
             else:
                 logger.debug(f"User {sid} connected to socketIO endpoint.")
+                return True
 
         @sio.on("disconnect", namespace=self.namespace)
         async def disconnect(sid: Text) -> None:

rasa/core/featurizers/tracker_featurizers.py

@@ -560,7 +560,9 @@ def training_states_labels_and_entities(
         domain: Domain,
         omit_unset_slots: bool = False,
         ignore_action_unlikely_intent: bool = False,
-    ) -> Tuple[List[List[State]], List[List[Text]], List[List[Dict[Text, Any]]]]:
+    ) -> Tuple[
+        List[List[State]], List[List[Optional[Text]]], List[List[Dict[Text, Any]]]
+    ]:
         """Transforms trackers to states, action labels, and entity data.
 
         Args:

rasa/core/lock_store.py

@@ -259,7 +259,10 @@ def get_lock(self, conversation_id: Text) -> Optional[TicketLock]:
         if serialised_lock:
             return TicketLock.from_dict(json.loads(serialised_lock))
 
+        return None
+
     def delete_lock(self, conversation_id: Text) -> None:
+        """Deletes lock for conversation ID."""
         deletion_successful = self.red.delete(self.key_prefix + conversation_id)
         self._log_deletion(conversation_id, deletion_successful)
 

rasa/core/nlg/callback.py

@@ -77,7 +77,7 @@ async def generate(
             method="post", json=body, timeout=DEFAULT_REQUEST_TIMEOUT
         )
 
-        if self.validate_response(response):
+        if isinstance(response, dict) and self.validate_response(response):
             return response
         else:
             raise RasaException("NLG web endpoint returned an invalid response.")