File: test_paginate.py

package info (click to toggle)
python-paginate 0.5.7-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 152 kB
  • sloc: python: 663; makefile: 2
file content (350 lines) | stat: -rw-r--r-- 15,135 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# -*- coding: utf-8 -*-

# Copyright (c) 2007-2012 Christoph Haas <email@christoph-haas.de>
# See the file LICENSE for copying permission.

""""Test paginate module."""
import pytest
import paginate

def test_wrong_collection():
    """Test whether an empty list is handled correctly."""
    with pytest.raises(TypeError):
        page = paginate.Page({}, page=0)


def test_empty_list():
    """Test whether an empty list is handled correctly."""
    items = []
    page = paginate.Page(items, page=0)
    assert page.page == 1
    assert page.first_item is None
    assert page.last_item is None
    assert page.first_page is None
    assert page.last_page is None
    assert page.previous_page is None
    assert page.next_page is None
    assert page.items_per_page == 20
    assert page.item_count == 0
    assert page.page_count == 0
    assert page.pager(url="http://example.org/page=$page") == ''
    assert page.pager(url="http://example.org/page=$page",
                      show_if_single_page=True) == ''


def test_one_page():
    """Test that fits 10 items on a single 10-item page."""
    items = range(10)
    page = paginate.Page(items, page=0, items_per_page=10)
    url = "http://example.org/foo/page=$page"
    assert page.page == 1
    assert page.first_item == 1
    assert page.last_item == 10
    assert page.first_page == 1
    assert page.last_page == 1
    assert page.previous_page is None
    assert page.next_page is None
    assert page.items_per_page == 10
    assert page.item_count == 10
    assert page.page_count == 1
    assert page.pager(url=url) == ''
    assert page.pager(url=url, show_if_single_page=True) == '1'


def test_many_pages():
    """Test that fits 100 items on seven pages consisting of 15 items."""
    items = range(100)
    page = paginate.Page(items, page=0, items_per_page=15)
    url = "http://example.org/foo/page=$page"
    assert hasattr(page.collection_type, '__iter__') is True
    assert page.page == 1
    assert page.first_item == 1
    assert page.last_item == 15
    assert page.first_page == 1
    assert page.last_page == 7
    assert page.previous_page is None
    assert page.next_page == 2
    assert page.items_per_page == 15
    assert page.item_count == 100
    assert page.page_count == 7
    assert page.pager(
        url=url) == '1 <a href="http://example.org/foo/page=2">2</a> <a href="http://example.org/foo/page=3">3</a> .. <a href="http://example.org/foo/page=7">7</a>'
    assert page.pager(url=url,
                      separator='_') == '1_<a href="http://example.org/foo/page=2">2</a>_<a href="http://example.org/foo/page=3">3</a>_.._<a href="http://example.org/foo/page=7">7</a>'
    assert page.pager(url=url, link_attr={'style': 'linkstyle'},
                      curpage_attr={'style': 'curpagestyle'}, dotdot_attr={
            'style': 'dotdotstyle'}) == '<span style="curpagestyle">1</span> <a href="http://example.org/foo/page=2" style="linkstyle">2</a> <a href="http://example.org/foo/page=3" style="linkstyle">3</a> <span style="dotdotstyle">..</span> <a href="http://example.org/foo/page=7" style="linkstyle">7</a>'


def test_slice_page_0():
    items = list(range(1, 1000))
    page = paginate.Page(items, page=0, items_per_page=10)
    assert page.page == 1
    assert page.first_item == 1
    assert page.last_item == 10
    assert page.first_page == 1
    assert page.last_page == 100
    assert page.previous_page is None
    assert page.next_page == 2
    assert page.items_per_page == 10
    assert page.item_count == 999
    assert page.page_count == 100
    assert page.items == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]


def test_slice_page_5():
    items = list(range(1, 1000))
    page = paginate.Page(items, page=5, items_per_page=10)
    assert page.page == 5
    assert page.first_item == 41
    assert page.last_item == 50
    assert page.first_page == 1
    assert page.last_page == 100
    assert page.previous_page is 4
    assert page.next_page == 6
    assert page.items_per_page == 10
    assert page.item_count == 999
    assert page.page_count == 100
    assert page.items == [41, 42, 43, 44, 45, 46, 47, 48, 49, 50]


