docs/pyutils.parallelize.rst

   1 pyutils.parallelize package
   2 ===========================
   3
   4 This package contains code related to parallelization including some
   5 utilities (:file:`thread_utils.py`) and a frameworks for simple
   6 parallelization (everything else).
   7
   8 Submodules
   9 ----------
  10
  11 pyutils.parallelize.deferred\_operand module
  12 --------------------------------------------
  13
  14 .. automodule:: pyutils.parallelize.deferred_operand
  15    :members:
  16    :undoc-members:
  17    :exclude-members: __repr__,
  18                      and_,
  19                      bool,
  20                      delitem,
  21                      getitem,
  22                      invert,
  23                      is_,
  24                      is_not,
  25                      lshift,
  26                      matmul,
  27                      mod,
  28                      neg,
  29                      or_,
  30                      pos,
  31                      rshift,
  32                      setitem,
  33                      truth,
  34                      xor
  35    :show-inheritance:
  36
  37 pyutils.parallelize.executors module
  38 ------------------------------------
  39
  40 .. automodule:: pyutils.parallelize.executors
  41    :members:
  42    :undoc-members:
  43    :show-inheritance:
  44
  45 pyutils.parallelize.parallelize module
  46 --------------------------------------
  47
  48 .. automodule:: pyutils.parallelize.parallelize
  49    :members:
  50    :undoc-members:
  51    :show-inheritance:
  52
  53 pyutils.parallelize.smart\_future module
  54 ----------------------------------------
  55
  56 Defines a SmartFuture class that is part of the parallelization
  57 framework.  A SmartFuture is a kind of Future (i.e. a representation
  58 of the result of asynchronous processing that may know its value or
  59 not depending on whether the asynchronous operation has completed).
  60 Whereas normal Python Futures must be waited on or resolved manually,
  61 a SmartFuture automatically waits for its result to be known as soon
  62 as it is utilized in an expression that demands its value.
  63
  64 Also contains some utilility code for waiting for one/many futures.
  65
  66 .. automodule:: pyutils.parallelize.smart_future
  67    :members:
  68    :undoc-members:
  69    :show-inheritance:
  70
  71 pyutils.parallelize.thread\_utils module
  72 ----------------------------------------
  73
  74 .. automodule:: pyutils.parallelize.thread_utils
  75    :members:
  76    :undoc-members:
  77    :show-inheritance:
  78
  79 Module contents
  80 ---------------
  81
  82 This module contains a framework for easy Python parallelization.  To
  83 see an example of how it is used, look at examples/wordle/...
  84
  85 This module also contains some utilities that deal with parallelization.
  86
  87 .. automodule:: pyutils.parallelize
  88    :members:
  89    :undoc-members:
  90    :show-inheritance: