aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/msrest/paging.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/msrest/paging.py')
-rw-r--r--.venv/lib/python3.12/site-packages/msrest/paging.py146
1 files changed, 146 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/msrest/paging.py b/.venv/lib/python3.12/site-packages/msrest/paging.py
new file mode 100644
index 00000000..c654ba34
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/msrest/paging.py
@@ -0,0 +1,146 @@
+# --------------------------------------------------------------------------
+#
+# 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 sys
+try:
+ from collections.abc import Iterator
+ xrange = range
+except ImportError:
+ from collections import Iterator
+
+from typing import Dict, Any, List, Callable, Optional, TYPE_CHECKING # pylint: disable=unused-import
+
+from .serialization import Deserializer
+from .pipeline import ClientRawResponse
+
+if TYPE_CHECKING:
+ from .universal_http import ClientResponse # pylint: disable=unused-import
+ from .serialization import Model # pylint: disable=unused-import
+
+if sys.version_info >= (3, 5, 2):
+ # Not executed on old Python, no syntax error
+ from .async_paging import AsyncPagedMixin # type: ignore
+else:
+ class AsyncPagedMixin(object): # type: ignore
+ pass
+
+class Paged(AsyncPagedMixin, Iterator):
+ """A container for paged REST responses.
+
+ :param ClientResponse response: server response object.
+ :param callable command: Function to retrieve the next page of items.
+ :param dict classes: A dictionary of class dependencies for
+ deserialization.
+ :param dict raw_headers: A dict of raw headers to add if "raw" is called
+ """
+ _validation = {} # type: Dict[str, Dict[str, Any]]
+ _attribute_map = {} # type: Dict[str, Dict[str, Any]]
+
+ def __init__(self, command, classes, raw_headers=None, **kwargs):
+ # type: (Callable[[str], ClientResponse], Dict[str, Model], Dict[str, str], Any) -> None
+ super(Paged, self).__init__(**kwargs) # type: ignore
+ # Sets next_link, current_page, and _current_page_iter_index.
+ self.next_link = ""
+ self._current_page_iter_index = 0
+ self.reset()
+ self._derserializer = Deserializer(classes)
+ self._get_next = command
+ self._response = None # type: Optional[ClientResponse]
+ self._raw_headers = raw_headers
+
+ def __iter__(self):
+ """Return 'self'."""
+ # Since iteration mutates this object, consider it an iterator in-and-of
+ # itself.
+ return self
+
+ @classmethod
+ def _get_subtype_map(cls):
+ """Required for parity to Model object for deserialization."""
+ return {}
+
+ @property
+ def raw(self):
+ # type: () -> ClientRawResponse
+ """Get current page as ClientRawResponse.
+
+ :rtype: ClientRawResponse
+ """
+ raw = ClientRawResponse(self.current_page, self._response)
+ if self._raw_headers:
+ raw.add_headers(self._raw_headers)
+ return raw
+
+ def get(self, url):
+ # type: (str) -> List[Model]
+ """Get an arbitrary page.
+
+ This resets the iterator and then fully consumes it to return the
+ specific page **only**.
+
+ :param str url: URL to arbitrary page results.
+ """
+ self.reset()
+ self.next_link = url
+ return self.advance_page()
+
+ def reset(self):
+ # type: () -> None
+ """Reset iterator to first page."""
+ self.next_link = ""
+ self.current_page = [] # type: List[Model]
+ self._current_page_iter_index = 0
+
+ def advance_page(self):
+ # type: () -> List[Model]
+ """Force moving the cursor to the next azure call.
+
+ This method is for advanced usage, iterator protocol is preferred.
+
+ :raises: StopIteration if no further page
+ :return: The current page list
+ :rtype: list
+ """
+ if self.next_link is None:
+ raise StopIteration("End of paging")
+ self._current_page_iter_index = 0
+ self._response = self._get_next(self.next_link)
+ self._derserializer(self, self._response)
+ return self.current_page
+
+ def __next__(self):
+ """Iterate through responses."""
+ # Storing the list iterator might work out better, but there's no
+ # guarantee that some code won't replace the list entirely with a copy,
+ # invalidating an list iterator that might be saved between iterations.
+ if self.current_page and self._current_page_iter_index < len(self.current_page):
+ response = self.current_page[self._current_page_iter_index]
+ self._current_page_iter_index += 1
+ return response
+ else:
+ self.advance_page()
+ return self.__next__()
+
+ next = __next__ # Python 2 compatibility.