def test_link_map():
    """Test that fits 10 items on a single 10-item page."""
    items = range(109)
    page = paginate.Page(items, page=0, items_per_page=15)
    url = "http://example.org/foo/page=$page"
    format = '$link_first $link_previous ~4~ $link_next $link_last (Page $page our of $page_count - total items $item_count)'
    result = page.link_map(format, url=url)
    fpage_result = {'current_page': {'attrs': {},
                                     'type': 'current_page',
                                     'href': 'http://example.org/foo/page=1',
                                     'value': 1},
                    'first_page': {'attrs': {},
                                   'href': 'http://example.org/foo/page=1',
                                   'number': 1,
                                   'type': 'first_page',
                                   'value': '&lt;&lt;'},
                    'last_page': {'attrs': {},
                                  'href': 'http://example.org/foo/page=8',
                                  'number': 8,
                                  'type': 'last_page',
                                  'value': '&gt;&gt;'},
                    'next_page': {'attrs': {},
                                  'href': 'http://example.org/foo/page=2',
                                  'number': 2,
                                  'type': 'next_page',
                                  'value': '&gt;'},
                    'previous_page': {'attrs': {},
                                      'href': 'http://example.org/foo/page=1',
                                      'number': 1,
                                      'type': 'previous_page',
                                      'value': '&lt;'},
                    'range_pages': [{'attrs': {},
                                     'href': 'http://example.org/foo/page=1',
                                     'number': 1,
                                     'type': 'current_page',
                                     'value': '1'},
                                    {'attrs': {},
                                     'href': 'http://example.org/foo/page=2',
                                     'number': 2,
                                     'type': 'page',
                                     'value': '2'},
                                    {'attrs': {},
                                     'href': 'http://example.org/foo/page=3',
                                     'number': 3,
                                     'type': 'page',
                                     'value': '3'},
                                    {'attrs': {},
                                     'href': 'http://example.org/foo/page=4',
                                     'number': 4,
                                     'type': 'page',
                                     'value': '4'},
                                    {'attrs': {},
                                     'href': 'http://example.org/foo/page=5',
                                     'number': 5,
                                     'type': 'page',
                                     'value': '5'},
                                    {'attrs': {},
                                     'href': '',
                                     'number': None,
                                     'type': 'span',
                                     'value': '..'}],
                    'radius': 4}
    assert result == fpage_result
    page = paginate.Page(items, page=100, items_per_page=15)
    result = page.link_map(format, url=url)
    l_page_result = {'current_page': {'attrs': {},
                                      'type': 'current_page',
                                      'href': 'http://example.org/foo/page=8',
                                      'value': 8},
                     'first_page': {'attrs': {},
                                    'href': 'http://example.org/foo/page=1',
                                    'number': 1,
                                    'type': 'first_page',
                                    'value': '&lt;&lt;'},
                     'last_page': {'attrs': {},
                                   'href': 'http://example.org/foo/page=8',
                                   'number': 8,
                                   'type': 'last_page',
                                   'value': '&gt;&gt;'},
                     'next_page': {'attrs': {},
                                   'href': 'http://example.org/foo/page=8',
                                   'number': 8,
                                   'type': 'next_page',
                                   'value': '&gt;'},
                     'previous_page': {'attrs': {},
                                       'href': 'http://example.org/foo/page=7',
                                       'number': 7,
                                       'type': 'previous_page',
                                       'value': '&lt;'},
                     'range_pages': [{'attrs': {},
                                      'href': '',
                                      'number': None,
                                      'type': 'span',
                                      'value': '..'},
                                     {'attrs': {},
                                      'href': 'http://example.org/foo/page=4',
                                      'number': 4,
                                      'type': 'page',
                                      'value': '4'},
                                     {'attrs': {},
                                      'href': 'http://example.org/foo/page=5',
                                      'number': 5,
                                      'type': 'page',
                                      'value': '5'},
                                     {'attrs': {},
                                      'href': 'http://example.org/foo/page=6',
                                      'number': 6,
                                      'type': 'page',
                                      'value': '6'},
                                     {'attrs': {},
                                      'href': 'http://example.org/foo/page=7',
                                      'number': 7,
                                      'type': 'page',
                                      'value': '7'},
                                     {'attrs': {},
                                      'href': 'http://example.org/foo/page=8',
                                      'number': 8,
                                      'type': 'current_page',
                                      'value': '8'}],
                     'radius': 4}
    assert result == l_page_result

    page = paginate.Page(items, page=100, items_per_page=15)
    result = page.link_map(format, url=url, symbol_next=u'nëxt',
                           symbol_previous=u'prëvious')
    next_page = {'attrs': {},
                 'href': u'http://example.org/foo/page=8',
                 'number': 8,
                 'type': 'next_page',
                 'value': u'nëxt'}
    assert next_page == result['next_page']


