1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
Persistence
===========
Persistence describes the ability for the plugins to persist data even
if Errbot is restarted.
How to use it
-------------
Your plugin *is* the store, simply use self as a dictionary.
Here is a simple example for storing and retrieving a value from the store.
.. code-block:: python
from errbot import BotPlugin, botcmd
class PluginExample(BotPlugin):
@botcmd
def remember(self, msg, args):
self['TODO'] = args
@botcmd
def recall(self, msg, args):
return self['TODO']
Caveats
-------
The storing occurs when you *assign the key*:
.. code-block:: python
# THIS WON'T WORK
d = {}
self['FOO'] = d
d['subkey'] = 'NONONONONONO'
What you need to do instead:
(manual method)
.. code-block:: python
# THIS WORKS
d = {}
self['FOO'] = d
# later ...
d['subkey'] = 'NONONONONONO'
self['FOO'] = d # restore the full key if something changed in memory.
Or use the mutable contex manager:
.. code-block:: python
# THIS WORKS AND IS CLEANER
d = {}
self['FOO'] = d
# later ...
with self.mutable('FOO') as d:
d['subkey'] = 'NONONONONONO'
# it will save automatically the key
|
