python async with和async for的使用


Posted in Python onJune 20, 2019

网上async with和async for的中文资料比较少,我把PEP 492中的官方陈述翻译一下。

异步上下文管理器”async with”

异步上下文管理器指的是在enter和exit方法处能够暂停执行的上下文管理器。

为了实现这样的功能,需要加入两个新的方法:__aenter__ 和__aexit__。这两个方法都要返回一个 awaitable类型的值。

异步上下文管理器的一种使用方法是:

class AsyncContextManager:
  async def __aenter__(self):
    await log('entering context')

  async def __aexit__(self, exc_type, exc, tb):
    await log('exiting context')

新语法

异步上下文管理器使用一种新的语法:

async with EXPR as VAR:
  BLOCK

这段代码在语义上等同于:

mgr = (EXPR)
aexit = type(mgr).__aexit__
aenter = type(mgr).__aenter__(mgr)
exc = True

VAR = await aenter
try:
  BLOCK
except:
  if not await aexit(mgr, *sys.exc_info()):
    raise
else:
  await aexit(mgr, None, None, None)

和常规的with表达式一样,可以在一个async with表达式中指定多个上下文管理器。

如果向async with表达式传入的上下文管理器中没有__aenter__ 和__aexit__方法,这将引起一个错误 。如果在async def函数外面使用async with,将引起一个SyntaxError(语法错误)。

例子

使用async with能够很容易地实现一个数据库事务管理器。

async def commit(session, data):
  ...

  async with session.transaction():
    ...
    await session.update(data)
    ...

需要使用锁的代码也很简单:

async with lock:
  ...

而不是:

with (yield from lock):
  ...

异步迭代器 “async for”

一个异步可迭代对象(asynchronous iterable)能够在迭代过程中调用异步代码,而异步迭代器就是能够在next方法中调用异步代码。为了支持异步迭代:

1、一个对象必须实现__aiter__方法,该方法返回一个异步迭代器(asynchronous iterator)对象。
2、一个异步迭代器对象必须实现__anext__方法,该方法返回一个awaitable类型的值。
3、为了停止迭代,__anext__必须抛出一个StopAsyncIteration异常。

异步迭代的一个例子如下:

class AsyncIterable:
  def __aiter__(self):
    return self

  async def __anext__(self):
    data = await self.fetch_data()
    if data:
      return data
    else:
      raise StopAsyncIteration

  async def fetch_data(self):
    ...

新语法

通过异步迭代器实现的一个新的迭代语法如下:

async for TARGET in ITER:
  BLOCK
else:
  BLOCK2

这在语义上等同于:

iter = (ITER)
iter = type(iter).__aiter__(iter)
running = True
while running:
  try:
    TARGET = await type(iter).__anext__(iter)
  except StopAsyncIteration:
    running = False
  else:
    BLOCK
else:
  BLOCK2

把一个没有__aiter__方法的迭代对象传递给 async for将引起TypeError。如果在async def函数外面使用async with,将引起一个SyntaxError(语法错误)。

和常规的for表达式一样, async for也有一个可选的else 分句。.

例子1

使用异步迭代器能够在迭代过程中异步地缓存数据:

async for data in cursor:
  ...

这里的cursor是一个异步迭代器,能够从一个数据库中每经过N次迭代预取N行数据。

下面的语法展示了这种新的异步迭代协议的用法:

class Cursor:
  def __init__(self):
    self.buffer = collections.deque()

  async def _prefetch(self):
    ...

  def __aiter__(self):
    return self

  async def __anext__(self):
    if not self.buffer:
      self.buffer = await self._prefetch()
      if not self.buffer:
        raise StopAsyncIteration
    return self.buffer.popleft()

接下来这个Cursor 类可以这样使用:

async for row in Cursor():
  print(row)
which would be equivalent to the following code:

i = Cursor().__aiter__()
while True:
  try:
    row = await i.__anext__()
  except StopAsyncIteration:
    break
  else:
    print(row)

例子2

下面的代码可以将常规的迭代对象变成异步迭代对象。尽管这不是一个非常有用的东西,但这段代码说明了常规迭代器和异步迭代器之间的关系。

class AsyncIteratorWrapper:
  def __init__(self, obj):
    self._it = iter(obj)

  def __aiter__(self):
    return self

  async def __anext__(self):
    try:
      value = next(self._it)
    except StopIteration:
      raise StopAsyncIteration
    return value

async for letter in AsyncIteratorWrapper("abc"):
  print(letter)

为什么要抛出StopAsyncIteration?

协程(Coroutines)内部仍然是基于生成器的。因此在PEP 479之前,下面两种写法没有本质的区别:

