# {py:mod}`django_twc_toolbox.paginator`

```{py:module} django_twc_toolbox.paginator
```

```{autodoc2-docstring} django_twc_toolbox.paginator
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`DatePaginator <django_twc_toolbox.paginator.DatePaginator>`
  - ```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator
    :summary:
    ```
* - {py:obj}`DatePage <django_twc_toolbox.paginator.DatePage>`
  -
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_T <django_twc_toolbox.paginator._T>`
  - ```{autodoc2-docstring} django_twc_toolbox.paginator._T
    :summary:
    ```
````

### API

````{py:data} _T
:canonical: django_twc_toolbox.paginator._T
:value: >
   'TypeVar(...)'

```{autodoc2-docstring} django_twc_toolbox.paginator._T
```

````

`````{py:class} DatePaginator(object_list: django.core.paginator._SupportsPagination[django_twc_toolbox.paginator._T], date_field: str, page_date_range: datetime.timedelta, **kwargs: typing.Any)
:canonical: django_twc_toolbox.paginator.DatePaginator

Bases: {py:obj}`typing.Generic`\[{py:obj}`django_twc_toolbox.paginator._T`\], {py:obj}`django.core.paginator.Paginator`\[{py:obj}`django_twc_toolbox.paginator._T`\]

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator.__init__
```

````{py:method} date_segments() -> list[tuple[datetime.date, datetime.date]]
:canonical: django_twc_toolbox.paginator.DatePaginator.date_segments

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator.date_segments
```

````

````{py:method} page(number: int | str) -> django_twc_toolbox.paginator.DatePage[django_twc_toolbox.paginator._T]
:canonical: django_twc_toolbox.paginator.DatePaginator.page

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator.page
```

````

````{py:method} _get_page_object_list_for_range(start_date: datetime.date, end_date: datetime.date) -> django.db.models.query.QuerySet[typing.Any] | list[typing.Any]
:canonical: django_twc_toolbox.paginator.DatePaginator._get_page_object_list_for_range

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator._get_page_object_list_for_range
```

````

````{py:method} chronological() -> bool
:canonical: django_twc_toolbox.paginator.DatePaginator.chronological

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator.chronological
```

````

````{py:method} _get_page(*args: typing.Any, **kwargs: typing.Any) -> django_twc_toolbox.paginator.DatePage[django_twc_toolbox.paginator._T]
:canonical: django_twc_toolbox.paginator.DatePaginator._get_page

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator._get_page
```

````

````{py:method} num_pages() -> int
:canonical: django_twc_toolbox.paginator.DatePaginator.num_pages

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator.num_pages
```

````

````{py:method} _check_object_list_is_ordered()
:canonical: django_twc_toolbox.paginator.DatePaginator._check_object_list_is_ordered

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePaginator._check_object_list_is_ordered
```

````

`````

`````{py:class} DatePage(object_list: django.core.paginator._SupportsPagination[django_twc_toolbox.paginator._T], number: int, paginator: django_twc_toolbox.paginator.DatePaginator[django_twc_toolbox.paginator._T], start_date: datetime.datetime, end_date: datetime.datetime)
:canonical: django_twc_toolbox.paginator.DatePage

Bases: {py:obj}`django.core.paginator.Page`\[{py:obj}`django_twc_toolbox.paginator._T`\]

````{py:method} min_date() -> datetime.datetime
:canonical: django_twc_toolbox.paginator.DatePage.min_date

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePage.min_date
```

````

````{py:method} max_date() -> datetime.datetime
:canonical: django_twc_toolbox.paginator.DatePage.max_date

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePage.max_date
```

````

````{py:method} date_range() -> tuple[datetime.datetime, datetime.datetime]
:canonical: django_twc_toolbox.paginator.DatePage.date_range

```{autodoc2-docstring} django_twc_toolbox.paginator.DatePage.date_range
```

````

`````