当前位置:   article > 正文

python 异步编程 asyncio_asyncio.run

asyncio.run

协程

协程(Coroutine),也可以被称为微线程,是一种用户态内的上下文切换技术。简而言之,其实就是通过一个线程实现代码块相互切换执行

在Python中有多种方式可以实现协程,例如:

  • greenlet,是一个第三方模块,用于实现协程代码(Gevent协程就是基于greenlet实现)
  • yield,生成器,借助生成器的特点也可以实现协程代码。
  • asyncio,在Python3.4中引入的模块用于编写协程代码。
  • async & awiat,在Python3.5中引入的两个关键字,结合asyncio模块可以更方便的编写协程代码。【推荐】

异步编程

异步编程的两大核心: 事件循环 + 协程函数

1.事件循环(可理解为死循环)

循环检查并执行一些任务,在特定条件下终止循环,这些任务会有三种运行状态: 待执行,正在执行,IO状态

  1. # 伪代码
  2. 任务列表 = [ 任务1, 任务2, 任务3,... ]
  3. while True:
  4. 可执行的任务列表,已完成的任务列表 = 去任务列表中检查所有的任务,将'可执行''已完成'的任务返回
  5. for 就绪任务 in 已准备就绪的任务列表:
  6. 执行已就绪的任务
  7. for 已完成的任务 in 已完成的任务列表:
  8. 在任务列表中移除 已完成的任务
  9. 如果 任务列表 中的任务都已完成,则终止循环

asyncio 生成或获取事件循环

  1. import asyncio
  2. # 生成或获取事件循环对象loop
  3. loop = asyncio.get_event_loop()
  4. # 将协程函数(任务)提交到事件循环的任务列表中,协程函数执行完成之后终止。
  5. # run_until_complete 会检查协程函数的运行状态,并执行协程函数
  6. loop.run_until_complete( func() )
  7. 注意: python3.7+ 后的写法:
  8. asyncio.run( func() ) # run方法内部封装了 get_event_loop() 与 run_until_complete()

2.协程函数

定义协程函数 :async def 关键字 (python3.5+)

协程对象:协程函数运行的结果即为协程对象

  1. async def func1():
  2. pass
  3. f = func() # 协程函数运行生成协程函数对象
  4. 注意: 协程函数加括号不会执行协程函数内部代码,只是得到一个协程对象

案例:

如果要运行协程函数内容代码,必须将协程函数交给asyncio事件循环来执行

  1. import asyncio
  2. async def func():
  3. print(1)
  4. f = func()
  5. loop = asyncio.get_event_loop()
  6. loop.run_until_complete( f )

await

用法:reponse = await + 可等待对象 

  • 可等待对象: 协程对象, Future,  Task对象  可理解为IO等待
  • response : 等待的结果
  • await 遇到IO操作会挂起当前协程(任务),当前协程挂起时,事件循环可以去执行其他协程(任务)

 注意:可等待对象若是协程对象则变成串行,若是Task对象则并发运行

  1. import asyncio
  2. async def func():
  3. print(1)
  4. response = await asyncio.sleep(2) # asyncio.sleep 模仿IO操作
  5. # 若 await 等待的是下载图片,那么 response 的值是下载的图片
  6. print('协程函数运行结束', response)
  7. loop = asyncio.get_event_loop()
  8. loop.run_until_complete( func() )

案例:

  1. import asyncio
  2. async def others():
  3. print("start")
  4. await asyncio.sleep(2)
  5. print('end')
  6. return '返回值'
  7. async def func():
  8. print("执行协程函数内部代码")
  9. # 遇到IO操作挂起当前协程(任务),等IO操作完成之后再继续往下执行。当前协程挂起时,事件循环可以去执行其他协程(任务)。
  10. response1 = await others()
  11. print("IO请求结束,结果为:", response1)
  12. response2 = await others()
  13. print("IO请求结束,结果为:", response2)
  14. # await 后面的可等待对象为 协程对象, 所有运行方式为串行
  15. loop = asyncio.get_event_loop()
  16. loop.run_until_complete( func() )
  17. >>>>>>>:
  18. 执行协程函数内部代码
  19. start
  20. end
  21. IO请求结束,结果为: 返回值
  22. start
  23. end
  24. IO请求结束,结果为: 返回值

