docs/pyutils.collectionz.rst

   1 pyutils.collectionz package
   2 ===========================
   3
   4 This subpackage contains some homegrown collections that try to emulate
   5 :mod:`collections` included in the Python standard library.  It ends
   6 with a 'z' so as not to collide with the standard library package.
   7
   8 Submodules
   9 ----------
  10
  11 pyutils.collectionz.bidict module
  12 ---------------------------------
  13
  14 .. automodule:: pyutils.collectionz.bidict
  15    :imported-members:
  16    :members:
  17    :undoc-members:
  18    :show-inheritance:
  19
  20 pyutils.collectionz.bst module
  21 ------------------------------
  22
  23 .. automodule:: pyutils.collectionz.bst
  24    :members:
  25    :undoc-members:
  26    :show-inheritance:
  27
  28 pyutils.collectionz.shared\_dict module
  29 ---------------------------------------
  30
  31 The shared\_dict.SharedDict class is a normal python dictionary that
  32 can be accessed safely in parallel from multiple threads or processes
  33 without (external) locking by using Multiprocessing.SharedMemory.  It
  34 uses internal locking and rewrites the shared memory region as it is
  35 changed so it is slower than a normal dict.  It also does not grow
  36 dynamically; the creator of the shared\_dict must declare a maximum
  37 size.
  38
  39 .. automodule:: pyutils.collectionz.shared_dict
  40    :members:
  41    :undoc-members:
  42    :show-inheritance:
  43
  44 pyutils.collectionz.trie module
  45 -------------------------------
  46
  47 .. automodule:: pyutils.collectionz.trie
  48    :members:
  49    :undoc-members:
  50    :show-inheritance:
  51
  52 Module contents
  53 ---------------
  54
  55 .. automodule:: pyutils.collectionz
  56    :members:
  57    :undoc-members:
  58    :show-inheritance: