feat(sdk): context lifecycle callbacks — on_context_enter / on_context_exit #381

New Issue

forbes · 2026-03-03T23:01:58Z

forbes commented

2026-03-03 23:01:58 +00:00

Summary

Add declarative lifecycle hooks so addons can react to context transitions without connecting to raw FreeCAD signals.

Current state (PARTIAL)

contextChanged signal exists in C++ (EditingContextResolver) and is exposed to Python via kcsdk pybind11 bindings. However:

No on_context_enter() / on_context_exit() hooks for addons
No enter/exit distinction — only a single state-change notification
Addons must connect to raw signals and re-derive context themselves

Proposed API

import kindred_sdk as sdk

sdk.on_context_enter("sketcher.edit", my_setup_callback)
sdk.on_context_exit("sketcher.edit", my_teardown_callback)
sdk.on_context_enter("*", my_global_callback)  # wildcard

Callbacks receive the full EditingContext snapshot (id, label, color, toolbars, breadcrumb).

Implementation notes

Build on top of existing contextChanged signal
SDK layer tracks previous context to derive enter/exit events
Add on_context_enter(), on_context_exit() to kindred_sdk/context.py
Wildcard "*" form for addons that need global awareness

Roadmap

v0.2.0 — SDK Core

## Summary Add declarative lifecycle hooks so addons can react to context transitions without connecting to raw FreeCAD signals. ## Current state (PARTIAL) `contextChanged` signal exists in C++ (`EditingContextResolver`) and is exposed to Python via kcsdk pybind11 bindings. However: - No `on_context_enter()` / `on_context_exit()` hooks for addons - No enter/exit distinction — only a single state-change notification - Addons must connect to raw signals and re-derive context themselves ## Proposed API ```python import kindred_sdk as sdk sdk.on_context_enter("sketcher.edit", my_setup_callback) sdk.on_context_exit("sketcher.edit", my_teardown_callback) sdk.on_context_enter("*", my_global_callback) # wildcard ``` Callbacks receive the full `EditingContext` snapshot (id, label, color, toolbars, breadcrumb). ## Implementation notes - Build on top of existing `contextChanged` signal - SDK layer tracks previous context to derive enter/exit events - Add `on_context_enter()`, `on_context_exit()` to `kindred_sdk/context.py` - Wildcard `"*"` form for addons that need global awareness ## Roadmap v0.2.0 — SDK Core

forbes added the enhancement label 2026-03-03 23:01:58 +00:00

forbes referenced this issue

2026-03-03 23:04:54 +00:00

docs: example addon template #395

forbes referenced this issue

2026-03-03 23:05:06 +00:00

test: integration tests for addon loader, context, and origin SDK APIs #396

Sign in to join this conversation.