mage.api_resources.abstract.listable_api_resource module¶

class mage.api_resources.abstract.listable_api_resource.ListObject(cls, fn, params, items, next_token, subresult=[])¶

Bases: object

The ListObject class is a list-like container for results returned from the MAGE server. It additionally tracks a ‘next_token’ which enables it to retrieve additional results from the server as needed.

auto_paging_iter()¶

Iterates through all results from the query, retrieving more from the server as needed.

Yields: all results items.

cls = None¶: the class of objects stored in the list

data = None¶: the data received from the server

fn = None¶: the function used as the main query for more records

next_page()¶: Retrieves the next set of results from the server.

next_token = None¶: the token to use for more results

class mage.api_resources.abstract.listable_api_resource.ListObjectIterator(lo)¶

Bases: object

Iterator class

class mage.api_resources.abstract.listable_api_resource.ListableAPIResource¶

Bases: mage.api_resources.abstract.data_api_resource.DataAPIResource, mage.api_resources.abstract.filterable_api_resource.FilterableAPIResource

This parent class provides functionality for retrieving data from the server.

classmethod get(id)¶

Gets a single result from the server for those classes that support it.

Parameters: id (str) – ID of the object to retrieve
Returns: Object instance of the the class

Results:

>>> import mage
>>> mage.connect()
>>> mage.Assessment.get('12345')

classmethod list(**params)¶

Queries the server backend for data.

Parameters: **params – Parameters to include in the query. These are indirectly passed in via calls to ‘select’, ‘contains’, etc.
Returns: ListObject of class instances

Example

>>> import mage
>>> mage.connect()
>>> mage.Assessment.list()

classmethod search(**params)¶

Queries the server backend that supports sorting and other useful features.

Parameters: **params – Parameters to include in the query. These are indirectly passed in via calls to ‘sort’, ‘match’, etc.
Returns: ListObject of class instances

Example

>>> import mage
>>> mage.connect()
>>> mage.Finding.search()

class mage.api_resources.abstract.listable_api_resource.ListableAPIResourceMeta¶: Bases: type