rest_framework.pagination.PageNumberPagination

class documentation

class PageNumberPagination(BasePagination): (source)

View In Hierarchy

A simple page number based style that supports page numbers as query parameters. For example: http://api.example.org/accounts/?page=4 http://api.example.org/accounts/?page=4&page_size=100

Method get_html_context Undocumented
Method get_next_link Undocumented
Method get_page_number Undocumented
Method get_page_size Undocumented
Method get_paginated_response Undocumented
Method get_paginated_response_schema Undocumented
Method get_previous_link Undocumented
Method get_schema_fields Undocumented
Method get_schema_operation_parameters Undocumented
Method paginate_queryset Paginate a queryset if required, either returning a page object, or `None` if pagination is not configured for this view.
Method to_html Undocumented
Class Variable invalid_page_message Undocumented
Class Variable last_page_strings Undocumented
Class Variable max_page_size Undocumented
Class Variable page_query_description Undocumented
Class Variable page_query_param Undocumented
Class Variable page_size_query_description Undocumented
Class Variable page_size_query_param Undocumented
Class Variable template Undocumented
Instance Variable display_page_controls Undocumented
Instance Variable page Undocumented
Instance Variable request Undocumented

Inherited from BasePagination:

Method get_results Undocumented
def get_html_context(self): (source)

Undocumented

def get_next_link(self): (source)

Undocumented

def get_page_number(self, request, paginator): (source)

Undocumented

def get_page_size(self, request): (source)

Undocumented

def get_paginated_response(self, data): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response

Undocumented

def get_paginated_response_schema(self, schema): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response_schema

Undocumented

def get_previous_link(self): (source)

Undocumented

def get_schema_fields(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_fields

Undocumented

def get_schema_operation_parameters(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_operation_parameters

Undocumented

def paginate_queryset(self, queryset, request, view=None): (source)
overrides rest_framework.pagination.BasePagination.paginate_queryset

Paginate a queryset if required, either returning a page object, or `None` if pagination is not configured for this view.

def to_html(self): (source)
overrides rest_framework.pagination.BasePagination.to_html

Undocumented

invalid_page_message = (source)

Undocumented

last_page_strings: tuple[str, ...] = (source)

Undocumented

max_page_size = (source)

Undocumented

page_query_description = (source)

Undocumented

page_query_param: str = (source)

Undocumented

page_size_query_description = (source)

Undocumented

page_size_query_param = (source)

Undocumented

template: str = (source)

Undocumented

display_page_controls: bool = (source)
overrides rest_framework.pagination.BasePagination.display_page_controls

Undocumented

page = (source)

Undocumented

request = (source)

Undocumented