def g1():
  yield from fut
  return 'spam'

def g2():
  yield from fut
  raise StopIteration('spam')

自从 PEP 479 得到接受并成为协程 的默认实现,下面这个例子将StopIteration包装成一个RuntimeError。

async def a1():
  await fut
  raise StopIteration('spam')

告知外围代码迭代已经结束的唯一方法就是抛出StopIteration。因此加入了一个新的异常类StopAsyncIteration。

由PEP 479的规定 , 所有协程中抛出的StopIteration异常都被包装在RuntimeError中。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python列表操作实例
Jan 14 Python
Python基于PycURL实现POST的方法
Jul 25 Python
Python实现基本线性数据结构
Aug 22 Python
详解解决Python memory error的问题(四种解决方案)
Aug 08 Python
python 通过手机号识别出对应的微信性别(实例代码)
Dec 22 Python
Python异步编程之协程任务的调度操作实例分析
Feb 01 Python
python 实现字符串下标的输出功能
Feb 13 Python
Python使用os.listdir和os.walk获取文件路径
May 21 Python
python seaborn heatmap可视化相关性矩阵实例
Jun 03 Python
小白教你PyCharm从下载到安装再到科学使用PyCharm2020最新激活码
Sep 25 Python
Python暴力破解Mysql数据的示例
Nov 09 Python
Python爬虫后获取重定向url的两种方法
Jan 19 Python
python aiohttp的使用详解
Jun 20 #Python
Python 中Django验证码功能的实现代码
Jun 20 #Python
Puppeteer使用示例详解
Jun 20 #Python
获取django框架orm query执行的sql语句实现方法分析
Jun 20 #Python
Python使用LDAP做用户认证的方法
Jun 20 #Python
Python OpenCV中的resize()函数的使用
Jun 20 #Python
python中的句柄操作的方法示例
Jun 20 #Python
You might like
支持oicq头像的留言簿(一)
2006/10/09 PHP
简单的php文件上传(实例)
2013/10/27 PHP
PHP中捕获超时事件的方法实例
2015/02/12 PHP
PHP自带ZIP压缩、解压缩类ZipArchiv使用指南
2015/03/03 PHP
JavaScript Event事件学习第一章 Event介绍
2010/02/07 Javascript
精心挑选的15款优秀jQuery 本特效插件和教程
2012/08/06 Javascript
js实现广告漂浮效果的小例子
2013/07/02 Javascript
jQuery中fadeOut()方法用法实例
2014/12/24 Javascript
七个不允许错过的jQuery小技巧
2015/12/21 Javascript
基于javascript实现文字无缝滚动效果
2016/03/22 Javascript
JS实现刷新父页面不弹出提示框的方法
2016/06/22 Javascript
一个仿微博登陆邮箱提示框js开发案例
2016/07/28 Javascript
jQuery组件easyui对话框实现代码
2016/08/25 Javascript
Bootstrap源码解读网格系统(3)
2016/12/22 Javascript
使用Vue-Router 2实现路由功能实例详解
2017/11/14 Javascript
Vue项目中使用Vux的安装过程
2018/05/01 Javascript
vue-cli3环境变量与分环境打包的方法示例
2019/02/18 Javascript
layui 选择列表,打勾,点击确定返回数据的例子
2019/09/02 Javascript
JavaScript中clientWidth,offsetWidth,scrollWidth的区别
2021/01/25 Javascript
[05:20]2018DOTA2亚洲邀请赛主赛事第三日战况回顾 LGD率先挺进胜者组决赛
2018/04/06 DOTA
python处理圆角图片、圆形图片的例子
2014/04/25 Python
python获取外网ip地址的方法总结
2015/07/02 Python
Python 元类实例解析
2018/04/04 Python
python中用logging实现日志滚动和过期日志删除功能
2019/08/20 Python
python 如何去除字符串头尾的多余符号
2019/11/19 Python
python向图片里添加文字
2019/11/26 Python
Python爬虫防封ip的一些技巧
2020/08/06 Python
CSS3用@font-face实现自定义英文字体
2013/09/23 HTML / CSS
英国在线自行车商店:Evans Cycles
2016/09/26 全球购物
俄罗斯设计师家具购物网站:The Furnish
2019/12/01 全球购物
自荐书范文
2013/12/08 职场文书
设备动力科岗位职责范本
2014/02/23 职场文书
行政秘书工作自我鉴定
2014/09/15 职场文书
饭店服务员岗位职责
2015/02/09 职场文书
2016年敬老月活动总结
2016/04/05 职场文书
SpringBoot+VUE实现数据表格的实战
2021/08/02 Java/Android