Skip to content

docs: mark mycroft.skill.handler.* as internal workshop->core sync (not spec) #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JarbasAl merged 1 commit into from
Jun 28, 2026
Merged

docs: mark mycroft.skill.handler.* as internal workshop->core sync (not spec) #436

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions ovos_workshop/skills/ovos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1429,12 +1429,32 @@ def _on_event_start(self, message: Message, handler_info: str,
"""
Indicate that the skill handler is starting.

Emits ``mycroft.skill.handler.start`` (when ``handler_info`` is set).

.. note::
``mycroft.skill.handler.{start,complete,error}`` are an **internal
ovos-workshop → ovos-core synchronization signal** — workshop's way
of reporting "I started / ended / errored" running a handler. They
are **explicitly NOT part of any OVOS specification**; they are an
implementation detail that exists only because skills (ovos-workshop)
run in a **separate process** from the orchestrator (ovos-core). If
core manipulated skill objects directly, in-process, this bus
round-trip would not be needed.

ovos-core consumes these as a private *done-signal* to emit the
authoritative PIPELINE-1 §8 handler-lifecycle trio
(``ovos.intent.handler.{start,complete,error}``). The legacy
``mycroft.skill.handler.*`` names are permanently ovos-workshop
event-wrapper signals and do **not** bridge to the spec namespace
(ovos-spec-tools MIGRATION_MAP deliberately excludes the trio).

activation (bool, optional): activate skill if True,
deactivate if False,
do nothing if None
"""
if handler_info:
# Indicate that the skill handler is starting if requested
# internal workshop->core done-signal (see docstring); NOT a spec
# topic -> emits mycroft.skill.handler.start
msg_type = handler_info + '.start'
message.context["skill_id"] = self.skill_id
self.bus.emit(message.forward(msg_type, skill_data))
Expand All @@ -1446,6 +1466,8 @@ def _on_event_end(self, message: Message, handler_info: str,
completed.
"""
if handler_info:
# internal workshop->core done-signal (see _on_event_start); NOT a
# spec topic -> emits mycroft.skill.handler.complete
msg_type = handler_info + '.complete'
message.context["skill_id"] = self.skill_id
self.bus.emit(message.forward(msg_type, skill_data))
Expand Down Expand Up @@ -1473,7 +1495,8 @@ def _on_event_error(self, error: str, message: Message, handler_info: str,
# append exception information in message
skill_data['exception'] = repr(error)
if handler_info:
# Indicate that the skill handler errored
# internal workshop->core done-signal (see _on_event_start); NOT a
# spec topic -> emits mycroft.skill.handler.error
msg_type = handler_info + '.error'
message = message or Message("")
message.context["skill_id"] = self.skill_id
Expand Down
Loading