Debian Codegraph @

Doc/library/asyncio-future.rst

raw
1 .. currentmodule:: asyncio
2
3
4 .. _asyncio-futures:
5
6 =======
7 Futures
8 =======
9
10 **Source code:** :source:`Lib/asyncio/futures.py`,
11 :source:`Lib/asyncio/base_futures.py`
12
13 -------------------------------------
14
15 *Future* objects are used to bridge **low-level callback-based code**
16 with high-level async/await code.
17
18
19 Future Functions
20 ================
21
22 .. function:: isfuture(obj)
23
24 Return ``True`` if *obj* is either of:
25
26 * an instance of :class:`asyncio.Future`,
27 * an instance of :class:`asyncio.Task`,
28 * a Future-like object with a ``_asyncio_future_blocking``
29 attribute.
30
31 .. versionadded:: 3.5
32
33
34 .. function:: ensure_future(obj, *, loop=None)
35
36 Return:
37
38 * *obj* argument as is, if *obj* is a :class:`Future`,
39 a :class:`Task`, or a Future-like object (:func:`isfuture`
40 is used for the test.)
41
42 * a :class:`Task` object wrapping *obj*, if *obj* is a
43 coroutine (:func:`iscoroutine` is used for the test);
44 in this case the coroutine will be scheduled by
45 ``ensure_future()``.
46
47 * a :class:`Task` object that would await on *obj*, if *obj* is an
48 awaitable (:func:`inspect.isawaitable` is used for the test.)
49
50 If *obj* is neither of the above a :exc:`TypeError` is raised.
51
52 .. important::
53
54 Save a reference to the result of this function, to avoid
55 a task disappearing mid-execution.
56
57 See also the :func:`create_task` function which is the
58 preferred way for creating new tasks or use :class:`asyncio.TaskGroup`
59 which keeps reference to the task internally.
60
61 .. versionchanged:: 3.5.1
62 The function accepts any :term:`awaitable` object.
63
64 .. deprecated:: 3.10
65 Deprecation warning is emitted if *obj* is not a Future-like object
66 and *loop* is not specified and there is no running event loop.
67
68
69 .. function:: wrap_future(future, *, loop=None)
70
71 Wrap a :class:`concurrent.futures.Future` object in a
72 :class:`asyncio.Future` object.
73
74 .. deprecated:: 3.10
75 Deprecation warning is emitted if *future* is not a Future-like object
76 and *loop* is not specified and there is no running event loop.
77
78 .. _asyncio-future-obj:
79
80 Future Object
81 =============
82
83 .. class:: Future(*, loop=None)
84
85 A Future represents an eventual result of an asynchronous
86 operation. Not thread-safe.
87
88 Future is an :term:`awaitable` object. Coroutines can await on
89 Future objects until they either have a result or an exception
90 set, or until they are cancelled. A Future can be awaited multiple
91 times and the result is same.
92
93 Typically Futures are used to enable low-level
94 callback-based code (e.g. in protocols implemented using asyncio
95 :ref:`transports <asyncio-transports-protocols>`)
96 to interoperate with high-level async/await code.
97
98 The rule of thumb is to never expose Future objects in user-facing
99 APIs, and the recommended way to create a Future object is to call
100 :meth:`loop.create_future`. This way alternative event loop
101 implementations can inject their own optimized implementations
102 of a Future object.
103
104 Futures are :ref:`generic <generics>` over the type of their results.
105
106 .. versionchanged:: 3.7
107 Added support for the :mod:`contextvars` module.
108
109 .. deprecated:: 3.10
110 Deprecation warning is emitted if *loop* is not specified
111 and there is no running event loop.
112
113 .. method:: result()
114
115 Return the result of the Future.
116
117 If the Future is *done* and has a result set by the
118 :meth:`set_result` method, the result value is returned.
119
120 If the Future is *done* and has an exception set by the
121 :meth:`set_exception` method, this method raises the exception.
122
123 If the Future has been *cancelled*, this method raises
124 a :exc:`CancelledError` exception.
125
126 If the Future's result isn't yet available, this method raises
127 an :exc:`InvalidStateError` exception.
128
129 .. method:: set_result(result)
130
131 Mark the Future as *done* and set its result.
132
133 Raises an :exc:`InvalidStateError` error if the Future is
134 already *done*.
135
136 .. method:: set_exception(exception)
137
138 Mark the Future as *done* and set an exception.
139
140 Raises an :exc:`InvalidStateError` error if the Future is
141 already *done*.
142
143 .. method:: done()
144
145 Return ``True`` if the Future is *done*.
146
147 A Future is *done* if it was *cancelled* or if it has a result
148 or an exception set with :meth:`set_result` or
149 :meth:`set_exception` calls.
150
151 .. method:: cancelled()
152
153 Return ``True`` if the Future was *cancelled*.
154
155 The method is usually used to check if a Future is not
156 *cancelled* before setting a result or an exception for it::
157
158 if not fut.cancelled():
159 fut.set_result(42)
160
161 .. method:: add_done_callback(callback, *, context=None)
162
163 Add a callback to be run when the Future is *done*.
164
165 The *callback* is called with the Future object as its only
166 argument.
167
168 If the Future is already *done* when this method is called,
169 the callback is scheduled with :meth:`loop.call_soon`.
170
171 An optional keyword-only *context* argument allows specifying a
172 custom :class:`contextvars.Context` for the *callback* to run in.
173 The current context is used when no *context* is provided.
174
175 :func:`functools.partial` can be used to pass parameters
176 to the callback, e.g.::
177
178 # Call 'print("Future:", fut)' when "fut" is done.
179 fut.add_done_callback(
180 functools.partial(print, "Future:"))
181
182 .. versionchanged:: 3.7
183 The *context* keyword-only parameter was added.
184 See :pep:`567` for more details.
185
186 .. method:: remove_done_callback(callback)
187
188 Remove *callback* from the callbacks list.
189
190 Returns the number of callbacks removed, which is typically 1,
191 unless a callback was added more than once.
192
193 .. method:: cancel(msg=None)
194
195 Cancel the Future and schedule callbacks.
196
197 If the Future is already *done* or *cancelled*, return ``False``.
198 Otherwise, change the Future's state to *cancelled*,
199 schedule the callbacks, and return ``True``.
200
201 The optional string argument *msg* is passed as the argument to the
202 :exc:`CancelledError` exception raised when a cancelled Future
203 is awaited.
204
205 .. versionchanged:: 3.9
206 Added the *msg* parameter.
207
208 .. method:: exception()
209
210 Return the exception that was set on this Future.
211
212 The exception (or ``None`` if no exception was set) is
213 returned only if the Future is *done*.
214
215 If the Future has been *cancelled*, this method raises a
216 :exc:`CancelledError` exception.
217
218 If the Future isn't *done* yet, this method raises an
219 :exc:`InvalidStateError` exception.
220
221 .. method:: get_loop()
222
223 Return the event loop the Future object is bound to.
224
225 .. versionadded:: 3.7
226
227
228 .. _asyncio_example_future:
229
230 This example creates a Future object, creates and schedules an
231 asynchronous Task to set result for the Future, and waits until
232 the Future has a result::
233
234 async def set_after(fut, delay, value):
235 # Sleep for *delay* seconds.
236 await asyncio.sleep(delay)
237
238 # Set *value* as a result of *fut* Future.
239 fut.set_result(value)
240
241 async def main():
242 # Get the current event loop.
243 loop = asyncio.get_running_loop()
244
245 # Create a new Future object.
246 fut = loop.create_future()
247
248 # Run "set_after()" coroutine in a parallel Task.
249 # We are using the low-level "loop.create_task()" API here because
250 # we already have a reference to the event loop at hand.
251 # Otherwise we could have just used "asyncio.create_task()".
252 loop.create_task(
253 set_after(fut, 1, '... world'))
254
255 print('hello ...')
256
257 # Wait until *fut* has a result (1 second) and print it.
258 print(await fut)
259
260 asyncio.run(main())
261
262
263 .. important::
264
265 The Future object was designed to mimic
266 :class:`concurrent.futures.Future`. Key differences include:
267
268 - unlike asyncio Futures, :class:`concurrent.futures.Future`
269 instances cannot be awaited.
270
271 - :meth:`asyncio.Future.result` and :meth:`asyncio.Future.exception`
272 do not accept the *timeout* argument.
273
274 - :meth:`asyncio.Future.result` and :meth:`asyncio.Future.exception`
275 raise an :exc:`InvalidStateError` exception when the Future is not
276 *done*.
277
278 - Callbacks registered with :meth:`asyncio.Future.add_done_callback`
279 are not called immediately. They are scheduled with
280 :meth:`loop.call_soon` instead.
281
282 - asyncio Future is not compatible with the
283 :func:`concurrent.futures.wait` and
284 :func:`concurrent.futures.as_completed` functions.
285
286 - :meth:`asyncio.Future.cancel` accepts an optional ``msg`` argument,
287 but :meth:`concurrent.futures.Future.cancel` does not.