diff options
| author | Lidi Zheng <lidiz@google.com> | 2020-06-02 15:06:04 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-02 22:06:04 +0000 |
| commit | dd9b2f38a70e85952cc05552ec8070cdf29ddbb4 (patch) | |
| tree | 91de6df237390c1c3fb1588fa6fd06b8707d9113 /docs | |
| parent | 7be1e59e9d75c112f346d2b76dce3dd60e3584a1 (diff) | |
| download | python-api-core-dd9b2f38a70e85952cc05552ec8070cdf29ddbb4.tar.gz | |
feat: AsyncIO Integration [Part 2] (#28)
Children PR of https://github.com/googleapis/python-api-core/pull/26.
This PR includes AsyncIO version of:
* Polling future
* Page iterator
The AsyncIO version of polling future still uses the same mechanism as the sync version. The AsyncIO polling future tries to update its own state whenever the application want to access information or perform actions.
For page iterator, it has similar interface design as sync version. But instead of fulfilling normal generator protocol, it is based on the async generator.
Related #23
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/futures.rst | 6 | ||||
| -rw-r--r-- | docs/operation.rst | 7 | ||||
| -rw-r--r-- | docs/page_iterator.rst | 7 |
3 files changed, 19 insertions, 1 deletions
diff --git a/docs/futures.rst b/docs/futures.rst index 7a43da9..d0dadac 100644 --- a/docs/futures.rst +++ b/docs/futures.rst @@ -7,4 +7,8 @@ Futures .. automodule:: google.api_core.future.polling :members: - :show-inheritance:
\ No newline at end of file + :show-inheritance: + +.. automodule:: google.api_core.future.async_future + :members: + :show-inheritance: diff --git a/docs/operation.rst b/docs/operation.rst index c5e6766..492cf67 100644 --- a/docs/operation.rst +++ b/docs/operation.rst @@ -4,3 +4,10 @@ Long-Running Operations .. automodule:: google.api_core.operation :members: :show-inheritance: + +Long-Running Operations in AsyncIO +------------------------------------- + +.. automodule:: google.api_core.operation_async + :members: + :show-inheritance: diff --git a/docs/page_iterator.rst b/docs/page_iterator.rst index 28842da..3652e6d 100644 --- a/docs/page_iterator.rst +++ b/docs/page_iterator.rst @@ -4,3 +4,10 @@ Page Iterators .. automodule:: google.api_core.page_iterator :members: :show-inheritance: + +Page Iterators in AsyncIO +------------------------- + +.. automodule:: google.api_core.page_iterator_async + :members: + :show-inheritance: |