注意: await 会等待 '可等待对象' 运行结束后,再继续向下执行代码

协程函数 + await + 协程对象  + await + 协程对象 ....... 可看做是一条线,当遇到IO时,循环事件列表中若有其他线,则运行其他线,若无其他线,则等待IO结束后再继续运行

Task对象

作用:在事件循环列表中添加多个任务

Tasks用于并发调度协程,通过asyncio.create_task(协程对象)的方式创建Task对象,这样可以让协程加入事件循环中等待被调度执行。除了使用 asyncio.create_task() 函数以外,还可以用低层级的 loop.create_task() 或 ensure_future() 函数。不建议手动实例化 Task 对象。

本质上是将协程对象封装成task对象,并将协程立即加入事件循环,同时追踪协程的状态。

注意:asyncio.create_task() 函数在 Python 3.7 中被加入。在 Python 3.7 之前,可以改用低层级的 asyncio.ensure_future() 函数。

  1. import asyncio
  2. async def func():
  3. print(1)
  4. await asyncio.sleep(2)
  5. print(2)
  6. return "返回值"
  7. async def main():
  8. print("main开始")
  9. # 创建协程,将协程封装到一个Task对象中并立即添加到事件循环的任务列表中,等待事件循环去执行(默认是就绪状态)。
  10. task1 = asyncio.ensure_future(func())
  11. # 创建协程,将协程封装到一个Task对象中并立即添加到事件循环的任务列表中,等待事件循环去执行(默认是就绪状态)。
  12. task2 = asyncio.ensure_future(func())
  13. # 此时,事件循环列表中有三个任务 [main(), func(), func()]
  14. print("main运行中")
  15. # 当执行某协程遇到IO操作时,会自动化切换执行其他任务。
  16. # 此处的await是等待相对应的协程全都执行完毕并获取结果, task1 与 task2 并发运行
  17. ret1 = await task1
  18. ret2 = await task2
  19. # 协程函数main() 等待 task1 和 task2 运行结束后再运行
  20. print(ret1, ret2)
  21. print("main结束")
  22. loop = asyncio.get_event_loop()
  23. loop.run_until_complete(main())
  24. >>>>>>:
  25. main开始
  26. main运行中
  27. 1
  28. 1
  29. 2
  30. 2
  31. 返回值 返回值
  32. main结束

常规写法1:

  1. import asyncio
  2. async def func():
  3. print(1)
  4. await asyncio.sleep(2)
  5. print(2)
  6. return "返回值"
  7. async def main():
  8. print("main开始")
  9. task_list = [
  10. asyncio.ensure_future(func()),
  11. asyncio.ensure_future(func())
  12. ]
  13. print("main运行中")
  14. done,pending = await asyncio.wait(
  15. task_list,
  16. timeout=None # timeout 等待时间,若等待时间内协程函数没有执行完,则放入pending中, None表示等待协程函数运行结束
  17. )
  18. print(done)
  19. print(pending)
  20. print("main结束")
  21. loop = asyncio.get_event_loop()
  22. loop.run_until_complete(main())

常规写法2:

  1. import asyncio
  2. async def func():
  3. print("执行协程函数内部代码")
  4. # 遇到IO操作挂起当前协程(任务),等IO操作完成之后再继续往下执行。当前协程挂起时,事件循环可以去执行其他协程(任务)。
  5. response = await asyncio.sleep(2)
  6. print("IO请求结束,结果为:", response)
  7. coroutine_list = [
  8. func(),
  9. func()
  10. ]
  11. # 错误:coroutine_list = [ asyncio.create_task(func()), asyncio.create_task(func()) ]
  12. # 此处不能直接 asyncio.create_task,因为将Task立即加入到事件循环的任务列表,
  13. # 但此时事件循环还未创建,所以会报错。
  14. # 使用asyncio.wait将列表封装为一个协程,并调用loop.run_until_complete实现执行两个协程
  15. # asyncio.wait内部会对列表中的每个协程执行ensure_future,封装为Task对象。
  16. loop = asyncio.get_event_loop()
  17. done,pending = loop.run_until_complete( asyncio.wait(coroutine_list) )

