telemenu

Easily build complex telegram menu logic with almost no code.

^{_{^{_{Because I'm writing a lot of code making that possible, lol.}}}}

Currently still a work in progress.

The details of what this library aims for, how it behaves and also some of the needed inner gearing is currently documented in telemenu/menus_old.py.

menus = TeleMenuMachine(database_driver=SimpleDictDriver(), teleflask_or_tblueprint=bot)

@menus.register
class MainMenu(GotoMenu):
    title = "test"
    description = "Lorem ipsum \n\n We even have access to the data:\n{data!r}"

    def menus(self):
        return [TestMenu, AnotherTestMenu]
    # end def
# end class

Have a look at that example, if you like to see a full working example.

Available variables

All menus

(e.g. GotoMenu, RadioMenu, CheckboxMenu )

title (type str):
The bold headline of the menu.
title_escape (type bool):
Set to False to turn off the automatic HTML escaping.
description (type str):
The message part with user instructions.
description_escape (type bool):
Set to False to turn off the automatic HTML escaping.
cancel (type str, CancelButton, BackButton, GotoButton, Menu):
Goes to a different menu, deleting the data. Provide a str which will be automatically be converted automatically to a CancelButton.
If you provide a BackButton or a GotoButton you have to set does_cancel to True.
back (type str, BackButton, GotoButton, Menu):
Goes to a different menu, without deleting or saving the data.
Provide a str which will be automatically be converted automatically to a BackButton. If you provide a BackButton or a GotoButton you have to set does_cancel to False.
done (type str, GotoButton, Menu):
Goes to a different menu, saving the data. Provide a str which will be automatically be converted automatically to a BackButton.
If you provide a GotoButton you have to set does_cancel to False.

Internal variables you usually don't have to replace as they already have a sane default:

_id (type str):
This allows you to overwrite the automaticly genereated name of the underlying state.
You should probably not change this.
text (type str): Returns a HTML string for the final rendered message. This is basically <b>{title}</b>\n{description}\n<i>{value}</i>.
value (type str): basically does a user representation of what the current menu is storing. So for example CheckboxMenu puts the labels of the selected strings (instead of the stored keys) as a comma separated list.
value_escape (type bool):
Set to False to turn off the automatic HTML escaping.

`GotoMenu`

menus (list containing any ChangeMenuButton button subclass (including GotoButton and BackButton) or simply some other Menus. You can mix those.):
This is a list of menus you can jump to.

`RadioMenu`

radiobuttons (list of RadioButton elements):
A list of values to choose a single entry from.

`CheckboxMenu`

checkboxes: (list of CheckboxMenu elements):
A list of values to choose a single entry from.

`TextStrMenu`

Make sure that all commands you want handled regardless of this menu are registered before this menu. Note, the ALL state is always processed only after all other states, including the menus. Therefore you must use a regular register. Instead you should use @bot.on_command and be sure to abort the processing of any other listeners. This can be done by either using the @abort_processing decorator (from teleflask import abort_processing) or by raising raise AbortProcessingPlease() (from teleflask.exceptions import AbortProcessingPlease) directly.

parsing_success (type str):
A text to send when the parsing succeed. Useful to hint users of /done, etc.
parsing_failure (type str):
A text to send when the parsing failed. Useful to hint users of /done, etc.

luckydonald / telemenu