docs/pyutils.collectionz.rst

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