improve_typing (#528)

* improve_typing * optimize imports * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update ovos_core/intent_services/ocp_service.py Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
OpenVoiceOS · Jul 22, 2024 · 41fb56b · 41fb56b
1 parent b603751
commit 41fb56b
Show file tree

Hide file tree

Showing 10 changed files with 129 additions and 137 deletions.
diff --git a/ovos_core/intent_services/__init__.py b/ovos_core/intent_services/__init__.py
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from collections import namedtuple
 from typing import Tuple, Callable
 from ovos_bus_client.message import Message
 from ovos_bus_client.session import SessionManager
@@ -31,20 +30,11 @@
 from ovos_utils.log import LOG, deprecated, log_deprecation
 from ovos_utils.metrics import Stopwatch
 from ovos_workshop.intents import open_intent_envelope
-
-# Intent match response tuple containing
-# intent_service: Name of the service that matched the intent
-# intent_type: intent name (used to call intent handler over the message bus)
-# intent_data: data provided by the intent match
-# skill_id: the skill this handler belongs to
-IntentMatch = namedtuple('IntentMatch',
-                         ['intent_service', 'intent_type',
-                          'intent_data', 'skill_id', 'utterance']
-                         )
+from ovos_plugin_manager.templates.pipeline import IntentMatch
 
 
 class IntentService:
-    """Mycroft intent service. parses utterances using a variety of systems.
+    """OVOS intent service. parses utterances using a variety of systems.
 
     The intent service also provides the internal API for registering and
     querying the intent service.

diff --git a/ovos_core/intent_services/adapt_service.py b/ovos_core/intent_services/adapt_service.py
@@ -13,19 +13,20 @@
 # limitations under the License.
 #
 """An intent parsing service using the Adapt parser."""
-from threading import Lock
 from functools import lru_cache
+from threading import Lock
 from typing import List, Tuple, Optional
 
 from adapt.engine import IntentDeterminationEngine
-from ovos_config.config import Configuration
 from ovos_bus_client.message import Message
-import ovos_core.intent_services
 from ovos_bus_client.session import IntentContextManager as ContextManager, \
     SessionManager
+from ovos_config.config import Configuration
 from ovos_utils import flatten_list
 from ovos_utils.log import LOG
 
+from ovos_plugin_manager.templates.pipeline import IntentMatch
+
 
 def _entity_skill_id(skill_id):
     """Helper converting a skill id to the format used in entities.
@@ -248,7 +249,7 @@ def take_best(intent, utt):
             sess.context.update_context(ents)
 
             skill_id = best_intent['intent_type'].split(":")[0]
-            ret = ovos_core.intent_services.IntentMatch(
+            ret = IntentMatch(
                 'Adapt', best_intent['intent_type'], best_intent, skill_id,
                 best_intent['utterance']
             )

diff --git a/ovos_core/intent_services/commonqa_service.py b/ovos_core/intent_services/commonqa_service.py
@@ -1,19 +1,19 @@
-import time
 from dataclasses import dataclass
 from os.path import dirname
 from threading import Event
-from typing import Dict
-
-from ovos_classifiers.opm.heuristics import BM25MultipleChoiceSolver
+from typing import Dict, Optional
 
-import ovos_core.intent_services
+import time
 from ovos_bus_client.message import Message
 from ovos_bus_client.session import SessionManager
+from ovos_classifiers.opm.heuristics import BM25MultipleChoiceSolver
 from ovos_config.config import Configuration
 from ovos_utils import flatten_list
 from ovos_utils.log import LOG
 from ovos_workshop.app import OVOSAbstractApplication
 
+from ovos_plugin_manager.templates.pipeline import IntentMatch
+
 
 @dataclass
 class Query:
@@ -76,7 +76,7 @@ def is_question_like(self, utterance: str, lang: str):
         # require a "question word"
         return self.voc_match(utterance, "QuestionWord", lang)
 
-    def match(self, utterances: str, lang: str, message: Message):
+    def match(self, utterances: str, lang: str, message: Message) -> Optional[IntentMatch]:
         """
         Send common query request and select best response
 
@@ -114,11 +114,11 @@ def match(self, utterances: str, lang: str, message: Message):
                 message.data["utterance"] = utterance
                 answered, skill_id = self.handle_question(message)
                 if answered:
-                    match = ovos_core.intent_services.IntentMatch(intent_service='CommonQuery',
-                                                                  intent_type=True,
-                                                                  intent_data={},
-                                                                  skill_id=skill_id,
-                                                                  utterance=utterance)
+                    match = IntentMatch(intent_service='CommonQuery',
+                                        intent_type=True,
+                                        intent_data={},
+                                        skill_id=skill_id,
+                                        utterance=utterance)
                 break
         return match
 

diff --git a/ovos_core/intent_services/converse_service.py b/ovos_core/intent_services/converse_service.py
@@ -1,7 +1,7 @@
-import time
 from threading import Event
+from typing import Optional
 
-import ovos_core.intent_services
+import time
 from ovos_bus_client.message import Message
 from ovos_bus_client.session import SessionManager, UtteranceState
 from ovos_bus_client.util import get_message_lang
@@ -11,6 +11,8 @@
 from ovos_utils.log import LOG
 from ovos_workshop.permissions import ConverseMode, ConverseActivationMode
 
+from ovos_plugin_manager.templates.pipeline import IntentMatch
+
 
 class ConverseService:
     """Intent Service handling conversational skills."""
@@ -311,7 +313,7 @@ def converse(self, utterances, skill_id, lang, message):
                             f'increasing "max_skill_runtime" in mycroft.conf might help alleviate this issue')
         return False
 
