Skip to content

Commit a07b9f1

Browse files
asfaltboyzoni
authored andcommitted
Docs: Add note about shelve module restriction (errbotio#1124)
When using ShelfStorage plugin (default), the user may not be aware that he needs to stop `errbot` to access it outside the bot, in the cli helper commands.
1 parent b76e4c4 commit a07b9f1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/user_guide/provisioning.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@ ahead of time for example at errbot installation (also called provisioning).
1212

1313
It is useful for installation scripts and deployments.
1414

15+
.. note::
16+
When using the default "Shelf storage", errbot may not be running when
17+
attempting to get or set data. Any attempt to do so while the bot is
18+
running will result in the error "Storage does not appear to have been
19+
opened yet" being returned. This is caused by the fact that the python
20+
`shelve` module only allows a single process to hold the database open.
21+
For further details, see the
22+
`shelve docs <https://docs.python.org/3/library/shelve.html#restrictions>`_.
23+
24+
1525
Reading stored values
1626
---------------------
1727

0 commit comments

Comments
 (0)