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实现指定字符串补全空格的方法
Apr 30 Python
举例讲解Python中的算数运算符的用法
May 13 Python
Python的Flask站点中集成xhEditor文本编辑器的教程
Jun 13 Python
python虚拟环境的安装配置图文教程
Oct 20 Python
python清理子进程机制剖析
Nov 23 Python
Python3爬虫爬取百姓网列表并保存为json功能示例【基于request、lxml和json模块】
Dec 05 Python
python处理multipart/form-data的请求方法
Dec 26 Python
Python minidom模块用法示例【DOM写入和解析XML】
Mar 25 Python
python使用Plotly绘图工具绘制水平条形图
Mar 25 Python
使用python接入微信聊天机器人
Mar 31 Python
python 实现二维字典的键值合并等函数
Dec 06 Python
Python xlwt模块使用代码实例
Jun 10 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
真正根据utf8编码的规律来进行截取字符串的函数(utf8版sub_str )
2012/10/24 PHP
smarty模板中拼接字符串的方法
2014/02/14 PHP
PHP合并静态文件详解
2014/11/14 PHP
ThinkPHP进程计数类Process用法实例详解
2015/09/25 PHP
php实现微信公众号创建自定义菜单功能的实例代码
2019/06/11 PHP
php校验公钥是否可用的实例方法
2019/09/17 PHP
Javascript----文件操作
2007/01/18 Javascript
IE的有条件注释判定IE版本详解(附实例代码)
2012/01/04 Javascript
解析Javascript中中括号“[]”的多义性
2013/12/03 Javascript
js整数字符串转换为金额类型数据(示例代码)
2013/12/26 Javascript
两个select多选模式的选项相互移动(示例代码)
2014/01/11 Javascript
JS+CSS实现表格高亮的方法
2015/08/05 Javascript
js正则表达式验证邮件地址
2015/11/12 Javascript
12 款 JS 代码测试必备工具(翻译)
2016/12/13 Javascript
Javascript 对cookie操作详解及实例
2016/12/29 Javascript
ajax接收后台数据在html页面显示
2017/02/19 Javascript
JavaScript设计模式之策略模式详解
2017/06/09 Javascript
js匿名函数使用&传参(实例)
2017/09/08 Javascript
Koa项目搭建过程详细记录
2018/04/12 Javascript
使用webpack搭建react开发环境的方法
2018/05/15 Javascript
浅谈Angular6的服务和依赖注入
2018/06/27 Javascript
vue ssr 指南详读
2018/06/29 Javascript
keep-alive保持组件状态的方法
2020/12/02 Javascript
[05:31]干嘛呢兄弟!DOTA2 TI9语音轮盘部分出处
2019/05/14 DOTA
python字典序问题实例
2014/09/26 Python
Python字符串处理之count()方法的使用
2015/05/18 Python
pymssql数据库操作MSSQL2005实例分析
2015/05/25 Python
修复CentOS7升级Python到3.6版本后yum不能正确使用的解决方法
2018/01/26 Python
python按综合、销量排序抓取100页的淘宝商品列表信息
2018/02/24 Python
pyenv与virtualenv安装实现python多版本多项目管理
2019/08/17 Python
TensorFlow 显存使用机制详解
2020/02/03 Python
C语言中一个结构不能包含指向自己的指针吗
2012/05/25 面试题
优秀语文教师事迹
2014/05/18 职场文书
学期个人自我总结
2015/02/13 职场文书
运动会200米广播稿
2015/08/19 职场文书
PyMongo 查询数据的实现
2021/06/28 Python