Pagination¶

The API provides a paginated response to requests, encapsulated in the Python client, returning an object that you can use to iterate over and explore the data.

from mbed_cloud import ConnectAPI
api = ConnectAPI()
paginator = api.list_connected_devices()
print(paginator.count())
print(paginator.first())
print(len(paginator))
for d in paginator:
  print(d)

Reference¶

Pagination

class mbed_cloud.pagination.PaginatedResponse(func, lwrap_type=None, _results_cache=True, page_size=None, max_results=None, **kwargs)¶

Represents a sequence of results from the API

To represent the potentially large number of results returned from an API query, the PaginatedResponse provides a lazily-evaluated generator which can be used to step through the full result set, fetching new pages of results as needed.

Usage:

response = PaginatedResponse(api_function)
response.first() {} first item
response.all() [{}, …] all items
list(response) [{}, …] all items from generator
[item for item in response] [{}, …] iteration over generator

all()¶: All results

count()¶: Approximate number of results, according to the API

data¶: Deprecated. Returns the data as a list

first()¶: Returns the first item from the query, or None if there are no results

next()¶: Next item in sequence (Python 2 compatibility)

to_dict()¶: Internal state

Documentation

Table Of Contents