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中元类用法实例
Oct 10 Python
Django imgareaselect手动剪切头像实现方法
May 26 Python
实践Python的爬虫框架Scrapy来抓取豆瓣电影TOP250
Jan 20 Python
分享python数据统计的一些小技巧
Jul 21 Python
fastcgi文件读取漏洞之python扫描脚本
Apr 23 Python
Python单元测试实例详解
May 25 Python
python爬虫的数据库连接问题【推荐】
Jun 25 Python
Python单元和文档测试实例详解
Apr 11 Python
Django 用户认证组件使用详解
Jul 23 Python
将自己的数据集制作成TFRecord格式教程
Feb 17 Python
python不同系统中打开方法
Jun 23 Python
opencv 分类白天与夜景视频的方法
Jun 05 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中3种生成XML文件方法的速度效率比较
2012/10/06 PHP
Javascript的构造函数和constructor属性
2010/01/09 Javascript
js 字符串转化成数字的代码
2011/06/29 Javascript
NodeJS框架Express的模板视图机制分析
2011/07/19 NodeJs
jquery中map函数遍历数组用法实例
2015/05/18 Javascript
EditPlus 正则表达式 实战(3)
2016/12/15 Javascript
AngularJS之ionic 框架下实现 Localstorage本地存储
2017/04/22 Javascript
Vue.js中数据绑定的语法教程
2017/06/02 Javascript
JS实现的文字间歇循环滚动效果完整示例
2018/02/13 Javascript
Koa项目搭建过程详细记录
2018/04/12 Javascript
vue cli3.0结合echarts3.0与地图的使用方法示例
2019/03/26 Javascript
微信小程序动态添加和删除组件的现实
2020/02/28 Javascript
[00:23]魔方之谜解锁款式
2018/12/20 DOTA
[33:09]完美世界DOTA2联赛循环赛 Forest vs DM BO2第二场 10.29
2020/10/29 DOTA
python类继承与子类实例初始化用法分析
2015/04/17 Python
Python 字典与字符串的互转实例
2017/01/13 Python
python安装教程 Pycharm安装详细教程
2017/05/02 Python
python计算两个地址之间的距离方法
2018/06/09 Python
Python2.7.10以上pip更新及其他包的安装教程
2018/06/12 Python
python实现时间o(1)的最小栈的实例代码
2018/07/23 Python
python ftp 按目录结构上传下载的实现代码
2018/09/12 Python
10款最好的Python开发编辑器
2019/07/03 Python
简单了解python代码优化小技巧
2019/07/08 Python
Python Pandas 如何shuffle(打乱)数据
2019/07/30 Python
Python(PyS60)实现简单语音整点报时
2019/11/18 Python
浅析python标准库中的glob
2020/03/13 Python
python 轮询执行某函数的2种方式
2020/05/03 Python
HTML5 背景的显示区域实现
2020/07/09 HTML / CSS
金宝贝童装官网:Gymboree
2016/08/31 全球购物
美国第一大药店连锁机构:Walgreens(沃尔格林)
2019/10/10 全球购物
机电专业个人自荐信格式模板
2013/09/23 职场文书
物业公司采购员岗位职责
2013/12/31 职场文书
读书活动实施方案
2014/03/10 职场文书
就业协议书的作用
2014/04/11 职场文书
2014年个人业务工作总结
2014/11/17 职场文书
故意伤害人身损害赔偿协议书
2014/11/19 职场文书