Async Stub Annotations #611
Conversation
|
See #536 for more discussion |
|
As I always say, the answer is always in github issues I added |
|
@nipunn1313 bumping this back to the top. |
|
|
||
| def __init__(self, channel: typing.Union[grpc.Channel, grpc.aio.Channel]) -> None: ... | ||
| UnaryUnary: grpc.UnaryUnaryMultiCallable[ | ||
| _MTVDummyService0 = typing_extensions.TypeVar( |
There was a problem hiding this comment.
don't love the name here. Is there a way to make the naming based on the service name / method name - rather than these iterating numbers?
Perhaps instead of {i} use the {method.name}
MTV also feels rather opaque. "MethodTypeVar" isn't particularly useful to the enduser (who will probably see these types when hovering around in vscode).
Perhaps we don't need the "_MTV" prefix at all?
There was a problem hiding this comment.
It's been a while so I'm going to have to remember why I did the naming like that. I know I wasn't a huge fan of it, but wanted to get something down on paper. Let me see what it looks like to not have the prefix.
There was a problem hiding this comment.
Ok here we go. I had to keep the leading underscore because of stubtest (left a comment with the SO explaining it, couldn't actually find it in stubtest docs, didn't look too long). So now it is just _ServiceNameMethodNameType which shouldn't conflict. Also cleaned it up so the typevar name building so it is more maintainable.
| @@ -53,7 +53,7 @@ async def test_grpc() -> None: | |||
| server = make_server() | |||
| await server.start() | |||
| async with grpc.aio.insecure_channel(ADDRESS) as channel: | |||
| client: dummy_pb2_grpc.DummyServiceAsyncStub = dummy_pb2_grpc.DummyServiceStub(channel) # type: ignore | |||
| client = dummy_pb2_grpc.DummyServiceStub(channel) | |||
|
sorry for the delay - I hadn't been focusing on this for a while (I'm unlikely to be highly responsive, but this very-long-wait isn't expected in general - aplogies). The PR now requires a rebase. On the whole this looks - great. Some requests. |
TypeVars have defaults to match expected behavior Overload init methods to get expected types back Create AsyncStub type alias Signed-off-by: Aidan Jensen <aidan@artificial.com>
Signed-off-by: Aidan Jensen <aidan@artificial.com>
Signed-off-by: Aidan Jensen <aidan@artificial.com>
Signed-off-by: Aidan Jensen <aidan@artificial.com>
artificial-aidan
force-pushed
the
aidan/async-stub-overload
branch
from
501d032
to
883de94
Compare
Signed-off-by: Aidan Jensen <aidan@artificial.com>
Signed-off-by: Aidan Jensen <aidan@artificial.com>
Rebased, let me know if you want me to squash or clean up any before you merge. |
|
Ok let's do it! |
|
Appreciate this one @nipunn1313 and @artificial-aidan! Looks promising for good grpc Python types |
This was a fun one, I think I've maintained existing behavior, while made it better to use. Initializing with an async channel will now get you the correct type without casting.
I found an issue with the negative tests, there seems to be some ambiguity about the note that mypy is returning, so it intermittently fails