1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------
import collections.abc
import logging
from typing import (
Iterable,
AsyncIterator,
TypeVar,
Callable,
Tuple,
Optional,
Awaitable,
Any,
)
from .exceptions import AzureError
_LOGGER = logging.getLogger(__name__)
ReturnType = TypeVar("ReturnType")
ResponseType = TypeVar("ResponseType")
__all__ = ["AsyncPageIterator", "AsyncItemPaged"]
class AsyncList(AsyncIterator[ReturnType]):
def __init__(self, iterable: Iterable[ReturnType]) -> None:
"""Change an iterable into a fake async iterator.
Could be useful to fill the async iterator contract when you get a list.
:param iterable: A sync iterable of T
"""
# Technically, if it's a real iterator, I don't need "iter"
# but that will cover iterable and list as well with no troubles created.
self._iterator = iter(iterable)
async def __anext__(self) -> ReturnType:
try:
return next(self._iterator)
except StopIteration as err:
raise StopAsyncIteration() from err
class AsyncPageIterator(AsyncIterator[AsyncIterator[ReturnType]]):
def __init__(
self,
get_next: Callable[[Optional[str]], Awaitable[ResponseType]],
extract_data: Callable[[ResponseType], Awaitable[Tuple[str, AsyncIterator[ReturnType]]]],
continuation_token: Optional[str] = None,
) -> None:
"""Return an async iterator of pages.
:param get_next: Callable that take the continuation token and return a HTTP response
:param extract_data: Callable that take an HTTP response and return a tuple continuation token,
list of ReturnType
:param str continuation_token: The continuation token needed by get_next
"""
self._get_next = get_next
self._extract_data = extract_data
self.continuation_token = continuation_token
self._did_a_call_already = False
self._response: Optional[ResponseType] = None
self._current_page: Optional[AsyncIterator[ReturnType]] = None
async def __anext__(self) -> AsyncIterator[ReturnType]:
if self.continuation_token is None and self._did_a_call_already:
raise StopAsyncIteration("End of paging")
try:
self._response = await self._get_next(self.continuation_token)
except AzureError as error:
if not error.continuation_token:
error.continuation_token = self.continuation_token
raise
self._did_a_call_already = True
self.continuation_token, self._current_page = await self._extract_data(self._response)
# If current_page was a sync list, wrap it async-like
if isinstance(self._current_page, collections.abc.Iterable):
self._current_page = AsyncList(self._current_page)
return self._current_page
class AsyncItemPaged(AsyncIterator[ReturnType]):
def __init__(self, *args: Any, **kwargs: Any) -> None:
"""Return an async iterator of items.
args and kwargs will be passed to the AsyncPageIterator constructor directly,
except page_iterator_class
"""
self._args = args
self._kwargs = kwargs
self._page_iterator: Optional[AsyncIterator[AsyncIterator[ReturnType]]] = None
self._page: Optional[AsyncIterator[ReturnType]] = None
self._page_iterator_class = self._kwargs.pop("page_iterator_class", AsyncPageIterator)
def by_page(
self,
continuation_token: Optional[str] = None,
) -> AsyncIterator[AsyncIterator[ReturnType]]:
"""Get an async iterator of pages of objects, instead of an async iterator of objects.
:param str continuation_token:
An opaque continuation token. This value can be retrieved from the
continuation_token field of a previous generator object. If specified,
this generator will begin returning results from this point.
:returns: An async iterator of pages (themselves async iterator of objects)
:rtype: AsyncIterator[AsyncIterator[ReturnType]]
"""
return self._page_iterator_class(*self._args, **self._kwargs, continuation_token=continuation_token)
async def __anext__(self) -> ReturnType:
if self._page_iterator is None:
self._page_iterator = self.by_page()
return await self.__anext__()
if self._page is None:
# Let it raise StopAsyncIteration
self._page = await self._page_iterator.__anext__()
return await self.__anext__()
try:
return await self._page.__anext__()
except StopAsyncIteration:
self._page = None
return await self.__anext__()
|