asycio.Future对象

  1. import asyncio
  2. async def func():
  3. print(3)
  4. await asyncio.sleep(2)
  5. print(4)
  6. async def main():
  7. print(1)
  8. # 获取当前事件循环
  9. loop = asyncio._get_running_loop()
  10. # 创建一个任务(Future对象),这个任务什么都不干。
  11. fut = loop.create_future()
  12. # 等待任务最终结果(Future对象),没有结果则会一直等下去。
  13. await fut
  14. print(2)
  15. loop = asyncio.get_event_loop()
  16. loop.run_until_complete(main())

asycio + 进程池/线程池的异步

在开发过程中会遇到一些模块不支持异步操作,这是就要用到 asycio + 线程池/进程池

run_in_executor() 方法可以将不支持异步操作的方法变为 asycio.Future 对象,从而和 asyncio 配合使用

run_in_executor()内部就是使用的线程池

  1. import time
  2. import asyncio
  3. import concurrent.futures
  4. def func1():
  5. # 某个耗时操作
  6. time.sleep(2)
  7. return "SB"
  8. async def main():
  9. loop = asyncio._get_running_loop()
  10. # 1. Run in the default loop's executor ( 默认ThreadPoolExecutor )
  11. # 第一步:内部会先调用 ThreadPoolExecutor 的 submit 方法去线程池中申请一个线程去执行func1函数,并返回一个concurrent.futures.Future对象
  12. # 第二步:调用asyncio.wrap_future将concurrent.futures.Future对象包装为asycio.Future对象。
  13. # 因为concurrent.futures.Future对象不支持await语法,所以需要包装为 asycio.Future对象 才能使用。
  14. fut = loop.run_in_executor(None, func1) # run_in_executor 返回的是 asycio.Future对象
  15. result = await fut
  16. print('default thread pool', result)
  17. # # 2. Run in a custom thread pool:
  18. # with concurrent.futures.ThreadPoolExecutor() as pool:
  19. # result = await loop.run_in_executor(
  20. # pool, func1)
  21. # print('custom thread pool', result)
  22. # # 3. Run in a custom process pool:
  23. # with concurrent.futures.ProcessPoolExecutor() as pool:
  24. # result = await loop.run_in_executor(
  25. # pool, func1)
  26. # print('custom process pool', result)
  27. asyncio.run(main())

案例:

  1. import asyncio
  2. import requests
  3. async def download_image(url):
  4. # 发送网络请求,下载图片(遇到网络下载图片的IO请求,自动化切换到其他任务)
  5. print("开始下载:", url)
  6. # loop = asyncio._get_running_loop()
  7. loop = asyncio.get_event_loop()
  8. # requests模块默认不支持异步操作,所以就使用线程池来配合实现了。
  9. future = loop.run_in_executor(None, requests.get, url)
  10. response = await future
  11. print('下载完成')
  12. # 图片保存到本地文件
  13. file_name = url.rsplit('_')[-1]
  14. with open(file_name, mode='wb') as file_object:
  15. file_object.write(response.content)
  16. if __name__ == '__main__':
  17. url_list = [
  18. 'https://www3.autoimg.cn/newsdfs/g26/M02/35/A9/120x90_0_autohomecar__ChsEe12AXQ6AOOH_AAFocMs8nzU621.jpg',
  19. 'https://www2.autoimg.cn/newsdfs/g30/M01/3C/E2/120x90_0_autohomecar__ChcCSV2BBICAUntfAADjJFd6800429.jpg',
  20. 'https://www3.autoimg.cn/newsdfs/g26/M0B/3C/65/120x90_0_autohomecar__ChcCP12BFCmAIO83AAGq7vK0sGY193.jpg'
  21. ]
  22. tasks = [download_image(url) for url in url_list]
  23. loop = asyncio.get_event_loop()
  24. loop.run_until_complete( asyncio.wait(tasks) )

异步迭代器

异步迭代器:

实现了 __aiter__() 和 __anext__() 方法的对象。__anext__ 必须返回一个 awaitable 对象。async for 会处理异步迭代器的 __anext__() 方法所返回的可等待对象,直到其引发一个 StopAsyncIteration 异常

异步可迭代对象:

