rspec/rules/S5631/python/rule.adoc

38 lines
788 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
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++``.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
----
import asyncio
def myfunction():
print("myfunction")
async def otherfunction():
await myfunction() # Noncompliant. myfunction is not marked as "async"
asyncio.run(otherfunction())
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
----
import asyncio
async def myfunction():
print("myfunction")
async def otherfunction():
await myfunction()
asyncio.run(otherfunction())
----
2021-04-28 16:49:39 +02:00
== See
* https://docs.python.org/3/library/asyncio-task.html[Python documentation - Coroutines and Tasks]