Queue.asyncio ValueError:task_done()被调用太多次-编码错误或检测到错误?

时间:2018-11-09 01:39:03

标签: python pytest python-asyncio python-3.7 pytest-asyncio

我实现了一段代码,该代码从一个Queue中获取一个元素,并将同一对象从队列列表中放入每个队列中。问题是,当我运行特定的测试时,我遇到了ValueError: task_done() called too many times异常。此错误发生在测试代码中,而不是在被测试的代码中。

我正在使用asyncio.Queue,并使用协程进行编程。 我将每个Queue.get与一个完全相同的Queue.task_done通话相匹配。 我正在用 pytest 测试代码。

我正在使用以下库:

  • Python 3.7
  • pytest == 3.10.0
  • pytest-asyncio == 0.9.0

我有两个文件:middleware.py包含我的类实现,test_middleware.py实现 pytest 测试。

文件middlware.py

import asyncio

class DistributorMiddleware:

    def __init__(self, in_queue, out_list_queue):
        self._in = in_queue
        self._out = out_list_queue

    async def distribute(self):

        while True:
            ele = await self._in.get()
            count=0
            for queue in self._out:
                await queue.put(ele)
                count+=1
                print(f'inserted ele in {count}')
            queue.task_done()
            if ele == None:
                break
        for queue in self._out:
            await queue.join()

文件test_middleware.py

import pytest
import asyncio                
from asyncio import Queue
from middleware import DistributorMiddleware
import random
import os


@pytest.mark.asyncio                                                                                     
async def test_distribution(request, event_loop):                                                        
    q_list = [ Queue() for _ in range(10) ]                                                              
    _in = Queue()
    distrib = DistributorMiddleware(_in, q_list)                                                         
    event_loop.create_task(distrib.distribute())                                                         
    num_ele = random.randint(1, 10)
    ele_set = set()
    for _ in range(num_ele):                                                                             
        ele = os.urandom(4)                                                                              
        ele_set.add(ele)
        await _in.put(ele)
    await _in.put(None)                                                                                  
    await asyncio.sleep(1)                                                                               

    for i,q in enumerate(q_list):
        assert q.qsize() == num_ele + 1
        c_set = ele_set.copy()
        count= 0
        while True:
            e = await q.get()
            count+=1
            print(f'Queue {i}: element: "{e}" number {count} extracted of {q.qsize()}!')
            q.task_done()
            if e == None:
                break
            assert e in c_set
            c_set.remove(e)

在测试中,中间件应从输入队列中获取元素,并将其放入列表中的10个队列中。并且可以正常工作。

测试代码从10个队列中的每个队列中获取所有元素,并检查它们是否存在于原始队列中。对于前9个队列,一切顺利,没有错误,但是当测试尝试从第十个列表中获取第一个元素时,将引发ValueError

request = <FixtureRequest for <Function 'test_distribution'>>, event_loop = <_UnixSelectorEventLoop running=False closed=False debug=False>

    @pytest.mark.asyncio
    async def test_distribution(request, event_loop):
        q_list = [ Queue() for _ in range(10) ]
        _in = Queue()
        distrib = DistributorMiddleware(_in, q_list)
        event_loop.create_task(distrib.distribute())
        num_ele = random.randint(1, 10)
        ele_set = set()
        for _ in range(num_ele):
            ele = os.urandom(4)
            ele_set.add(ele)
            await _in.put(ele)
        await _in.put(None)
        await asyncio.sleep(1)

        for i,q in enumerate(q_list):
            assert q.qsize() == num_ele + 1
            c_set = ele_set.copy()
            count= 0
            while True:
                e = await q.get()
                count+=1
                print(f'Queue {i}: element: "{e}" number {count} extracted of {q.qsize()}!')
>               q.task_done()

