Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

L103 Draft: Add Types to the remainder of the gRPC Python API Surface #337

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions L103-python-add-typing-to-sync-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
Add Typing to gRPC Python Sync API
----
* Author(s): XuanWnag-Amos
* Approver: gnossen
* Status: Draft
* Implemented in: Python
* Last updated: 11/10/2022
* Discussion at: <google group thread> (filled after thread exists)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder to create the Google group thread once the gRFC is in a presentable state.


## Abstract

Add type annotations to the remainder of the gRPC Python API.

## Background

[Type Hints](https://peps.python.org/pep-0484/#union-types) was introduced for a while now, we already added type annotation to python Async APIs since it has a high enough version floor. Now it's time to do the same for Sync APIs.

This proposal plans to add type annotation to python Sync public APIs which allows users to build safer code by running static type analysis tools.


### Related Proposals:
* Loosely related to [Async API proposal](https://github.com/lidizheng/proposal/blob/grpc-python-async-api/L58-python-async-api.md#introduce-typing-to-generated-code).
* The proposal includes the part to introduce typing to gRPC Python Async APIs.


## Proposal

Add type annotation to the following:
* All public Python APIs listed in [`__all__` variable](https://github.com/grpc/grpc/blob/54dd7563c2d563bff74e4b558f2e985db4a01f2d/src/python/grpcio/grpc/__init__.py#L2100) (the actuall list is too long, please refer to the following PR for changes):
* [PR link holder]
* gRPC Python generated Code.
* [PR Link holder]
* Python ancillary packages.
XuanWang-Amos marked this conversation as resolved.
Show resolved Hide resolved
* [PR link holder]

## Rationale

The alternative is keep APIs in Sync stack unchanged and without type annotation, this way users won't be able to know if their implementation is correct or not without actually running the code.

After add type annotation, instead of original un-typed API (`UnaryUnaryMultiCallable.__call__`):
```python
@abc.abstractmethod
def __call__(self,
request,
timeout=None,
metadata=None,
credentials=None,
wait_for_ready=None,
compression=None):
```

We'll have typed API which will looks like this:
```python
@abc.abstractmethod
def __call__(self,
request: RequestType,
timeout: Optional[float] = None,
metadata: Optional[MetadataType] = None,
credentials: Optional[CallCredentials] = None,
wait_for_ready: Optional[bool] = None,
compression: Optional[Compression] = None) -> ResponseType:
```

## Implementation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once it exists, the implementation PR should be linked to here.


* Add typing to internal APIs.
* [PR1: Add typing for some internal python files.](https://github.com/grpc/grpc/pull/31514)
* Add typing to public API and test though pre-release.
XuanWang-Amos marked this conversation as resolved.
Show resolved Hide resolved
* [PR link holder]
* Release typed public APIs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider writing a blog post about this on grpc.io once it's finished.

CC @tmwilson


## Open issues (if applicable)

N/A