feat/pipeline_plugins

mycroft/skills/intent_service.py

@@ -14,23 +14,238 @@
 #
 """Mycroft's intent service, providing intent parsing since forever!"""
 from mycroft.metrics import report_timing
-from mycroft.skills.intent_services import (
-    IntentMatch
-)
+# compat imports
+from mycroft.skills.intent_services.adapt_service import AdaptService
+from mycroft.skills.intent_services.padatious_service import PadatiousService
 from ovos_bus_client.message import Message
+from ovos_bus_client.session import SessionManager
 from ovos_core.intent_services import IntentService as _IS
-from ovos_utils.log import LOG
-# compat imports
-from ovos_utils.intents.intent_service_interface import open_intent_envelope
+from ovos_utils.log import LOG, log_deprecation, deprecated
 
 
 class IntentService(_IS):
-    """Mycroft intent service. parses utterances using a variety of systems.
+    """contains only junk code that logs deprecation warnings to not break downstream api"""
+
+    @deprecated("mycroft.skills module is deprecated, migrate to ovos_core.intent_services.IntentService", "0.0.8")
+    def __init__(self, bus):
+        self.bus = bus
+        self.pipeline_plugins = {}
+        self._converse = None
+        self._common_qa = None
+        self._fallback = None
+        self._adapt_service = None
+        self._padatious_service = None
+        self._padacioso_service = None
+
+    # deprecated properties / handlers
+    # convenience properties around default pipeline components / backwards compat
+    @property
+    def active_skills(self):
+        log_deprecation("self.active_skills is deprecated! use Session instead", "0.0.9")
+        session = SessionManager.get()
+        return session.active_skills
+
+    @active_skills.setter
+    def active_skills(self, val):
+        log_deprecation("self.active_skills is deprecated! use Session instead", "0.0.9")
+        session = SessionManager.get()
+        session.active_skills = []
+        for skill_id, ts in val:
+            session.activate_skill(skill_id)
+
+    @property
+    def converse(self):
+        log_deprecation("self.converse has been deprecated, "
+                        "pipeline plugin object references can be found under self.pipeline_plugins", "0.1.0")
+        if self._converse is None:
+            self._converse = self.pipeline_plugins.get("converse")
+        return self._converse
+
+    @property
+    def common_qa(self):
+        log_deprecation("self.common_qa has been deprecated, "
+                        "pipeline plugin object references can be found under self.pipeline_plugins", "0.1.0")
+        if self._common_qa is None:
+            self._common_qa = self.pipeline_plugins.get("common_qa")
+        return self._common_qa
+
+    @property
+    def fallback(self):
+        log_deprecation("self.fallback has been deprecated, "
+                        "pipeline plugin object references can be found under self.pipeline_plugins", "0.1.0")
+        if self._fallback is None:
+            self._fallback = self.pipeline_plugins.get("fallback")
+        return self._fallback
+
+    @property
+    def adapt_service(self):
+        log_deprecation("self.adapt_service has been deprecated, "
+                        "get plugin object reference via self.pipeline_plugins.get('adapt')", "0.1.0")
+        if self._adapt_service is None:
+            _p = self.pipeline_plugins.get("adapt")
+            self._adapt_service = AdaptService(self.bus)
+            self._adapt_service.bind(_p)
+        return self._adapt_service
+
+    @property
+    def padacioso_service(self):
+        log_deprecation("self.padacioso has been deprecated, "
+                        "get plugin object reference via self.pipeline_plugins.get('padacioso')", "0.1.0")
+        if self._padacioso_service is None:
+            _p = self.pipeline_plugins.get("padacioso")
+            self._padacioso_service = PadatiousService(self.bus, config={"regex_only": True})
+            self._padacioso_service.bind(_p)
+        return self._padacioso_service
+
+    @property
+    def padatious_service(self):
+        log_deprecation("self.padatious has been deprecated, "
+                        "get plugin object reference via self.pipeline_plugins.get('padatious')", "0.1.0")
+        if self._padatious_service is None:
+            _p = self.pipeline_plugins.get("padatious")
+            self._padatious_service = PadatiousService(self.bus)
+            self._padatious_service.bind(_p)
+        return self._padatious_service
+
+    @property
+    def skill_names(self):
+        log_deprecation("self.skill_names has been deprecated and is always an empty dict,"
+                        " skill names no longer in use, reference skill_id directly", "0.0.8")
+        return {}
+
+    @property
+    def registered_intents(self):
+        log_deprecation("self.registered_intents has been deprecated, moved to AdaptService,"
+                        "pipeline plugin object references can be found under self.pipeline_plugins", "0.1.0")
+        return self.adapt_service.registered_intents
+
+    @property
+    def registered_vocab(self):
+        log_deprecation("self.registered_vocab has been deprecated, moved to AdaptService,"
+                        "pipeline plugin object references can be found under self.pipeline_plugins", "0.1.0")
+        return self.adapt_service.registered_vocab
+
+    @deprecated("skill names have been replaced across the whole ecosystem with skill_ids, "
+                "this handler is no longer connected to the messagebus", "0.0.8")
+    def update_skill_name_dict(self, message):
+        """Messagebus handler, updates dict of id to skill name conversions."""
+        pass
+
+    @deprecated("skill names have been replaced across the whole ecosystem with skill_ids, "
+                "get_skill_name is no longer necessary", "0.0.8")
+    def get_skill_name(self, skill_id):
+        """Get skill name from skill ID.
+
+        Args:
+            skill_id: a skill id as encoded in Intent handlers.
+
+        Returns:
+            (str) Skill name or the skill id if the skill wasn't found
+        """
+        return skill_id
 
-    The intent service also provides the internal API for registering and
-    querying the intent service.
-    """
+    @deprecated("use 'skillmanager.list' -> 'mycroft.skills.list' instead "
+                "this handler is not connected to bus events, subclassing it has no effect", "0.0.8")
+    def handle_get_skills(self, message):
+        """Send registered skills to caller.
+
+        Argument:
+            message: query message to reply to.
+        """
+        self.bus.emit(message.reply("intent.service.skills.reply", {"skills": []}))
+
+    @deprecated("handle_register_intent moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_register_vocab(self, message):
+        """Register adapt vocabulary.
+
+        Args:
+            message (Message): message containing vocab info
+        """
+
+    @deprecated("handle_register_intent moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_register_intent(self, message):
+        """Register adapt intent.
+
+        Args:
+            message (Message): message containing intent info
+        """
+
+    @deprecated("handle_detach_intent moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_detach_intent(self, message):
+        """Remover adapt intent.
+
+        Args:
+            message (Message): message containing intent info
+        """
 
+    @deprecated("handle_detach_skill moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_detach_skill(self, message):
+        """Remove all intents registered for a specific skill.
+
+        Args:
+            message (Message): message containing intent info
+        """
+
+    @deprecated("handle_get_adapt moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_get_adapt(self, message):
+        """handler getting the adapt response for an utterance.
+
+        Args:
+            message (Message): message containing utterance
+        """
+
+    @deprecated("handle_adapt_manifest moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_adapt_manifest(self, message):
+        """Send adapt intent manifest to caller.
+
+        Argument:
+            message: query message to reply to.
+        """
+
+    @deprecated("handle_vocab_manifest moved to AdaptService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_vocab_manifest(self, message):
+        """Send adapt vocabulary manifest to caller.
+
+        Argument:
+            message: query message to reply to.
+        """
+
+    @deprecated("handle_get_padatious moved to PadatiousService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_get_padatious(self, message):
+        """messagebus handler for perfoming padatious parsing.
+
+        Args:
+            message (Message): message triggering the method
+        """
+
+    @deprecated("handle_padatious_manifest moved to PadatiousService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_padatious_manifest(self, message):
+        """Messagebus handler returning the registered padatious intents.
+
+        Args:
+            message (Message): message triggering the method
+        """
+
+    @deprecated("handle_entity_manifest moved to PadatiousService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
+    def handle_entity_manifest(self, message):
+        """Messagebus handler returning the registered padatious entities.
+
+        Args:
+            message (Message): message triggering the method
+        """
+
+    @deprecated("do_converse moved to ConverseService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
     def do_converse(self, utterances, skill_id, lang, message):
         """DEPRECATED: do not use, method only for api backwards compatibility
 
@@ -43,18 +258,17 @@ def do_converse(self, utterances, skill_id, lang, message):
             lang (str): current language
             message (Message): message containing interaction info.
         """
-        # NOTE: can not delete method for backwards compat with upstream
-        LOG.warning("self.do_converse has been deprecated!\n"
-                    "use self.converse.converse instead")
         return self.converse.converse(utterances, skill_id, lang, message)
 
+    @deprecated("do_converse moved to ConverseService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
     def handle_converse_error(self, message):
         """DEPRECATED: do not use, method only for api backwards compatibility
         Logs a warning
         """
-        # NOTE: can not delete method for backwards compat with upstream
-        LOG.warning("handle_converse_error has been deprecated!")
 
+    @deprecated("do_converse moved to ConverseService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
     def remove_active_skill(self, skill_id):
         """DEPRECATED: do not use, method only for api backwards compatibility
 
@@ -63,11 +277,10 @@ def remove_active_skill(self, skill_id):
         Args:
             skill_id (str): skill to remove
         """
-        # NOTE: can not delete method for backwards compat with upstream
-        LOG.warning("self.remove_active_skill has been deprecated!\n"
-                    "use self.converse.deactivate_skill instead")
         self.converse.deactivate_skill(skill_id)
 
+    @deprecated("do_converse moved to ConverseService, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
     def add_active_skill(self, skill_id):
         """DEPRECATED: do not use, method only for api backwards compatibility
 
@@ -76,11 +289,10 @@ def add_active_skill(self, skill_id):
         Args:
             skill_id (str): identifier of skill to be added.
         """
-        # NOTE: can not delete method for backwards compat with upstream
-        LOG.warning("self.add_active_skill has been deprecated!\n"
-                    "use self.converse.activate_skill instead")
         self.converse.activate_skill(skill_id)
 
+    @deprecated("send_metrics/selene has been deprecated, overriding this method has no effect, "
+                "it has been disconnected from the bus event", "0.0.8")
     def send_metrics(self, intent, context, stopwatch):
         """Send timing metrics to the backend.
 
@@ -110,33 +322,3 @@ def send_metrics(self, intent, context, stopwatch):
 
         report_timing(ident, 'intent_service', stopwatch,
                       {'intent_type': intent_type})
-
-    def handle_utterance(self, message):
-        """Main entrypoint for handling user utterances with Mycroft skills
-
-        Monitor the messagebus for 'recognizer_loop:utterance', typically
-        generated by a spoken interaction but potentially also from a CLI
-        or other method of injecting a 'user utterance' into the system.
-
-        Utterances then work through this sequence to be handled:
-        1) Active skills attempt to handle using converse()
-        2) Padatious high match intents (conf > 0.95)
-        3) Adapt intent handlers
-        5) CommonQuery Skills
-        6) High Priority Fallbacks
-        7) Padatious near match intents (conf > 0.8)
-        8) General Fallbacks
-        9) Padatious loose match intents (conf > 0.5)
-        10) Catch all fallbacks including Unknown intent handler
-
-        If all these fail the complete_intent_failure message will be sent
-        and a generic info of the failure will be spoken.
-
-        Args:
-            message (Message): The messagebus data
-        """
-        try:
-            match, message.context, stopwatch = super().handle_utterance(message)
-            self.send_metrics(match, message.context, stopwatch)
-        except Exception as err:
-            pass

mycroft/skills/intent_services/__init__.py

@@ -1,14 +1,9 @@
-from ovos_core.intent_services import AdaptService,\
-    ConverseService,\
+from ovos_core.intent_services import ConverseService,\
     CommonQAService, \
-    FallbackService, \
-    PadaciosoService, \
-    PadatiousService
-from ovos_core.intent_services import IntentMatch
+    FallbackService
+
+from mycroft.skills.intent_services.adapt_service import AdaptService
+from mycroft.skills.intent_services.padatious_service import PadatiousService
 from mycroft.skills.intent_services.adapt_service import AdaptIntent, IntentBuilder, Intent
 
-try:  # TODO -remove backwards compat import, before 0.0.8, ovos_core module didnt make it into a stable release yet!
-    from ovos_core.intent_services import PadatiousMatcher
-except ImportError:
-    from ovos_utils.log import LOG
-    LOG.warning("padatious not installed")
+