-    def converse_with_skills(self, utterances, lang, message):
+    def converse_with_skills(self, utterances, lang, message) -> Optional[IntentMatch]:
         """Give active skills a chance at the utterance
 
         Args:
@@ -335,12 +337,12 @@ def converse_with_skills(self, utterances, lang, message):
                 continue
             if self.converse(utterances, skill_id, lang, message):
                 state = session.utterance_states.get(skill_id, UtteranceState.INTENT)
-                return ovos_core.intent_services.IntentMatch(intent_service='Converse',
-                                                             intent_type=state != UtteranceState.RESPONSE,
-                                                             # intent_type == True -> emit "ovos.utterance.handled"
-                                                             intent_data={},
-                                                             skill_id=skill_id,
-                                                             utterance=utterances[0])
+                return IntentMatch(intent_service='Converse',
+                                   intent_type=state != UtteranceState.RESPONSE,
+                                   # intent_type == True -> emit "ovos.utterance.handled"
+                                   intent_data={},
+                                   skill_id=skill_id,
+                                   utterance=utterances[0])
         return None
 
     def handle_get_response_enable(self, message):

diff --git a/ovos_core/intent_services/fallback_service.py b/ovos_core/intent_services/fallback_service.py
@@ -15,16 +15,17 @@
 """Intent service for Mycroft's fallback system."""
 import operator
 from collections import namedtuple
+from typing import Optional
 
 import time
+from ovos_bus_client.session import SessionManager
 from ovos_config import Configuration
-
-import ovos_core.intent_services
 from ovos_utils import flatten_list
 from ovos_utils.log import LOG
-from ovos_bus_client.session import SessionManager
 from ovos_workshop.skills.fallback import FallbackMode
 
+from ovos_plugin_manager.templates.pipeline import IntentMatch
+
 FallbackRange = namedtuple('FallbackRange', ['start', 'stop'])
 
 
@@ -157,7 +158,7 @@ def attempt_fallback(self, utterances, skill_id, lang, message):
                             f'increasing "max_skill_runtime" in mycroft.conf might help alleviate this issue')
         return False
 
-    def _fallback_range(self, utterances, lang, message, fb_range):
+    def _fallback_range(self, utterances, lang, message, fb_range) -> Optional[IntentMatch]:
         """Send fallback request for a specified priority range.
 
         Args:
@@ -187,24 +188,24 @@ def _fallback_range(self, utterances, lang, message, fb_range):
                 continue
             result = self.attempt_fallback(utterances, skill_id, lang, message)
             if result:
-                return ovos_core.intent_services.IntentMatch(intent_service='Fallback',
-                                                             intent_type=None,
-                                                             intent_data={},
-                                                             skill_id=skill_id,
-                                                             utterance=utterances[0])
+                return IntentMatch(intent_service='Fallback',
+                                   intent_type=None,
+                                   intent_data={},
+                                   skill_id=skill_id,
+                                   utterance=utterances[0])
         return None
 
-    def high_prio(self, utterances, lang, message):
+    def high_prio(self, utterances, lang, message) -> Optional[IntentMatch]:
         """Pre-padatious fallbacks."""
         return self._fallback_range(utterances, lang, message,
                                     FallbackRange(0, 5))
 
-    def medium_prio(self, utterances, lang, message):
+    def medium_prio(self, utterances, lang, message) -> Optional[IntentMatch]:
         """General fallbacks."""
         return self._fallback_range(utterances, lang, message,
                                     FallbackRange(5, 90))
 
-    def low_prio(self, utterances, lang, message):
+    def low_prio(self, utterances, lang, message) -> Optional[IntentMatch]:
         """Low prio fallbacks with general matching such as chat-bot."""
         return self._fallback_range(utterances, lang, message,
                                     FallbackRange(90, 101))