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