feed.core.feed module

class feed.core.feed.DataFeed(streams: List[feed.core.base.Stream])[source]

Bases: feed.core.base.Stream

A stream the compiles together streams to be run in an organized manner.

Parameters:streams (List[Stream]) – A list of streams to be used in the data feed.
compile() → None[source]

Compiles all the given stream together.

Organizes the order in which streams should be run to get valid output.

forward() → dict[source]

Generates the next value from the underlying data streams.

Returns:The next value in the stream.
Return type:T
has_next() → bool[source]

Checks if there is another value.

Returns:If there is another value or not.
Return type:bool
next() → dict[source]
reset() → None[source]

Resets all the listeners of the stream.

run() → None[source]

Runs all the streams in processing order.

class feed.core.feed.PushFeed(streams: List[feed.core.base.Stream])[source]

Bases: feed.core.feed.DataFeed

A data feed for working with live data in an online manner.

All sources of data to be used with this feed must be a Placeholder. This ensures that the user can wait until all of their data has been loaded for the next time step.

Parameters:streams (List[Stream]) – A list of streams to be used in the data feed.
is_loaded
next() → dict[source]
push(data: dict) → dict[source]

Generates the values from the data feed based on the values being provided in data.

Parameters:data (dict) – The data to be pushed to each of the placholders in the feed.
Returns:The next data point generated from the feed based on data.
Return type:dict