test_middlewares.py:34: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <Queue at 0x7f7af5b9d828 maxsize=0 _queue=[b'\x15\xad\t\xaf', b'\x8b\xa2M=', None]>

    def task_done(self):
        """Indicate that a formerly enqueued task is complete.

        Used by queue consumers. For each get() used to fetch a task,
        a subsequent call to task_done() tells the queue that the processing
        on the task is complete.

        If a join() is currently blocking, it will resume when all items have
        been processed (meaning that a task_done() call was received for every
        item that had been put() into the queue).

        Raises ValueError if called more times than there were items placed in
        the queue.
        """
        if self._unfinished_tasks <= 0:
>           raise ValueError('task_done() called too many times')
E           ValueError: task_done() called too many times

/usr/lib/python3.7/asyncio/queues.py:202: ValueError

每个get与一个task_done匹配。我可以验证对test_middlware.py文件进行以下修改:

-            q.task_done()
+            try:
+                q.task_done()
+            except ValueError as err:
+                print(f'Value Error: {err}')
+                print(q.qsize())

这样做,即使看到许多ValueError被提出,元素仍会从队列中检索出来。测试成功:

platform linux -- Python 3.7.1, pytest-3.10.0, py-1.7.0, pluggy-0.8.0
rootdir: /tmp/stack, inifile:
plugins: asyncio-0.9.0
collected 1 item                                                                                                                                                                                                  

test_middlewares.py .                                                                                                                                                                                       [100%]

============================================================================================ 1 passed in 1.04 seconds =============================================================================================

为确保测试使用了所有列表中的所有元素,我在测试结束时强加了一个错误,使其添加错误的断言:

             assert e in c_set
             c_set.remove(e)

+    assert False == True
+

结果输出表明,从所有列表中检索了所有元素,但是最后一个队列上的每个task_done都生成一个ValueError

Queue 7: element: "b'\x9b\xf8m\x02'" number 1 extracted of 3!
Queue 7: element: "b'\x15\xad\t\xaf'" number 2 extracted of 2!
Queue 7: element: "b'\x8b\xa2M='" number 3 extracted of 1!
Queue 7: element: "None" number 4 extracted of 0!
Queue 8: element: "b'\x9b\xf8m\x02'" number 1 extracted of 3!
Queue 8: element: "b'\x15\xad\t\xaf'" number 2 extracted of 2!
Queue 8: element: "b'\x8b\xa2M='" number 3 extracted of 1!
Queue 8: element: "None" number 4 extracted of 0!
Queue 9: element: "b'\x9b\xf8m\x02'" number 1 extracted of 3!
============================================================================================ 1 failed in 1.06 seconds ==

问题是,我是否缺少某些内容,我的代码中有错误还是我发现了错误?

1 个答案:

答案 0 :(得分:2)

您的代码中有错误。实际上,queue.task_done()仅应在将元素带出到队列中时调用,而不是在将它们放入队列中时调用。

但是您的中间件类正在.put()列表中的最后一个队列中,在刚刚使用self._out的队列上调用它;从queue.task_done()中删除DistributorMiddleware.distribute()呼叫:

async def distribute(self):

    while True:
        ele = await self._in.get()
        count=0
        for queue in self._out:
            await queue.put(ele)
            count+=1
            print(f'inserted ele in {count}')
        queue.task_done()
        # ^^^^^ you didn't take anything from the queue here!

删除该行时,您的测试通过。

看到 test 中引发异常的原因是,只有这样队列才知道task_done()被频繁调用。 queue.task_done()中的DistributorMiddleware.distribute()调用将未完成的任务计数器递减1,但是只有当该计数器降至低于零时,才能检测到异常。而且,只有在test_distribution()中将最后一个任务从队列中取出后,您才到达该点,此时未完成的任务计数器至少过早地达到了0。

也许是要打电话给self._in.task_done()吗?您确实只是在while循环中从队列中取出了一个元素:

async def distribute(self):

    while True:
        ele = await self._in.get()
        # getting an element from self._in
        count=0
        for queue in self._out:
            await queue.put(ele)
            count+=1
            print(f'inserted ele in {count}')
        self._in.task_done()
        # done with ele, so decrement the self._in unfinished tasks counter