yellowdog_client.common – Common

yellowdog_client.common contains the classes that the yellowdog_client services share, such as the yellowdog_client.common.SearchClient that each search returns.

class yellowdog_client.common.SearchClient(get_next_slice_function)
Parameters:

get_next_slice_function (Callable[[SliceReference], Slice[TypeVar(T)]])

iterate()

Iterates over all the items. Warning: This method will iterate over all response slices, loading slices when required by the iterator. See the slice method for more control. :rtype: SliceIterator[TypeVar(T)] :return: an iterator for all items

list_all()

Lists all the items. Warning: This method will automatically iterate over all response slices. See the slice method for more control. :rtype: List[TypeVar(T)] :return: a list of all items

slice(slice_reference)

Retrieve a slice of items from a given point & with a given size defined by a slice reference. :type slice_reference: SliceReference :param slice_reference: the slice reference :rtype: Slice[TypeVar(T)] :return: a slice of items from the given point

class yellowdog_client.common.SliceIterator(get_next_slice_function)
Parameters:

get_next_slice_function (Callable[[SliceReference], Slice[TypeVar(T)]])

class yellowdog_client.common.server_sent_events.SubscriptionEventListener
subscription_cancelled()

Invoked if the server cancels the subscription associated with this listener

Return type:

None

subscription_error(error)

Invoked if an error occurs on the subscription associated with this listener.

Parameters:

error (Exception) – the error that occurred

Return type:

None

updated(obj)

Invoked when an updated instance of the object is received from YellowDog Platform.

Parameters:

obj (TypeVar(T)) – an updated instance of the object for which the listener was registered

Return type:

None

class yellowdog_client.common.Proxy

The base class of the service proxies, which send the services’ requests to the YellowDog Platform.

class yellowdog_client.common.server_sent_events.sse4python.EventSource(url, auth, headers, timeout=(None, None))
Parameters: