AsyncGenerator abstractmethods typechecked as coroutine incorrectly

[SandyChapman]

I'm trying to define an abstract base class with an abstractmethod that returns an AsyncGenerator. The typechecker appears to operate inconsistently between usages of the abstract base vs concrete implementations.

E.g.

"""Base class for Extractors."""

import abc
from typing import AsyncGenerator
import asyncio


class AbstractBase(abc.ABC):
    """ABC for Extractors."""

    @abc.abstractmethod
    async def get_entries(self) -> AsyncGenerator[str, None]:
        """Retrieves all of the entries given by this extractor."""
        ...

class Concrete(AbstractBase):

    async def get_entries(self) -> AsyncGenerator[str, None]:
        await asyncio.sleep(0.5)
        yield "Implement2-1"
        await asyncio.sleep(1.5)
        yield "Implement2-2"

async def async_main(base: AbstractBase):
    async for x in base.get_entries():  # "Coroutine[Any, Any, AsyncGenerator[str, None]]" is not iterable  "__aiter__" method not defined reportGeneralTypeIssues
        print(x)
    async for x in Concrete().get_entries():
        print(x)


def main():
    impl = Concrete()
    asyncio.run(async_main(impl))

if __name__ == '__main__':
    main()

Removing async from the abstractmethod causes the error to disappear, but I don't believe this is the correct annotation (and pylint also reports it as an error that the base class signature does not match the concrete class). This doesn't appear to report an error when running pyright 1.1.208 directly.

pyrightconfig.json:

{
    "typeCheckingMode": "basic"
}

I'm running Pylance v2022.1.3 on VS Code Version: 1.63.2 (Universal) (Mac OS)

[erictraut]

The problem is that the abstract method is missing a yield statement, so it's being treated differently. If you add a yield "" statement before the ..., it will work as expected. Without a yield statement, it's not considered a generator. Given that you've annotated it explicitly as returning a generator object, it should probably still be considered a generator. I'll look into fixing that.

For what it's worth, mypy issues the same error in this case.

[SandyChapman]

Thanks, @erictraut ! This seems like a less common usage, so thanks for addressing it.

[erictraut]

I've added special-case code to handle this condition. It will be fixed in the next release.

[debonte]

This issue was fixed in version 2022.1.5. You can find the changelog here: CHANGELOG.md

[nbilgrien-hbs]

This still appears to be a problem. Here is a minimum example:

from abc import abstractmethod
from collections.abc import AsyncGenerator


class A():
    @abstractmethod
    async def foo() -> AsyncGenerator[int, None]:
        pass


    async def bar(self):
        generator = self.foo()
        async for i in generator:
            print(i)

I am on the vscode pylance extension version v2024.11.3

[rchiodo]

It seems the pass is not supported. If you change it to this it works:

from abc import abstractmethod
from collections.abc import AsyncGenerator


class A():
    @abstractmethod
    async def foo() -> AsyncGenerator[int, None]:
        ...


    async def bar(self):
        generator = self.foo()
        async for i in generator:
            print(i)