type issue: "StreamGenerator" is not iterable

[shooit]

This issue was introduced with the changes in 2.17.0. It exists for each of the pyright version I tested at random.

It is only a type issue -- the code behaves as expected.

Environment details

• OS type and version: MacOS
• Python version: python --version 3.11.7
• pip version: pip --version poetry
• google-cloud-firestore version: pip show google-cloud-firestore 2.17.0
• pyright version: 1.1.375

Steps to reproduce

1. Setup environment as above
2. Run pyright

Code example

client = firestore_v1.Client()


def example():
    collection = client.collection("foo")
    docs = collection.stream()
    for doc in docs:
        print(doc)

Error message

eample.py
  example.py:7:20 - error: "StreamGenerator" is not iterable
    "__next__" method not defined on type "DocumentSnapshot" (reportGeneralTypeIssues)

[daniel-sanche]

Thanks for letting us know. We're aware that the type annotations for this repo are currently broken. But @Linchin is working on some changes related to the StreamGenerator, so maybe this can be addressed there

[Linchin]

The type annotation changes in #938 should be able to resolve this error, but I don't think this single PR will clean up all existing type annotation errors.

[jekozyra]

fyi, this is broken for AsyncStreamGenerator as well.

[Linchin]

It can be fixed by adding type annotation to the init function of StreamGenerator here. I'm still not 100% sure, but it feels like pyright is trying to infer the parameter type, but somehow wasn't correct (probably due to other type annotation errors.)