document non-atomicity

2014-10-04 11:51:07 -04:00 · 2014-10-04 11:51:07 -04:00 · 201520e2ba
parent 84a3c45db8
commit 201520e2ba
1 changed files with 5 additions and 0 deletions
--- a/bidict.py
+++ b/bidict.py
@ -185,6 +185,11 @@ Caveats
  collapsing mappings to proceed with no indication when they've occurred.
  See :class:`bidict.collapsingbidict` for examples.

+* As with built-in dicts, mutating operations on a bidict are not atomic. So
+  if you need to mutate the same bidict from two different threads, use a
+  ``threading.Lock`` around mutating operations to synchronize access/prevent
+  race conditions.
+
 Links
 -----