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实现模拟时钟代码推荐
Nov 08 Python
使用Python编写爬虫的基本模块及框架使用指南
Jan 20 Python
浅谈pyhton学习中出现的各种问题(新手必看)
May 17 Python
解决python3爬虫无法显示中文的问题
Apr 12 Python
Django实现全文检索的方法(支持中文)
May 14 Python
Python3中详解fabfile的编写
Jun 24 Python
Python微医挂号网医生数据抓取
Jan 24 Python
Python用Try语句捕获异常的实例方法
Jun 26 Python
python字典的常用方法总结
Jul 31 Python
TensorFlow tf.nn.softmax_cross_entropy_with_logits的用法
Apr 19 Python
Jupyter 无法下载文件夹如何实现曲线救国
Apr 22 Python
python3 字符串str和bytes相互转换
Mar 23 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
跟我学Laravel之安装Laravel
2014/10/15 PHP
php中switch与ifelse的效率区别及适用情况分析
2015/02/12 PHP
关于laravel 日志写入失败问题汇总
2019/10/17 PHP
JSON 入门指南 想了解json的朋友可以看下
2009/08/26 Javascript
jQuery实现冻结表头的方法
2015/03/09 Javascript
jQuery实现简单二级下拉菜单
2015/04/12 Javascript
jquery图片切换实例分析
2015/04/15 Javascript
JQuery使用index方法获取Jquery对象数组下标的方法
2015/05/18 Javascript
Javascript中实现String.startsWith和endsWith方法
2015/06/10 Javascript
JS实现的表格行上下移动操作示例
2016/08/03 Javascript
微信小程序开发经验总结(推荐)
2017/01/11 Javascript
jqGrid翻页时数据选中丢失问题的解决办法
2017/02/13 Javascript
vue学习之mintui picker选择器实现省市二级联动示例
2017/10/12 Javascript
Vue中的无限加载vue-infinite-loading的方法
2018/04/08 Javascript
浅谈vue引用静态资源需要注意的事项
2018/09/28 Javascript
微信JS-SDK updateAppMessageShareData安卓不能自定义分享详解
2019/03/29 Javascript
抖音上用记事本编写爱心小程序教程
2019/04/17 Javascript
关于vue里页面的缓存详解
2019/11/04 Javascript
python 中文乱码问题深入分析
2011/03/13 Python
Python基础入门之seed()方法的使用
2015/05/15 Python
Django 迁移、操作数据库的方法
2019/08/02 Python
复古斯堪的纳维亚儿童服装:Baby go Retro
2017/09/09 全球购物
Jacadi Paris美国官方网站:法国童装品牌
2017/10/15 全球购物
网络安全方面的面试题
2015/11/04 面试题
大学生标准推荐信范文
2013/11/25 职场文书
车间副主任岗位职责
2013/12/24 职场文书
七年级地理教学反思
2014/01/26 职场文书
小学新教师培训方案
2014/02/03 职场文书
六年级数学教学反思
2014/02/03 职场文书
十八届三中全会报告学习材料
2014/02/17 职场文书
寒假家长评语大全
2014/04/16 职场文书
篮球比赛策划方案
2014/06/05 职场文书
银行员工犯错检讨书
2014/09/16 职场文书
2014年社区计生工作总结
2014/11/18 职场文书
评职称个人总结
2015/03/05 职场文书
QT连接MYSQL数据库的详细步骤
2021/07/07 MySQL