ebonite.core.objects.dataset_source module

class ebonite.core.objects.dataset_source.AbstractDataset(dataset_type: ebonite.core.objects.dataset_type.DatasetType)[source]

Bases: pyjackson.core.Unserializable

ABC for Dataset objects

Parameters:dataset_type – DatasetType instance for the data in the Dataset
iterate() → collections.abc.Iterable[source]

Abstract method to iterate through data

get()[source]

Abstract method to get data object

get_writer()[source]

Returns writer for this dataset. Defaults to dataset_type.get_writer()

get_reader()[source]

Returns reader for this dataset. Defaults to dataset_type.get_reader()

class ebonite.core.objects.dataset_source.Dataset(data: Any, dataset_type: ebonite.core.objects.dataset_type.DatasetType)[source]

Bases: ebonite.core.objects.dataset_source.AbstractDataset

Wrapper for dataset objects

Parameters:
  • data – raw dataset
  • dataset_type – DatasetType of the raw data
iterate() → collections.abc.Iterable[source]

Abstract method to iterate through data

get()[source]

Abstract method to get data object

classmethod from_object(data)[source]

Creates Dataset instance from raw data object

to_inmemory_source() → ebonite.core.objects.dataset_source.InMemoryDatasetSource[source]

Returns InMemoryDatasetSource with this dataset

class ebonite.core.objects.dataset_source.DatasetSource(dataset_type: ebonite.core.objects.dataset_type.DatasetType)[source]

Bases: ebonite.core.objects.dataset_source.DatasetSource, pyjackson.decorators.SubtypeRegisterMixin

Class that represents a source that can produce a Dataset

Parameters:dataset_type – DatasetType of contained dataset
type = 'pyjackson.decorators.DatasetSource'
class ebonite.core.objects.dataset_source.CachedDatasetSource(source: ebonite.core.objects.dataset_source.DatasetSource)[source]

Bases: ebonite.core.objects.dataset_source.DatasetSource

Wrapper that will cache the result of underlying source on the first read

Parameters:source – underlying DatasetSource
read() → ebonite.core.objects.dataset_source.Dataset[source]

Abstract method that must return produced Dataset instance

cache()[source]

Returns CachedDatasetSource that will cache data on the first read

type = 'ebonite.core.objects.dataset_source.CachedDatasetSource'
class ebonite.core.objects.dataset_source.InMemoryDatasetSource(dataset: ebonite.core.objects.dataset_source.Dataset)[source]

Bases: ebonite.core.objects.dataset_source.CachedDatasetSource, pyjackson.core.Unserializable

DatasetSource that holds existing dataset inmemory

Parameters:dataset – Dataset instance to hold
type = 'ebonite.core.objects.dataset_source.InMemoryDatasetSource'