telegram.ext.BasePersistence¶
-
class
telegram.ext.
BasePersistence
(*args, **kwargs)¶ Bases:
abc.ABC
Interface class for adding persistence to your bot. Subclass this object for different implementations of a persistent bot.
All relevant methods must be overwritten. This includes:
If you don’t actually need one of those methods, a simple
pass
is enough. For example, ifstore_bot_data=False
, you don’t needget_bot_data()
andupdate_bot_data()
.Warning
Persistence will try to replace
telegram.Bot
instances byREPLACED_BOT
and insert the bot set withset_bot()
upon loading of the data. This is to ensure that changes to the bot apply to the saved objects, too. If you change the bots token, this may lead to e.g.Chat not found
errors. For the limitations on replacing bots seereplace_bot()
andinsert_bot()
.Note
replace_bot()
andinsert_bot()
are used independently of the implementation of theupdate/get_*()
methods, i.e. you don’t need to worry about it while implementing a custom persistence subclass.- Parameters
store_user_data (
bool
, optional) – Whether user_data should be saved by this persistence class. Default isTrue
.store_chat_data (
bool
, optional) – Whether chat_data should be saved by this persistence class. Default isTrue
.store_bot_data (
bool
, optional) – Whether bot_data should be saved by this persistence class. Default isTrue
.
-
store_user_data
¶ Optional, Whether user_data should be saved by this persistence class.
- Type
bool
-
store_chat_data
¶ Optional. Whether chat_data should be saved by this persistence class.
- Type
bool
-
store_bot_data
¶ Optional. Whether bot_data should be saved by this persistence class.
- Type
bool
-
REPLACED_BOT
: ClassVar[str] = 'bot_instance_replaced_by_ptb_persistence'¶ Placeholder for
telegram.Bot
instances replaced in saved data.- Type
str
-
flush
()¶ Will be called by
telegram.ext.Updater
upon receiving a stop signal. Gives the persistence a chance to finish up saving or close a database connection gracefully.
-
abstract
get_bot_data
()¶ Will be called by
telegram.ext.Dispatcher
upon creation with a persistence object. It should return thebot_data
if stored, or an emptydict
.- Returns
The restored bot data.
- Return type
dict
-
abstract
get_chat_data
()¶ Will be called by
telegram.ext.Dispatcher
upon creation with a persistence object. It should return thechat_data
if stored, or an emptydefaultdict(dict)
.- Returns
The restored chat data.
- Return type
defaultdict
-
abstract
get_conversations
(name)¶ Will be called by
telegram.ext.Dispatcher
when atelegram.ext.ConversationHandler
is added iftelegram.ext.ConversationHandler.persistent
isTrue
. It should return the conversations for the handler with name or an emptydict
- Parameters
name (
str
) – The handlers name.- Returns
The restored conversations for the handler.
- Return type
dict
-
abstract
get_user_data
()¶ Will be called by
telegram.ext.Dispatcher
upon creation with a persistence object. It should return theuser_data
if stored, or an emptydefaultdict(dict)
.- Returns
The restored user data.
- Return type
defaultdict
-
insert_bot
(obj)¶ Replaces all instances of
REPLACED_BOT
that occur within the passed object withbot
. Currently, this handles objects of typelist
,tuple
,set
,frozenset
,dict
,defaultdict
and objects that have a__dict__
or__slot__
attribute, excluding objects that can’t be copied with copy.copy.- Parameters
obj (
object
) – The object- Returns
Copy of the object with Bot instances inserted.
- Return type
obj
-
classmethod
replace_bot
(obj)¶ Replaces all instances of
telegram.Bot
that occur within the passed object withREPLACED_BOT
. Currently, this handles objects of typelist
,tuple
,set
,frozenset
,dict
,defaultdict
and objects that have a__dict__
or__slot__
attribute, excluding objects that can’t be copied with copy.copy.- Parameters
obj (
object
) – The object- Returns
Copy of the object with Bot instances replaced.
- Return type
obj
-
set_bot
(bot)¶ Set the Bot to be used by this persistence instance.
- Parameters
bot (
telegram.Bot
) – The bot.
-
abstract
update_bot_data
(data)¶ Will be called by the
telegram.ext.Dispatcher
after a handler has handled an update.- Parameters
data (
dict
) – Thetelegram.ext.dispatcher.bot_data
.
-
abstract
update_chat_data
(chat_id, data)¶ Will be called by the
telegram.ext.Dispatcher
after a handler has handled an update.- Parameters
chat_id (
int
) – The chat the data might have been changed for.data (
dict
) – Thetelegram.ext.dispatcher.chat_data
[chat_id].
-
abstract
update_conversation
(name, key, new_state)¶ Will be called when a
telegram.ext.ConversationHandler.update_state
is called. This allows the storage of the new state in the persistence.- Parameters
name (
str
) – The handler’s name.key (
tuple
) – The key the state is changed for.new_state (
tuple
|any
) – The new state for the given key.
-
abstract
update_user_data
(user_id, data)¶ Will be called by the
telegram.ext.Dispatcher
after a handler has handled an update.- Parameters
user_id (
int
) – The user the data might have been changed for.data (
dict
) – Thetelegram.ext.dispatcher.user_data
[user_id].