16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
59 lines
1.1 KiB
Plaintext
59 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
The ``++await++`` keyword can only be used on https://docs.python.org/3/library/asyncio-task.html#awaitables["Awaitable" objects]. Python has three types of awaitables: Future, Task and Coroutines. Calling await on any other object will raise a ``++TypeError++``.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,python]
|
|
----
|
|
import asyncio
|
|
|
|
def myfunction():
|
|
print("myfunction")
|
|
|
|
async def otherfunction():
|
|
await myfunction() # Noncompliant. myfunction is not marked as "async"
|
|
|
|
asyncio.run(otherfunction())
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,python]
|
|
----
|
|
import asyncio
|
|
|
|
async def myfunction():
|
|
print("myfunction")
|
|
|
|
async def otherfunction():
|
|
await myfunction()
|
|
|
|
asyncio.run(otherfunction())
|
|
----
|
|
|
|
|
|
== Resources
|
|
|
|
* https://docs.python.org/3/library/asyncio-task.html[Python documentation - Coroutines and Tasks]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
* change this statement so that it awaits on a Future, a Coroutine or a Task
|
|
|
|
|
|
=== Highlighting
|
|
|
|
Primary: the await keyword
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|