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写的创建文件夹自定义函数mkdir()
Aug 25 Python
Python多进程编程技术实例分析
Sep 16 Python
python编程羊车门问题代码示例
Oct 25 Python
Python实现将数据框数据写入mongodb及mysql数据库的方法
Apr 02 Python
Python图像处理之识别图像中的文字(实例讲解)
May 10 Python
Pandas 合并多个Dataframe(merge,concat)的方法
Jun 08 Python
Python动态导入模块的方法实例分析
Jun 28 Python
代码实例讲解python3的编码问题
Jul 08 Python
python系列 文件操作的代码
Oct 06 Python
wxPython之wx.DC绘制形状
Nov 19 Python
Windows下PyCharm配置Anaconda环境(超详细教程)
Jul 31 Python
深入理解pytorch库的dockerfile
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
PHP图片库imagemagick安装方法
2014/09/23 PHP
php 实现301重定向跳转实例代码
2016/07/18 PHP
php/JS实现的生成随机密码(验证码)功能示例
2019/06/06 PHP
js word表格动态添加代码
2010/06/07 Javascript
JavaScript学习历程和心得小结
2010/08/16 Javascript
EXT窗口Window及对话框MessageBox
2011/01/27 Javascript
js实现文本框中输入文字页面中div层同步获取文本框内容的方法
2015/03/03 Javascript
js点击文本框后才加载验证码实例代码
2015/10/20 Javascript
基于jQuery实现仿51job城市选择功能实例代码
2016/03/02 Javascript
利用Angularjs中模块ui-route管理状态的方法
2016/12/27 Javascript
js实现复制功能(多种方法集合)
2018/01/06 Javascript
详解使用React.memo()来优化函数组件的性能
2019/03/19 Javascript
vue.js实现备忘录demo
2019/06/26 Javascript
js实现超级玛丽小游戏
2020/03/18 Javascript
[29:23]2014 DOTA2国际邀请赛中国区预选赛 LGD-GAMING VS CIS 第一场1
2014/05/23 DOTA
Python 抓取动态网页内容方案详解
2014/12/25 Python
Python中的zipfile模块使用详解
2015/06/25 Python
Python中字符串的格式化方法小结
2016/05/03 Python
Python中operator模块的操作符使用示例总结
2016/06/28 Python
Python3操作SQL Server数据库(实例讲解)
2017/10/21 Python
python实现日常记账本小程序
2018/03/10 Python
实例详解Matlab 与 Python 的区别
2019/04/26 Python
使用Python的OpenCV模块识别滑动验证码的缺口(推荐)
2019/05/10 Python
python单例设计模式实现解析
2020/01/07 Python
基于pytorch padding=SAME的解决方式
2020/02/18 Python
Django-xadmin后台导入json数据及后台显示信息图标和主题更改方式
2020/03/11 Python
python dict如何定义
2020/09/02 Python
python利用xpath爬取网上数据并存储到django模型中
2021/02/26 Python
CSS3 filter(滤镜)实现网页灰色或者黑色模式的代码
2020/11/30 HTML / CSS
美国首屈一指的礼品篮供应商:GiftTree
2018/01/06 全球购物
新年晚会主持词
2014/03/24 职场文书
普通党员群众路线教育实践活动心得体会
2014/11/04 职场文书
2019年英语版感谢信(8篇)
2019/09/29 职场文书
使用php的mail()函数实现发送邮件功能
2021/06/03 PHP
MySQL表类型 存储引擎 的选择
2021/11/11 MySQL
Spring Cloud OpenFeign模版化客户端
2022/06/25 Java/Android