fix: symmetric state param for on_exit_state across compound boundaries

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud

[fgmacedo]

Symmetric state for on_exit_state across compound boundaries

Closes#634.

Problem

When exiting a compound state directly (a transition like child -> outsider),
the generic on_exit_state() callback reported the transition's source for
every exited state. Exiting child and its parent parent both arrived
with state/source bound to child, so the parent level was never
observable and the two exit calls were indistinguishable.

This was asymmetric with on_enter_state(), which already binds state
(and target) to each individual state being entered.

Fix

_get_args_kwargs gains a source override mirroring the existing target
one, and _exit_states passes source=info.state. Now state/source track
the individual state being exited. Applied to both the sync and async
engines (the async engine re-implements these methods).

exit child (source=child)
exit parent (source=parent) # was: exit child (source=child)

State-specific callbacks (on_exit_<state>) were already correctly keyed per
state and are unaffected. Flat machines are unaffected, since there the exited
state is always the transition's source.

Tests & docs

• New parametric sm_runner test exercising both engines on the exact scenario
  from the issue (tests/test_statechart_compound.py).
• 100% branch coverage preserved on both engine modules.
• docs/actions.md note corrected (it previously described the old, asymmetric
  behavior).
• Release notes docs/releases/3.2.1.md added (also covering fix: support negative indices in OrderedSet.__getitem__ #633), listed in
  the toctree.

Also included (docs, Refs #631)

This branch also carries a docs-only commit documenting
allow_event_without_transition as a method-call ordering protocol
(docs/events.md) and clarifying the scope of catch_errors_as_events
(docs/behaviour.md).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2c1aa0c) to head (d0869c0).

Additional details and impacted files

@@ Coverage Diff @@## develop #635 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 52 52 Lines 5499 5505 +6 Branches 867 869 +2 =========================================
+ Hits 5499 5505 +6 

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate failed

Failed conditions
26.6% Duplication on New Code (required ≤ 10%)

See analysis details on SonarQube Cloud