File: test_paging.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (132 lines) | stat: -rw-r--r-- 5,101 bytes parent folder | download
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
# --------------------------------------------------------------------------
#
# 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.
#
# --------------------------------------------------------------------------

from azure.core.paging import ItemPaged
from azure.core.exceptions import HttpResponseError

import pytest


class TestPaging(object):
    def test_basic_paging(self):
        def get_next(continuation_token=None):
            """Simplify my life and return JSON and not response, but should be response."""
            if not continuation_token:
                return {"nextLink": "page2", "value": ["value1.0", "value1.1"]}
            else:
                return {"nextLink": None, "value": ["value2.0", "value2.1"]}

        def extract_data(response):
            return response["nextLink"], iter(response["value"])

        pager = ItemPaged(get_next, extract_data)
        result_iterated = list(pager)

        assert ["value1.0", "value1.1", "value2.0", "value2.1"] == result_iterated

    def test_by_page_paging(self):
        def get_next(continuation_token=None):
            """Simplify my life and return JSON and not response, but should be response."""
            if not continuation_token:
                return {"nextLink": "page2", "value": ["value1.0", "value1.1"]}
            else:
                return {"nextLink": None, "value": ["value2.0", "value2.1"]}

        def extract_data(response):
            return response["nextLink"], iter(response["value"])

        pager = ItemPaged(get_next, extract_data).by_page()
        page1 = next(pager)
        assert list(page1) == ["value1.0", "value1.1"]

        page2 = next(pager)
        assert list(page2) == ["value2.0", "value2.1"]

        with pytest.raises(StopIteration):
            next(pager)

    def test_advance_paging(self):
        def get_next(continuation_token=None):
            """Simplify my life and return JSON and not response, but should be response."""
            if not continuation_token:
                return {"nextLink": "page2", "value": ["value1.0", "value1.1"]}
            else:
                return {"nextLink": None, "value": ["value2.0", "value2.1"]}

        def extract_data(response):
            return response["nextLink"], iter(response["value"])

        pager = ItemPaged(get_next, extract_data)
        page1 = next(pager)
        assert page1 == "value1.0"
        page1 = next(pager)
        assert page1 == "value1.1"

        page2 = next(pager)
        assert page2 == "value2.0"
        page2 = next(pager)
        assert page2 == "value2.1"

        with pytest.raises(StopIteration):
            next(pager)

    def test_none_value(self):
        def get_next(continuation_token=None):
            return {"nextLink": None, "value": None}

        def extract_data(response):
            return response["nextLink"], iter(response["value"] or [])

        pager = ItemPaged(get_next, extract_data)
        result_iterated = list(pager)
        assert len(result_iterated) == 0

    def test_print(self):
        def get_next(continuation_token=None):
            return {"nextLink": None, "value": None}

        def extract_data(response):
            return response["nextLink"], iter(response["value"] or [])

        pager = ItemPaged(get_next, extract_data)
        output = repr(pager)
        assert output.startswith("<iterator object azure.core.paging.ItemPaged at")

    def test_paging_continue_on_error(self):
        def get_next(continuation_token=None):
            if not continuation_token:
                return {"nextLink": "foo", "value": ["bar"]}
            else:
                raise HttpResponseError()

        def extract_data(response):
            return response["nextLink"], iter(response["value"] or [])

        pager = ItemPaged(get_next, extract_data)
        assert next(pager) == "bar"
        with pytest.raises(HttpResponseError) as err:
            next(pager)
        assert err.value.continuation_token == "foo"