current_state in Docs

[vincedbowen]

In the docs current_state is still shown as an API, but when using the getter (per the upgrade guide) you receive a depreciation warning. This maybe deserves an update in the docs saying it is depreciated.

API Docs

Also if I use the setter I do not get a depreciation warning. Is that desired behavior?

from statemachine import State, StateMachine

class SM(StateMachine):
    a = State("a", initial=True)
    b = State("b")

    ab = a.to(b)
    ba = b.to(a)

sm = SM()
sm.current_state = sm.b
print(sm.configuration)

Output

{b}

[fgmacedo]

Thanks for reporting this @vincedbowen! You're right on both counts.

The current_state property is deprecated since v3.0.0, and the setter was indeed missing the deprecation warning — that's a bug. I've just pushed a fix that:

1. Makes the setter emit DeprecationWarning consistently with the getter.
2. Adds a proper deprecated directive to the docstring so the API docs on ReadTheDocs will clearly mark it as deprecated.

The recommended API going forward is:

• sm.configuration — returns the set of active State objects.
• sm.configuration_values — returns the set of active state values (useful for persistence/serialization).
• sm.is_terminated — replaces sm.current_state.final.

The upgrade guide has more details on migrating.

This will ship in 3.1.0.

[vincedbowen]

Thanks, appreciate it!