可在 async for 语句中被使用的对象。必须通过它的 __aiter__() 方法返回一个 asynchronous iterator 异步迭代器

自定义异步迭代器:

  1. import asyncio
  2. class Reader(object):
  3. """ 自定义异步迭代器(同时也是异步可迭代对象) """
  4. def __init__(self, n):
  5. self.count = 0
  6. self.n = n
  7. async def readline(self):
  8. # await asyncio.sleep(1)
  9. self.count += 1
  10. if self.count == self.n:
  11. return None
  12. return self.count
  13. def __aiter__(self):
  14. return self
  15. async def __anext__(self):
  16. val = await self.readline()
  17. if val == None:
  18. raise StopAsyncIteration
  19. return val
  20. async def func(n):
  21. # 创建异步可迭代对象
  22. async_iter = Reader(n)
  23. # async for 必须要放在async def函数内,否则语法错误。
  24. async for item in async_iter:
  25. print(item)
  26. loop = asyncio.get_event_loop()
  27. loop.run_until_complete(func(5))
  28. # asyncio.run(func())

异步上下文管理器

对象通过定义 __aenter__() 和 __aexit__() 方法来对 async with 语句中的环境进行控制

开发过程中 打开、处理、关闭 操作时,就可以用这种方式来处理

自定义异步上文管理器:

  1. import asyncio
  2. class AsyncContextManager:
  3. def __init__(self):
  4. self.conn = 0
  5. async def do_something(self):
  6. # 异步操作数据库
  7. return 666
  8. async def __aenter__(self):
  9. # 异步链接数据库
  10. self.conn = await asyncio.sleep(1)
  11. return self
  12. async def __aexit__(self, exc_type, exc, tb):
  13. # 异步关闭数据库链接
  14. await asyncio.sleep(1)
  15. async def func():
  16. async with AsyncContextManager() as f:
  17. result = await f.do_something()
  18. print(result)
  19. loop = asyncio.get_event_loop()
  20. loop.run_until_complete(func())
  21. # asyncio.run(func())

参考

asyncio

  1. import asyncio
  2. @asyncio.coroutine
  3. def func1():
  4. print(1)
  5. yield from asyncio.sleep(2) # 遇到IO耗时操作,自动化切换到tasks中的其他任务
  6. # 此处的 yield from 作用 :1.挂起函数,2.去运行 asyncio.sleep(2)来模仿IO操作
  7. # 模仿实际项目中的IO操作,如网络IO请求,读写磁盘IO请求
  8. print(2)
  9. @asyncio.coroutine
  10. def func2():
  11. print(3)
  12. yield from asyncio.sleep(2) # 遇到IO耗时操作,自动化切换到tasks中的其他任务
  13. print(4)
  14. # loop = asyncio.get_event_loop() # 创建事件循环
  15. # loop.run_until_complete(func1()) # 执行 协程函数
  16. '''
  17. 被 @asyncio.coroutine 装饰的函数为协程函数
  18. 协程函数不能单独运行,如 func1()无法运行,需要通过 创建事件循环 来执行 携程函数
  19. '''
  20. tasks = [
  21. asyncio.ensure_future( func1() ),
  22. asyncio.ensure_future( func2() )
  23. ]
  24. loop = asyncio.get_event_loop() # 创建事件循环
  25. loop.run_until_complete(asyncio.wait(tasks)) # python随机执行tasks任务列表中注册的协程函数

async & awiat

async & awit 关键字代替了 @asyncio.coroutine 和 yield from

awit:挂起协程函数,等待IO任务完成后继续执行

  1. import asyncio
  2. async def func1():
  3. print(1)
  4. await asyncio.sleep(2)
  5. print(2)
  6. async def func2():
  7. print(3)
  8. await asyncio.sleep(2)
  9. print(4)
  10. tasks = [
  11. asyncio.ensure_future(func1()),
  12. asyncio.ensure_future(func2())
  13. ]
  14. loop = asyncio.get_event_loop()
  15. loop.run_until_complete(asyncio.wait(tasks))

问题:RuntimeError: There is no current event loop in thread 'ThreadPoolExecutor-0_0

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/知新_RL/article/detail/79988
推荐阅读
相关标签
  

闽ICP备14008679号