/usr/share/doc/python-distributed-doc/html/_sources/api.rst.txt is in python-distributed-doc 1.20.2+ds.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | .. _api:
API
===
.. currentmodule:: distributed.client
**Client**
.. autosummary::
Client
Client.call_stack
Client.cancel
Client.close
Client.compute
Client.gather
Client.get
Client.get_dataset
Client.get_executor
Client.get_metadata
Client.get_scheduler_logs
Client.get_worker_logs
Client.has_what
Client.list_datasets
Client.map
Client.ncores
Client.persist
Client.publish_dataset
Client.profile
Client.rebalance
Client.replicate
Client.restart
Client.run
Client.run_on_scheduler
Client.scatter
Client.scheduler_info
Client.set_metadata
Client.start_ipython_workers
Client.start_ipython_scheduler
Client.submit
Client.unpublish_dataset
Client.upload_file
Client.who_has
.. currentmodule:: distributed
.. autosummary::
worker_client
get_worker
get_client
secede
rejoin
Reschedule
.. currentmodule:: distributed.recreate_exceptions
.. autosummary::
ReplayExceptionClient.get_futures_error
ReplayExceptionClient.recreate_error_locally
.. currentmodule:: distributed.client
**Future**
.. autosummary::
Future
Future.add_done_callback
Future.cancel
Future.cancelled
Future.done
Future.exception
Future.result
Future.traceback
**Client Coordination**
.. currentmodule:: distributed
.. autosummary:: Lock
.. autosummary:: Queue
.. autosummary:: Variable
**Other**
.. autosummary::
as_completed
distributed.diagnostics.progress
wait
fire_and_forget
Asynchronous methods
--------------------
Most methods and functions can be used equally well within a blocking or
asynchronous environment using Tornado coroutines. If used within a Tornado
IOLoop then you should yield or await otherwise blocking operations
appropriately.
You must tell the client that you intend to use it within an asynchronous
environment by passing the ``asynchronous=True`` keyword
.. code-block:: python
# blocking
client = Client()
future = client.submit(func, *args) # immediate, no blocking/async difference
result = client.gather(future) # blocking
# asynchronous Python 2/3
client = yield Client(asynchronous=True)
future = client.submit(func, *args) # immediate, no blocking/async difference
result = yield client.gather(future) # non-blocking/asynchronous
# asynchronous Python 3
client = await Client(asynchronous=True)
future = client.submit(func, *args) # immediate, no blocking/async difference
result = await client.gather(future) # non-blocking/asynchronous
The asynchronous variants must be run within a Tornado coroutine. See the
:doc:`Asynchronous <asynchronous>` documentation for more information.
Client
------
.. currentmodule:: distributed.client
.. autoclass:: Client
:members:
.. autoclass:: distributed.recreate_exceptions.ReplayExceptionClient
:members:
Future
------
.. autoclass:: Future
:members:
Other
-----
.. autofunction:: as_completed
.. autofunction:: distributed.diagnostics.progress
.. autofunction:: wait
.. currentmodule:: distributed
.. autofunction:: distributed.worker_client
.. autofunction:: distributed.get_worker
.. autofunction:: distributed.get_client
.. autofunction:: distributed.secede
.. autofunction:: distributed.rejoin
.. autoclass:: Queue
:members:
.. autoclass:: Variable
:members:
Asyncio Client
--------------
.. currentmodule:: distributed.asyncio
.. autoclass:: AioClient
:members:
Adaptive
--------
.. currentmodule:: distributed.deploy
.. autoclass:: Adaptive
:members:
|