def test_empty_link_map():
    """Test that fits 10 items on a single 10-item page."""
    items = []
    page = paginate.Page(items, page=0, items_per_page=15)
    url = "http://example.org/foo/page=$page"
    format = '$link_first $link_previous ~4~ $link_next $link_last (Page $page our of $page_count - total items $item_count)'
    result = page.link_map(format, url=url)
    assert result == {'current_page': None,
                      'first_page': None,
                      'last_page': None,
                      'next_page': None,
                      'previous_page': None,
                      'radius': 4,
                      'range_pages': []}


def test_make_html_tag():
    """Test the make_html_tag() function"""
    assert paginate.make_html_tag('div') == '<div>'
    assert paginate.make_html_tag('a',
                                  href="/another/page") == '<a href="/another/page">'
    assert paginate.make_html_tag('a', href="/another/page",
                                  text="foo") == '<a href="/another/page">foo</a>'
    assert paginate.make_html_tag('a', href=u"/другой/страница",
                                  text="foo") == u'<a href="/другой/страница">foo</a>'
    assert paginate.make_html_tag('a', href="/another/page", text="foo",
                                  onclick="$('#mydiv').focus();") == """<a href="/another/page" onclick="$('#mydiv').focus();">foo</a>"""
    assert paginate.make_html_tag('span',
                                  style='green') == '<span style="green">'
    assert paginate.make_html_tag('div', _class='red',
                                  id='maindiv') == '<div class="red" id="maindiv">'


def test_url_assertion():
    page = paginate.Page(range(100), page=0, items_per_page=10)
    url = "http://example.org/"
    with pytest.raises(Exception):
        page.pager(url=url)


def test_url_generation():
    def url_maker(page_number):
        return str('x%s' % page_number)

    page = paginate.Page(range(100), page=1, url_maker=url_maker)
    assert page.pager() == '1 <a href="x2">2</a> <a href="x3">3</a> .. <a href="x5">5</a>'


def test_pager_without_any_pattern():
    def url_maker(page_number):
        return str('x%s' % page_number)

    page = paginate.Page(range(100), page=1, url_maker=url_maker)
    assert page.pager('') == ''


def test_pager_without_radius_pattern():
    def url_maker(page_number):
        return str('x%s' % page_number)

    page = paginate.Page(range(100), page=2, url_maker=url_maker)
    assert page.pager(
        '$link_first FOO $link_last') == '<a href="x1">&lt;&lt;</a> FOO <a href="x5">&gt;&gt;</a>'


class UnsliceableSequence(object):
    def __init__(self, seq):
        self.l = seq

    def __iter__(self):
        for i in self.l:
            yield i

    def __len__(self):
        return len(self.l)


class UnsliceableSequence2(UnsliceableSequence):
    def __getitem__(self, key):
        raise TypeError("unhashable type")


class TestCollectionTypes(object):
    rng = list(range(10))  # A list in both Python 2 and 3.

    def test_list(self):
        paginate.Page(self.rng)

    def test_list_of_dicts(self):
        rng = [{'a':x} for x in range(200)]
        page = paginate.Page(rng)
        assert page.item_count == 200

    def test_tuple(self):
        paginate.Page(tuple(self.rng))

    def test_unsliceable_sequence(self):
        with pytest.raises(TypeError):
            paginate.Page(UnsliceableSequence(self.rng))

    def test_unsliceable_sequence2(self):
        with pytest.raises(TypeError):
            paginate.Page(UnsliceableSequence2(self.rng))

    def test_unsliceable_sequence3(self):
        with pytest.raises(TypeError):
            paginate.Page(dict(one=1))