encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-03-02 18:26:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add get_page_size hook to CursorPagination. Closes #3068.

Browse Source
This commit is contained in:
Tom Christie 2015-07-14 11:40:15 +01:00
parent 1d012aeb93
commit 14a32ae32d
2 changed files with 0 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
rest_framework/pagination.py
View File

@ -454,14 +454,6 @@ class CursorPagination(BasePagination):
# Defaults to `None`, meaning pagination is disabled. # Defaults to `None`, meaning pagination is disabled.
page_size = api_settings.PAGE_SIZE page_size = api_settings.PAGE_SIZE
# Client can control the page size using this query parameter.
# Default is 'None'. Set to eg 'page_size' to enable usage.
page_size_query_param = None
# Set to an integer to limit the maximum page size the client may request.
# Only relevant if 'page_size_query_param' has also been set.
max_page_size = None
invalid_cursor_message = _('Invalid cursor') invalid_cursor_message = _('Invalid cursor')
ordering = '-created' ordering = '-created'
template = 'rest_framework/pagination/previous_and_next.html' template = 'rest_framework/pagination/previous_and_next.html'
@ -544,16 +536,6 @@ class CursorPagination(BasePagination):
return self.page return self.page
def get_page_size(self, request): def get_page_size(self, request):
if self.page_size_query_param:
try:
return _positive_int(
request.query_params[self.page_size_query_param],
strict=True,
cutoff=self.max_page_size
)
except (KeyError, ValueError):
pass
return self.page_size return self.page_size
def get_next_link(self): def get_next_link(self):

20
tests/test_pagination.py
View File

@ -513,8 +513,6 @@ class TestCursorPagination:
class ExamplePagination(pagination.CursorPagination): class ExamplePagination(pagination.CursorPagination):
page_size = 5 page_size = 5
page_size_query_param = 'page_size'
max_page_size = 20
ordering = 'created' ordering = 'created'
self.pagination = ExamplePagination() self.pagination = ExamplePagination()
@ -650,24 +648,6 @@ class TestCursorPagination:
assert isinstance(self.pagination.to_html(), type('')) assert isinstance(self.pagination.to_html(), type(''))
def test_page_size(self):
(previous, current, next, previous_url, next_url) = \
self.get_pages('/?page_size=10')
assert previous is None
assert current == [1, 1, 1, 1, 1, 1, 2, 3, 4, 4]
assert next == [4, 4, 5, 6, 7, 7, 7, 7, 7, 7]
assert 'page_size=10' in next_url
(previous, current, next, previous_url, next_url) = \
self.get_pages(next_url.replace('page_size=10', 'page_size=4'))
assert previous == [2, 3, 4, 4]
assert current == [4, 4, 5, 6]
assert next == [7, 7, 7, 7]
assert 'page_size=4' in previous_url
assert 'page_size=4' in next_url
def test_get_displayed_page_numbers(): def test_get_displayed_page_numbers():
""" """