State Managers

class navmenu.state.StateHandler

A generic menu state manager.

abstract create(user_id)

If specified user does not exist, create them and return True.

Parameters

user_id (Optional[int]) – A value used to identify the user.

Return type

bool

Returns

True if user was successfully created.

abstract get(user_id)

Get the current state for specified user.

Parameters

user_id (Optional[int]) – A value used to identify the user.

Return type

str

Returns

The current state for specified user.

abstract go_back(user_id, count=1)

Return to the one of previous states.

Parameters

• user_id (Optional[int]) – A value used to identify the user.

• count (Optional[int]) – How many steps to go back.

Return type

None

abstract set(user_id, new_state)

Set the current state for specified user.

Parameters

• user_id (Optional[int]) – A value used to identify the user.

• new_state (str) – A state to set.

Return type

None

class navmenu.state.MemoryStateHandler(default_state)

Bases: navmenu.state.StateHandler

A menu state manager that uses a dictionary to store data.

Parameters

default_state (str) – The state that will be assigned to new users.

create(user_id)

If specified user does not exist, create them and return True.

Parameters

user_id (Optional[int]) – A value used to identify the user.

Return type

bool

Returns

True if user was successfully created.

get(user_id)

Get the current state for specified user.

Parameters

user_id (Optional[int]) – A value used to identify the user.

Return type

str

Returns

The current state for specified user.

go_back(user_id, count=1)

Return to the one of previous states.

Parameters

• user_id (Optional[int]) – A value used to identify the user.

• count (Optional[int]) – How many steps to go back.

Return type

None

set(user_id, new_state)

Set the current state for specified user.

Parameters

• user_id (Optional[int]) – A value used to identify the user.

• new_state (str) – A state to set.

Return type

None