Paginator¶
Summary¶
Classes
|
Paginator that attempts to get as many results as possible from an autocomplete endpoint. |
|
Paginator for ID-based endpoints that only accept a limited number of IDs per request |
|
Paginate by a range of IDs instead of standard pagination parameters |
|
|
|
|
|
Paginator mixin that returns raw response dicts instead of model objects |
|
Class to handle pagination of API requests, with async support |
|
Paginator class that wraps results that have already been fetched. |
Functions
|
Get all pages of a multi-page request. |
Module Contents¶
Classes to handle pagination of API requests
- class pyinaturalist.paginator.AutocompletePaginator(*args, **kwargs)¶
Bases:
Paginator
Paginator that attempts to get as many results as possible from an autocomplete endpoint. This is necessary for some problematic queries for which there are many matches but not ranked with the desired match(es) first.
This works based on different rankings being returned for order_by=area. No other fields can be sorted on, and direction can’t be specified, but this can at least provide a few additional results beyond the limit of 20.
All results will be de-duplicated and returned as a single page. This may potentially be applied to other autocomplete endpoints, but so far is only needed for places.
- class pyinaturalist.paginator.IDPaginator(*args, ids=None, ids_per_request=1, **kwargs)¶
Bases:
Paginator
Paginator for ID-based endpoints that only accept a limited number of IDs per request
- class pyinaturalist.paginator.IDRangePaginator(*args, **kwargs)¶
Bases:
Paginator
Paginate by a range of IDs instead of standard pagination parameters
Note
Note on pagination by ID, from the iNaturalist documentation:
The large size of the observations index prevents us from supporting the page parameter when retrieving records from large result sets. If you need to retrieve large numbers of records, use the ``per_page`` and ``id_above`` or ``id_below`` parameters instead.
- class pyinaturalist.paginator.JsonIDRangePaginator(request_function, *request_args, **kwargs)¶
Bases:
JsonPaginatorMixin
,IDRangePaginator
- class pyinaturalist.paginator.JsonPaginator(request_function, *request_args, **kwargs)¶
Bases:
JsonPaginatorMixin
,Paginator
- class pyinaturalist.paginator.JsonPaginatorMixin(request_function, *request_args, **kwargs)¶
Bases:
object
Paginator mixin that returns raw response dicts instead of model objects
- class pyinaturalist.paginator.Paginator(request_function, model, *request_args, limit=None, per_page=None, loop=None, **request_kwargs)¶
Bases:
Iterable
,AsyncIterable
,Generic
[T
]Class to handle pagination of API requests, with async support
- Parameters:
request_function (
Callable
) – API request function to paginatemodel (
Type
[TypeVar
(T
, bound= BaseModel)]) – Model class to use for resultslimit (
Optional
[int
]) – Maximum number of total results to fetchper_page (
Optional
[int
]) – Maximum number of results to fetch per pageloop (
Optional
[AbstractEventLoop
]) – An event loop to use to run any executors used for async iterationkwargs – Original request parameters
- async async_all()¶
Get all results in a single list (non-blocking)
- count()¶
Get the total number of results for this query, without fetching response data.
- Return type:
- Returns:
Either the total number of results, if the endpoint provides pagination info, or
-1
- next_page()¶
Get the next page of results, as model objects
- class pyinaturalist.paginator.WrapperPaginator(results, *args, **kwargs)¶
Bases:
Paginator
Paginator class that wraps results that have already been fetched.
- count()¶
Get the total number of results for this query, without fetching response data.
- Return type:
- Returns:
Either the total number of results, if the endpoint provides pagination info, or
-1
- next_page()¶
Get the next page of results, as model objects